Create Course API

This API is used to create new courses in Zoho People LMS

Request URL:

http://people.zoho.com/api/v1/courses

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Parameters:

*courseData - {"name" : "API Testing Create Course",  "type" : 1, "description" : "Description for the course","aboutCourse" : "About the API", "duration" : 30, "durationUnit" : "minute",

                                 "courseCode" : "API_001", "courseAdmins" : [<ERECNO_1>,<ERECNO_2>],"categories" : [<CategoryId_1>, <CategoryId_2>], "permissionSettings" : {}}


             type - 1 | 2| 3  {1 - Self paced, 2 - Blended learning, 3 - E-Material }
             durationUnit - minute|hour|day
             permissionSettings -  {"whoCanEnroll" : ["admin","learner"], "whoCanUnenroll" : ["admin","learner"], "whenAnEntityIsConsideredAsCompleted" : 2,                                                  "whenACourseIsConsideredAsCompleted" : 2, "whenAModuleIsConsideredAsCompleted" : 2}
             whoCanEnroll  -  admin|courseAdmin|manager|learner
             whoCanUnenroll-  admin|courseAdmin|manager|learner
             whenAnEntityIsConsideredAsCompleted - 1|2  {}
             whenACourseIsConsideredAsCompleted  - 1|2
             whenAModuleIsConsideredAsCompleted  - 1|2

Request

Copiedhttp://people.zoho.com/api/v1/courses

Header:

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response:

Copied{
    "code": "200",
    "course": {
        "canUserRequestToJoin": false,
        "canUserAddLearners": true,
        "durationAsDisplayString": "30 Minutes",
        "courseCode": "API_121",
        "description": "Description for the course",
        "courseURL": "https://people17.zoho.com/kavyalms/zp/lmscourse#lms-learner/course/117376000000809017/overview",
        "type": "1",
        "canUserGiveFeedback": true,
        "canUserShare": true,
        "canUserDelete": true,
        "permissionSettings": {
            "whenAModuleIsConsideredAsCompleted": "1",
            "whoCanEnroll": [
                "admin",
                "courseAdmin",
                "learner"
            ],
            "whenAnEntityIsConsideredAsCompleted": "1",
            "whenACourseIsConsideredAsCompleted": "2"
        },
        "hasUserCompleted": false,
        "canUserUnpublish": true,
        "canUserSuggest": false,
        "currentUserRole": {
            "settingsAdmin": false,
            "courseOwner": true,
            "trainer": false,
            "sharedUser": false,
            "learner": false,
            "admin": true,
            "courseAdmin": true,
            "dataAdmin": false
        },
        "canUserShareCourseURL": false,
        "isSuggestedCourse": false,
        "isDisabled": false,
        "isFavourite": false,
        "courseId": "117376000000809017",
        "aboutCourse": "About the API",
        "publishStatus": "unpublished",
        "hasUserStarted": true,
        "introFiles": [],
        "canUserFavourite": true,
        "progressAsDisplayString": "0 of 0 Completed",
        "canUserDisable": false,
        "typeAsDisplayString": "Self paced learning",
        "isSharedCourse": false,
        "canUserDeleteLearners": true,
        "percentageOfProgress": 0,
        "courseOwners": [
            {
                "erecno": "117376000000246005",
                "displayName": "Kavya yarram",
                "employeeId": "1",
                "emailId": "kavya.y+999@zohotest.com",
                "displayPictureURL": "https://contacts.zoho.com/file?ID=62917626&fs=thumb"
            }
        ],
        "canUserStartDiscussion": false,
        "canUserComplete": false,
        "statusAsDisplayString": "Drafted",
        "canUserUnEnroll": true,
        "canUserUnfavourite": true,
        "canUserRevokeCompletion": false,
        "courseImageURL": null,
        "canUserPublish": true,
        "name": "API Testing Create Course",
        "courseAdmins": [
            {
                "erecno": "117376000000246005",
                "displayName": "Kavya yarram",
                "employeeId": "1",
                "emailId": "kavya.y+999@zohotest.com",
                "displayPictureURL": "https://contacts.zoho.com/file?ID=62917626&fs=thumb"
            }
        ],
        "canUserEnroll": true,
        "canUserPreview": true,
        "status": 0
    },
    "message": "success"
}