Get Course

Table of Contents

Note: Applicable to all services except Zoho Creator.

Overview

The zoho.learn.getCourse task fetches the details of a course by its URL.

Scope

ZohoLearn.course.READ

Syntax

<response>=zoho.learn.course.getCourseByUrl(<portalUrl>,<courseUrl>,<connection>);

where:

ParameterData TypeDescription
<response>KEY-VALUEThe response returned contains the details of the specified course.
portalUrlTEXTThe URL of the hub/network (portal) in Zoho Learn.
courseUrlTEXTThe URL of the course whose details need to be fetched.
connectionTEXTThe connection link name created for this service. A Zoho OAuth connection with the scope ZohoLearn.course.READ must be configured.

Example

The following script fetches the details of a course using its URL:

response=zoho.learn.course.getCourseByUrl("zylker","course-1","learnconnection");

where:

responseThe KEY-VALUE response variable that holds the course details.
zylkerThe TEXT representing the URL of the hub/network.
course-1The TEXT representing the URL of the course whose details need to be fetched.
learnconnectionThe connection link name in TEXT format.

Response Format

Success Response

The success response will be returned in the following format:

{ "STATUS": "OK", "DATA": { "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": "0", "lastVisitLesson": { "questionCount": "0", "modifiedTime": "1689155924590", "canRead": "true", "courseUrl": "course-1", "type": "TEXT", "canFavourite": "true", "createdTime": "1689155549707", "modifiedBy": "799705715", "canDelete": "true", "id": "6342496000000086007", "viewCount": "3", "courseId": "6342496000000086001", "order": "0", "canDuplicate": "true", "elapsedLongTime": "0", "url": "text-lesson", "courseName": "Course 1", "currentQuestionNumber": "0", "lessonVersion": "1.4", "learnerStatus": "0.0", "createdBy": "799705715", "lessonMeta": { "EDIT_ZFS_ID": "5145876000000113002", "lastupdatedid": "0", "blockordermap": "{"0":0}", "VIEW_ZFS_ID": "5145876000000113002", "content": "" }, "name": "Text Lesson", "status": "ACTIVE", "lessons": [] }, "isAdmin": "true", "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": "PRIVATE", "lessons": [ { "questionCount": "0", "modifiedTime": "1689155924590", "canRead": "true", "courseUrl": "course-1", "type": "TEXT", "canFavourite": "true", "createdTime": "1689155549707", "modifiedBy": "799705715", "canDelete": "true", "id": "6342496000000086007", "viewCount": "3", "courseId": "6342496000000086001", "order": "0", "canDuplicate": "true", "elapsedLongTime": "0", "url": "text-lesson", "courseName": "Course 1", "currentQuestionNumber": "0", "lessonVersion": "1.4", "learnerStatus": "0.0", "createdBy": "799705715", "lessonMeta": { "EDIT_ZFS_ID": "5145876000000113002", "lastupdatedid": "0", "blockordermap": "{"0":0}", "VIEW_ZFS_ID": "5145876000000113002", "content": "" }, "name": "Text Lesson", "status": "ACTIVE", "lessons": [] }, { "questionCount": "0", "modifiedTime": "1689227886727", "canRead": "true", "courseUrl": "course-1", "type": "BLOCK", "canFavourite": "true", "createdTime": "1689155559124", "modifiedBy": "799705715", "canDelete": "true", "id": "6342496000000086013", "viewCount": "7", "courseId": "6342496000000086001", "order": "1", "canDuplicate": "true", "elapsedLongTime": "0", "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", "status": "ACTIVE", "lessons": [] }, { "questionCount": "0", "modifiedTime": "1689167843993", "canRead": "true", "courseUrl": "course-1", "type": "DOCUMENT", "canFavourite": "true", "createdTime": "1689155565991", "modifiedBy": "799705715", "canDelete": "true", "id": "6342496000000086019", "viewCount": "4", "courseId": "6342496000000086001", "order": "2", "canDuplicate": "true", "elapsedLongTime": "0", "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", "status": "ACTIVE", "lessons": [] }, { "questionCount": "0", "modifiedTime": "1689228020755", "canRead": "true", "courseUrl": "course-1", "type": "VIDEO", "canFavourite": "true", "createdTime": "1689155571337", "modifiedBy": "799705715", "canDelete": "true", "id": "6342496000000086025", "viewCount": "3", "courseId": "6342496000000086001", "order": "3", "canDuplicate": "true", "elapsedLongTime": "0", "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", "status": "ACTIVE", "lessons": [] }, { "questionCount": "0", "modifiedTime": "1689228046969", "canRead": "true", "courseUrl": "course-1", "type": "VIDEO", "canFavourite": "true", "createdTime": "1689155682441", "modifiedBy": "799705715", "canDelete": "true", "id": "6342496000000086065", "viewCount": "4", "courseId": "6342496000000086001", "order": "4", "canDuplicate": "true", "elapsedLongTime": "0", "url": "video-lesson-embed-url", "courseName": "Course 1", "currentQuestionNumber": "0", "lessonVersion": "1.5", "learnerStatus": "0.0", "createdBy": "799705715", "lessonMeta": { "EDIT_ZFS_ID": "5145876000000113001", "lastupdatedid": "0", "blockordermap": "{"0":0}", "VIEW_ZFS_ID": "5145876000000113001", "content": "" }, "name": "Video Lesson Embed URL", "status": "ACTIVE", "lessons": [] }, { "questionCount": "0", "modifiedTime": "1689228149206", "canRead": "true", "courseUrl": "course-1", "type": "VIDEO", "canFavourite": "true", "createdTime": "1689155689814", "modifiedBy": "799705715", "canDelete": "true", "id": "6342496000000086071", "viewCount": "5", "courseId": "6342496000000086001", "order": "5", "canDuplicate": "true", "elapsedLongTime": "0", "url": "video-lesson-embed-code", "courseName": "Course 1", "currentQuestionNumber": "0", "lessonVersion": "1.6", "learnerStatus": "0.0", "createdBy": "799705715", "lessonMeta": { "EDIT_ZFS_ID": "5145876000000114001", "lastupdatedid": "0", "blockordermap": "{"0":0}", "VIEW_ZFS_ID": "5145876000000114001", "content": "" }, "name": "Video Lesson Embed Code", "status": "ACTIVE", "lessons": [] }, { "questionCount": "0", "modifiedTime": "1689228303861", "canRead": "true", "courseUrl": "course-1", "type": "QUIZ", "canFavourite": "true", "createdTime": "1689155578017", "modifiedBy": "799705715", "canDelete": "true", "id": "6342496000000086031", "viewCount": "4", "courseId": "6342496000000086001", "order": "6", "canDuplicate": "true", "elapsedLongTime": "0", "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", "shouldLessonMustBePassed": "true", "status": "ACTIVE", "lessons": [] }, { "questionCount": "0", "modifiedTime": "1689155647296", "canRead": "true", "courseUrl": "course-1", "type": "ASSIGNMENT", "canFavourite": "true", "createdTime": "1689155584755", "modifiedBy": "799705715", "canDelete": "true", "id": "6342496000000086037", "viewCount": "2", "courseId": "6342496000000086001", "order": "7", "canDuplicate": "true", "elapsedLongTime": "0", "url": "assignment-lesson", "courseName": "Course 1", "currentQuestionNumber": "0", "lessonVersion": "0.0", "learnerStatus": "0.0", "createdBy": "799705715", "lessonMeta": {}, "name": "Assignment Lesson", "status": "ACTIVE", "lessons": [] } ], "status": "ACTIVE", "durationText": "1h:10m", "clients": [], "role": "ADMIN", "attachments": [], "canManageUsers": "true", "canEdit": "true", "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 }, "bannerThumbUrl": "//css.zohostatic.com/newwiki/v_480/images/course-img/course-bg3.jpg", "certificateTemplateId": "37315000000002001", "overallRating": { "rating": "0.0", "count": "0" }, "learnerCount": "1", "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": "0.0", "coAuthors": [ { "role": "ADMIN", "name": "James Arthur", "colorIndex": "1", "emailId": "arthur@zylker.com", "id": "799705715", "type": "MEMBER", "learnerCourseStatus": "YET_TO_START", "status": "ACTIVE", "learnerCourseProgress": "0.0" } ], "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" }, "expiryTime": "30 Jul, 12:30 PM", "intAccessLevelToViewReports": "0", "elapsedTime": "0 seconds" } }

Failure Response

The failure response for an invalid or non-existent course URL will be returned in the following format:

{ "result": "failure", "reason": "Access Denied", "errorCode": "9001" }

 

Related Topics