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.

Supported Roles
Available Services
1. Field Origins for a Property Type
Flexmls: Listing Meta Origins Description
Expansions

Supported Roles

Role	Reads	Writes
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:

None

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.