Integration API​

New Features​

• New Endpoint Available - List Routes
  • Route: GET /routes
  • This endpoint will list the portal's Routes (the web addresses learners use to reach the portal) in priority order, including department routes for departments the caller can view.
  • Each route includes a course link template, deepLinks.courseTemplate, which opens a course in the learner experience once the {id} placeholder is filled in.
  • Supports pagination.
  • Available in v1 and v2.

Integration API​

New Features​

• New Endpoint Available - Create Online Course

  • Route: POST /online-courses
  • This endpoint will create Online Course, including general details, completion certificate settings, availability window, catalog visibility, notification messages, attributes, and notes.
  • Available in v2 only.

• New Endpoint Available - Update Online Course

  • Route: PUT /online-courses/{id}
  • This endpoint will update a select set of Online Course metadata, including general details, completion certificate settings, availability window, catalog visibility, notification messages, attributes, and notes. Fields not present in the request are left unchanged.
  • Available in v2 only.

• New Endpoint Available - Update Instructor Led Course

  • Route: PUT /instructor-led-courses/{id}
  • This endpoint will update a select set of Instructor Led Course metadata, including general details, completion certificate settings, availability window, catalog visibility, notification messages, attributes, and notes. Fields not present in the request are left unchanged.
  • Available in v2 only.

• New Endpoint Available - Create Instructor Led Course

  • Route: POST /instructor-led-courses
  • This endpoint will create Instructor Led Course, including general details, completion certificate settings, availability window, catalog visibility, notification messages, attributes, and notes.
  • Available in v2 only.

• New Endpoint Available - Create Session

  • Route: POST /instructor-led-courses/{id}/sessions
  • This endpoint will create a Session for an Instructor Led Course from a repeat rule, including venue, instructors, class size, waitlist and meeting link, and returns the session with every class generated.
  • Times are local to the session's timeZone; send them without Z or an offset.
  • Available in v2 only.

• New Endpoint Available - Update Session

  • Route: PUT /instructor-led-courses/{id}/sessions/{sessionId}
  • This endpoint will replace a Session of an Instructor Led Course and move its classes to the new repeat rule. Fields not present in the request are cleared. Classes that have already started are kept as they were.
  • Available in v2 only.

• New Endpoint Available - List Enrollments

  • Route: GET /enrollments
  • This endpoint will list every course Enrollment in the portal, across online courses, instructor led courses and curricula. Course bundle enrollments are excluded, but the enrollments for a bundle's courses are included.
  • Supports pagination, filtering and sorting, and sorts by full name by default.
  • Available in v2 only.

Integration API​

New Features​

• New OAuth 2.0 Grant Available - Client Credentials
  • Route: POST /oauth/token with grant_type=client_credentials
  • Server-to-server integrations can now get an access token with the portal's Integration API OAuth client ID and client secret, sent as HTTP Basic authentication, with no admin user signing in.
  • Send the token with every request as Authorization: Bearer <access_token>, with Bearer written exactly like that. No refresh token is issued; request a new token when the current one expires. Several tokens can be valid at the same time.
  • Endpoints that return data for the signed-in user, such as /my-enrollments and /my-details, return 403 to a client credentials token, and the response names the administrative endpoint to use instead.
  • Available on every portal that has the Integration API enabled, in v1 and v2.
  • See OAuth 2.0 for the request, the response and the errors.

Integration API​

Bug Fixes​

• Provinces endpoint no longer returns townships to conform with ISO 3166-2

Integration API​

New Features​

• New Endpoint Available - Create Group

  • Route: POST /groups
  • This endpoint will create a new Group.
  • Available in only v2.

• New Endpoint Available - Assign Users to Group

  • Route: POST /groups/{id}/users/assign
  • This endpoint will assign users to an existing manual Group.
  • Available in only v2.

• New Endpoint Available - Unassign Users to Group

  • Route: POST /groups/{id}/users/unassign
  • This endpoint will unassign users from an existing manual Group.
  • Available in only v2.

• New Endpoint Available - Update the Group

  • Route: PUT /groups/{id}
  • This endpoint will update the existing Group.
  • Available in only v2

• Multi-session enrollment is now supported on the following endpoint

  • POST /users/{userId}/enrollments/{courseId}/session/{sessionId}

Integration API​

New Features​

• Re-enrollments now trigger a course enrollment email to be sent.

Integration API​

Bugfixes​

• Removed unused id request property on user update/upsert calls.
• Fixed enrollments being returned for deleted courses.

Integration API​

New Features​

• New Endpoint Available - List Course Evaluation Answers

  • Route: GET /courses/{courseId}/evaluation-answers
  • This endpoint will return Evaluation Answers for a specified Course.
  • Available in v2 only.

• New Endpoint Available - List Course Evaluation Questions

  • Route: GET /courses/{courseId}/evaluation-questions
  • This endpoint will return Evaluation Questions for a specified Course.
  • Available in v2 only.

• New Endpoint Available - Get Course Evaluation Question

  • Route: GET /courses/{courseId}/evaluation-questions/{questionId}
  • This endpoint will return single Evaluation Question for a specified Course by questionId.
  • Available in v2 only.

Bugfixes​

• Removed unused timeSpentTicks request property on POST enrollment endpoint.

Integration API​

Bugfixes​

• Resolved issue where saving user management settings would always remove Reviewer user type

Integration API​

Bugfixes​

• Resolved issue where negative credits could be applied to enrollments