Get Worker Preferences

Describes the API specifications for retrieving all profile worker UI preferences.

Request

URI: https://<SAP Fieldglass envionment URL>/api/vi/worker-preferences/<username>

HTTP Method: GET

Request Parameters

Parameter	Required	Data Type	Description	Parameter Type
username name	Yes	String	The unique name of the user.	Path

Request Example

GET https://company.com/api/v1/worker-preferences/sabine_bosch
authorization: Bearer WDXlKj3TTOn3rpg9GHnZpbKmvj1=
x-ApplicationKey: 5c91f4fdb0c6ee9992ff476f89bf6cf25e589350
content-type: application/json

Response

Response Status and Error Codes

See Common Status and Error Codes for more information.

Response Body

Parameter

Data Type

Description

locale

Object

UI preferences associated with a profile worker's locale.

Parameter	Data Type	Description
timeZone	String	The profile worker's time zone.
dateFormat	String	The preferred date format.
timeFormat	String	The preferred time format.
numberFormat	String	The preferred number format.
language	String	The profile worker's preferred language.

messaging

Object

A list of profile worker messaging preferences.

Parameter	Data Type	Description
emailFormat	String	The preferred format for email messages.
emailMessage	String	The preferred type of email messages received.
systemMessage	String	The preferred type of system messages received.

Response Example

{
    "locale": {
        "timeZone": "US/Eastern",
        "dateFormat": "YYYY-MM-DD",
        "timeFormat": "12 Hour Clock",
        "numberFormat": "#,##9.99 (Example: 1,234,567.99)",
        "language": "English (United States)"
    },
    "messaging": {
        "emailFormat": "Plain Text",
        "emailMessage": "Work Item",
        "systemMessage": "Notification"
    }
}