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

Name	Type	Description
learningSpace*	string	Id của learning space (phần subdomain, ví dụ nal, hocvienagile, hblab,...)

Headers

Name	Type	Description
Content-type*	string	application/json
Accept*	string	application/json
Authentication*	string	Access token

200 Cake successfully retrieved.

{
    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": ""
            }
        }]
}

401

403

404

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 v2

GET https://api.agilearn.app/api-getCourseDetail/v2

Lấy dữ liệu chi tiết một khóa học

Query Parameters

Name	Type	Description
classId*	string	id lớp của người dùng
userEmail*	string	email của người dùng cần lấy thông tin khóa học
learningSpaceId*	string	learning space id mà người dùng đang sử dụng (ví dụ: chatops, hocvienagile,...)
courseId*	string	id của khóa học cần lấy thông tin

Headers

Name	Type	Description
Content-type*	string	application/json
Accept*	string	application/json
Authorization*	string	{access token}

200

{
    "status": true
    "data": {
        "id": "course id",
        "title": "course title",
        "shortCode": "short code",
        "displayShortCode": "display short code", // optional
        "state": "PUBLIC" or "UNPUBLISHED" or "DRAFT",
        "brief": "course brief", // optional
        "numberOfUsers": 68,
        "introduction": {
            "purposes": {
                "0": "purpose 1",
                "2": "purpose 2",
                ...
            },
            "description": "description",
            "video": "introduction video"
        },
        "timeTracks": {
            "publicAt": 1617786302 // optional
        } // optional
        "appearance": {
            "color": "color code",
            "thumbnailUrl": "thumbnail url",
            "coverPhotoUrl": "cover photo url"
        },
        "sections": [{
            "id": "section id",
            "title": "section title",
            "ordering": 0,
            "lectures": [{
                "id": "lecture id",
                "title": "lecture title",
                "ordering": 0,
                "brief": "lecture brief", // optional
                "durations": 60, // optional
                "icon": "media" or "document" or "practice",
                "isRequired": true,
                "version": 1.0.0
            }],
            "quizzes": [{
                "id": "quiz id",
                "ordering": 0,
                "name": "name",
                "settings": {
                    "deductPoint": {
                        "checked": true,
                        "value": 0
                    },
                    "litmitTime": {
                        "checked": true,
                        "value": 0
                    },
                    "maxAttempt": 10,
                    "pointToPass": 0.8,
                    "randomOrder": true,
                    "recordResultOn": "HIGHEST" or "LAST" or "FIRST",
                    "showCorrectAnswers": true,
                    "showHistory": true,
                    "showOverallFeedback": true
                }
            }]
        }]
        
    }
}

400

401

404

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 v2

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

Name	Type	Description
classId*	string	id của lớp của người dùng
userEmail*	string	email của người dùng cần lấy thông tin bài học
learningSpaceId*	string	learning space mà người dùng đang sử dụng (ví dụ: chatops, hocvienagile,...)
courseId*	string	id của khóa học chứa bài học
id*	string	id của bài học cần lấy thông tin

Headers

Name	Type	Description
Accept*	string	application/json
Content-type	string	application/json
Authorization*	string	{access token}

200

{
    "status": true,
    "data: {
        "id": "1",
        "title": "This is title",
        "brief": "This ti brief" // Optional,
        "durations: 0, // Optional,
        "intro: "This is intro", // Optional,
        "icon": "media" or "document" or "practice",
        "activities?": [{
            "id": "1",
            "title: "This is activity's title",
            "description: "This is discription", // Optional,
            "ordering": 0,
            "durations": 0, // optional
            "type: "practice" | "video" | "audio" | "review_question" | "reading" | "files_list" | "url"
            "data": {
                "url: "" // optional
                "description": "" // optional
                "files": [{fileName: "", filePath: ""}] // optional
                "content": "" /optional,
                "questions": [
                    
                ]
            }
        }],
        "state": "PUBLIC" or "UNPUBLISHED"
    }
}

400

401

404

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 v2

GET https://api.agilearn.app/api-getQuizDetail/v2

Truy xuất dữ liệu chi tiết bài kiểm tra của khóa học

Query Parameters

Name	Type	Description
learningSpaceId*	string	learning space mà người dùng đang sử dụng (ví dụ: chatops, hocvienagile...)
userEmail*	string	email của người dùng cần lấy thông tin bài thi
classId*	string	id lớp của người dùng
courseId*	string	id của khóa học chứa bài thi
quizId*	string	id của bài thi cần lấy thông tin

Headers

Name	Type	Description
Accept*	string	application/json
Content-type	string	application/json
Authorization*	string	{access token}

200

{
    "status": true
    "data": [{
        "id": "id",
        "name": "name",
        "settings": {
                    "deductPoint": {
                        "checked": true,
                        "value": 0
                    },
                    "litmitTime": {
                        "checked": true,
                        "value": 0
                    },
                    "maxAttempt": 10,
                    "pointToPass": 0.8,
                    "randomOrder": true,
                    "recordResultOn": "HIGHEST" or "LAST" or "FIRST",
                    "showCorrectAnswers": true,
                    "showHistory": true,
                    "showOverallFeedback": true
                }
        }]
    }]
}

400

401

404

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

Get Signed Download Url v2

GET https://api.agilearn.app/api-getSignedDownloadUrl/v2

Lấy url download

Query Parameters

Name	Type	Description
classId*	string	id lớp học của người dùng
courseId*	string	id khóa học chứa file cần download
userEmail*	string	email của người dùng cần lấy thông tin
learningSpaceId*	string	learning space người dùng đang sử dụng (ví dụ: chatops, hocvienagile,...)
p*	string	đường dẫn file cần lấy link download

Headers

Name	Type	Description
Content-type*	string	application/json
Accept*	string	application/json
Authorization*	string	{access token}

200

{
 "status": true,
 "data": {
    "signedUrl": "https://...",
    "expireAt": "2021-04-09T02:27:03.207Z"
   }
}

400

401

404

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

Create Class

POST https://api.agilearn.app/api-createClass/v2

Headers

Name	Type	Description
Authorization*	string	{access_token}
Content-type*	string	application/json
Accept*	string	application/json

Request Body

Name	Type	Description
brief	string	Tóm tắt nội dung lớp học
startAt	string	Thời gian bắt đầu lớp học (UTC Format)
finishAt	string	Thời gian kết thúc lớp học (UTC Format)
className*	string	Tên lớp sẽ tạo
userEmail*	string	email người tạo lớp
learningSpaceId*	string	learning space mà người tạo lớp đang sử dụng
courseId*	string	id của khóa học sẽ được thêm vào lớp sau khi tạo xong

200

{
    status: true,
    data: {
        classId: string
    }
}

400

401

404

Mark Activity Complete

POST https://api.agilearn.app/api-markActivityComplete/v2

Headers

Name	Type	Description
Content-type*	string	application/json
Accept*	string	application/json
Authorization*	string	{access_token}

Request Body

Name	Type	Description
lectureId*	string	id của bài học chứa hoạt động
activityId*	string	id của hoạt động (có thể là video, câu hỏi ôn tập hoặc bài đọc)
userEmail*	string	email của người dùng
enrolledId*	string	id của object đại diện cho khóa học mà học viên đang học, được lấy về từ API getCourseDetail

200

{
 "status": true,
}

400

401

403

Join Class

POST https://api.agilearn.app/api-joinClass/v2

Headers

Name	Type	Description
Content-type*	string	application/json
Accept*	string	application/json
Authorization*	string	{access_token}

Request Body

Name	Type	Description
classId*	string	id của lớp mà học viên muốn tham gia
userEmail*	string	email của học viên muốn tham gia lớp
learningSpaceId*	string	learning space của lớp đang sử dụng

200

{
 "status": true,
}

400

401

403

Execute Quiz

POST https://api.agilearn.app/api-executeQuiz/v2

Sử dụng khi học viên bắt đầu làm bài thi, gọi API này sẽ tạo ra một submission đại diện cho lần làm bài đó của học viên

Headers

Name	Type	Description
Accept*	string	application/json
Content-type*	string	application/json
Authorization*	string	{access_token}

Request Body

Name	Type	Description
userEmail*	string	email của học viên làm bài
enrolledId*	string	id của object đại diện cho khóa học mà học viên đang học, được lấy từ API getCourseDetail
quizId*	string	id của bài thi

200

"status": true
    "data": [{
        "submissionId": "submissionId",
        "name": "name",
        "settings": {
                    "deductPoint": {
                        "checked": true,
                        "value": 0
                    },
                    "litmitTime": {
                        "checked": true,
                        "value": 0
                    },
                    "maxAttempt": 10,
                    "pointToPass": 0.8,
                    "randomOrder": true,
                    "recordResultOn": "HIGHEST" or "LAST" or "FIRST",
                    "showCorrectAnswers": true,
                    "showHistory": true,
                    "showOverallFeedback": true
                }
        "questions": [{
            "id": "question id",
            "bloomLadderLevel": "Remembering"
                                or "Understanding"
                                or "Applying"
                                or "Analyzing"
                                or "Evaluating"
                                or "Creating",
            "content": "content",
            "type": "SINGLE" or "MULTIPLE" or "BOOLEAN"
            "answers": [{
                "id": "answer id",
                "content": "content",
                "isCorrect": true,
                "overallFeedback": "overall feedback",
            }]
        }]
    }]
}

400

401

403

Submit Quiz

POST https://api.agilearn.app/api-submitQuiz/v2

Chấm bài làm của học viên và trả về kết quả, lưu kết quả vào submission được tạo ra khi gọi API executeQuiz

Headers

Name	Type	Description
Content-type*	string	application/json
Accept*	string	application/json
Authorization*	string	{access_token}

Request Body

Name	Type	Description
userAnswers*	object	câu trả lời của học viên
userEmail*	string	email của học viên nộp bài
enrolledId*	string	id của object đại diện cho khóa học mà học viên đang học, được lấy từ API getCourseDetail
submissionId*	string	id của submission được tạo ra khi học viên bắt đầu làm bài, được lấy từ API executeQuiz

200

{
    "status": true,
    "data": {
        "point": number,
        "status": "PASSED" || "FAILED"
    }
}

400

401

403

userAnswers là object đại diện cho câu trả lời của học viên, trông giống như dưới đây:

"userAnswers": {
    "4pW4QwtMrDb9IaYV36yN": {                          // id của câu hỏi 
        "answeredAt": "Thu, 09 Sep 2021 03:20:45 GMT", // Thời gian trả lời câu hỏi, định dạng GMT
        "answers": {
            "WoivEeu8uuU8K8Ul9AKQ": true               // id của câu trả lời học viên chọn
        }
    }
}

Giải thích: id của câu hỏi, câu trả lời được lấy về từ API executeQuiz

Với mỗi câu hỏi, tạo một object với key là id của câu hỏi. Học viên có thể chọn nhiều câu trả lời, với một câu trả lời, thêm vào object answers một element có dạng "{id của câu trả lời}": true

Get Course Progress

GET https://api.agilearn.app/api-getCourseProgress/v2

Sử dụng để lấy tiến độ khóa học

Query Parameters

Name	Type	Description
learningSpaceId*	string	learning space của người dùng
userEmail*	string	email của người dùng muốn lấy dữ liệu tiến độ khóa học
courseId*	string	id của khóa học cần lấy tiến độ
classId*	string	id lớp của học viên

Headers

Name	Type	Description
Accept*	string	application/json
Content-type*	string	application/json
Authorization*	string	{access_token}

200

{
    "status": true,
    "data": {
        "enrolledId": string,
        "title": string,
        "lectureResults": {
            "QdpsG6PZ5UTC4IJxLFwY": {
                "id": "QdpsG6PZ5UTC4IJxLFwY",
                "state": "INCOMPLETE"
            },
            "xPmJtPFmCvLOwjWkA523": {
                "id": "xPmJtPFmCvLOwjWkA523",
                "state": "INCOMPLETE"
            }
        },
        "quizResults": {},
        "courseId": string,
        "learningSpaceId": string,
        "classId": string,
        "progress": number,
        "state": 'ACTIVE' | 'INACTIVE' | 'HIDDEN'
        "status:   | 'IN PROGRESS'
                      | 'COMPLETED'
                      | 'DROP OUT'
                      | 'CANCELED'
                      | 'FAILED'
                      | 'PENDING'
    }
}

400

401

403

Get Class Detail

GET https://api.agilearn.app/api-getClassDetail/v2

Sử dụng để lấy tiến độ khóa học

Query Parameters

Name	Type	Description
learningSpaceId*	string	learning space của người dùng
userEmail*	string	email của người dùng muốn lấy chi tiết lớp học
classId*	string	id lớp cần lấy chi tiết

Headers

Name	Type	Description
Accept*	string	application/json
Content-type*	string	application/json
Authorization*	string	{access_token}

200

{
    "status": true,
    "data": {
        "id": string,
        "name": string,
        "statistics": {
            "totalStudents": number,
            "totalCourses": number,
            "totalTeachers": number
        },
        "status": "ACTIVE" | "INACTIVE",
        "sections": [
            {
                "activities": [
                {
                ....
                }
                ]
            },
        ]
    }
}

400

401

403

Submit Review Question

POST https://api.agilearn.app/api-submitReviewQuestion/v2

Chấm bài làm của học viên và trả về kết quả, lưu kết quả vào submission được tạo ra khi gọi API executeQuiz

Headers

Name	Type	Description
Content-type*	string	application/json
Accept*	string	application/json
Authorization*	string	{access_token}

Request Body

Name	Type	Description
answeredAt	string	thời gian trả lời, định dạng GMT, ví dụ: "Tue, 14 Sep 2021 10:04:46 GMT", nếu không truyền vào thì sẽ lấy thời gian gửi API làm thời gian trả lời
learningSpaceId*	string	learning space của người dùng
questionId*	string	id của câu hỏi
reviewQuestionActivityId*	string	id của activitiy dạng câu hỏi ôn tập
lectureId*	string	id của bài học chứa câu hỏi ôn tập
userAnswers*	array	câu trả lời của học viên, mảng id các câu trả lời học viên chọn
userEmail*	string	email của học viên nộp bài
classId*	string	id lớp của học viên
courseId*	string	id của khóa học chứa bài học

200

{
    "status": true,
    "data": {
        "passed": boolean
    }
}

400

401

403

Add Assignment To Class

POST https://api.agilearn.app/api-addAssignmentToClass/v2

Thêm bài tập vào nội dung lớp học

Headers

Name	Type	Description
Content-type*	string	multipart/form-data
Accept*	string	*/*
Authorization*	string	{access_token}

Request Body

Name	Type	Description
attachments*	object	File đính kèm bài tập (tổng dung lượng dưới 10MB)
learningSpaceId*	string	learning space của người dùng
content*	string	Nội dung bài tập
title*	string	Tiêu đề của bài tập
sectionId*	string	section mà bài tập sẽ được thêm vào
userEmail*	string	email của người thêm bài tập
classId*	string	id lớp muốn thêm bài tập

200

{
    "status": true,
    "data": {
        "assignmentId": string
    }
}

400

401

403

Lưu ý: Tổng dung lượng các file upload lên phải dưới 10MB, do firebase hiện tại giới hạn và chưa cho phép tăng mức giới hạn

Firebase giới hạn HTTP request size ở mức 10MB

Submit Assignment

POST https://api.agilearn.app/api-submitAssignment/v2

Dành cho học viên nộp bài tập

Headers

Name	Type	Description
Content-type*	string	multipart/form-data
Accept*	string	*/*
Authorization*	string	{access_token}

Request Body

Name	Type	Description
attachments*	object	File bài nộp của học viên (tổng dung lượng dưới 10MB)
learningSpaceId*	string	learning space của người dùng
assignmentId*	string	id của bài tập
userEmail*	string	email của người nộp bài tập
classId*	string	id lớp

200

{
    "status": true,
}

400

401

403

Lưu ý: Tổng dung lượng các file upload lên phải dưới 10MB, do firebase hiện tại giới hạn và chưa cho phép tăng mức giới hạn

Firebase giới hạn HTTP request size ở mức 10MB

Get Class Assignment

GET https://api.agilearn.app/api-getClassAssignment/v2

Sử dụng để lấy chi tiết bài tập

Query Parameters

Name	Type	Description
assignmentId*	string	Id của hoạt động bài tập
classId*	string	Id lớp học chứa bài tập
userEmail*	string	Nếu không truyền vào tham số userEmail, api sẽ trả về thông tin bài nộp và điểm của tất cả học viên đã nộp bài, nếu có truyền vào thì api sẽ trả về thông tin bài nộp và điểm của học viên đó
learningSpaceId*	string	learning space chứa lớp học và bài tập

Headers

Name	Type	Description
Accept*	string	application/json
Content-type*	string	application/json
Authorization*	string	{access_token}

200

// Trường hợp lấy dữ liệu của tất cả học viên
{
    "status": boolean,
    "data": {
        "title": string,
        "content": string,
        "attachments": [
            {
                "storageUrl": string,
                "title": string
            },
        ],
        "students": [
            {
                "email": string,
                "submissions": [
                    {
                        "attachments": [
                            {
                                "name": string, // tên file bài nộp
                                "storageUrl": string
                            },
                        ],
                        "createdAt": "Tue, 28 Sep 2021 01:42:43 GMT", // giờ theo format GMT
                        "updatedAt": "Tue, 28 Sep 2021 01:42:43 GMT"
                    }
                ],
                "grade": {
                    "grade": number,
                    "feedback": string,
                    "state": "GRADED",
                    "createdAt": "Tue, 28 Sep 2021 01:43:56 GMT",
                    "updatedAt": "Tue, 28 Sep 2021 01:43:56 GMT",
                    "gradedBy": {
                        "name": string,
                        "email": string,
                        "photoUrl": string
                    }
                }
            }
        ]
    }
}

// Trường hợp lấy dữ liệu của 1 học viên
{
    "status": boolean,
    "data": {
        "title": string,
        "content": string,
        "attachments": [
            {
                "storageUrl": string,
                "title": string
            },
        ],
        "submissions": [
            {
                "attachments": [
                    {
                        "name": string, // tên file bài nộp
                        "storageUrl": string
                    },
                ],
                "createdAt": "Tue, 28 Sep 2021 01:42:43 GMT",
                "updatedAt": "Tue, 28 Sep 2021 01:42:43 GMT"
            }
        ],
        "grade": {
            "grade": number,
            "feedback": string,
            "state": "GRADED",
            "createdAt": "Tue, 28 Sep 2021 01:43:56 GMT",
            "updatedAt": "Tue, 28 Sep 2021 01:43:56 GMT",
            "gradedBy": {
                "name": string,
                "email": string,
                "photoUrl": string
            }
        }
    }
}

400

401

403

Grade Assignment

POST https://api.agilearn.app/api-gradeAssignment/v2

Dành cho học viên nộp bài tập

Headers

Name	Type	Description
Content-type*	string	application/json
Accept*	string	application/json
Authorization*	string	{access_token}

Request Body

Name	Type	Description
feedback	string	Đánh giá của người chấm
grade*	number	Điểm chấm cho học viên
learningSpaceId*	string	learning space của người dùng
assignmentId*	string	id của bài tập
teacherEmail*	string	email của người chấm điểm
classId*	string	id lớp
studentEmail*	string

200

{
    "status": true
}

400

401

403

Add Attachment To Class

POST https://api.agilearn.app/api-addAttachmentToClass/v2

Dành cho học viên nộp bài tập

Headers

Name	Type	Description
Content-type*	string	multipart/form-data
Accept*	string	*/*
Authorization*	string	{access_token}

Request Body

Name	Type	Description
isRequired	boolean	Hoạt động có bắt buộc hay không, mặc định là false
userEmail*	string	Email của người thêm tài liệu vào lớp
attachment*	object	File tài liệu, chỉ upload duy nhất 1 file (dưới 10MB)
title*	string	Tiêu đề của file
learningSpaceId*	string	Learning space
classId*	string	Id của lớp sẽ thêm tài liệu
sectionId*	string	Id của section sẽ thêm tài liệu

200

{
    "status": true,
    "data": {
        "attachmentId": string
    }
}

400

401

403

Lưu ý: Tổng dung lượng các file upload lên phải dưới 10MB, do firebase hiện tại giới hạn và chưa cho phép tăng mức giới hạn

Firebase giới hạn HTTP request size ở mức 10MB

Get Class Grade By User

GET https://api.agilearn.app/api-getClassGradeByUser/v2

Sử dụng để lấy điểm của học viên trong lớp

Query Parameters

Name	Type	Description
learningSpaceId*	string	learning space của người dùng
userEmail*	string	email của người dùng muốn lấy điểm
classId*	string	id lớp của người dùng

Headers

Name	Type	Description
Accept*	string	application/json
Content-type*	string	application/json
Authorization*	string	{access_token}

200

{
    "status": true,
    "data": {
        "grade": number
    }
}

400

401

403

Get Class Leaderboard

GET https://api.agilearn.app/api-getClassLeaderboard/v2

Query Parameters

Name	Type	Description
classId*	string	Id lớp muốn lấy bảng xếp hạng
learningSpaceId*	string	learning space chứa lớp

Headers

Name	Type	Description
Content-type*	string	Application/json
Accept*	string	Application/json
Authorization*	string	{access_token}

200

{
    "status": true,
    "data": [
        {
            "email": string,
            "grade": number
        },
    ]
}

400: Bad Request

401: Unauthorized

403: Forbidden

Add External Link To Class

POST https://api.agilearn.app/api-addExternalLinkToClass/v2

Dành cho học viên nộp bài tập

Headers

Name	Type	Description
Content-type*	string	multipart/form-data
Accept*	string	*/*
Authorization*	string	{access_token}

Request Body

Name	Type	Description
isRequired	boolean	Hoạt động có bắt buộc hay không, mặc định là false
userEmail*	string	Email của người thêm liên kết ngoài vào lớp
link*	object	Link
title*	string	Tiêu đề
learningSpaceId*	string	Learning space
classId*	string	Id của lớp sẽ thêm liên kết ngoài
sectionId*	string	Id của section sẽ thêm liên kết ngoài

200

{
    "status": true,
    "data": {
        "externalLinkId": string
    }
}

400

401

403

Get Classes

GET https://api.agilearn.app/api-getClasses/v2

Query Parameters

Name	Type	Description
userEmail	string	nếu truyền vào tham số userEmail, API sẽ trả về danh sách lớp của người dùng đó trong learning space
learningSpaceId*	string	learning space muốn lấy danh sách lớp

Headers

Name	Type	Description
Content-type*	string	Application/json
Accept*	string	Application/json
Authorization*	string	{access_token}

200

{
    "status": true,
    "data": [
        {
            "brief": string | null,
            "id": string,
            "name": string,
            "statistics": {
                "totalStudents": number,
                "totalTeachers": number,
                "totalCourses": number
            },
            "createdAt": "Tue, 14 Sep 2021 06:49:39 GMT", // giờ theo format GMT
            "startAt": "Mon, 13 Sep 2021 17:00:00 GMT",
            "finishAt": null || string (giờ theo format GMT)
        },
    ]
}

400

401

403

Get Schemes

GET https://api.agilearn.app/api-getSchemes/v2

Query Parameters

Name	Type	Description
learningSpaceId*	string	learning space muốn lấy danh sách scheme

Headers

Name	Type	Description
Content-type*	string	Application/json
Accept*	string	Application/json
Authorization*	string	{access_token}

200

{
    "status": true,
    "data": [
        {
            "id": string,
            "name": string,
            "description": string,
            "appearances": {
                "thumbnailUrl": string
            }
            "timeTracks": {
                "createdAt": "Tue, 24 Aug 2021 06:34:36 GMT", // thời gian ở định dạng GMT
                "updatedAt": "Tue, 24 Aug 2021 06:39:35 GMT"
            }
        },
    ]
}

400

401

403

Get Scheme Detail

GET https://api.agilearn.app/api-getSchemeDetail/v2

Query Parameters

Name	Type	Description
schemeId*	string	id của chương trình học muốn lấy chi tiết
userEmail*	string	email người request
learningSpaceId*	string	learning space

Headers

Name	Type	Description
Content-type*	string	Application/json
Accept*	string	Application/json
Authorization*	string	{access_token}

200

{
    "status": true,
    "data": [
        {
            "id": string,
            "name": string,
            "description": string,
            "appearances": {
                "thumbnailUrl": string
            }
            "timeTracks": {
                "createdAt": "Tue, 24 Aug 2021 06:34:36 GMT", // thời gian ở định dạng GMT
                "updatedAt": "Tue, 24 Aug 2021 06:39:35 GMT"
            }
            "sections": [
            {
                "activities": [
                {
                ....
                }
                ]
            },
        ]
        },
    ]
}

400

401

403

Create Class From Scheme

POST https://api.agilearn.app/api-createClassFromScheme/v2

Tạo lớp học từ chương trình học có sẵn

Headers

Name	Type	Description
Authorization*	string	{access_token}
Content-type*	string	application/json
Accept*	string	application/json

Request Body

Name	Type	Description
brief	string	Tóm tắt nội dung lớp học
startAt	string	Thời gian bắt đầu lớp học (UTC Format)
finishAt	string	Thời gian kết thúc lớp học (UTC Format)
className*	string	Tên lớp sẽ tạo
userEmail*	string	email người tạo lớp
learningSpaceId*	string	learning space mà người tạo lớp đang sử dụng
schemeId*	string	id của chương trình học mà từ đó tạo thành lớp

200

{
    status: true,
    data: {
        classId: string
    }
}

400

401

403

Class Quiz Execute

POST https://api.agilearn.app/api-classQuizExecute/v2

API làm bài kiểm tra trong lớp

Headers

Name	Type	Description
Authorization*		{access_token}
Content-type*	String	application/json
Accept*	String	application/json

Request Body

Name	Type	Description
learningSpaceId*	String
userEmail*	String
classId*	String
quizId*	String

200: OK

{
    "status": true,
    "data": {
        "settings": {                        // settings của bài thi
            "randomOrder": boolean,
            "showOverallFeedback": boolean,
            "recordResultOn": "HIGHEST",
            "pointToPass": number,
            "limitTime": {
                "value": number,
                "checked": boolean
            },
            "showCorrectAnswers": boolean,
            "deductPoint": {
                "checked": boolean,
                "value": number
            },
            "showHistory": true,
            "maxAttempt": 10
        },
        "title": string,
        "isRequired": boolean,
        "id": string,
        "submissionId": string,             // id của object đại diện cho lần làm bài của học viên
        "sectionId": string,
        "questions": [
            {
                "bloomLadderLevel": "Remembering",
                "content": string,
                "type": "SINGLE" | "MULTIPLE" | "BOOLEAN",
                "id": string,
                "answers": [
                    {
                        "content": string,
                        "overallFeedback": string,
                        "ordering": number,
                        "id": string
                    },
                ],
                "ordering": 0
            }
        ]
    }
}

400: Bad Request

401: Unauthorized

403: Forbidden

Submit Class Quiz

POST https://api.agilearn.app/api-submitClassQuiz/v2

Headers

Name	Type	Description
Authorization*	String	{access_token}
Content-type*	String	application/json
Accept*	String	application/json

Request Body

Name	Type	Description
submissionId*	String	id của lần làm bài học viên đang thực hiện, được lấy về từ api classQuizExecute
classId*	String	id của lớp chứa bài kiểm tra
learningSpaceId*	String	id của learning space chứa lớp
selectedAnswers*	object	object đại diện cho câu trả lời của học viên
quizId*	String	id bài kiểm tra học viên đang làm
userEmail*	String	email của học viên nộp bài

200: OK

{
    // Response
}

400: Bad Request

401: Unauthorized

403: Forbidden

selectedAnswers là object đại diện cho câu trả lời của học viên, trông giống như dưới đây:

"selectedAnswers": {
    "4pW4QwtMrDb9IaYV36yN": {                          // id của câu hỏi 
        "answeredAt": "Thu, 09 Sep 2021 03:20:45 GMT", // Thời gian trả lời câu hỏi, định dạng GMT
        "answers": {
            "WoivEeu8uuU8K8Ul9AKQ": true               // id của câu trả lời học viên chọn
        }
    }
}

Giải thích: id của câu hỏi, câu trả lời được lấy về từ API classQuizExecute

Với mỗi câu hỏi, tạo một object với key là id của câu hỏi. Học viên có thể chọn nhiều câu trả lời, với một câu trả lời, thêm vào object answers một element có dạng "{id của câu trả lời}": true

Get class reflections

GET https://api.agilearn.app/api-getClassReflections/v2

Query Parameters

Name	Type	Description
learningSpaceId*	String	id của learning space chứa lớp
classId*	String	id của lớp muốn lấy danh sách reflection
studentEmail	String	email của học viên muốn lấy reflection, nếu không truyền vào tham số này, api sẽ trả về danh sách của cả lớp

Headers

Name	Type	Description
Authorization*	String	{{access_token}}

200: OK

{
    status: true
    data: [
    {
        studentEmail: string
        title: string
        lastSubmiitedAt: string GMT
        lastGradedAt: string GMT
        grade: number
        feedback: string
        gradedBy: string
        type: 'ONLINE_COURSE' | 'BOOK' | 'PRACTICE'
        content: [
            {
                question: string
                answer: string
            }
        ]
    }
    ]}

Attendance

POST https://api.agilearn.app/api-attendance/v2

Request Body

Name	Type	Description
userEmail*	String	Email của giảng viên hoặc cá nhân thực hiện điểm danh
classId*	String	id của lớp học muốn điểm danh
learningSpaceId*	String	id của space chưa lớp học
actId*	String	id của event muốn điểm danh
data*	Object	{ [k: string (Email của học viên)]: "ON_TIME | "LATE" | "ABSENT" }

200: OK { "status" : true }

{
    // Response
}

RecordStudentBehavior

POST https://api.agilearn.app/api-recordStudentBehavior/v2

Request Body

Name	Type	Description
userEmail*	String	Email của giảng viên hoặc cá nhân ghi nhận hành vi
classId*	String	Id của lớp học
learningSpaceId*	String	id của learning space
actId*	String	Id của sự kiện muốn ghi nhận hành vi
data*	Object	dữ liệu hành vi của học viên trong lớp

200: OK { "status": true }

{
    // Response
}

Dạng dữ liệu của tham số data là:

    [e: string]: {
      behavior: {
        ASKED?: boolean
        STATED?: boolean
        COMMUNICATED_POSITIVELY?: boolean
        INTERACTED?: boolean
      }
      note?: string
    }

Trong đó: [e: string] là email của học viên

Lấy thông tin điểm danh của sự kiện

GET https://api.agilearn.app/api-getAttendance/v2

Query Parameters

Name	Type	Description
learningSpaceId*	String	learning space chứa lớp
classId*	String	id của lớp
actId*	String	id của hoạt động sự kiện

Headers

Name	Type	Description
Authorization*	String	{{access_token}}

200: OK

{
    "status": true,
    "data": [
        {
            "email": string,
            "actId": string,
            "status": "LATE" | "ABSENT" | "ON_TIME",
            "createdAt": "Tue, 09 Nov 2021 02:31:46 GMT", // time in GTM
            "updatedAt": "Tue, 09 Nov 2021 02:36:22 GMT" | null
        },
    ]
}

Nộp reflection

POST https://api.agilearn.app/api-submitClassReflection/v2

Headers

Name	Type	Description
Authorization*	String	{{access_token}}

Request Body

Name	Type	Description
learningSpaceId*	String	learning space chứa lớp
classId*	String	id của lớp
userEmail*	String	Email của người nộp
content*	Array	Nội dung reflection. Ví dụ: [ { "question": "abc", "answer": "123" } ]
title*	String	Tiêu đều reflection
type*	String	BOOK | ONLINE_COURSE | PRACTICE
reflectionId	String	Nếu truyền vào tham số reflectionId, api sẽ cập nhật lại dữ liệu của reflection tương ứng chứ không tạo ra reflection mới

200: OK

{
    "status": true,
    "data": {
        "reflectionId": string
    }
}

Chấm điểm reflection

POST https://api.agilearn.app/api-gradeReflection/v2

Headers

Name	Type	Description
Authorization*	String	{{access_token}}

Request Body

Name	Type	Description
learningSpaceId*	String	learning space chứa lớp
classId*	String	id của lớp
teacherEmail*	String	email của giáo viên (người chấm)
grade*	number	điểm
feedback	String	phản hồi
reflectionId*	String	id của reflection cần chấm điểm

200: OK

{
    status: true
}

Lấy lịch sử tham gia sự kiện của học viên

GET https://api.agilearn.app/api-getStudentBehavior/v2

Query Parameters

Name	Type	Description
learningSpaceId*	String	learning space chứa lớp
classId*	String	id của lớp
actId*	String	id của hoạt động sự kiện cần lấy lịch sử

Headers

Name	Type	Description
Authorization*	String	{{access_token}}

200: OK

{
    "status": true,
    "data": [
        {
            "email": string,
            "actId": string,
            "behavior": {
                "STATED": boolean,
                "ASKED": boolean,
                "COMMUNICATED_POSITIVELY": boolean,
                "INTERACTED": boolean
            } | null,
            "note": string | null,
            "createdAt": "Tue, 09 Nov 2021 02:31:46 GMT",
            "updatedAt": "Tue, 09 Nov 2021 02:36:22 GMT" | null
        },
    ]
}

Xóa 1 hoạt động khỏi lớp học

DELETE https://api.agilearn.app/api-deleteActivityFromClass/v2

Hiện tại hỗ trợ xóa các hoạt động dạng ASSIGNMENT, EVENT, EXTERNAL_LINK, ATTACHMENT.

Chưa hỗ trợ xóa QUIZ và COURSE.

Headers

Name	Type	Description
Authorization*	String	{{access_token}}

Request Body

Name	Type	Description
learningSpaceId*	String	id của learning space chứa lớp
classId*	String	id của lớp chứa hoạt động
activityId*	String	id của hoạt động cần xóa

200: OK

{
    status: true
}

Cập nhật nội dung một hoạt động sự kiện trong lớp

PUT https://api.agilearn.app/api-updateClassEventActivity/v2

Headers

Name	Type	Description
Authorization*	String	{{access_token}}

Request Body

Name	Type	Description
learningSpaceId*	String	learning space chứa lớp
classId*	String	id của lớp chứa hoạt động sự kiện
eventActivityId*	String	id của hoạt động sự kiện
title	String	nội dung cần thay đổi của trường title
description	String	nội dung cần thay đổi của trường description
address	String	nội dung cần thay đổi của trường address
startAt	String	(Thời gian ở dạng GMT) nội dung cần thay đổi của trường startAt
finishAt	String	(Thời gian ở dạng GMT) nội dung cần thay đổi của trường finishAt

200: OK

{
    status: true,
    data: {
        title: string,
        description: string,
        address: string,
        startAt: string | null, // Thoi gian GMT
        finishAt: string | null, // Thoi gian GMT
    }
}

Lấy danh sách chứng chỉ của học viên

GET https://api.agilearn.app/api-getStudentCertificates/v2

Query Parameters

Name	Type	Description
studentEmail*	String	Email của học viên muốn lấy chứng chỉ
ttl	String	Thời gian sống của các link chứng chỉ, thời gian mặc định là 60 phút
type	String	Loại chứng chỉ muốn lấy, có 2 loại chứng chỉ là chứng chỉ khóa học và chứng chỉ từ bài thi, giá trị có thể truyền vào là "COURSE" hoặc "EXAM"
sourceId	String	Id của khóa học hoặc bài thi đã có chứng chỉ, hiện tại với bài thi (EXAM), client chưa thể lấy được id, còn với khóa học (COURSE) thì id này sẽ là enrolledId, id của object đại diện cho khóa học của học viên, được lấy từ api getCourseDetail

Headers

Name	Type	Description
Authorization*	String	{{access_token}}

200: OK

{
    "status": true,
    "data": [
        {
            "certJpgUrl": string,
            "certPdfUrl": string,
            "title": string,
            "type": "EXAM" | "COURSE"
        }
    ]
}