03 March 2025

REST Services

The new and updated REST Services for the 4.46 release are detailed in the table below.

Fund Manager
Header Business Impact

Integrations user is able to perform various actions using the new Fund Manager APIs.

An integrations user is able to perform the following actions using the new Fund Manager APIs:

  • Retrieve a list of funds

  • Retrieve a single fund record

  • Update a fund

  • Delete a single fund record

  • Retrieve and view list of learners on a fund

  • Create a fund

  • Assign or add a set of learners to a fund

The image below shows the new Fund Manager APIs in the ebs REST Documentation.

Fund Manager APIs in Swagger

Integrations user is able to perform various actions using the new Reference Data APIs.

An integrations user is able to perform the following actions using the new Reference Data APIs:

  • Retrieve list of Funding Years defined in ebs reference data

  • Retrieve list of Verifiers defined in ebs reference data

  • Retrieve list of LSC Verifiers defined in ebs reference data

The image below shows the new Reference Data APIs in the ebs REST Documentation.

Integrations user is able to perform various actions using the new Learners APIs.

An integrations user is able to perform the following actions using the new Learners APIs:

  • Retrieve list of enrolled learners

  • Query and retrieve a list of courses a learner is attached to.

The image below shows the new Learners APIs in the ebs REST Documentation.

Learner APIs for Fund manager

Integrations user is able to perform various actions using the new Staff APIs.

An integrations user is able to perform the following actions using the new Learners APIs:

  • Retrieve list of staff members

The image below shows the new Staff APIs in the ebs REST Documentation.

Fund manager staff search api

REST Services
Header Business Impact Affected Topics

Verifier / Reference Data API call amendment

The endpoint for the existing web service API call to retrieve verifier values by domain has been amended from Verifier/GetVerifierValues/{rv_domain} to Verifiers/GetVerifierValues/{rv_domain}.

That this change could break integrations from third-party systems using the API.

Not applicable

Created a new webservice: Update Enrolment Learner

The Enrolments > Update Enrolments > Learner REST services have been updated to include the following fields:

  • AclProvisionType

  • TLOut

These properties enable the saving of a learner's ACL_PROVISION and TAILORED_LEARNING_OUTCOME information.

Also, the Update Enrolment Learner service is available in the service drop-down in Designer to enable service service usability in ebs: ontrack Hub.

REST Services Available in Designer

Added new properties in Update Orders Web Service for Learners

The Orders > Update Orders REST services have been updated to include the following fields:

  • AclProvisionType

  • TLOut

These properties save the ACL_PROVISION and TAILORED_LEARNING_OUTCOME information for a learner's enrolment in the table PEOPLE_UNITS_SPECIAL. This is reflected on the Enrolment Special Detail in ebs: central.

Also, the Update Order service is now available in the service drop-down in Designer to enable service usability in ebs: ontrack Hub.

REST Services Available in Designer

For more information on the REST services, go to ebs REST Documentation.