Skip to main content

Lesson API

學習課程相關的API

Endpoints​

# Endpoints
GET
/app/lesson/overview
# 獲取課程學習情況
GET
/app/lesson/categories
# 獲取課程分類
GET
/app/lesson/learning
# 獲取正在學習課程
POST
/app/lesson/all-lesson-page
# 全部課程
POST
/app/lesson/my-lesson-page
# 我的課程

Get overview​

獲取課程概覽

Request​

GET /app/lesson/overview

Response (LessonOverview)​

{
  "success": true,
  "message": "",
  "data": [
    {
      "finished": 0,
      "studying": 1,
      "learnable": 3,
      "hasNew": false,
      "recommendationTotal": 5
    }
  ]
}

Get categories​

獲取課程类别

Request​

GET /app/lesson/categories

Response (LessonCategories)​

{
  "success": true,
  "message": "",
  "data": [
    [
      {
        "type": 1,
        "desc": "復元概念"
      },
      {
        "type": 2,
        "desc": "精神健康"
      },
      {
        "type": 3,
        "desc": "身體健康"
      },
      {
        "type": 4,
        "desc": "與人聯繫"
      }
    ]
  ]
}

Get continue learning​

獲取學習建議

Request​

GET /app/lesson/learning

Response (LearningLessonDTO)​

{
  "success": true,
  "message": "",
  "data": [
    {
      "lessonId": "fe8f75a9-b8a0-4f54-8249-fe136011e5f1",
      "title": "课程標題",
      "chapterTotal": 3,
      "isVideo": false,
      "isAudio": false,
      "isImage": true,
      "pic": {
        "fileKey": "mhahk/lesson/cover/L004/1",
        "url": "https://jcci-test-media.aritaone.com/mhahk/lesson/cover/L004/1"
      }
    }
  ]
}

All lesson​

全部課程

Request (GetAllLessonReqDTO)​

POST /app/lesson/all-lesson-page
{
  "category": 0,
  "pagination": {
    "page": 1,
    "size": 10
  },
  "sortings": []
}

Response (AllLessonRespDTO)​

{
  "success": true,
  "message": "",
  "data": {
    "pagination": {
      "page": 1,
      "size": 10,
      "totalItems": 4,
      "totalPages": 1
    },
    "sortings": [
      {
        "direction": "DESC",
        "property": "createdAt"
      }
    ],
    "items": [
      {
        "lessonId": "d1f0f358-0e67-4d8e-bf40-0517b99245ce",
        "title": "課程一",
        "chapterTotal": 0,
        "opened": false,
        "isVideo": true,
        "isAudio": true,
        "isImage": true,
        "categories": [
          "精神健康"
        ],
        "pic": {
          "fileKey": "mhahk/lesson/cover/L004/1",
          "url": "https://jcci-test-media.aritaone.com/mhahk/lesson/cover/L004/1"
        }
      }
    ]
  }
}

My lesson​

全部課程

Request (GetMyLessonReqDTO)​

POST /app/lesson/my-lesson-page
{
  "status": 1,
  "pagination": {
    "page": 1,
    "size": 10
  },
  "sortings": []
}

Response (MyLessonRespDTO)​

{
  "success": true,
  "message": "",
  "data": {
    "pagination": {
      "page": 1,
      "size": 10,
      "totalItems": 4,
      "totalPages": 1
    },
    "sortings": [
      {
        "direction": "DESC",
        "property": "createdAt"
      }
    ],
    "items": [
      {
        "lessonId": "63238871-bfb5-4b24-8987-78ab55acbb21",
        "title": "浴袍团之观人我要",
        "chapterTotal": 1,
        "finishedCount": 0,
        "categories": [
          "復元概念",
          "精神健康",
          "身體健康",
          "與人聯繫"
        ],
        "pic": {
          "fileKey": "mhahk/lesson/cover/L001/1",
          "url": "https://jcci-test-media.aritaone.com/mhahk/lesson/cover/L001/1"
        },
        "chapterFinishedCollection": [
          {
            "chapterSort": 1,
            "isFinished": true
          },
          {
            "chapterSort": 2,
            "isFinished": false
          }
        ]
      }
    ]
  }
}

Resources​

LessonOverview​

properties
  • finished
    int
    required
    已完成課程
  • studying
    int
    required
    學習中課程
  • learnable
    int
    required
    可學課程
  • hasNew
    boolean
    required
    是否學習建議的紅點
  • recommendationTotal
    int
    required
    學習建議的數量

LearningLessonDTO​

properties
  • lessonId
    string
    required
    課程ID
  • title
    string
    required
    课程標題
  • chapterTotal
    int
    required
    章節總數
  • isVideo
    boolean
    required
    是否有視頻
  • isAudio
    boolean
    required
    是否有音頻
  • isImage
    boolean
    required
    是否有圖片
  • pic
    object
    required
    封面圖片
  • fileKey
    string
    required
    封面圖片FileKey
  • url
    string
    required
    封面圖片連結

GetAllLessonReqDTO​

properties
  • category
    LessonCategory
    課程類別

AllLessonRespDTO​

properties
  • lessonId
    string
    required
    課程ID
  • title
    string
    required
    課程標題
  • chapterTotal
    int
    required
    章節總數
  • opened
    boolean
    required
    是否打開過課程, 未打開過：false， 已打開過：true
  • isVideo
    boolean
    required
    是否有視頻
  • isAudio
    boolean
    required
    是否有音頻
  • isImage
    boolean
    required
    是否有圖片
  • categories
    int
    required
    課程類別
  • pic
    object
    required
    封面圖片
  • fileKey
    string
    required
    封面圖片FileKey
  • url
    string
    required
    封面圖片連結

GetMyLessonReqDTO​

properties
  • status
    LessonStudyStatus
    課程學習狀態

MyLessonRespDTO​

properties
  • lessonId
    string
    required
    課程ID
  • title
    string
    required
    課程標題
  • chapterTotal
    int
    required
    章節總數
  • finishedCount
    int
    required
    完成章節數
  • categories
    array[string]
    required
    課程類別
  • pic
    object
    required
    封面圖片
  • fileKey
    string
    required
    封面圖片FileKey
  • url
    string
    required
    封面圖片連結
  • chapterFinishedCollection
    array[object]
    required
    章節完成情況對象
  • chapterSort
    int
    required
    章節序號
  • isFinished
    boolean
    required
    是否完成

LessonCategories​

properties
  • type
    int
    required
    type
  • desc
    string
    required
    desc

LessonCategory​

TypeDescription
0所有
1復元概念
2精神健康
3身體健康
4與人聯繫

LessonStudyStatus​

TypeDescription
1學習中
2已完成