IDX Links

  1. Applicable API Key Roles
  2. Authentication
  3. Available Services
    1. Retrieve IDX links for a user
    2. Retrieve info about a specific IDX link
  4. Response description

Applicable API Key Roles

This service is available to API keys with private or IDX roles with IDX permissions; IDX roles with Portal permissions do not have access to this service. More information about roles may be found here.

Authentication

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

Available Services

Retrieve IDX Links For A User

URI: /<API Version>/idxlinks/

HTTP Method Description Notes
GET Returns a list of all IDX links 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": [
            {
                "ResourceUri": "/idxlinks/20101115061222486591000000",
                "Id": "20101115061222486591000000",
                "Name": "Residential Search",
                "Uri": "http://link.flexmls.com/riptgq7ohvr,12",
                "LinkId": "riptgq7ohvr",
                "LinkType": "QuickSearch"
            },
            {
                "ResourceUri": "/idxlinks/20101116011322386631000000",
                "Id": "20101116011322386631000000",
                "Name": "Commercial Search",
                "Uri": "http://link.flexmls.com/Xiptgq7ohvr,12",
                "LinkId": "Xiptgq7ohvr",
                "LinkType": "QuickSearch"
            }
        ]
    }
}

Retrieve info about a specific IDX link

URI: /<API Version>/idxlinks/XX

XX is the ID of the link.

HTTP Method Description Notes
GET Returns info about the specified IDX link
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:

  • None

GET Response

Example:

{
    "D": {
        "Success": true,
        "Results": [
            {
                "ResourceUri": "/idxlinks/20101116011322386631000000",
                "Id": "20101116011322386631000000",
                "Name": "Commercial For Sale",
                "Uri": "http://link.flexmls.com/Xiptgq7ohvr,12",
                "LinkId": "Xiptgq7ohvr",
                "LinkType": "SavedSearch",
                "SearchId": "20091219144256948576000000"
            }
        ]
    }
}

Response description

The attributes returned in the response have the following meanings.

Attribute Description
ResourceUri The URI to the particular IDX link
Id The ID of the particular IDX link, which is a subset of ResourceUri
Name The name of the IDX link, as entered by the flexmls user
Uri The URI of the IDX link itself. This link may be opened with a web browser.
LinkId This is a subset of the Uri parameter, basically the unique portion of the URI.
LinkType Valid values include: QuickSearch, SavedSearch, MyListings, and Roster. Each link type represents what content will appear when the link is loaded in the browser.
SearchId Only provided when LinkType=SavedSearch . This is the ID of the saved search that’s used in the IDX link.

Comments on this entry are closed.