UserUIPrefsResponse

The response to a /ui_prefs/ui_prefs GET request.

response_codeinteger

HTTP status code of the response for reference purposes.

Default value: 200

Example: 200

successboolean

Indicates whether the request was successful (normally true if it's not an error response).

Default value: true

uristring

URL of the current request / resource, for reference purposes.

Example: https://example.apps.journyx.com/api/v1/users

statusstring[]

An array of status (confirmation) messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a green icon.

errorsstring[]

An array of error messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a red error icon.

warningsstring[]

An array of warning messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a yellow warning icon.

infostring[]

An array of informational messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a blue info icon.

results object

The result of a /ui_prefs/ui_prefs GET request.

PagedTable object

The user's preferences for the Paged Table component.

itemsPerPage object

The user's preference for the number of items to display per page.

The keys are the component or page in question and the value is the number of items to display per page, as a string.

property name*string

Example: dashboard-approvals-table

SheetSummaryView object

decimalTimeFormatboolean

Indicates whether the user prefers to display time in decimal format.

Example: true

expandLevelsstring

The number of nested Entry Code levels to expand in the summary entry view. E.g. Project -> Activity -> Bill Type -> Pay Type

Example: 0

viewModestring

The user's preference for the view mode of the summary entry view, either showing organized around comments or dates.

Possible values: [comments, dates]

Example: comments

UserUIPrefsResponse

{
  "response_code": 200,
  "success": true,
  "uri": "https://example.apps.journyx.com/api/v1/users",
  "status": [
    "string"
  ],
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "info": [
    "string"
  ],
  "results": {
    "PagedTable": {
      "itemsPerPage": {}
    },
    "SheetSummaryView": {
      "decimalTimeFormat": true,
      "expandLevels": "0",
      "viewMode": "comments"
    }
  }
}