Preferences

The Preferences service returns various user-specified settings.
  1. Supported Roles
  2. Available Services
    1. All Connnect Preferences
  3. Response Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads? Writes?
IDX Yes No
VOW Yes No
Private Yes No
More information about roles may be found here.

Available Services

All Connect Preferences

URI: /<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.