IDX Links
The IDX Links API is used to retrieve the list of IDX links created by flexmls Web IDX subscribers.
Supported Roles
Role | Reads | Writes | Notes |
---|---|---|---|
IDX | Yes | No | |
Public | Yes | No | |
VOW | Yes | No | |
Portal | Yes | No | |
Private | Yes | No |
More information about roles may be found here.
Available Services
All IDX Links
/<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",
"ViewId": "20100216182649622225000000",
"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",
"ViewId": "20100216182649622225000000",
"Default": false,
"UseAsNewSearch": false
}
]
}
}
Individual IDX Link
/<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
/<API Version>/idxlinks/default
Users who have purchased IDX can select a default IDX link. If none has been chose by a user, a dummy link with a null Id
attribute (along with all other attributes that have no default values) will be returned as a QuickSearch
link, referencing the user's default search template.
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:
Parameter | Required | Notes |
---|---|---|
Standard expansion parameters | No |
GET Response
See the GET request section for IDX links service.
Global Default IDX Link
/<API Version>/idxlinks/default
The Global Default IDX Link is a generic link that is identical for all users across all MLSs. It use returned from the default link service when no custom link can be determined as the default for the current user.
HTTP Method | Description | Conditional | Notes |
---|---|---|---|
GET | Returns the global 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:
Parameter | Required | Notes |
---|---|---|
Standard expansion parameters | No |
GET Response
See the GET request section for IDX links service.
Default IDX Link for an IDX Product
/<API Version>/idxlinks/default/products/<FlexmlsProduct>
An extension of the Default IDX Link service, this service will return the user-defined default IDX link only if the current user has purchased the FlexmlsProduct
specified in the URI. Otherwise, the global default link will be returned. See the System Info service for a list of supported products.
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:
Parameter | Required | Notes |
---|---|---|
Standard expansion parameters | No |
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 |
ViewId |
Character | No | This is the ID of the View 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/Portal 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/Portal 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/Portal account after this many listing searches have been run |
RegistrationAfterListingViews |
Integer | No | The end user should be prompted to register for a VOW/Portal account after this many listings have been viewed |
RegistrationBypass |
Boolean | No | Users are allowed to bypass the registration prompt |
RestrictedUIComponents |
Character List | No | The UI views and components the agent has requested be hidden for the IDX link. See the table below for more information |
StartPosition |
Character | No | The UI view the consumer should start at when visiting this IDX link. See the table below for more information |
UI Components
These values populate some of the settings above, such as RestrictedUIComponents
.
Value | Description |
---|---|
Compare |
A view to Compare listings |
Details |
View listing data as intended for listing reports |
Documents |
A view containing the documents for the listings |
History |
A view showing the history for a listing, or historical listings for the same property. |
Map |
Map view for the listings |
MlsDataSharing |
A UI component that allows the user to select which MLSs to search listings. This corresponds to the MlsId listing search parameter. |
MortgageCalculator |
A view showing a mortage calculator for the listings |
OpenHouses |
A view containing the open house information for the listings |
Photos |
Photos view for the listings |
RentalCalendar |
A view showing the rental calendar information for the listings |
Report |
Basic information for the listings |
Search |
A view which allows you to edit search criteria |
Summary |
Brief view of the listing data |
Supplement |
A view containing the supplements for the listings |
Tax |
A view containing the tax information for the listings |
VirtualTours |
A view which contains the virtual tours for the listings |
Expansions
Expansion | Roles | Single Record Only? | Selection Support? | Description |
---|---|---|---|---|
QuickSearch |
All | Yes | No | A hash detailing the quick search related to the IDX link. |
SavedSearch |
All | Yes | No | A hash detailing the saved search related to the IDX link. |
Settings |
All | Yes | No | A hash detailing user defined settings for the IDX link. |
View |
All | Yes | No | A hash detailing the view related to the IDX link. |