How to add custom data to the Learner List via API

About this guide

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.

Creating a new custom column

To create the new custom column do the following:

1. Use the endpoint /odata/v2/UserFields

2. Specify the required parameters, e.g:

{"Description":"new custom column",

"IsVisible":true,

"IsSynced":true,

"Type":"String",

"Title":"new column"}

Examining existing columns in the API

To update the values for the custom column:

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

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

}

]

}

Updating the LMS365 system field

To update the LMS365 System field:

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

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"

}