{"info":{"_postman_id":"197b5bcb-1dcb-4770-906c-df0c0654d7af","name":"LP Provisioning","description":"

This API is exposed to customers on request for integration. The APIs primary aim is to push data to the various applications in the Learningpool ecosystem (Currently LXP and Skillsbuilder) as means of keeping employee related data in sync with external systems.

\n

Authentication

\n

Authentication for the API will be a tiered approach. Authentication will be based on two components:

\n

An API Key

\n

API keys are unique per customer. They are generated by AWS API Gateway and are associated with a consumption / usage plan that again is unique to each customer.

\n

A Unique Tenant ID

\n

The Tenant ID is a unique identifier for each Organisation. This ID will be generated for customers when they request an integration with the Learningpool User Provisioning API. The ID will be formatted as a Universally Unique Id (UUID). It is a 128 bit Integer value. An example would be 73c9ac34-bc35-4c17-b60f-8ec0b134a72b.

\n

As part of authentication / authorization, both values must be in the header of each requests. The header keys are x-tenant-id and x-api-key.

\n

Authentication Stage 1

\n

When a request is made, API Gateway will first determine if a valid API Key has been provided, is valid for the route in the request and is associated with an appropriate consumption plan. If the key is valid, we move to stage 2.

\n

Authentication Stage 2

\n

This stage ensures that based on the details provided, they caller has been authentication and that they are authorized to make the request. Best practice with AWS Gateway is to make use of a Custom Lambda Authorizer in conjunction with the API Key.

\n

In this stage, the authorizer will take the Tenant ID provided and perform the following verifications:

\n

Ensure the ID is a valid Tenant ID (Has been set up for integration)

\n

Ensures that the API key is the correct API Key for the tenant. (Every tenant will have a unique API Key and Tenant ID combination).

\n

If the verification steps pass, then the caller is granted permission and the API request is processed.

\n

Key rotation

\n

It is also possible for the API key and / or Tenant ID values to be rotated. This can be done at the request of the customer.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"}],"owner":"31630327","collectionId":"197b5bcb-1dcb-4770-906c-df0c0654d7af","publishedId":"2s9YkgDkKb","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-12-08T14:43:56.000Z"},"item":[{"name":"Create User","id":"21e25471-267e-4c9b-95a7-8bb65458ec14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{apiKey}}"},{"key":"x-tenant-id","value":"{{tenantId}}"}],"body":{"mode":"raw","raw":"{ \n\t\"userId\" : \"EMPssoupdate99\", \n\t\"username\": \"ssoupdate99\",\n\t\"firstName\": \"ssoupdate99\",\n\t\"lastName\" : \"ssoupdate99\",\n\t\"email\" : \"ssoupdate99.ssoupdate99@mydomain.com\",\n\t\"country\": \"BHR\",\n\t\"timezone\" : \"Europe/London\",\n\t\"language\" : \"en_GB\"\n}"},"url":"{{baseURL}}/users","description":"

This request will create a new User object.

\n

Request Body

\n
PropertyData TypeDescriptionApplies to
userId
string
(Required) A unique identifier for the user within the Ecosystem. Often a HR Id from external systems.
LXP, Skillsbuilder
username
string
(Required) The chosen username for the user. Used when logging into the applications. Must be unique.
LXP, Skillsbuilder
firstName
string
(Required) The users first name.
LXP, Skillsbuilder
lastName
string
(Required) The users last name.
LXP, Skillsbuilder
email
string
(Required) The users email address.
LXP, Skillsbuilder
customFields
array
Array of custom field names and values. The custom fields must already exist and the value provided must conform to the expected data type.
LXP
country
string
This field will accept the 3 digit ISO code for the users country of work.
LXP
leaderboardOptOut
boolean
Determines if the user will be part of the leaderboard.
LXP
viewProfile
boolean
Determines if the users profile is visible to other users..
LXP
orgRef
string
Populates the Org Ref property for the user in the LXP.
LXP
disableManualLogin
boolean
Dictates whether the user will have the ability to log in manually (not using SSO).
LXP
language
string
en_GB default en
LXP
timezone
string
Default Europe/London. Value must be a supported PHP Timezone. Valid Timezones
LXP

expiresAt
date string 2017-10-06 14:51:38
A date and time of expiry for the user. Upon this date, the user will be inactive within the LXP.
LXP
","urlObject":{"path":["users"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"33a10f3e-4c0c-4170-9381-e5ae0e2a65d7","name":"Create User","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{apiKey}}"},{"key":"x-tenant-id","value":"{{tenantId}}"}],"body":{"mode":"raw","raw":""},"url":"{{baseURL}}/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 15 Mar 2021 16:21:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"227"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"230df4dc-c8c9-4179-aa86-1ca1e372e63e"},{"key":"x-amz-apigw-id","value":"cPJtIG5ljoEFcjA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-604f8987-0ec92d303123a17152eb107c"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"User successfully submitted for processing\",\n \"requestId\": \"228225e3-caeb-49b6-8177-b2f0594866e2\",\n \"status\": \"https://api.learningpool.com/api/progress-status/228225e3-caeb-49b6-8177-b2f0594866e2\"\n}"}],"_postman_id":"21e25471-267e-4c9b-95a7-8bb65458ec14"},{"name":"Update User","id":"20aba9f3-f5ec-484d-a456-0b0da43b5051","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{apiKey}}"},{"key":"x-tenant-id","value":"{{tenantId}}"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"john\",\n \"lastName\": \"doe\",\n \"email\": \"john.doe@mydomain.com\",\n \"customFields\": [\n {\n \"id\": \"phone-number\",\n \"value\": \"04691228343\"\n },\n {\n \"id\": \"work-phone\",\n \"value\": \"046918323432\"\n },\n {\n \"id\": \"city\",\n \"value\": \"derry\"\n }\n ],\n \"country\": \"BHR\",\n \"timezone\": \"Europe/London\",\n \"language\": \"en_GB\"\n}"},"url":"{{baseURL}}/users/{user-id}","description":"

This request will update a user with the matching user-id (as provided in the URL). All properties here are optional. The only properties expected to be provided are the deltas (the properties that require update).

\n

Request Body

\n
PropertyData TypeDescriptionApplies to
firstName
string
The users first name.
LXP, Skillsbuilder
lastName
string
The users last name.
LXP, Skillsbuilder
email
string
The users email address.
LXP, Skillsbuilder
customFields
array
Array of custom field names and values. The custom fields must already exist.
LXP
country
string
This field will accept the 3 digit ISO code for the users country of work.
LXP
leaderboardOptOut
boolean
Determines if the user will be part of the leaderboard.
LXP
viewProfile
boolean
Determines if the users profile is visible to other users..
LXP
orgRef
string
Populates the Org Ref property for the user in the LXP.
LXP
disableManualLogin
boolean
Dictates whether the user will have the ability to log in manually (not using SSO).
LXP
language
string
en_GB default en
LXP
timezone
string
Default Europe/London. Value must be a supported PHP Timezone. Valid Timezones
LXP
expiresAt
date string 2017-10-06 14:51:38
A date and time of expiry for the user. Upon this date, the user will be inactive within the LXP.
LXP
","urlObject":{"path":["users","{user-id}"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"25e0a944-bce4-4f06-9e1a-fac51c317e68","name":"Update User","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{apiKey}}"},{"key":"x-tenant-id","value":"{{tenantId}}"}],"body":{"mode":"raw","raw":""},"url":"{{baseURL}}/users/{user-id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 15 Mar 2021 10:41:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"227"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"2361174e-1a71-4e1e-a504-3b1d7a71de0d"},{"key":"x-amz-apigw-id","value":"cOX2rHb9DoEFTGQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-604f39c4-694a0dc86dbd676d57f3474e"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"User successfully submitted for processing\",\n \"requestId\": \"df17beae-b123-4b74-80c7-b7dc756d5cff\",\n \"status\": \"https://api.learningpool.com/api/progress-status/df17beae-b123-4b74-80c7-b7dc756d5cff\"\n}"}],"_postman_id":"20aba9f3-f5ec-484d-a456-0b0da43b5051"},{"name":"Update User Status","id":"43e6e4a6-1064-49de-bbe4-37a128781102","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-tenant-id","value":"{{tenantId}}"},{"key":"x-api-key","value":"{{apiKey}}"}],"body":{"mode":"raw","raw":"{ \n\t\"status\": \"DELETED\"\n}"},"url":"{{baseURL}}/{user-id}/status","description":"

This request will update the status a user with the matching user-id (as provided in the URL). The users status can be updated to either DELETED or ACTIVE. This endpoint allows for deletion and restoring of users.

\n

Request Body

\n\n \n \n \n \n \n \n \n \n \n \n
PropertyData TypeDescription
statusstringAccepted values are 'DELETED' or 'ACTIVE'
","urlObject":{"path":["{user-id}","status"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"6678adf1-58f0-40b4-8bad-335f1fede5c1","name":"Update User Status","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-tenant-id","value":"{{tenantId}}"},{"key":"x-api-key","value":"{{apiKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{baseURL}}/users/{user-id}/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 16 Mar 2021 14:22:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"62"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"327a0458-1087-4c18-a292-ae51ce7457e1"},{"key":"x-amz-apigw-id","value":"cSLMBE41DoEFiWg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6050bf19-66ef06ed04fa055a6fa373a0"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"User status sucessfully submitted for processing\"\n}"}],"_postman_id":"43e6e4a6-1064-49de-bbe4-37a128781102"},{"name":"Add User Job Assignment","id":"0de72002-e9de-4191-a1f8-dbe42d9bb65f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-tenant-id","value":"{{tenantId}}"},{"key":"x-api-key","value":"{{apiKey}}"}],"body":{"mode":"raw","raw":"{ \n\t\"managerId\": \"EMP9831111\",\n\t\"jobAssignmentId\": \"J123\",\n\t\"jobAssignmentName\": \"receptionist\",\n\t\"managerJobAssignmentId\": \"J134\",\n\t\"organisationFrameworkId\": \"OF1\",\n\t\"organisationLevelId\": \"104\",\n\t\"positionFrameworkId\": \"PF1\",\n\t\"positionLevelId\": \"104\",\n\t\"startDate\": \"\",\n\t\"endDate\" : \"\",\n \"isOrganisationManager\" : false\n}"},"url":"{{baseURL}}/users/{user-id}/job-assignment","description":"

In the LXP The Job Assignment entity represents a role that has been assigned to an employee in the Organisation. A user can have multiple Job Assignments. In the LXP, this is a Job Role. In Skillsbuilder, this is simply a means of associating a user with and Organisation (organisationLevelId) and determining if they are a manager of the Organisation (isOrganisationManager).

\n

This request is to be used for assignment / creation of a new role to a user in the LXP.

\n

From Skillsbuilders perspective, a Job Assignment resource is used to assign a User to a Skillsbuilder Organisation and assign them a role (PALYX_MANAGER and PALYX_USER).

\n

Request Body

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
PropertyData TypeDescriptionApplies to
managerIdstringThe ID of the manager. This is the userId of a user that has been previously provisioned into the Ecosystem.LXP
jobAssignmentIdstring(Required) The ID of the users job assignment. If the job assignment does not currently exist, it will be created.This value is unique per user.LXP, Skillsbuilder
jobAssignmentNamestring(Required)The name of the users job assignment.LXP, Skillsbuilder
managerJobAssignmentIdstringThe id of the managers job assignment.LXP
startDatedate string 2017-10-06 14:51:38The start date of the users employment within the organisation.LXP
endDatedate string 2017-10-06 14:51:38The end date of the users employment within the organisation.LXP
organisationFrameworkIdstringThe name of the organisation framework that the user is part of.LXP
organisationLevelIdstringThis is ID of the Organisation Hierarchy tier that the Job Assignment is associated with. For Skillsbuilder, this identifes the Organisation External ID to associate the user with.LXP, Skillsbuilder
positionFrameworkIdstringThe name of the position framework that the user is part of.LXP
positionLevelIdstringThis is ID of the Position Hierarchy tier that the Job Assignment is associated with.LXP
isOrganisationManagerbooleanIn the LXP, this Determines whether the user is a manager of the Organisation Level (node) linked in the organisationLevelId property. For Skillsbuilder it would make the user a PALYX_MANAGER or PALYX_USERLXP, Skillsbuilder
","urlObject":{"path":["users","{user-id}","job-assignment"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"0d0b45e6-8b80-474a-8c49-9a21384008f2","name":"Add User Job Assignment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-tenant-id","value":"{{tenantId}}"},{"key":"x-api-key","value":"{{apiKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{baseURL}}/users/{user-id}/job-assignment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 16 Mar 2021 14:18:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"237"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"70ea6672-ea3d-4ef5-aae3-8d72d697dc5d"},{"key":"x-amz-apigw-id","value":"cSKn_EpzDoEFuLQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6050be33-6cb26b5b3b32abc86353e1d5"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Job Assignment successfully submitted for processing\",\n \"requestId\": \"60b716e9-a4ac-43e6-968a-fbf686052c1a\",\n \"status\": \"https://api.learningpool.com/api/progress-status/60b716e9-a4ac-43e6-968a-fbf686052c1a\"\n}"}],"_postman_id":"0de72002-e9de-4191-a1f8-dbe42d9bb65f"},{"name":"Update User Job Assignment","id":"303588d1-f1e4-4109-bda4-7d38fc16ce14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{apiKey}}"},{"key":"x-tenant-id","value":"{{tenantId}}"}],"body":{"mode":"raw","raw":"{ \n\t\"managerId\": \"EMP9811\",\n\t\"jobAssignmentName\": \"cook\",\n\t\"managerJobAssignmentId\": \"J134\",\n\t\"organisationFrameworkId\": \"OF1\",\n\t\"organisationLevelId\": \"104\",\n\t\"positionFrameworkId\": \"PF1\",\n\t\"positionLevelId\": \"104\",\n\t\"startDate\": \"\",\n\t\"endDate\" : \"\",\n \"isOrganisationManager\" : false\n}"},"url":"{{baseURL}}/users/{user-id}/job-assignment/{job-assignment-id}","description":"

In the LXP The Job Assignment entity represents a role that has been assigned to an employee in the Organisation. A user can have multiple Job Assignments. In the LXP, this is a Job Role. In Skillsbuilder, this is simply a means of associating a user with and Organisation (organisationLevelId) and determining if they are a manager of the Organisation (isOrganisationManager).

\n

This request is to be used for updating of a role in the LXP.

\n

From Skillsbuilders perspective, a Job Assignment resource is used to assign a User to a Skillsbuilder Organisation and assign them a role (PALYX_MANAGER and PALYX_USER).

\n

Request Body

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
PropertyData TypeDescriptionApplies To
managerIdstringThe ID of the manager. This is the userId of a user that has been previously provisioned into the Ecosystem.LXP
jobAssignmentNamestringThe name of the users job assignment.LXP
managerJobAssignmentIdstringThe id of the managers job assignment.LXP
startDatedate string 2017-10-06 14:51:38The start date of the users employment within the organisation.LXP
endDatedate string 2017-10-06 14:51:38The end date of the users employment within the organisation.LXP
organisationFrameworkIdstringThe name of the organisation framework that the user is part of.LXP
organisationLevelIdstringThis is ID of the Organisation Hierarchy tier that the Job Assignment is associated with. For Skillsbuilder, this identifes the Organisation External ID to associate the user with.LXP, Skillsbuilder
positionFrameworkIdstringThe name of the position framework that the user is part of.LXP
positionLevelIdstringThis is ID of the Position Hierarchy tier that the Job Assignment is associated with.LXP
isOrganisationManagerbooleanIn the LXP, this Determines whether the user is a manager of the Organisation Level (node) linked in the organisationLevelId property. For Skillsbuilder it would make the user a PALYX_MANAGER or PALYX_USERLXP, Skillsbuilder
","urlObject":{"path":["users","{user-id}","job-assignment","{job-assignment-id}"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"f68e1429-6113-4d20-b771-7e06da3418b5","name":"Update User Job Assignment","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{apiKey}}"},{"key":"x-tenant-id","value":"{{tenantId}}"}],"body":{"mode":"raw","raw":""},"url":"{{baseURL}}/users/{user-id}/job-assignment/{job-assignment-id}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 16 Mar 2021 14:13:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"59"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"2f3e37f8-6d8e-4424-a45f-59d259eaa60c"},{"key":"x-amz-apigw-id","value":"cSJ0-EEzjoEFsoA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6050bcec-69cc2db8313898d13f4736d7"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Job Assignment successfully submitted for processing\",\n \"requestId\": \"60b716e9-a4ac-43e6-968a-fbf686052c1a\",\n \"status\": \"https://api.learningpool.com/api/progress-status/60b716e9-a4ac-43e6-968a-fbf686052c1a\"\n}"}],"_postman_id":"303588d1-f1e4-4109-bda4-7d38fc16ce14"},{"name":"Add Organisation level","id":"306581c2-4443-4aec-a46e-1a3689e22446","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-tenant-id","value":"{{tenantId}}"},{"key":"x-api-key","value":"{{apiKey}}"}],"body":{"mode":"raw","raw":"{ \n\t\"parentId\": \"1\",\n \"levelId\": \"EGY1\",\n\t\"levelName\" : \"Egypt\",\n \"customFieldSetId\" : \"organisation-fields\",\n \"customFields\" : [\n\t\t{\n\t\t\t\"id\" : \"store-open-date\",\n\t\t\t\"value\" : \"2021-03-31T15:22:08Z\"\n\t\t}\n\t]\n}"},"url":"{{baseURL}}/organisation-framework/{framework-id}/organisation-level","description":"

In the LXP, this request is used to add another Organisation Node to a tier in the hierarchy underneath a specified Organisation Framework.

\n

All nodes added to the Organisation Framework will be added as Organisations in Skills Builder.

\n

Request Body

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
PropertyData TypeDescription
parentIdstringThe ID of the parent level. If this is left empty, the new level will be added to the root.
levelIdstring(Required)The Id of the new level. This will be required when performing subsequent level updates.
levelNamestringThe label / name of to be displayed for the level on the UI.
customFieldSetIdstringThe ID of Custom Field Set to associate with this level.
customFieldsstringArray of custom field names and values. The custom fields must already exist and the value provided must conform to the expected data type. The custom field must also be associated with the customFieldSetId provided
","urlObject":{"path":["organisation-framework","{framework-id}","organisation-level"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"68432ab0-6bbc-43b2-97b9-bfbd17ea3ba4","name":"Add Organisation level","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-tenant-id","value":"{{tenantId}}"},{"key":"x-api-key","value":"{{apiKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{baseURL}}/organisation-framework/{framework-id}/organisation-level"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 16 Mar 2021 14:24:02 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"241"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"72409a10-80e1-4100-9ba7-33771f080d53"},{"key":"x-amz-apigw-id","value":"cSLb8EMojoEFXRg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6050bf7f-37527d60393f900c67b510f6"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Organisation Level successfully submitted for processing\",\n \"requestId\": \"4e998788-8290-4a60-8ba1-4db767dff283\",\n \"status\": \"https://api.learningpool.com/api/progress-status/4e998788-8290-4a60-8ba1-4db767dff283\"\n}"}],"_postman_id":"306581c2-4443-4aec-a46e-1a3689e22446"},{"name":"Add Position level","id":"5dd952b4-f462-42f1-a9d0-a3784e841282","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-tenant-id","value":"{{tenantId}}"},{"key":"x-api-key","value":"{{apiKey}}"}],"body":{"mode":"raw","raw":"{ \n\t\"parentId\": \"\",\n \"levelId\": \"ENG\",\n\t\"levelName\" : \"Engineer\"\n}"},"url":"{{baseURL}}/position-framework/{framework-id}/position-level","description":"

This request is used to add another Position Level to a tier in the hierarchy underneath a specified Position Framework.

\n

Request Body

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
PropertyData TypeDescription
parentIdstringThe ID of the parent level. If this is left empty, the new level will be added to the root.
levelIdstring(Required)The Id of the new level. This will be required when performing subsequent level updates.
levelNamestringThe label / name of to be displayed for the level on the UI.
","urlObject":{"path":["position-framework","{framework-id}","position-level"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"287b8e67-8105-49c3-9f18-6f3243a80751","name":"Add Position level","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-tenant-id","value":"{{tenantId}}"},{"key":"x-api-key","value":"{{apiKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{baseURL}}/position-framework/{framework-id}/position-level"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 16 Mar 2021 14:25:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"237"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ce47c7f3-ce80-428c-9bc0-8c076290e77f"},{"key":"x-amz-apigw-id","value":"cSLnjEQRjoEFo-g="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6050bfc9-76b9bb754b8379e049e149b4"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Position Level successfully submitted for processing\",\n \"requestId\": \"6ed2dd89-49c5-4989-8f8f-45bdd0cd5bd9\",\n \"status\": \"https://api.learningpool.com/api/progress-status/6ed2dd89-49c5-4989-8f8f-45bdd0cd5bd9\"\n}"}],"_postman_id":"5dd952b4-f462-42f1-a9d0-a3784e841282"},{"name":"Update Organisation level","id":"5d7db0ae-2f52-4028-aa30-829740f1a526","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-tenant-id","value":"{{tenantId}}"},{"key":"x-api-key","value":"{{apiKey}}"}],"body":{"mode":"raw","raw":"{ \n\t\"parentId\": \"1234567\",\n \"levelName\" : \"Egypt\",\n \"customFieldSetId\" : \"organisation-fields\",\n \"customFields\" : [\n\t\t{\n\t\t\t\"id\" : \"store-open-date\",\n\t\t\t\"value\" : \"2021-03-31T15:22:08Z\"\n\t\t}\n\t]\n}"},"url":"{{baseURL}}/organisation-framework/{framework-id}/organisation-level/{id}","description":"

This request is used to update a specific Organisation level. This request is a partial update and will only require the updated properties to be provided in the request body.

\n

Request Body

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n
PropertyData TypeDescription
parentIdstringThe ID of the parent level. If this is left empty, the new level will be added to the root.
levelNamestringThe label / name of to be displayed for the level on the UI.
customFieldSetIdstringThe ID of Custom Field Set to associate with this level.
customFieldsstringArray of custom field names and values. The custom fields must already exist and the value provided must conform to the expected data type. The custom field must also be associated with the customFieldSetId provided
","urlObject":{"path":["organisation-framework","{framework-id}","organisation-level","{id}"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"bbaa59b0-fa96-40cd-b80d-43850340f3f7","name":"Update Organisation level","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-tenant-id","value":"{{tenantId}}"},{"key":"x-api-key","value":"{{apiKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{baseURL}}/organisation-framework/{framework-id}/organisation-level/{id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 16 Mar 2021 14:14:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"240"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"d5f3726a-0e1a-401f-8447-0cfff6cfc7f9"},{"key":"x-amz-apigw-id","value":"cSKGIFA2joEFo-A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6050bd5a-579f1e4b1b125c9c5da97e98"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Organisation Level sucessfully submitted for processing\",\n \"requestId\": \"47e19402-a20b-44e8-818e-843478dd31ad\",\n \"status\": \"https://api.learningpool.com/api/progress-status/47e19402-a20b-44e8-818e-843478dd31ad\"\n}"}],"_postman_id":"5d7db0ae-2f52-4028-aa30-829740f1a526"},{"name":"Update Position level","id":"bea632c1-c37d-4eac-ba24-f5f4670f1f0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{apiKey}}"},{"key":"x-tenant-id","value":"{{tenantId}}"}],"body":{"mode":"raw","raw":"{ \n \"levelName\" : \"Engineer\",\n \"customFieldSetId\" : \"position-fields\"\n}"},"url":"{{baseURL}}/position-framework/test1/position-level/ENG","description":"

This request is used to update a specific Organisation level. This request is a partial update and will only require the updated properties to be provided in the request body.

\n

Request Body

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
PropertyData TypeDescription
parentIdstringThe ID of the parent level. If this is left empty, the new level will be added to the root.
levelNamestringThe label / name of to be displayed for the level on the UI.
","urlObject":{"path":["position-framework","test1","position-level","ENG"],"host":["{{baseURL}}"],"query":[{"disabled":true,"key":"x-api-key","value":"{{apiKey}}"},{"disabled":true,"key":"x-tenant-id","value":"{{tenantId}}"}],"variable":[]}},"response":[{"id":"38628593-c13c-499b-84f8-51f0b1e94b83","name":"Update Position level","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{apiKey}}"},{"key":"x-tenant-id","value":"{{tenantId}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{baseURL}}/position-framework/{framework-id}/position-level/{id}","host":["{{baseURL}}"],"path":["position-framework","{framework-id}","position-level","{id}"],"query":[{"key":"x-api-key","value":"{{apiKey}}","disabled":true},{"key":"x-tenant-id","value":"{{tenantId}}","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 16 Mar 2021 14:27:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"237"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a7a2ebc4-fbf4-4db4-b42a-be25dca44a7b"},{"key":"x-amz-apigw-id","value":"cSL4zEFPjoEFVMA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6050c038-79ef5ca34c2ad78d3980640e"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Position Level successfully submitted for processing\",\n \"requestId\": \"0c085aeb-708e-440c-b668-c35a8e4dc98c\",\n \"status\": \"https://api.learningpool.com/api/progress-status/0c085aeb-708e-440c-b668-c35a8e4dc98c\"\n}"}],"_postman_id":"bea632c1-c37d-4eac-ba24-f5f4670f1f0b"},{"name":"Get Request Progress","id":"3c44bf4e-fdf4-4692-aa5a-b6c627bce5bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"x-tenant-id","value":"{{tenantId}}"}],"url":"{{baseURL}}/progress-status/{request-id}","description":"

This Endpoint can be used to check the status of a particular request. In the body of the Response, we can identify if the the Request has a status of 1 (In Progress), 2 (Complete), 3 (In Error) or 4 (Retrying). Please note here that in cases of Retry or Error, the actual error message returned will have been generated by the downstream applications and as such may make use of terminology that is not consistent with the upstream API. For example, when creating or updating a user, if an incorrect userId is provided, then the error message may mention the property sso_id (Stream LXP terminology), which is effectively the userId property.

\n","urlObject":{"path":["progress-status","{request-id}"],"host":["{{baseURL}}"],"query":[{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[{"id":"68315aa3-c2f2-4fab-a60f-e6c4ee721e8f","name":"Get Request Progress - Error Status","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"x-tenant-id","value":"{{tenantId}}"}],"url":{"raw":"{{baseURL}}/progress-status/{request-id}","host":["{{baseURL}}"],"path":["progress-status","{request-id}"],"query":[{"key":"","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 16 Mar 2021 14:28:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"377"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"d1a09b71-c7ad-4409-85a0-4f4cd424fa91"},{"key":"x-amz-apigw-id","value":"cSMEBF4vDoEFf2w="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6050c080-5c72b9d3720188f94b150785"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 3,\n \"status\": \"In Error\",\n \"errors\": \"The given data was invalid : {\\\"username\\\":[\\\"The username has already been taken.\\\"]}\",\n \"model\": {\n \"firstName\": \"john\",\n \"lastName\": \"doe\",\n \"email\": \"john.doe@mydomain.com\",\n \"userId\": \"EMP204\",\n \"username\": \"john.doe\",\n \"timezone\": \"London/Europe\",\n \"language\": \"en_GB\",\n \"country\": \"Bahrain\",\n \"customFields\": [\n {\n \"value\": \"046918343\",\n \"id\": \"phone-number\"\n }\n ]\n }\n}"},{"id":"30482a09-9e5b-48dd-9aa9-a38ce433c856","name":"Get Request Progress - Retry Status","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"x-tenant-id","value":"{{tenantId}}"}],"url":{"raw":"{{baseURL}}/progress-status/{request-id}","host":["{{baseURL}}"],"path":["progress-status","{request-id}"],"query":[{"key":"","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 16 Mar 2021 14:28:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"377"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"d1a09b71-c7ad-4409-85a0-4f4cd424fa91"},{"key":"x-amz-apigw-id","value":"cSMEBF4vDoEFf2w="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6050c080-5c72b9d3720188f94b150785"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 4,\n \"status\": \"Retrying\",\n \"errors\": \"Reties remaining : 2. Current Error: No query results for model [App\\\\Models\\\\Position].\",\n \"model\": {\n \"firstName\": \"john\",\n \"lastName\": \"doe\",\n \"email\": \"john.doe@mydomain.com\",\n \"userId\": \"EMP204\",\n \"username\": \"john.doe\",\n \"timezone\": \"London/Europe\",\n \"language\": \"en_GB\",\n \"country\": \"Bahrain\",\n \"customFields\": [\n {\n \"value\": \"046918343\",\n \"id\": \"phone-number\"\n }\n ]\n }\n}"},{"id":"7d55c220-450c-4fcf-9f64-05478f40ffd8","name":"Get Request Progress - In Progress","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"x-tenant-id","value":"{{tenantId}}"}],"url":{"raw":"{{baseURL}}/progress-status/{request-id}","host":["{{baseURL}}"],"path":["progress-status","{request-id}"],"query":[{"key":"","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 16 Mar 2021 14:29:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"294"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"860a3331-e377-4262-8396-21dc3cb9323b"},{"key":"x-amz-apigw-id","value":"cSMQgFM9DoEFdvw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6050c0cf-79fe6e164bd1b56f216d223d"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 1,\n \"status\": \"In Progress\",\n \"errors\": \"\",\n \"model\": {\n \"firstName\": \"john\",\n \"lastName\": \"doe\",\n \"email\": \"john.doe@mydomain.com\",\n \"userId\": \"EMP204\",\n \"username\": \"john.doe\",\n \"timezone\": \"London/Europe\",\n \"language\": \"en_GB\",\n \"country\": \"Bahrain\",\n \"customFields\": [\n {\n \"value\": \"046918343\",\n \"id\": \"phone-number\"\n }\n ]\n }\n}"},{"id":"a839a64d-75c0-45b2-a1e3-68c1ebb66483","name":"Get Request Progress - Complete Status","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apiKey}}"},{"key":"x-tenant-id","value":"{{tenantId}}"}],"url":{"raw":"{{baseURL}}/progress-status/{request-id}","host":["{{baseURL}}"],"path":["progress-status","{request-id}"],"query":[{"key":"","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 16 Mar 2021 14:31:25 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"294"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"578e7edb-5792-4039-9e5c-d965efd3fb63"},{"key":"x-amz-apigw-id","value":"cSMhqENWjoEF3NQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6050c13d-35008d164bac039966f25c1a"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 2,\n \"status\": \"Complete\",\n \"errors\": \"\",\n \"model\": {\n \"firstName\": \"john\",\n \"lastName\": \"doe\",\n \"email\": \"john.doe@mydomain.com\",\n \"userId\": \"EMP2041\",\n \"username\": \"john.doe23\",\n \"timezone\": \"London/Europe\",\n \"language\": \"en_GB\",\n \"country\": \"Bahrain\",\n \"customFields\": [\n {\n \"value\": \"046918343\",\n \"id\": \"phone-number\"\n }\n ]\n }\n}"}],"_postman_id":"3c44bf4e-fdf4-4692-aa5a-b6c627bce5bf"},{"name":"Update Job Assignment Status","id":"d6b08aa2-512f-4bd0-9145-7912da65f93f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-tenant-id","value":"{{tenantId}}"},{"key":"x-api-key","value":"{{apiKey}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n\t\"status\": \"DELETED\"\n}"},"url":"{{baseURL}}/users/123/job-assignment/456/status","urlObject":{"path":["users","123","job-assignment","456","status"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"bad291aa-f387-4916-8d1e-5159abd59122","name":"Update Job Assignment Status","originalRequest":{"method":"PATCH","header":[{"key":"x-tenant-id","value":"{{tenantId}}"},{"key":"x-api-key","value":"{{apiKey}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{baseURL}}/users/123/job-assignment/456/status"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"31dc535b-af5d-49a6-904a-d4934fb1f6aa","name":"Update Job Assignment Status to Deleted","originalRequest":{"method":"PATCH","header":[{"key":"x-tenant-id","value":"{{tenantId}}"},{"key":"x-api-key","value":"{{apiKey}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{baseURL}}/users/123/job-assignment/456/status"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d6b08aa2-512f-4bd0-9145-7912da65f93f"}]}