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 present delivered from this service.

  1. Supported Roles
  2. Available Services
    1. All Property Types
    2. Individual Property Types
    3. Last Updated Timestamp
  3. Field Order Description
  4. Expansions
  5. API Explorer

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

URI: /<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

URI: /<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

URI: /<API Version>/fields/order/lastupdated

URI: /<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 Description

Attribute Data Type Description
Label Character The human-readable label for the field.
Domain Character The type of listing field. Either StandardFields or CustomFields.
Field Character The field attribute.
GroupField Character The unique group field identifier for the custom field. Useful in conjunction with the CustomFieldsRaw expansion for listings, or when searching on custom fields.
FieldCategory Character 'Detail' if the Detail flag is true. Otherwise, 'Main'.
Detail Boolean true if the Domain is CustomFields and the field resides in the Details sub-attribute (as opposed to Main).
Searchable Boolean true if listings can be filtered by the field.
FormatWithCommas Boolean true if the listing value for this field (numeric types) should be formatted for presentation using commas.
OriginalCustomField Character When Domain is 'StandardFields' and the field was recently standardized from a custom field, this will reference the Field name of the duplicate standard field. The field is retained as a duplicate after standardization to prevent existing references to the custom field, such as saved _filter criteria, from breaking.
Type Character The field type.

Expansions

None.

API Explorer

Interact with this service using the API Explorer.