Gets the courses available to the specified person

get https://example.com/v1/people/{personId}/courses

Recipes

📚

Learn - Retrieve courses left to do or completed for a specific user

Open Recipe

This endpoint allows the API consumer to grab the relevant courses for a user. These courses can take the following forms:

Mandatory Courses
Non mandatory Courses
Courses that are completed

Please check out our Recipes for more information.

Use Cases

How would I be able to construct links in order to click through to the relevant course in Learn?

When the API is successfully called, you will get a list of courses back for the user in question. Within each course, you will be able to see a course identifier courseIdthat can be used for the above purpose. Whilst we progress with our public API offerings, you should be able to construct your own link to the course within Learn using the below template:

https://{learnSiteDomain}/learn/#/course/{courseId}

learnSiteDomain - the base domain of your Learn site e.g. test.kallidus-suite.com
courseId - courseId's returned from the successful API response e.g. `abcdefgh-1234-1234-1234-abcdefghijkl

Path Params

personId

uuid

required

The unique identifier of the person.

Query Params

$skip

string

The $skip query requests the number of items in the queried collection that are to be skipped and not included in the result. A client can request a particular page of items by combining $top and $skip. e.g. $top=10&$skip=1

$top

string

The $top query requests the number of items in the queried collection to be included in the result. A client can request a particular page of items by combining $top and $skip. e.g. $top=10&$skip=1

$filter

string

The $filter query allows clients to filter a collection of resources that are addressed by a request URL. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. e.g $filter=CourseIsEnabled eq true

$orderby

string

The $orderby query allows clients to request resources in a particular order. e.g $orderby=Title

Responses

401

Unauthorized - when a valid Bearer token is not supplied in the authorization header.

403

Forbidden - when the person requesting it is not the person with the specified id or if the person cannot be found.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://example.com/v1/people/personId/courses \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Use Cases

200OK - a page of courses, each enriched with learner data for the specified person.

400Bad request - if an empty guid is supplied for the person id.