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

SAP Knowledge Base Article - Public

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

Symptom

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.

Environment

SuccessFactors LMS
Learning Management System

Resolution

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:


  "primaryKey":"",
  "enrollmentStatus":[ 
    { 
      "scheduleID":7961,
      "userID":"XYZ",
      "personExternalID": "JWICK",
      "personGUID":"96358F7B60E34B859F9BC4D35EB503B4",
      "newEnrollmentStatusID":"CANCELLED",
      "registrationChangeTime":1458593685000,
      "timezone":"US/Eastern",
      "cancellationReasonID":"OUT_OF_OFFICE"
    }
]
}

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"

 

 

 

Cancellation_Reason1.png

 

For full information on all the OData API available please check our help page : https://help.sap.com/hr_api

Keywords

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

Product

SAP SuccessFactors Learning 1702