Preferences

Authentication

Requests must be authenticated according to these instructions or HTTP 401 (Unauthorized) will be returned.

Applicable API Key Roles

This service is available to API keys with private or IDX roles. Within the IDX role, both IDX and Portal permissions may access this service. More information about roles may be found here.

Available Services

Retrieve Preferences

URI: /<API Version>/connect/prefs

GET Request

Parameters:

  • None

GET Response

{
    "D": {
        "Success": true,
        "Results": [
            {
                "Name": "RequiredFields",
                "Value": [
                    "name",
                    "email",
                    "address",
                    "phone"
                ]
            },
            {
                "Name": "OtherPref",
                "Value": "OtherValue"
            }
        ]
    }
}

Supported Preferences

This service currently supports the following preferences:

  1. Which fields are required when a user signs up for a portal account: RequiredFields .

Comments on this entry are closed.