This operation returns a list of additional settings at the user level.
Request
Syntax
GET <webservice>/User/{userId}/preferences/{prefType}?includeAdditionalSettings=true HTTP/1.1
Host: <host name>
Accept: {application/xml | application/json}
Authtoken: <authentication token>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Parameters
|
Name |
Description |
Required |
|
userId |
The user ID for the user. If the user ID is not known, use the GET User API to retrieve it. |
Yes |
|
prefType |
The console for which the additional settings were created. Valid values:
|
Yes |
Request Headers
|
Name |
Description |
|
Host |
The host name of the Web Server or Web Console used in the API request. |
|
Accept |
The format of the response. Valid values are: application/xml or application/json. |
|
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Response
Response Parameters
|
Parameter |
Description |
Element |
|
atterValue |
The user-assigned value of the additional setting. |
consoleSettings |
|
relativePath |
The category of the additional setting, for example, CommServeDB.Console. |
consoleSettings |
|
attrName |
The name of the additional setting. |
consoleSettings |
|
attrType |
The data type of the additional setting. Valid values:
|
consoleSettings |
Examples
Sample Request
GET <webservice>/User/1/preferences/all?includeAdditionalSettings=true HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
<App_GetUserPreferenceResponse> <nameValueMap /> <consoleSettings atterValue="2" relativePath="CommServDB.Console" attrName="MaxNumberOfDaysForEvents" attrType="0" />
</App_GetUserPreferenceResponse>
