Preferences
The Preferences service returns various user-specified settings.
Supported Roles
| Role | Reads | Writes | Notes |
|---|---|---|---|
| IDX | Yes | No | |
| Public | Yes | No | |
| VOW | Yes | No | |
| Portal | Yes | No | |
| Private | Yes | No |
More information about roles may be found here.
Available Services
All Connect Preferences
/<API Version>/connect/prefs
| HTTP Method | Description | Notes |
|---|---|---|
| GET | Returns a list of all preferences for the current user | |
| POST,PUT,DELETE | Returns HTTP 405 (Method Not Allowed) | Not implemented |
GET Request
Parameters:
- None
GET Response
Example:
{
"D": {
"Success": true,
"Results": [
{
"Name": "RequiredFields",
"Value": [
"name",
"email",
"address",
"phone"
]
},
{
"Name": "OtherPref",
"Value": "OtherValue"
}
]
}
}Response Description
| Attribute | Description |
|---|---|
Name |
The name of the preference. |
Value |
The preference value. |
The supported preferences are:
| Name | Value |
|---|---|
RequiredFields |
An array of any combination of the following: address, phone. |
Expansions
None.
API Explorer
Interact with this service using the API Explorer.