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: Mapping Layers Flexmls: Mapping Shapegen 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: Floor Plans Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Required Documents 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: Floor Plans 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: Required Documents 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 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 Overlays Overlays: Shapes Portals Portals: Listing Categories Portals: Metadata Preferences 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
Supporting Documentation
Examples
RESO Web API
RETS
FloPlan
Terms of Use

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.

 
  1. Supported Roles
  2. Available Services
    1. Field List Translations from Spark® to Flexmls
    2. Field List Translations from Flexmls to Spark
  3. Flexmls: Listing Field List Meta Translations Description
  4. Expansions
 

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 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.