Alpha Only: This service is subject to change
This service is a work in progress. It is currently subject to change or removal without notice.

IDX

  1. Supported Roles
  2. Available Services
    1. Current User's IDX Settings
  3. IDX Description
  4. Expansions
  5. API Explorer

Supported Roles

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

Available Services

Current User's IDX Settings

/<API Version>/idx

HTTP Method Description Notes
GET Returns the IDX information for the current user
PUT Updates the IDX setting
DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

No parameters

GET Response

Example: 
{
    "D": {
        "Success": true,
        "Results": [{
          "ResourceUri": "/v1/idx",
          "OwnerId": "20000426143505724628000000",
          "ModificationTimestamp": "2015-08-17T21:33:25Z",
          "Report": {
            "Value": null,
            "Editable": true
          },
          "TaxInfo": {
            "Value": true,
            "Editable": true
          },
          "History": {
            "Value": false,
            "Editable": true
          },
          "Documents": {
            "Value": true,
            "Editable": true
          },
          "OpenHouses": {
            "Value": true,
            "Editable": true
          },
          "AllowOpenHouseSearch": {
            "Value": true,
            "Editable": true
          },
          "ForceRegistration": {
            "Value": false,
            "Editable": true
          },
          "RegisterBeforeSummary": {
            "Value": false,
            "Editable": true
          },
          "RegisterBeforeDetails": {
            "Value": false,
            "Editable": true
          },
          "RegisterAfterMinutes": {
            "Value": null,
            "Editable": true
          },
          "RegisterAfterSearches": {
            "Value": null,
            "Editable": true
          },
          "RegisterAfterDetails": {
            "Value": null,
            "Editable": true
          },
          "GoogleAnalyticsTrackingId": {
            "Value": "",
            "Editable": true
          },
          "SearchWidgetEnabled": {
            "Value": true,
            "Editable": true
          },
          "FeaturedSearchesEnabled": {
            "Value": true,
            "Editable": true
          },
          "PortalVersion": {
            "Value": 2.0,
            "Editable": true
          }
        }]
    }
}

POST Request

Request Body 
{
    "D": {
      "TaxInfo": {"Value": true},
      "Report": { "Value": null }
    }
}

POST Response

The standard success/fail response is returned.

PUT Request

Any field used in the POST request to create a IDX Setting may be used in a PUT request to update the IDX Setting.
Request Body 
{
    "D": {
      "TaxInfo": {"Value": true},
      "Report": { "Value": null }
    }
}

PUT Response

The standard success/fail response is returned.

Preference Description

Data Type represents the type of the Value attribute

Attribute Data Type Writeable Required Description
Report Character No No Id of a report to show when viewing in flexmls web
TaxInfo Boolean No No Show listing tax information in idx products.
History Boolean No No Show listing history in idx products.
Documents Boolean No No Show listing documents in idx products.
OpenHouses Boolean No No Show open houses in idx products
AllowOpenHouseSearch Boolean No No Allow searching of open houses within IDX.
ForceRegistration Boolean No No Force registration within IDX when prompting to register.
RegisterBeforeSummary Boolean No No Preference to prompt registration pior to showing listing summary pages.
RegisterBeforeDetails Boolean No No Preference to prompt registration pior to showing listing detail pages.
RegisterAfterMinutes Decimal No No Preference to prompt registration after specified number of minutes.
RegisterAfterSearches Decimal No No Preference to prompt registration after specified number of searches.
RegisterAfterDetails Decimal No No Preference to prompt registration after specified number of listing detail views.
GoogleAnalyticsTrackingId Character No No Tracking ID for google analytics.
SearchWidgetEnabled Boolean No No Preference to show the search widget on the portal homepage.
FeaturedSearchesEnabled Boolean No No Preference to show the featured searches on the portal homepage.
PortalVersion Decimal Yes No The version of the portal application to use.