User Information Integration Point

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.

Fetch User Information

When a GET request is received, a response is returned containing the user information of the logged in user. The URI for GET requests is:

http://<host>:<port>/<contextRoot>/userinformation

The response payload containing the user information looks like this:

{
  "loginName": "",
  "displayName": "",
  "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":""
  }]
}

Update User Preferences

The user preferences of the logged in user can be updated by sending in a PUT request containing the user preferences. The URI for PUT requests is:

http://<host>:<port>/<contextRoot>/userinformation/userpreference

The request payload containing the user preferences looks like this:

{
  "accessibilitySet": "",
  "highContrast": "",
  "largeFonts": "",
  "screenReader": "",
  "displayLanguageCode": "",
  "shortCutKeys"=""
}

Response Messages

This integration point will provide 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.

The following error message that is specific to this integration point can be returned in the response messages:

Code	Severity	Message
OHI-IP-USER-003	Fatal	Language code {code} is unknown