Alpha Only: This service is subject to change
This service is a work in progress. It is currently subject to change or removal without notice.
Listings: Required Documents
The Required Documents service returns data about which Listing Documents are required by the MLS for a given listing. The returned list may change as fields on the listing change, depending on what the MLS requires and when.
Document Uploads
See the Document Uploads documentation to see how to upload, and attach, a new document to a listing.
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
Required Documents
/<API Version>/listings/<Listing.Id>/documents/required
/<API Version>/listings/incomplete/<IncompleteListing.Id>/documents/required
| HTTP Method | Description | Notes |
|---|---|---|
| GET | Returns a list of all documents required by the MLS for this listing | |
| POST | Returns HTTP 405 (Method Not Allowed) | Not implemented |
| PUT | Returns HTTP 405 (Method Not Allowed) | Not implemented |
| DELETE | Returns HTTP 405 (Method Not Allowed) | Not implemented |
GET Request
Parameters:
- None
GET Response
Example:
{
"D": {
"Success": true,
"Results": [
{
"Name": "Document name",
"Present": true
},
{
"Name": "Another Document",
"Present": false
}
]
}
}