How to add custom data to the Learner List via API

How to add custom data to the Learner List via API

 

You can now create user profile columns as well as edit existing ones (except the Username, User is in Course Catalog and Manager columns) with your own data source, using the LMS365 API. e.g. using Swagger or Postman. Please be advised when the Custom Synchronization is enabled, LMS365 will no longer synchronize the data field from Microsoft Azure AD but you can populate the data from your data source via API.

 

These endpoints have been implemented for you to:

 

  • create а new custom column.

  • use existing user profile columns with your own Data.

 

To create the new custom column:

  1. 1) Use the endpoint /odata/v2/UserFields

  2. 2) Specify the required parameters, e.g:

 

{"Description":"new custom column",

"IsVisible":true,

"IsSynced":true,

"Type":"String",

"Title":"new column"}

 

  • 🛈We support the following data type: String (enter 0 in the parameters field), Boolean (enter 1), Number (enter 2), Date and Time (enter 3).

  • 🛈You will not be able to change the column type.

 

To update the values for the custom column:

 

  1. 1) Use the endpoint /odata/v2/Users('{LoginName}')/ UpdateUserFieldValues.

  2. 2) Enter the full login name with all the prefixes of the User for whom you want to specify the value and all the needed parameters, e.g:

{

"UserFieldValues": [

{

"FieldId": "enter the custom column ID",

"Value": "2019-04-01T14:48:16.877Z"

},

{

"FieldId": " enter the custom column ID ",

"Value": 53789

}

]

}

 

  • 🛈To get the FieldId, please navigate to the endpoint GET /odata/v2/UserFields, you can find the required FieldId in the Response Body.

  • 🛈Value should be corresponded to the type of the column.

  • 🛈For the column with the number type you can specify the positive or decimal numbers (max. 2 digits after the decimal point or comma).


To update the LMS365 System field:

  1. 1) Navigate to the endpoint PUT odata/v2/Users(‘{LoginName}’).

  2. 2) Enter the full login name with all the prefixes of the User for whom you want to specify the value and all the parameters, e.g:

{

"Department": "Department 1",

"Office": "Office, 1",

"JobTitle": "Developer",

"City": "Amsterdam",

"Company": "BIG Company"

}

Was this article helpful?
2 out of 2 found this helpful
Have more questions? Submit a request

Comments

Article is closed for comments.