Integration API Change Log

The Absorb Integration API, which is a REST API, allows for performative communication and interaction with the LMS without using the Absorb UI. The Integration API itself receives ongoing updates and changes to ensure consistent performance and quality of life features.

Update History

Captured below are versions of the Integration API which have been made available, alongside the changes associated with each version.

Release Version Release Date Changes
5.119.0 25th of August 2024

Manager Experience:

New Endpoint Available - List Manager Direct Reports

  • Route: GET/managers/{managerId}/direct-reports
  • This endpoint will return Direct Report details for a Manager.
  • Available in v2 only.

New Endpoint Available - Update Manager Direct Reports

  • Route: POST/managers/{managerId}/direct-reports
  • This endpoint will update and return Direct Reports for a Manager.
  • Available in v2 only.

Updated Endpoint - List Users

  • Route: GET/users
  • The endpoint will also return the IsManager property.
  • Available in v1 and v2.

Updated Endpoint - Get User

  • Route: GET/users/{userId}
  • The endpoint will also return the IsManager property.
  • Available in v1 and v2.

Updated Endpoint - Get Currently Authenticated User's Details

  • Route: GET/users/my-details
  • The endpoint will also return the IsManager property.
  • Available in v1 and v2.

New Endpoint Available - Get Manager Roles

  • Route: GET/managers/roles
  • This endpoint will return all Manager Roles.
  • Available in v2 only.

New Endpoint Available - Get a Manager's Manager Roles

  • Route: GET/managers/{managerId}/roles
  • This endpoint will return the Manager Roles for a specified Manager.
  • Available in v2 only.

New Endpoint Available - Update a Manager's Manager Roles

  • Route: PUT/managers/{managerId}/roles
  • This endpoint will update the Manager Roles for a specified Manager.
  • Available in v2 only.

New Endpoint Available - Get User Management Settings

  • Route: GET/users/{userId}/user-management-settings
  • This endpoint will get the management settings for a specified User.
  • Available in v2 only.

Updated Endpoint - Update User Management Settings

  • Route: PUT/users/{userId}/user-management-settings
  • Added a new request field userTypes that will allow for an option to set a User as a Learner, Admin, Instructor and/or Manager.
  • userManagementType has an additional enumeration value.
  • The endpoint will additionally return a 422 status code if validation rules are broken.
  • Available in v2 only.

External Training:

New Endpoint Available - List External Training Submissions

  • Route: GET/external-training/submissions
  • This endpoint will return a paginated collection of External Training Submissions.
  • Available in v2 only.

New Endpoint Available - Get External Training Submission

  • Route: GET/external-training/submissions/{id}
  • This endpoint will return the specified External Training Submission.
  • Available in v2 only.

New Endpoint Available - Create External Training Submission

  • Route: POST/external-training/submissions
  • This endpoint will create an External Training Submission.
  • Available in v2 only.

New Endpoint Available - Update External Training Submission

  • Route: PUT/external-training/submissions/{id}
  • This endpoint will update an existing External Training Submission.
  • Available in v2 only.

New Endpoint Available - Get External Training Template

  • Route: GET/external-training/templates/{id}
  • This endpoint will get an External Training Template.
  • Available in v2 only.

New Endpoint Available - List External Training Templates

  • Route: GET/external-training/templates
  • This endpoint will return a paginated collection of External Training Templates.
  • Available in v2 only.
5.118.0 20th of May 2024

New Endpoint Available - GetLearningPath

  • Route: /learning-path/{userId}
  • This endpoint will return Learning Path details for a User.
  • This will also be reflected in the API documentation.

New Endpoint Available - GetSelfAssessmentRatings

  • Route: /self-assessments/{selfAssessmentId}/skill-and-competency-ratings
  • The endpoint will return Skills and Competency ratings for a given Self Assessment.
  • This will also be reflected in the API documentation.
5.117.1 29th of February 2024

New Endpoint Available - GET Competency Definition

  • Route : api/rest/v1_5/competency-definition/{id}

  • This new endpoint exposes competency information for Admins who are looking to retrieve definition information about a specific Competency in the LMS give its competency ID.

  • As an example, If a Learner has gained a Competency, and you have its ID, you can use this new API to learn more about the Competency achieved, including a link to the badge image (if one is present).

  • This will also be reflected in the API documentation.

5.116.3 11th of January 2024

Bug Fixes

  • Fixed an issue to make usernametype field for POST {{protocol}}://{{host}}/enrollment-keys optional

5.116.1 22nd of November 2023

Bug Fixes

  • Fixed an issue where the endpoint “POST users/userId/enrollments” was not correctly updating the Status of the enrollment. The call now correctly sets this value.

5.116.0 5th of November 2023

Pagination Changes

  • Endpoints Changed:

    • List Venues endpoint - https://rest.myabsorb.com/venues

    • List User’s messages endpoint - https://rest.myabsorb.com/Users/{userId}/messages

    • List User’s received messages endpoint  - https://rest.myabsorb.com/Users/{userId}/messages/received

  • All changes support the versioning header (X-API-Version):

    • Supports 1.5.0 (default) and 1.5.1 as values.

    • Contract change applies only to 1.5.1.

  • New error code returned:

    • 422 Error: Occurs when the provided parameters result in an error.

Rate & Burst Limiting

  • Rate Limits have been introduced for all plans at 200 calls per second with a 100 call burst limit.

Bug Fixes

  • Fixed issue where the endpoint “get Course Bundles for sale” was returning all Course Bundles regardless of whether or not they were for sale.

  • Updated documentation for “list User’s available courses” endpoint to accurately reflect its paginated and versioned changes.

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.