Fetch My Courses API

This API is used to fetch all the courses that you have joined

Request URL:

https://people.zoho.com/api/v1/courses/mycourses

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Scope:

ZOHOPEOPLE.training.ALL
OR
ZOHOPEOPLE.training.READ

Possible Operation Types:

ALL - Complete access to data
READ - Only to read data

Method:

GET

Request Parameters

Parameters	Values Allowed	Default Value	Description
startIndex	<Integer>	0	Specify from which record the response should be fetched
search	<String>	-	Specify the string to check match with course name
type	1\|2\|3	-	1-> Self paced 2-> Blended 3-> E-mat course
categoryId	<CategoryId> \| "MyfavouriteCategories"	-	Specify the categoryId
trainerId	<TrainerId>	-	Specify the trainer id
state	drafted \| published \| disabled	-	Specify the course state
sortBy	name \| -name	-	sortBy=name -> ascending order of name (A-Z) sortBy=-name -> descending order of name (Z-A)
startDate	<DateInMillis>	-	Specify start date to filter courses
endDate	<DateInMillis>	-	Specify end date to filter courses
sharedToMe	true\|false	-	-
suggestedToMe	true\|false	-	-

JSON Example

Request:

Copiedhttps://people.zoho.com/api/v1/courses/mycourses

Header:

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response:

Copied{
    "courses": [
        {
            "durationAsDisplayString": null,
            "canUserDisable": false,
            "isSharedCourse": false,
            "typeAsDisplayString": "Blended learning",
            "description": null,
            "type": "2",
            "canUserShare": true,
            "canUserDelete": true,
            "statusAsDisplayString": "Published",
            "currentUserRole": {
                "settingsAdmin": false,
                "courseOwner": true,
                "trainer": true,
                "sharedUser": false,
                "learner": false,
                "admin": true,
                "courseAdmin": true,
                "dataAdmin": false
            },
            "courseImageURL": "https://people.zoho.com/newhr/images/lmsbg/cat32.png",
            "name": "Public API Testing (BL)",
            "isDisabled": false,
            "isFavourite": false,
            "courseId": "219225000000645203",
            "publishStatus": "published",
            "status": 1
        },
        {
            "durationAsDisplayString": null,
            "canUserDisable": false,
            "isSharedCourse": false,
            "typeAsDisplayString": "Self paced learning",
            "description": null,
            "type": "1",
            "canUserShare": true,
            "canUserDelete": true,
            "statusAsDisplayString": "Published",
            "currentUserRole": {
                "settingsAdmin": false,
                "courseOwner": true,
                "trainer": false,
                "sharedUser": false,
                "learner": false,
                "admin": true,
                "courseAdmin": true,
                "dataAdmin": false
            },
            "courseImageURL": "https://people.zoho.com/newhr/images/lmsbg/cat31.png",
            "name": "Public API Testing(SP)",
            "isDisabled": false,
            "isFavourite": false,
            "courseId": "219225000000642002",
            "publishStatus": "published",
            "status": 1
        },
        {
            "durationAsDisplayString": null,
            "canUserDisable": false,
            "isSharedCourse": false,
            "typeAsDisplayString": "E-Material",
            "description": null,
            "type": "3",
            "canUserShare": true,
            "canUserDelete": true,
            "statusAsDisplayString": null,
            "currentUserRole": {
                "settingsAdmin": false,
                "courseOwner": true,
                "trainer": false,
                "sharedUser": false,
                "learner": false,
                "admin": true,
                "courseAdmin": true,
                "dataAdmin": false
            },
            "courseImageURL": "https://people.zoho.com/newhr/images/lmsbg/cat11.png",
            "name": "ABCDEFG - EMAT",
            "isDisabled": false,
            "isFavourite": false,
            "courseId": "219225000000234001",
            "publishStatus": null,
            "status": 2
        },
        {
            "durationAsDisplayString": null,
            "canUserDisable": false,
            "isSharedCourse": false,
            "typeAsDisplayString": "Self paced learning",
            "description": "THIS IS COURSE DESCRIPTION.",
            "type": "1",
            "canUserShare": true,
            "canUserDelete": true,
            "statusAsDisplayString": "Published",
            "currentUserRole": {
                "settingsAdmin": false,
                "courseOwner": true,
                "trainer": false,
                "sharedUser": false,
                "learner": false,
                "admin": true,
                "courseAdmin": true,
                "dataAdmin": false
            },
            "courseImageURL": "https://people.zoho.com/newhr/images/lmsbg/cat1.png",
            "name": "B123",
            "isDisabled": false,
            "isFavourite": true,
            "courseId": "219225000000172466",
            "publishStatus": "published",
            "status": 1
        }
    ],
    "code": "200",
    "message": "success",
    "hasMoreRecords": false
}