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 Origins 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
FloPlan
Terms of Use

Flexmls: Listing Meta Origins

This service exposes the relationship between standard and custom fields, specifically which custom fields a standard field is composed of, and which standard fields a custom field contributes to. It is important to distinguish this service from translations which includes only fields that directly translate in a one-to-one fashion and does not account for fields derived from many source fields.

 
  1. Supported Roles
  2. Available Services
    1. Field Origins for a Property Type
  3. Flexmls: Listing Meta Origins 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 Origins for a Property Type

/<API Version>/flexmls/propertytypes/<PropertyType.MlsCode>/origins

HTTP Method Description Conditional Notes
GET Returns the data for all standard and custom fields 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:

 

GET Response

{
  "D": {
    "Success": true,
    "Results": [{
      "StandardFields": {
        "AssociationAmenities": {
          "FlexmlsGroupName": null,
          "FlexmlsFieldName": null,
          "FlexmlsFieldId": null,
          "RetsSystemName": null,
          "RetsLongName": null,
          "ComposedOf": [
            {
              "Domain": "CustomFields",
              "Group": "Amenities",
              "Field": "Fireplace",
              "FlexmlsGroupName": "Amenities",
              "FlexmlsFieldName": "Fireplace",
              "FlexmlsFieldId": "Fireplace",
              "RetsSystemName": "FEAT20200000000000000000000001",
              "RetsLongName": "Amenities: Fireplace"
            },
            {
              "Domain": "CustomFields",
              "Group": "Amenities",
              "Field": "Draw Bridge",
              "FlexmlsGroupName": "Amenities",
              "FlexmlsFieldName": "Draw Bridge",
              "FlexmlsFieldId": "DB",
              "RetsSystemName": "GF20200000000000000000000002",
              "RetsLongName": "Amenities"
            }
          ]
        },
        "BedsTotal": {
          "FlexmlsGroupName": null,
          "FlexmlsFieldName": null,
          "FlexmlsFieldId": null,
          "RetsSystemName": null,
          "RetsLongName": null,
          "ComposedOf": [
            {
              "Domain": "CustomFields",
              "Group": "General Property Description",
              "Field": "Total Bedrooms2",
              "FlexmlsGroupName": "General Property Description",
              "FlexmlsFieldName": "Total Bedrooms",
              "FlexmlsFieldId": "total_br",
              "RetsSystemName": null,
              "RetsLongName": null
            }
          ]
        },
        "City": {
          "FlexmlsGroupName": null,
          "FlexmlsFieldName": null,
          "FlexmlsFieldId": null,
          "RetsSystemName": null,
          "RetsLongName": null,
          "ComposedOf": [
            {
              "Domain": "CustomFields",
              "Group": "Tax Location and Legal",
              "Field": "City2",
              "FlexmlsGroupName": "Tax; Location and Legal",
              "FlexmlsFieldName": "City",
              "FlexmlsFieldId": "city",
              "RetsSystemName": null,
              "RetsLongName": null
            }
          ]
        }
      },
      "CustomFields": {
        "Amenities": {
          "Draw Bridge": {
            "FlexmlsGroupName": "Amenities",
            "FlexmlsFieldName": "Draw Bridge",
            "FlexmlsFieldId": "DB",
            "RetsSystemName": "GF20200000000000000000000002",
            "RetsLongName": "Amenities",
            "ContributesTo": [
              {
                "Domain": "StandardFields",
                "Group": null,
                "Field": "AssociationAmenities",
                "FlexmlsGroupName": null,
                "FlexmlsFieldName": null,
                "FlexmlsFieldId": null,
                "RetsSystemName": null,
                "RetsLongName": null
              }
            ]
          },
          "Fireplace": {
            "FlexmlsGroupName": "Amenities",
            "FlexmlsFieldName": "Fireplace",
            "FlexmlsFieldId": "Fireplace",
            "RetsSystemName": "FEAT20200000000000000000000001",
            "RetsLongName": "Amenities: Fireplace",
            "ContributesTo": [
              {
                "Domain": "StandardFields",
                "Group": null,
                "Field": "AssociationAmenities",
                "FlexmlsGroupName": null,
                "FlexmlsFieldName": null,
                "FlexmlsFieldId": null,
                "RetsSystemName": null,
                "RetsLongName": null
              }
            ]
          }
        },
        "General Property Description": {
          "Total Bedrooms2": {
            "FlexmlsGroupName": "General Property Description",
            "FlexmlsFieldName": "Total Bedrooms",
            "FlexmlsFieldId": "total_br",
            "RetsSystemName": null,
            "RetsLongName": null,
            "ContributesTo": [
              {
                "Domain": "StandardFields",
                "Group": null,
                "Field": "BedsTotal",
                "FlexmlsGroupName": null,
                "FlexmlsFieldName": null,
                "FlexmlsFieldId": null,
                "RetsSystemName": null,
                "RetsLongName": null
              }
            ]
          }
        },
        "Tax Location and Legal": {
          "City2": {
            "FlexmlsGroupName": "Tax; Location and Legal",
            "FlexmlsFieldName": "City",
            "FlexmlsFieldId": "city",
            "RetsSystemName": null,
            "RetsLongName": null,
            "ContributesTo": [
              {
                "Domain": "StandardFields",
                "Group": null,
                "Field": "City",
                "FlexmlsGroupName": null,
                "FlexmlsFieldName": null,
                "FlexmlsFieldId": null,
                "RetsSystemName": null,
                "RetsLongName": null
              }
            ]
          }
        }
      }
    }]
  }
}
 
 

Flexmls: Listing Meta Origins Description

Attribute Data Type Description
Domain Character The Spark domain, Standard or Custom. Note that this is only present for elements of ComposedOf and ContributesTo; above that level it can be inferred from context.
Group Character The Spark custom field group name, where applicable. Note that this is only present for elements of ComposedOf and ContributesTo; above that level it can be inferred from context.
Field Character The Spark field name. Note that this is only present for elements of ComposedOf and ContributesTo; above that level it can be inferred from context.
FlexmlsGroupName Character The group name from Flexmls Web, where applicable.
FlexmlsFieldName Character The field name from Flexmls Web, where applicable.
FlexmlsFieldId Character The unique name for the field from Flexmls Web, where applicable.
RetsSystemName Character The system name from RETS, where applicable.
RetsLongName Character The long name from RETS, where applicable.
ComposedOf Array The custom fields from which a standard field's value is derived. Note that this attribute is present only for standard fields.
ContributesTo Array The standard fields to which a custom field contributes. Note that this attribute is present only for custom fields.
 

Expansions

None.

 

API Explorer

Interact with this service using the API Explorer.