IDX Links

The IDX Links API is used to retrieve the list of IDX links created by flexmls Web IDX subscribers.
  1. Supported Roles
  2. Available Services
    1. All IDX Links
    2. Individual IDX Link
  3. Response Description
  4. Expansions
  5. API Explorer

Supported Roles

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

Available Services

All IDX Links

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"
            }
        ]
    }
}

Individual IDX Link

URI: /<API Version>/idxlinks/<Id>

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

Attribute Description
ResourceUri The URI to the IDX link resource.
Id The unique id of the IDX link.
Name The name of the IDX link.
Uri The URI of the IDX link itself. This link may be opened with a web browser.
LinkId The alternative unique Id as used in 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.

Expansions

None.

API Explorer

Interact with this service using the API Explorer.