getDisplaypreferencesById
Gets a user's display preferences for an item
Requires authentication as user
getDisplaypreferencesById
Request
get /DisplayPreferences/{Id}
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*Id | path | Item Id |
||
*UserId | query | User Id |
||
*Client | query | Client |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | DisplayPreferences | Operation successful. Returning a DisplayPreferences object. |
|
400 | Bad Request. Server cannot process request. |
||
401 | Unauthorized. Client needs to authenticate. |
||
403 | Forbidden. No permission for the reqested operation. |
||
404 | Resource not found or unavailable. |
||
500 | Server error. |
Definitions
DisplayPreferences
Name | Type | Notes |
---|---|---|
Id | string | The user id. |
SortBy | string | The sort by. |
CustomPrefs | object | The custom prefs. |
SortOrder | SortOrder | Enum SortOrder |
Client | string | The client |
SortOrder
Enum Values
- Ascending
- Descending