Field Order
Provides the desired default field order of both standard and custom fields for the current MLS. Only fields that exist and are visible for the corresponding property type across all relevant MLSs are presently delivered from this service.
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 Property Types
/<API Version>/fields/order
The property types are represented by their property type codes. Additionally, the fields themselves are grouped in attributes representing the human-readable name of each group. The unique identifier for each group is present in the GroupField attribute.
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns the field order meta data for all property types | Yes | |
| 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 |
|---|---|---|
| _mls | No | A comma-separated list of MLS IDs the ordered fields should be common across |
GET Response
{
"D": {
"Success": true,
"Results": [
{
"A": [
{
"Listing Information": [
{
"Label": "Status",
"Domain": "StandardFields",
"Field": "MlsStatus",
"GroupField": "ListingInfo",
"FieldCategory": "Main",
"Detail": false,
"Searchable": true,
"FormatWithCommas": false,
"OriginalCustomField": null,
"Type": "Character"
},
{
"Label": "Price",
"Domain": "StandardFields",
"Field": "ListPrice",
"GroupField": "ListingInfo",
"FieldCategory": "Main",
"Detail": false,
"Searchable": true,
"FormatWithCommas": true,
"OriginalCustomField": "List Price",
"Type": "Decimal"
}
]
},
{
"Property Information": [
{
"Label": "Realtor.com",
"Domain": "CustomFields",
"Field": "Realtor.com",
"GroupField": "ListingInfo",
"FieldCategory": "Main",
"Detail": false,
"Searchable": true,
"FormatWithCommas": false,
"OriginalCustomField": null,
"Type": "Character"
},
{
"Label": "Type",
"Domain": "StandardFields",
"Field": "PropertySubType",
"GroupField": "ListingInfo",
"FieldCategory": "Main",
"Detail": false,
"Searchable": true,
"FormatWithCommas": false,
"OriginalCustomField": null,
"Type": "Character"
},
{
"Label": "Total Bedrooms",
"Domain": "StandardFields",
"Field": "BedsTotal",
"GroupField": "ListingInfo",
"FieldCategory": "Main",
"Detail": false,
"Searchable": true,
"FormatWithCommas": false,
"OriginalCustomField": null,
"Type": "Decimal"
}
]
}
]
}
]
}
}
Individual Property Type
/<API Version>/fields/order/<PropertyType.MlsCode>
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns the field order for an individual property type | Yes | |
| 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 |
|---|---|---|
| _mls | No | A comma-separated list of MLS IDs the ordered fields should be common across |
GET Response
{
"D": {
"Success": true,
"Results": [
{
"Listing Information": [
{
"Label": "Status",
"Domain": "StandardFields",
"Field": "MlsStatus",
"GroupField": "ListingInfo",
"FieldCategory": "Main",
"Detail": false,
"Searchable": true,
"FormatWithCommas": false,
"OriginalCustomField": null,
"Type": "Character"
},
{
"Label": "Price",
"Domain": "StandardFields",
"Field": "ListPrice",
"GroupField": "ListingInfo",
"FieldCategory": "Main",
"Detail": false,
"Searchable": true,
"FormatWithCommas": true,
"OriginalCustomField": "List Price",
"Type": "Decimal"
}
]
},
{
"Property Information": [
{
"Label": "Realtor.com",
"Domain": "CustomFields",
"Field": "Realtor.com",
"GroupField": "ListingInfo",
"FieldCategory": "Main",
"Detail": false,
"Searchable": true,
"FormatWithCommas": false,
"OriginalCustomField": null,
"Type": "Character"
},
{
"Label": "Type",
"Domain": "StandardFields",
"Field": "PropertySubType",
"GroupField": "ListingInfo",
"FieldCategory": "Main",
"Detail": false,
"Searchable": true,
"FormatWithCommas": false,
"OriginalCustomField": null,
"Type": "Character"
},
{
"Label": "Total Bedrooms",
"Domain": "StandardFields",
"Field": "BedsTotal",
"GroupField": "ListingInfo",
"FieldCategory": "Main",
"Detail": false,
"Searchable": true,
"FormatWithCommas": false,
"OriginalCustomField": null,
"Type": "Decimal"
}
]
}
]
}
}
Last Updated Timestamp
/<API Version>/fields/order/lastupdated
/<API Version>/fields/order/<PropertyType.MlsCode>/lastupdated
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns the LastUpdated attribute, which notes the last time the data provided by this service was updated. |
Yes | |
| 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 |
|---|---|---|
| _mls | No | A comma-separated list of MLS IDs the ordered fields should be common across |
GET Response
{
"D": {
"Success": true,
"LastUpdated":"2012-11-01T20:55:02Z"
}
}
Field Order Settings
/<API Version>/fields/order/settings
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns extraneous field order settings for an MLS. Given each section's specialized nature, only significant field attributes are included, and the fields should span all property types. | Yes | |
| 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
{
"D": {
"Success": true,
"Results": [
{
"ShowingInstructions": [
{
"Domain": "StandardFields",
"Field": "ListOfficePhone",
"GroupField": null
},
{
"Domain": "CustomFields",
"Field": "Vacant",
"GroupField": "Property Access",
}
]
}
]
}
}
Expansions
None.