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
  3. Documents Description
  4. Expansions
  5. API Explorer

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 No Retrieves the meta data for listing documents
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": [
          {
            "Privacy": {
              "Default": "Private",
              "HasEditNames": {
                "A": ["Private Document", "Property Disclosure"],
                "B": ["Exclusive Right to Lease"],
                "C": []
              },
              "Options": ["Public", "Private"]
            }
          }
        ]
    }
}
  

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.

Expansions

None.

API Explorer

The API Explorer does not currently support this service.