Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
1.1 Introduction
The Curriculum Item Status web service is intended to provide the status of items/sub-curricula/requirements in curricula for displaying
them in the customer portal.
1.3 Deprecation
As of May 5, 2015, all new customer / new webservices implementations are required to use OData
APIs for integrations (http://help.sap.com/hr_api/). This guide will remain available and RESTful web
services will continue to be supported (but no longer enhanced) for customers that had already
implemented a solution based on the RESTful APIs prior to May 5, 2015.
Authentication Mechanism
Webservice client will access the token provider tool in the LMS to get the user based token which later on will be passed with rest
API call. A Secret Key will be shared between LMS token provider and webservice client and will be used for authentication when web
service client is requesting for the token.
Service Invocation
RESOURCE DESCRIPTION
https://(learning server)/learning/public-api/rest/v1/current-user/curriculum-item-
Request URL
status?targetUserID=<value>&curriculumID=<value>&rootCurriculumID=<value>
Request Method GET
Description Get Curriculum Item Status.
Request Header Accept: application/json (Optional)
Parameters None
Request Body None
RESPONSE HEADER 200: OK. Or ERROR see HTTP error codes.
RestOperationStatusVOX object (This response object will have
RESPONSE Body List<CurriculumItemStatusDTO> put in its "data" field. CurriculumItemStatusDTO will contain
all the output parameters given below as Key/value pair)
Outputs
RestOperationStatusVOX
Field Description
Operation Operation name
Status Success/Fail
Data Data returned (as described in Response body above in service invocation section)
Errors Json errors (if any)
Warnings Json warnings (if any)
The HTTP Response Code is used as a primary indicator of the success or failure of the API call:
HTTP Error Code Description
400 Bad request – invalid or missing inputs
Validations
Error Code Error Message
500 User do not have access to other user’s details.
500 Curriculum ID cannot be null.
500 Root Curriculum ID cannot be null.
500 The user ID does not exist in the LMS
500 The user is an inactive user.
500 The curriculum ID does not exist in the LMS.
500 The root curriculum ID does not exist in the LMS.
500 The curriculum is an inactive curriculum.
500 The root curriculum is an inactive curriculum.
500 The root curriculum is not a root for the Curriculum.
500 User does not have access to curriculum status workflow.
500 Admin does not have access to “View Curriculum Assigned To User” workflow.
500 Curriculum ID is not associated to the user.
500 User does not have any Items in the associated Curriculum.
Output will be in JSON format and contains the following data elements:
No Parameter Name Data Type Description
1 curriculaID String Curricula ID
10 displayOrder Number
SEQ_ORDER for the items to be displayed. The order
defined in the Curricula – Contents page specifying the
order in which the items should be displayed within that
specific curricula/sub-curricula
11 globalDisplayOrder String The display order of the items/sub-curricula/requirements from
the given Curricula ID. See the attached response where the
globalDisplayOrder is calculated from the first record in the
response
12 completionDate Timestamp Completion Date of the item in milliseconds in DB timezone
SuccessFactors Confidential Page 3 of 7
User Curricula Item Status Web Service
CurriculumRequirementItemDTO
No Parameter Name Data Type Description
1 itemTypeID String Item Type ID within the LMS
{
restOperationStatusVOX: {
errors: null