Complete a lesson
The purpose of this API is to complete a lesson.
Request URL: | https://learn.zoho.com/learn/api/v1/portal/<networkurl>/course/<courseId>/lesson/<lessonId>/complete |
OAuth Scope: | ZohoLearn.lesson.UPDATE |
Request Method: | POST |
Success Response
Copied{
"COURSE_STATUS": "INPROGRESS",
"STATUS": "OK",
"STATUS_COMPLETED": 100.0,
"COURSE": {
"colorIndex": "3",
"type": "COURSE",
"expiryLongTime": "1690741800000",
"members": "[]",
"reportsViewAccessLevel": [],
"canFavourite": "true",
"createdTime": "12 Jul, 03:52 AM",
"userExpiryTime": "30 Jul, 12:30 PM",
"id": "6342496000000086001",
"flow": "RESTRICTED",
"createdUser": "799705715",
"elapsedLongTime": "12608040",
"lastVisitLesson": {
"questionCount": "0",
"canDuplicate": "true",
"modifiedTime": "1689227886727",
"elapsedLongTime": "0",
"canRead": "true",
"courseUrl": "course-1",
"type": "BLOCK",
"url": "block-lesson",
"courseName": "Course 1",
"currentQuestionNumber": "0",
"lessonVersion": "8.0",
"learnerStatus": "0.0",
"createdBy": "799705715",
"lessonMeta": {
"EDIT_ZFS_ID": "5145876000000112002",
"lastupdatedid": "15",
"blockordermap": "{\"11\":11,\"12\":12,\"13\":\"14\",\"14\":\"15\",\"15\":\"13\",\"0\":0,\"1\":1,\"2\":2,\"3\":3,\"4\":4,\"5\":5,\"6\":6,\"7\":7,\"8\":8,\"9\":9,\"10\":10}",
"content": "",
"VIEW_ZFS_ID": "5145876000000112002"
},
"name": "Block Lesson",
"canFavourite": "true",
"createdTime": "1689155559124",
"modifiedBy": "799705715",
"id": "6342496000000086013",
"viewCount": "10",
"courseId": "6342496000000086001",
"status": "ACTIVE",
"order": "1",
"lessons": []
},
"tags": [],
"isCertificationCourse": "true",
"meta": {
"COURSE_SETTINGS": {
"IS_RATING_ENABLED": "true"
},
"THEME": {
"SHOW_BANNER_IN_SIDEBAR": "false",
"BANNER_OVERLAY_PERCENTAGE": "30%"
},
"COURSE_COMPLETION_CONSENT": {
"COURSE_COMPLETION_CONSENT_ENABLE": "true",
"COURSE_COMPLETION_CONSENT_MANDATORY_ENABLE": "true",
"COURSE_COMPLETION_CONSENT_THEME": "3",
"COURSE_COMPLETION_CONSENT_MESSAGE": "I assure that I've read and understood this lesson."
}
},
"certificateTemplateName": "Course 1_certificate",
"name": "Course 1",
"enrollmentType": "ON_REQUEST",
"learnerCourseStatus": "INPROGRESS",
"lessons": [
{
"questionCount": "1",
"modifiedTime": "1689241634152",
"canRead": "true",
"courseUrl": "course-1",
"type": "TEXT",
"canFavourite": "true",
"createdTime": "1689155549707",
"modifiedBy": "799705715",
"id": "6342496000000086007",
"viewCount": "7",
"courseId": "6342496000000086001",
"order": "0",
"canDuplicate": "true",
"elapsedLongTime": "12608040",
"url": "text-lesson",
"courseName": "Course 1",
"currentQuestionNumber": "0",
"lessonVersion": "1.5",
"learnerStatus": "100.0",
"learnerLastVisitTime": "1689254297436",
"createdBy": "799705715",
"lessonMeta": {
"EDIT_ZFS_ID": "5145876000000113002",
"lastupdatedid": "0",
"blockordermap": "{\"0\":0}",
"VIEW_ZFS_ID": "5145876000000113002",
"content": ""
},
"name": "Text Lesson",
"status": "ACTIVE",
"elapsedTime": "3 hours 30 minutes 8 seconds",
"lessons": []
},
{
"questionCount": "0",
"canDuplicate": "true",
"modifiedTime": "1689227886727",
"elapsedLongTime": "0",
"canRead": "true",
"courseUrl": "course-1",
"type": "BLOCK",
"url": "block-lesson",
"courseName": "Course 1",
"currentQuestionNumber": "0",
"lessonVersion": "8.0",
"learnerStatus": "0.0",
"createdBy": "799705715",
"lessonMeta": {
"EDIT_ZFS_ID": "5145876000000112002",
"lastupdatedid": "15",
"blockordermap": "{\"11\":11,\"12\":12,\"13\":\"14\",\"14\":\"15\",\"15\":\"13\",\"0\":0,\"1\":1,\"2\":2,\"3\":3,\"4\":4,\"5\":5,\"6\":6,\"7\":7,\"8\":8,\"9\":9,\"10\":10}",
"content": "",
"VIEW_ZFS_ID": "5145876000000112002"
},
"name": "Block Lesson",
"canFavourite": "true",
"createdTime": "1689155559124",
"modifiedBy": "799705715",
"id": "6342496000000086013",
"viewCount": "10",
"courseId": "6342496000000086001",
"status": "ACTIVE",
"order": "1",
"lessons": []
},
{
"questionCount": "0",
"canDuplicate": "true",
"modifiedTime": "1689167843993",
"elapsedLongTime": "0",
"courseUrl": "course-1",
"type": "DOCUMENT",
"url": "document-lesson",
"courseName": "Course 1",
"currentQuestionNumber": "0",
"lessonVersion": "1.5",
"learnerStatus": "0.0",
"createdBy": "799705715",
"lessonMeta": {
"EDIT_ZFS_ID": "5145876000000112001",
"lastupdatedid": "0",
"blockordermap": "{\"0\":0}",
"VIEW_ZFS_ID": "5145876000000112001",
"content": ""
},
"name": "Document Lesson",
"canFavourite": "true",
"createdTime": "1689155565991",
"modifiedBy": "799705715",
"id": "6342496000000086019",
"viewCount": "4",
"courseId": "6342496000000086001",
"status": "ACTIVE",
"order": "2",
"lessons": []
},
{
"questionCount": "0",
"canDuplicate": "true",
"modifiedTime": "1689228020755",
"elapsedLongTime": "0",
"courseUrl": "course-1",
"type": "VIDEO",
"url": "video-lesson",
"courseName": "Course 1",
"currentQuestionNumber": "0",
"lessonVersion": "1.5",
"learnerStatus": "0.0",
"createdBy": "799705715",
"lessonMeta": {
"EDIT_ZFS_ID": "5145876000000111002",
"lastupdatedid": "0",
"blockordermap": "{\"0\":0}",
"VIEW_ZFS_ID": "5145876000000111002",
"content": ""
},
"name": "Video Lesson Upload",
"canFavourite": "true",
"createdTime": "1689155571337",
"modifiedBy": "799705715",
"id": "6342496000000086025",
"viewCount": "3",
"courseId": "6342496000000086001",
"status": "ACTIVE",
"order": "3",
"lessons": []
},
{
"questionCount": "0",
"canDuplicate": "true",
"modifiedTime": "1689228046969",
"elapsedLongTime": "0",
"courseUrl": "course-1",
"type": "VIDEO",
"url": "video-lesson-embed-url",
"courseName": "Course 1",
"currentQuestionNumber": "0",
"lessonVersion": "1.5",
"learnerStatus": "1.0",
"createdBy": "799705715",
"lessonMeta": {
"EDIT_ZFS_ID": "5145876000000113001",
"lastupdatedid": "0",
"blockordermap": "{\"0\":0}",
"VIEW_ZFS_ID": "5145876000000113001",
"content": ""
},
"name": "Video Lesson Embed URL",
"canFavourite": "true",
"createdTime": "1689155682441",
"modifiedBy": "799705715",
"id": "6342496000000086065",
"viewCount": "6",
"courseId": "6342496000000086001",
"status": "ACTIVE",
"order": "4",
"lessons": []
},
{
"questionCount": "0",
"canDuplicate": "true",
"modifiedTime": "1689228149206",
"elapsedLongTime": "0",
"courseUrl": "course-1",
"type": "VIDEO",
"url": "video-lesson-embed-code",
"courseName": "Course 1",
"currentQuestionNumber": "0",
"lessonVersion": "1.6",
"learnerStatus": "1.0",
"createdBy": "799705715",
"lessonMeta": {
"EDIT_ZFS_ID": "5145876000000114001",
"lastupdatedid": "0",
"blockordermap": "{\"0\":0}",
"VIEW_ZFS_ID": "5145876000000114001",
"content": ""
},
"name": "Video Lesson Embed Code",
"canFavourite": "true",
"createdTime": "1689155689814",
"modifiedBy": "799705715",
"id": "6342496000000086071",
"viewCount": "5",
"courseId": "6342496000000086001",
"status": "ACTIVE",
"order": "5",
"lessons": []
},
{
"questionCount": "0",
"canDuplicate": "true",
"modifiedTime": "1689228303861",
"elapsedLongTime": "0",
"courseUrl": "course-1",
"type": "QUIZ",
"url": "quiz-lesson",
"courseName": "Course 1",
"currentQuestionNumber": "0",
"lessonVersion": "0.0",
"learnerStatus": "0.0",
"createdBy": "799705715",
"lessonMeta": {
"showDiscussion": "true",
"ignoreEvaluationForPassed": "false",
"manualEvaluation": "false",
"showAttemptInfo": "true",
"passingScore": "0",
"shouldPassToContinue": "true",
"canSkip": "true",
"canShowScore": "true"
},
"name": "Quiz Lesson",
"canFavourite": "true",
"createdTime": "1689155578017",
"modifiedBy": "799705715",
"id": "6342496000000086031",
"viewCount": "4",
"shouldLessonMustBePassed": "true",
"courseId": "6342496000000086001",
"status": "ACTIVE",
"order": "6",
"lessons": []
},
{
"questionCount": "0",
"canDuplicate": "true",
"modifiedTime": "1689155647296",
"elapsedLongTime": "0",
"courseUrl": "course-1",
"type": "ASSIGNMENT",
"url": "assignment-lesson",
"courseName": "Course 1",
"currentQuestionNumber": "0",
"lessonVersion": "0.0",
"learnerStatus": "0.0",
"createdBy": "799705715",
"lessonMeta": {},
"name": "Assignment Lesson",
"canFavourite": "true",
"createdTime": "1689155584755",
"modifiedBy": "799705715",
"id": "6342496000000086037",
"viewCount": "2",
"courseId": "6342496000000086001",
"status": "ACTIVE",
"order": "7",
"lessons": []
}
],
"status": "ACTIVE",
"durationText": "1h:10m",
"clients": [],
"role": "MEMBER",
"attachments": [],
"bannerUrl": "//css.zohostatic.com/newwiki/v_480/images/course-img/course-bg3.jpg",
"description": "Brief Description of the Course",
"articleCount": "0",
"userExpiryLongTime": "1690741800000",
"duration": {
"hours": 1,
"seconds": 0,
"minutes": 10
},
"startTime": {
"date": "12 Jul 2023",
"time": "04:13 AM"
},
"bannerThumbUrl": "//css.zohostatic.com/newwiki/v_480/images/course-img/course-bg3.jpg",
"certificateTemplateId": "37315000000002001",
"overallRating": {
"rating": "0.0",
"count": "0"
},
"learnerCount": "0",
"clientsCount": "0",
"nameTile": "C",
"completionType": "LEARNERS_CAN_MARK_COMPLETE",
"url": "course-1",
"lessonCount": "8",
"metaInfo": {
"courseSettings": {
"isRatingEnabled": "true"
},
"theme": {
"showBannerInSidebar": "false",
"bannerOverlayPercentage": "30%"
},
"courseCompletionConsent": {
"courseCompletionConsentTheme": "3",
"courseCompletionConsentMessage": "I assure that I've read and understood this lesson.",
"courseCompletionConsentMandatoryEnable": "true",
"courseCompletionConsentEnable": "true"
}
},
"learnerStatus": "12.75",
"coAuthors": [],
"learners": [],
"createdUserDetails": {
"role": "MEMBER",
"name": "James Arthur",
"colorIndex": "1",
"emailId": "arthur@zylker.com",
"id": "799705715",
"type": "MEMBER",
"learnerCourseStatus": "YET_TO_START",
"status": "ACTIVE",
"learnerCourseProgress": "0.0"
},
"publishedByDetails": {
"role": "MEMBER",
"name": "James Arthur",
"colorIndex": "1",
"emailId": "arthur@zylker.com",
"id": "799705715",
"type": "MEMBER",
"learnerCourseStatus": "YET_TO_START",
"status": "ACTIVE",
"learnerCourseProgress": "0.0"
},
"completedOn": {
"date": "13 Jul 2023",
"time": "07:18 AM"
},
"expiryTime": "30 Jul, 12:30 PM",
"intAccessLevelToViewReports": "0",
"courseCompleteStatus": "CANNOT_COMPLETE",
"elapsedTime": "3 hours 30 minutes 8 seconds"
}
}Show full
Show less
Failure Response: Access Denied
Copied{
"result":"failure",
"reason": "Access Denied",
"errorCode": "9001"
}Failure Response: Course Expired
Copied{
"result":"failure",
"reason": "This course has expired.",
"errorCode": "106"
}Failure Response: Course Completed
Copied{
"result":"failure",
"reason": "You've already completed the course.",
"errorCode": "111"
}