Flexmls: Listing Field List Meta Translations

This service provides a dictionary that translates the FieldList.Value for standard and custom fields to their corresponding values in Flexmls Web.

Supported Roles
Available Services
1. Field List Translations from Spark® to Flexmls
2. Field List Translations from Flexmls to Spark
Flexmls: Listing Field List Meta Translations 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 List Translations from Spark to Flexmls

`/<API Version>/flexmls/propertytypes/<PropertyType.MlsCode>/fields/fieldlists/translations`

HTTP Method	Description	Conditional	Notes
GET	Returns the translations for field values specified by the `_filter`.	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)	Yes	Searchable fields are standard fields; and custom fields. Note: standard and custom fields can only be joined by `Or` conjunctions. Example: `City Eq 'Fargo' Or State Eq 'ND'`

GET Response

{
  "D": {
    "Results": [{
      "StandardFields": {
        "City": {
          "Fargo": {
            "FlexmlsValue": "FAR"
          }
        }
      },
      "CustomFields": {
        "General Property Description": {
          "New Construction": {
            "Yes": {
              "FlexmlsValue": "Y"
            }
          }
        }
      }
    }],
    "Success": true
  }
}

Field List Translations from Flexmls to Spark

`/<API Version>/flexmls/propertytypes/<PropertyType.MlsCode>/fields/fieldlists/translations/flexmls`

This service takes the field list value from flexmls web for a given set of standard and custom fields, and returns the value used in Spark API. Note that this service still uses the Spark field and group names, and not the flexmls field names.

HTTP Method	Description	Conditional	Notes
GET	Returns the translations for field values specified by the `_filter`.	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)	Yes	Searchable fields are standard fields; and custom fields. Note: standard and custom fields can only be joined by `Or` conjunctions. Example: `City Eq 'Fargo' Or State Eq 'ND'`

GET Response

{
  "D": {
    "Results": [{
      "StandardFields": {
        "City": {
          "FAR": {
            "SparkValue": "Fargo"
          }
        }
      },
      "CustomFields": {
        "General Property Description": {
          "New Construction": {
            "Y": {
              "SparkValue": "Yes"
            }
          }
        }
      }
    }],
    "Success": true
  }
}

Flexmls: Listing Field List Meta Translations Description

Attribute	Data Type	Description
`FlexmlsValue`	Character	The value used in flexmls web for this field. Note that field list values passed in to the filter query are not validated for existence, so fields that do not exist will be returned as though there is no translation needed.
`SparkValue`	Character	The value used in Spark API for this field. Note that field list values passed in to the filter query are not validated for existence, so fields that do not exist will be returned as though there is no translation needed.

Expansions

None.