Listings Meta: Field Relations

This service provides the related FieldLists for standard and custom fields as defined by the MLS. These are parent/child relationships so that, when one value is selected (say, a City of Fargo), only certain values from another field are allowed (say, a State of ND).

A common use case for this service is to _filter the results by the fields and values currently selected by the user, when that standard or custom field has HasList: true in the meta data.

For example, if a use has selected a City of Fargo, the following query will return all related fields and values for that use case:

/v1/fields/fieldlists/relations?_expand=FieldList&_filter=City Eq 'Fargo'

  1. Supported Roles
  2. Available Services
    1. Field List Relations
  3. Listing Meta: Field Relations 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

Field List Relations

/<API Version>/fields/fieldlists/relations

By default, the returned relations are across all property types, and for the current MLS. This can be overridden by the _filter parameter.

HTTP Method Description Conditional Notes
GET Returns the field relation meta data 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 syntax (_filter only) No Searchable fields are: MlsId; PropertyType; standard fields; and custom fields.

Note: standard and custom fields can only be joined by Or conjunctions.

Example: PropertyType Eq 'A' And MlsId Eq '20100000000000000000000000' And (City Eq 'Fargo' Or State Eq 'ND')
Standard expansion parameters No

GET Response

{
  "D": {
    "Success": true,
    "Results": [
      {
        "StandardFields": {
          "City": {
            "Relations": [{
                "Domain": "CustomFields",
                "GroupField": "None",
                "Field": "Community"
              },
              {
                "Domain": "StandardFields",
                "GroupField": "Tax Location and Legal",
                "Field": "PostalCode"
              },
              {
                "Domain": "CustomFields",
                "GroupField": "General Property Description",
                "Field": "User Defined 102"
              }
            ]
          },
          "CountyOrParish": {
            "Relations": [{
              "Domain": "StandardFields",
              "GroupField": "Contract Data",
              "Field": "SubdivisionName"
            }]
          },
          "PostalCode": {
            "Relations": [{
                "Domain": "CustomFields",
                "GroupField": "Tax Location and Legal",
                "Field": "Elementary School2"
              },
              {
                "Domain": "CustomFields",
                "GroupField": "General Property Description",
                "Field": "Elementary School3"
              },
              {
                "Domain": "CustomFields",
                "GroupField": "None",
                "Field": "User Defined 2"
              }
            ]
          }
        },
        "CustomFields": {
          "General Property Description": {
            "Fields": {
              "Garage Type2": {
                "Relations": [{
                  "Domain": "CustomFields",
                  "GroupField": "General Property Description",
                  "Field": "Garage Stall2"
                }]
              }
            }
          }
        }
      }
    ]
  }
}

Listing Meta: Field Relations Description

Attribute Data Type Searchable Description
MlsId Character Yes Searching only. The Id for the MLSs the the results should be restricted to. By default, only relations for the current user's MLS are returned.
PropertyType Character Yes Searching only. The MlsCode for the property type the results should be restricted to.
Relations Array of JSON Objects A list of fields related to the parent field.
Domain Character No The type of listing field. Either StandardFields or CustomFields.
GroupField Character No The CustomField group the Field resides under. null if Domain is StandardFields.
Field Character No The standard or custom field.

Expansions

Expansion Roles Single Record Only? Selection Support? Description
FieldList All No No Returns the FieldList values for each record in the Relations array that are related to the fields and values provided in the _filter parameter. This expansion requires the _filter parameter be supplied.

API Explorer

Interact with this service using the API Explorer.