API Khóa học
Các API truy xuất dữ liệu khóa khọc
Get Courses
GET https://api.agilearn.app/api-getCourses
Lấy dữ liệu tất cả các khóa học của Agilearn
Query Parameters
learningSpace
string
Id của learning space (phần subdomain, ví dụ nal, hocvienagile, hblab,...)
Headers
Content-type
string
application/json
Accept
string
application/json
Authentication
string
Access token
{
status: true,
data: [{
"id": '1',
"title": "",
"shortCode": "",
"displayShortCode": "" // optional,
"state": "PUBLIC" or "UNPUBLISHED" or "DRAFT",
"brief": "" // optional,
"numberOfUsers": 0 // optional,
"introduction": {
"purpose": //optional
"0": "purpose 1",
"1": "purpose 2",
...
"description": "" // optional
"video": "" // optional
}
"timeTracks": {
publicAt: "2020-12-27T17:00:00.000Z" // optional
} // optional,
"appearance": {
"color": ""
"coverPhotoUrl": ""
"thumbnailUrl": ""
}
}]
}Mô tả dữ liệu trả về
Trường
Dữ liệu
Mô tả
status
boolean
Trạng thái
id
string
ID của khóa học
title
string
Tiêu đề khóa học
shortCode
string
Mã rút gọn của khóa học
displayShortCode (optional)
string
Hiển thị của mã rút gọn khóa học
state
string
Trạng thái của khóa học
brief
string
Tóm tắt nội dung khóa học
numberOfUsers (optional)
number
Số lượng người đang học khóa học
introduction
object
Giới thiệu khóa học
purpose (optional)
object
Mục tiêu của khóa học
description (optional)
string
Mô tả giới thiệu khóa học
video (optional)
string
Url của video giới thiệu
timeTracks (optional)
object
Các dữ liệu thời gian
publicAt (optional)
Date
Thời điểm khóa học được xuất bản
appearance
object
color
string
Màu chủ đạo của khóa học
thumbnailUrl
string
Url của ảnh thumbnail khóa học
coverPhotoUrl
string
Url của ảnh cover khóa học
Get Course Detail v1
GET https://api.agilearn.app/api-getCourseDetail/v1
Lấy dữ liệu chi tiết một khóa học
Query Parameters
courseId
string
course id
Headers
Content-type
string
application/json
Accept
string
application/json
Authorization
string
{access token}
Mô tả dữ liệu trả về
Trường
Dữ liệu
Mô tả
status
boolean
Trạng thái
id
string
ID của khóa học
title
string
Tiêu đề khóa học
shortCode
string
Mã rút gọn của khóa học
displayShortCode (optional)
string
Hiển thị mã rút gọn của khóa học
state
string
Trạng thái của khóa học
brief
string
Tóm tắt nội dung khóa học
numberOfUsers (optional)
string
Số lượng người đang học khóa học
introduction
object
Giới thiệu khóa học
purpose (optional)
object
Mục tiêu của khóa học
description (optional)
string
Mô tả giới thiệu khóa học
video (optional)
string
Url của video giới thiệu
timeTracks (optional)
object
Các dữ liệu thời gian
publicAt (optional)
Date
Thời điểm khóa học được xuất bản
appearance
object
color
string
Màu chủ đạo của khóa học
thumbnailUrl
string
Url của ảnh thumbnail khóa học
coverPhotoUrl
string
Url của ảnh cover khóa học
Các mục của khóa học
sections
array
Các mục trong khóa học
id (sectionId)
string
ID của mục
title
string
Tiêu đề của mục
ordering
number
Thứ tự của mục trong khóa học
Các bài học trong mục
lectures
array
Các bài học trong 1 mục
id (lectureId)
string
ID của bài học
title
string
Tiêu đề của bài học
ordering
number
Thứ tự của bài học trong mục
brief (optional)
string
Tóm tắt nội dung bài học
durations
number
Thời lượng của bài học, tính bằng giây (second)
icon
string
Icon hiển thị của bài học
isRequired
boolean
Bài học có bắt buộc không
version
string
Phiên bản của bài học
Các bài kiểm tra trong mục
quizzes
array
Các bài kiểm tra trong 1 mục
id (quizId)
string
ID của bài kiểm tra
ordering
number
Thứ tự của bài kiểm tra trong mục
name
string
Tên bài kiểm tra
settings
object
Cấu hình bài kiểm tra
deductPoint
object
Cấu hình trừ điểm của bài kiểm tra
deductPoint - checked
boolean
Có trừ điểm khi làm sai không
deductPoint - value
number
Giá trị tính theo % của điểm trừ khi làm sai câu hỏi
limitTime
object
Cấu hình giới hạn thời gian làm bài kiểm tra
limitTime - checked
boolean
Có giới hạn thời gian làm bài không
limitTime - value
number
Thời gian giới hạn làm bài tính bằng phút (minute)
maxAttempt
number
Số lần làm bài tối đa
pointToPass
number
Điểm để vượt qua bài thi (đã chia 100, ví dụ điểm vượt qua là 80% thì giá trị của pointToPass là 0.8)
randomOrder
boolean
Có xáo trộn vị trí các câu hỏi khi làm bài hay không
recordResultOn
string
Cách ghi nhận kết quả làm bài. HIGHEST là lấy điểm bài làm cao nhất, FIRST là lấy điểm lần làm bài đầu tiên, LAST là lấy điểm lần làm bài cuối cùng
showCorrectAnswers
boolean
Có hiển thị đáp án của câu hỏi sau khi học viên xem lại bài kiểm tra không
showHistory
boolean
Có hiển thị lịch sử làm bài kiểm tra của học viên không
showOverallFeedback
boolean
Có hiển thị overall feedback của câu hỏi sau khi học viên xem lại bài kiểm tra không
Get Lecture Detail v1
GET https://api.agilearn.app/api-getLectureDetail/v1
Truy xuất dữ liệu chi tiết của bài học
Query Parameters
id
string
lecture id
Headers
Accept
string
application/json
Content-type
string
application/json
Authorization
string
{access token}
Trường
Dữ liệu
Mô tả
status
boolean
Trạng thái
id
string
ID của bài học
title
string
Tiêu đề của bài học
brief
string
Tóm tắt bài học
durations
number
Thời lượng của bài học tính bằng giây
intro
string
Giới thiệu bài học
icon
string
Icon hiển thị của bài học
state
string
Trạng thái của bài học
Các hoạt động của bài học
activities
array
Các hoạt động của bài học
id (activityId)
string
ID của hoạt động
title
string
Tiêu đề của hoạt động
description
string
Mô tả hoạt động
ordering
number
Thứ tự của hoạt động trong bài học
durations (optional)
number
Thời lượng của hoạt động tính bằng giây (second)
type
string
Loại hoạt động
data
object
Dữ liệu của hoạt động
url (optional)
string
Url của hoạt động dạng video hoặc url
description (optional)
string
Mô tả hoạt động
files (optional)
object
Các file của hoạt động dạng file_list
fileName
string
Tên file trong hoạt động dạng file_list
filePath
string
Đường đẫn của file trong hoạt động dạng file_list (sử dụng api getSignedDownloadUrl để lấy url)
content (optional)
string
Nội dung của hoạt động dạng reading
questions
object
Các câu hỏi của hoạt động dạng review_question
Get Quiz Detail v1
GET https://api.agilearn.app/api-getQuizDetail/v1
Truy xuất dữ liệu chi tiết bài kiểm tra của khóa học
Query Parameters
courseId
string
course id
quizId
string
quiz id
Headers
Accept
string
application/json
Content-type
string
application/json
Authorization
string
{access token}
Mô tả dữ liệu trả về
Trường
Dữ liệu
Mô tả
status
boolean
Trạng thái
id
string
ID của bài kiểm tra
name
string
Tên bài kiểm tra
settings
object
Cấu hình bài kiểm tra
Các câu hỏi của bài kiểm tra
questions
array
Các câu hỏi của bài kiểm tra
id (questionId)
string
ID của câu hỏi
bloomLadderLevel
string
Mức độ trên thang bloom của câu hỏi
content
string
Nội dung câu hỏi
type
string
Loại câu hỏi
Các câu trả lời của câu hỏi
answers
array
Các câu trả lời của câu hỏi
id (answerId)
string
ID của câu trả lời
content
string
Nội dung câu trả lời
isCorrect
boolean
Có phải là câu trả lời đúng không
overallFeedback
string
overall feedback
Get Signed Download Url v1
GET https://api.agilearn.app/api-getSignedDownloadUrl
Lấy url download
Query Parameters
p
string
File path
Headers
Content-type
string
application/json
Accept
string
application/json
Authorization
string
{access token}
Trường
Dữ liệu
Mô tả
status
boolean
Trạng thái
signedUrl
string
Url của file trong hệ thống
expireAt
Date
Thời điểm url sẽ hết hạn và không còn hiệu lực
Last updated
Was this helpful?