SAP Knowledge Base Article - Public

2421933 - LMS - Scheduled Offering ODATA API -- Support Cancellation Reason (Product Enhancement b1702 - LRN-15619)


PUT calls to scheduledoffering-service/v1/EnrollmentStatuses now include cancellation reasons, so you can describe why users' enrollment status changes when you call the API. Cancellation reasons are used in reporting to describe why users canceled (for example, personal reasons or schedule conflict). Earlier, the API did not support passing Cancellation Reason as a parameter. In the release b1702 we have included Cancellation Reason as a parameter to the payload.


SuccessFactors LMS
Learning Management System


If User status is moved from Enrolled/Waitlisted to Cancelled State and if the Scheduled offering has Cancellation Reason config enabled, then input must have a Cancellation ReasonID.

Request Method: PUT

Request URLs:
https://[LMS server host]/learning/odatav4/public/admin/scheduledoffering-service/v1/EnrollmentStatuses('') - Used when admin is performing the action.
https://[LMS server host]/learning/odatav4/public/user/scheduledoffering-service/v1/EnrollmentStatuses('') - Used when user/supervisor is performing the action.

Sample Payload:

      "personExternalID": "JWICK",

Points to Note:

Cancellation Reason ID must be passed in the payload, if it is configured in the Scheduled Offering. If it is set to No, then you need not pass Cancellation Reason as a parameter in the payload.

If you navigate to Learning > Scheduled Offering > Search for Scheduled Offering > Look for flag "Enable Cancellation Reason"






For full information on all the OData API available please check our help page :


Scheduled Offering
Cancellation Reason , KBA , LOD-SF-LMS-ODA , Web Services OData , LOD-SF-LMS , Learning Management System , Product Enhancement


SAP SuccessFactors Learning 1702