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

Listing Data Display Rules

Multiple RESO Dictionary Support
This service supports multiple RESO Data Dictionary versions.

 

Listing data displayed by your application, must abide by MLS defined compliance rules. These rules are provided by the System Info service and the Listings service.

  1. Listing Views Explained
  2. General MLS Rules
  3. Listing Specific Rules
 

Listing Views Explained

How you access listing data defines the View of the listing. When in doubt, the DisplayCompliance.View attribute of every listing retrieved through the API specifies which view of the listing data you have retrieved.

Summary

Summary listing data is intended as a brief view of the listing data, the best example being the view of listing data you may see on a search results grid. Specifically, you are viewing Summary data any time you access a listing through the listing search service.

Detail

Detail listing data is intended for listing reports. You are viewing Detail data any time you access a listing through the listing search service with a _limit of 1 or when you access an individual listing directly.

General MLS Rules

The System Info service contains a DisplayCompliance attribute which dictates which StandardFields attributes must be displayed to the end user on listing Summary and Detail views.

 
{
    "D": {
        "Success": true,
        "Results": [
            {
                "DisplayCompliance":{
                   "20000426143505724628000000":{
                      "View":{
                         "Summary":{
                            "DisplayCompliance":[
                               "ListOfficeName",
                               "ListingUpdateTimestamp"
                            ]
                         },
                         "Detail":{
                            "DisplayCompliance":[
                               "ListOfficeName",
                               "ListOfficePhone",
                               "ListOfficeEmail",
                               "ListingUpdateTimestamp"
                            ]
                         }
                      },
                      "DisclaimerText":"Information is deemed to be reliable, but is not guaranteed.",
                      "DisclaimerTextOnly":"Information is deemed to be reliable, but is not guaranteed."
                   }
                }
            }
        ]
    }
}
 
Attribute Description Returned for Which User Type(s) Returned for Which API Key Role(s)
View.Summary A list of StandardField attributes to be displayed in a summary view of a listing. All All
View.Detail A list of StandardField attributes to be displayed in a detailed view of a listing. All All
DisclaimerText Text to be displayed with the listings in either a summary or detail view. All All
DisclaimerTextOnly Disclaimer text stripped of all html tags which can be displayed instead of the DisclaimerText attribute in environments which don't support html with the listings in either a summary or detail view. All All
 

Listing Specific Rules

A few listing display rules depend on the invidivual listing being accessed. Because of this, the final set of compliance rules is bundled in with the listing data itself. Currently, these rules only apply to listings retrieved under the IDX role.

 
{
    "D": {
        "Success": true,
        "Results": [
            {
                "ResourceUri": "/vX/listings/20060412165917817933000000",
                "Id": "20060412165917817933000000",
                "StandardFields": {
                   ...
                }
                "DisplayCompliance":{
                    "IDXLogoSmall":{
                       "LogoUri":"http://somesite.com/logo/small.jpg",
                       "Type":"Uri"
                    },
                    "View":"Detail",
                    "IDXLogo":{
                       "LogoUri":"Acme Realty",
                       "Type":"Text"
                    },
                }   
            }   
        ]
    }
}
 
Attribute Description Returned for Which User Type(s) Returned for Which API Key Role(s)
IDXLogoSmall.LogoUri A small version of the idx logo to be displayed with the listing. All IDX
IDXLogoSmall.Type Will be one of two options, Uri or Text. If Uri, the value from IDXLogoSmall.LogoUri is to be treated as an image. If text, it is text to be displayed. All IDX
IDXLogo.LogoUri The full sized IDX logo. All IDX
IDXLogo.Type Will be one of two options, Uri or Text. If Uri, the value from IDXLogo.LogoUri is to be treated as an image. If Text, it is text to be displayed. All IDX
View Will be one of two options, Summary or Detail. If Summary, the fields from System Info View.Summary are required to be displayed. If Detail, the fields from System Info View.Detail are required to be displayed. All All