Documents: Metadata
The Documents Metadata service describes the allowable values for listing documents, which varies by MLS.
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:
- 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"]
},
"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:
- None
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.
|
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.
|
Expansions
None.