Developer Documentation
Platform Overview
Authentication
API Services
Overview Accounts Accounts: Associations Accounts: Metadata Accounts: Profile Appstore: Users Broker Distributions Broker Tours Consumers Consumers: Linked Agents Contacts Contacts: Activity Contacts: Export Contacts: Tags Contacts: Portal Accounts Developers: Identities Developers: Keys Developers: Authorizations Developers: Billing Summary Developers: Change History Developers: Domains Developers: News Feed Webhooks Developers: Roles Developers: Syndications Developers: Templates Developers: Usage Detail Developers: Usage Summary Devices Flexmls: Email Links Flexmls: Listing Meta Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Listing Updates IDX IDX Links Listing Carts Listing Carts: Portal/VOW Carts Incomplete Listings Incomplete Listings: Documents Incomplete Listings: Documents Metadata Incomplete Listings: Document Uploads Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Rooms Incomplete Listings: Tickets Incomplete Listings: Units Incomplete Listings: Videos Incomplete Listings: Videos Metadata Incomplete Listings: Virtual Tours Incomplete Listings: Virtual Tours Metadata Listings Listings: Clusters Listings: Documents Listings: Documents Metadata Listings: FloPlans Listings: Historical Listings: History Listings: Hot Sheet Parameters Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Rooms Listings: Rules Listings: Tour of Homes Listings: Tickets Listings: Units Listings: Validation Listings: Videos Listings: Videos Metadata Listings: Virtual Tours Listings: Virtual Tours Metadata Listing Meta: Custom Fields Listing Meta: Custom Field Groups Listing Meta: Field Order Listing Meta: Field Relations Listing Meta: Property Types Listing Meta: Rooms Listing Meta: Standard Fields Listing Meta: Units Registered Listings Market Statistics Messages News Feed News Feed: Curation News Feed: Events News Feed: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Portals Portal Groups Portal Groups: Current Portal Groups: Tags Portals: Listing Categories Portals: Metadata Preferences Properties Properties: Clusters Properties Meta: Standard Fields Saved Searches Saved Searches: Provided Saved Searches: Restrictions Saved Searches: Tags Search Templates: Quick Searches Search Templates: Views Search Templates: Sorts Shared Links System Info System Info: Languages System Info: Search Templates
API Explorer
Supporting Documentation
Examples
RESO Web API
RETS
Terms of Use

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
    2. Individual 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"
                }]
              }
            }
          }
        }
      }
    ]
  }
}
 
 

Individual Field List Relations

/<API Version>/fields/<FieldName>/fieldlists/relations

Returns all relations for a single standard field or custom field. When requesting a custom field, the FieldName must match the format used for the individual custom field service.

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 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"
              }
            ]
          }
      }
    ]
  }
}
 
 

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, except when accessing an individual field. Each FieldList item contains a ParentValue attribute for the requested field, and a Value attribute for the related field.
 

API Explorer

Interact with this service using the API Explorer.