API/Member/DemographicSync
Triggers the Demographic Synchronization process. Allows for periodic synchronization without relying on users to actually log in through SSO.
Workflow Attribute names are case-sensitive. Attribute names must be capitalized in the payload exactly as they are configured in LearningBuilder.
Overview
Accepts as input a list of Unique Identifiers that identify the Members to update.
Adds those identifiers to a queue for processing in the background.
Calling the API
Authentication
Requires an API Key with the DEMOGRAPHIC_SYNC permission.
Request
POST /API/Member/DemographicSync
args={list of Unique Ids}Form Parameter | Description |
|---|---|
| Required: List of Unique Identifiers to synchronize Example of JsonBody [
{
"uniqueId": "45645645"
},
{
"uniqueId": "90165469"
},
{
"uniqueId": "54564564"
}
] |
1 You must provide either TaskGroupId or TaskGroupTitle, but not both.
Response
If successful:
{
"success": true,
}A successful response indicates that the Unique Ids were added to the processing queue. It does NOT indicate whether those IDs were successfully synchronized or not.
If unsuccessful:
{
"success": false,
"errors": [array of strings]
}Information Dump from Integrations
Process at a high level
When the call is received, we batch all of the unique ids on an LB Queue in sql. Then we call the demographic sync endpoint for each uniqueId.
Utilizing the endpoint observations
If high volume of traffic is happening this endpoint may be slow to respond.
Theoretically, sending batches of 5000 can be fine, however depending on what the demographic sync is doing it may take away resources. An example would be we are running a sproc for a member role as part of the demo sync, or during the demographic information gathering a call to O’data is made. So there for it is best to send smaller payloads for faster and easier response.
LearningBuilder will allow 100 seconds for the process to respond before throwing an error and disconnecting.
If a vendor is calling this endpoint
If their batch size will be less then 4000, i think it will be okay to send one batch of 5000 records successfully.
If their batch size will be MORE then 4000, I think we should recommend them to send the Id’s in batches of 500 - 1000.
These recommendations were made for LearningBuilder instances on version 11.0.38 or less. The process may have sped up and it may be safe to batch more at this time, but investigation should be done.