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. Default IDX Link
  3. Response Description
  4. Expansions
  5. API Explorer

Supported Roles

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

Available Services

All IDX Links

URI: /<API Version>/idxlinks

HTTP Method Description Conditional Notes
GET Returns a list of all IDX links for the current user. No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:
Parameter Required Notes
Standard search and paging syntax No

GET Response

{
    "D": {
        "Success": true,
        "Results": [
            {
                "ResourceUri": "/idxlinks/20101115061222486591000000",
                "Id": "20101115061222486591000000",
                "Name": "Residential Search",
                "Uri": "http://link.flexmls.com/riptgq7ohvr,12",
                "LinkId": "riptgq7ohvr",
                "LinkType": "QuickSearch",
                "QuickSearchId": "20101219154253948578000000",
                "Default": true,
                "UseAsNewSearch": false
            },
            {
                "ResourceUri": "/idxlinks/20101116011322386631000000",
                "Id": "20101116011322386631000000",
                "Name": "Commercial Search",
                "Uri": "http://link.flexmls.com/Xiptgq7ohvr,12",
                "LinkId": "Xiptgq7ohvr",
                "LinkType": "QuickSearch",
                "QuickSearchId": "20111219354254944572000000",
                "Default": false,
                "UseAsNewSearch": false
            }
        ]
    }
}

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",
                "UseAsNewSearch": true
            }
        ]
    }
}

Default IDX Link

URI: /<API Version>/idxlinks/default

Many users have an IDX link they prefer to be used as their IDX link.

HTTP Method Description Conditional Notes
GET Returns the user's default IDX link No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:
  • None

GET Response

See the GET request section for IDX links service.

IDX Links Description

Attribute Data Type Searchable Description
ResourceUri Character No The URI to the IDX link resource
Id Character No The unique id of the IDX link
Name Character No The name of the IDX link
Uri Character No The URI of the IDX link itself. This link may be opened with a web browser
LinkId Character No The alternative unique Id as used in the URI
LinkType Character Yes Valid values include: QuickSearch, SavedSearch, MyListings, and Roster. Each link type represents what content will appear when the link is loaded in the browser. When searching, only the Eq operator is supported.
Default Character No If true, the link is specified as the current user's default IDX link.
QuickSearchId Character No Only provided when LinkType=QuickSearch . This is the ID of the Quick Search that's used in the IDX link
SearchId Character No Only provided when LinkType=SavedSearch . This is the ID of the Saved Search that's used in the IDX link
UseAsNewSearch Boolean Yes If true, the link has been specified as selectable by consumers to use the the basis for starting a new search. For VOW roles, only links with this attribute set to true are returned in this service.
Settings Expansion The attributes below reside under the Settings expansion
AllowClosedListingSearch Boolean No If true, the consumer should be given the option to search for sold listings when visiting this link
ResultsRequireRegistration Boolean No If true, the end user should be presented with a registration prompt before viewing listing search results
DetailRequiresRegistration Boolean No If true, the end user should be presented with a registration prompt before viewing listing detail reports
RegistrationAfterMinutes Integer No The end user should be prompted to register for a VOW account after the user has visited the IDX link for this many minutes
RegistrationAfterSearches Integer No The end user should be prompted to register for a VOW account after this many listing searches have been run
RegistrationAfterListingViews Integer No The end user should be prompted to register for a VOW account after this many listings have been viewed
RegistrationBypass Boolean No Users are allowed to bypass the registration prompt
StartPosition Character No The UI view the consumer should start at when visiting this IDX link. See the table below for more information

StartPosition

The value of StartPosition represents a view in the UI a user should start at when visiting the link.
Value Description
Summary Brief view of the listing data
Search A view which allows you to edit search criteria
Map Map view for the listings
Photos Photos view for the listings
VirtualTours A view which contains the virtual tours for the listings
Compare A view to Compare listings
Details View listing data as intended for listing reports
Report Basic information for the listings
Tax A view containing the tax information for the listings
Supplement A view containing the supplements for the listings
Documents A view containing the documents for the listings
OpenHouses A view containing the open house information for the listings
RentalCalendar A view showing the rental calendar information for the listings
MortageCalculator A view showing a mortage calculator for the listings

Expansions

Expansion Roles Single Record Only? Selection Support? Description
SavedSearch VOW Yes No A hash detailing the saved search related to the IDX link. No effect when LinkType is QuickSearch.
Settings All Yes No A hash detailing user defined settings for the IDX link.

API Explorer

Interact with this service using the API Explorer.