User Information
This integration point provides the ability to fetch the user information (user preferences, access restriction grants, etc.) and to update the user preferences of the logged in user.
Operations
|
|
`POST |
|
Request Messages
Example Request Message to Update User Information (click to open)
{ "accessibilitySet": "", "highContrast": "", "largeFonts": "", "screenReader": "", "displayLanguageCode": "", "shortcutKeys"="" }
Response Messages
Example Response Message for User Information (click to open)
{ "loginName": "", "id":"", "displayName": "", "lastLoginTimestamp": { "value": "" }, "defaultCountry": { "code": "", "amountNumberFormat": "", "integerFormat": "", "numberFormat": "", "primaryDateFormat": "", "secondaryDateFormat": "" }, "userPreference": { "accessibilitySet": "", "highContrast": "", "largeFonts": "", "screenReader": "", "displayLanguageCode": "", "shortcutKeys"="" }, "accessRestrictionGrantList": [ { "accessRestriction": { "code": "", "type": "", "id": "" }, "retrieve": "", "create": "", "update": "", "delete": "" } ] "accessRoleList:[{ "code": "", "descr":"", "name":"" }] }
This integration point provides HTTP status codes as defined in Response Messages. If an error occurs, the appropriate HTTP status code is returned and a notification is sent containing error details. This way, the request can be sent again after the reason for failure has been fixed.