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: 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: 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 News Feed News Feed: Curation News Feed: Events News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Open Houses Overlays Overlays: Shapes Portals 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

Documents: Metadata

The Documents Metadata service describes the allowable values for listing documents, which varies by MLS.

 
  1. Supported Roles
  2. Available Services
    1. Documents Metadata
    2. Documents Metadata (by Property Type)
  3. Documents Description
  4. Expansions
 

Supported Roles

Role Reads Writes Notes
IDX No No
Public No No
VOW No No
Portal No No
Private Yes No

More information about roles may be found here.

 

Available Services

Listing Documents Metadata

/<API Version>/listings/documents/meta
/<API Version>/listings/incomplete/documents/meta

HTTP Method Description Conditional Notes
GET Retrieves the meta data for listing documents 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": [
          {
            "Privacy": {
              "Default": "Private",
              "HasEditNames": {
                "A": ["Private Document", "Property Disclosure"],
                "B": ["Exclusive Right to Lease"],
                "C": []
              },
              "Options": ["Public", "Private"]
            },
            "DocumentLists": {
              "A": {
                "Documents": [
                  {
                    "Name": "Private Document",
                    "Privacy": "Private"
                  },
                  {
                    "Name": "Property Disclosure",
                    "Privacy": "Public"
                  },
                  {
                    "Name": "A Third Option",
                    "Privacy": "Public"
                  }
                ]
              },
              "B": {
                "Documents": [
                  {
                    "Name": "Private Document",
                    "Privacy": "Private"
                  },
                  {
                    "Name": "Property Disclosure",
                    "Privacy": "Public"
                  }
                ],
                "Another Document Group": [
                  {
                    "Name": "Exclusive Right to Lease",
                    "Privacy": "Public"
                  }
                ]
              },
              "C": {}
            }
          }
        ]
    }
}
  
 
 

Listing Documents Metadata (by Property Type)

/<API Version>/listings/documents/propertytypes/<PropertyType.MlsCode>/meta
/<API Version>/listings/incomplete/documents/propertytypes/<PropertyType.MlsCode>/meta

HTTP Method Description Conditional Notes
GET Retrieves the meta data for listing documents (by property type) 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": [
          {
            "Privacy": {
              "Default": "Private",
              "HasEditNames": ["Private Document", "Property Disclosure"],
              "Options": ["Public", "Private"]
            },
            "DocumentLists": {
              "Documents": [
                {
                  "Name": "Private Document",
                  "Privacy": "Private"
                },
                {
                  "Name": "Property Disclosure",
                  "Privacy": "Public"
                },
                {
                  "Name": "A Third Option",
                  "Privacy": "Public"
                }
              ]
            }
          }
        ]
    }
}
  
 
 

Documents Metadata Description

Attribute Data Type Description
Privacy JSON Object Meta data for the Privacy attribute on listing documents.
Default Character The default Privacy setting for documents. If this is null, there is no default setting, and Privacy must always be explicitly set to one of the values in Options or the document must have a Name specified in the HasEditNames list.
HasEditNames Character List A list of document Name values that are defined as always pivate for this MLS. Any document entered with this name _must_ have a Privacy setting of HasEdit.

{
  "A": ["Private Document", "Property Disclosure"],
  "B": ["Exclusive Right to Lease"],
  "C": []
}
Options Character List The Privacy values users can manually choose when saving or updating a document.
DocumentLists JSON Object Lists of document Name values available for a given property type and their default Privacy setting defined by the MLS. Document Name values are not limited to these lists, but the lists are used to determine if a listing or document meets requirements set by the MLS . The lists are divided into named groups for each property type.

{
  "A": {
    "Documents": [
      {
        "Name": "Private Document",
        "Privacy": "Private"
      },
      {
        "Name": "Property Disclosure",
        "Privacy": "Public"
      },
      {
        "Name": "A Third Option",
        "Privacy": "Public"
      }
    ]
  },
  "B": {
    "Documents": [
      {
        "Name": "Private Document",
        "Privacy": "Private"
      },
      {
        "Name": "Property Disclosure",
        "Privacy": "Public"
      }
    ],
    "Another Document Group": [
      {
        "Name": "Exclusive Right to Lease",
        "Privacy": "Public"
      }
    ]
  },
  "C": {}
}
 

Expansions

None.