Listings: Open Houses
The Open Houses sub-resource returns data about upcoming open houses scheduled for a listing.
Supported Roles
Role | Reads | Writes | Notes |
---|---|---|---|
IDX | Yes | No | |
Public | Yes | No | |
VOW | Yes | No | |
Portal | Yes | No | |
Private | Yes | Yes |
Available Services
Open Houses
/<API Version>/listings/<Listing.Id>/openhouses
HTTP Method | Description | Conditional | Notes |
---|---|---|---|
GET | Returns upcoming open houses for a listing | No | |
POST | Creates a new open house record | No | |
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": [ { "ResourceUri": "/vX/listings/20060412165917817933000000/openhouses/20101127153422574618000000", "Id": "20101127153422574618000000", "Date": "10/01/2010", "StartTime": "09:00 AM", "EndTime": "12:00 PM", "Comments": "Free chips!" }, { "ResourceUri": "/vX/listings/20060412165917817933000000/openhouses/20101127153422174618000000", "Id": "20101127153422174618000000", "Date": "10/08/2010", "StartTime": "09:00 AM", "EndTime": "12:00 PM", "Comments": null } ] } }
POST Request
Request body:{ "D":{ "Date": "10/01/2010", "StartTime": "09:00 AM", "EndTime": "12:00 PM", "Comments": "Free chips!" } }
POST Response
The standard success/fail response is returned.Open Houses
/<API Version>/listings/<Listing.Id>/openhouses/<OpenHouse.Id>
HTTP Method | Description | Conditional | Notes |
---|---|---|---|
GET | Returns a specified open house record | No | |
POST | Returns HTTP 405 (Method Not Allowed) | No | Not implemented |
PUT | Updates an existing open house record | No | |
DELETE | Deletes an open house record | No |
GET Request
Parameters:- None
GET Response
See the GET request section for for the Open Houses serivice.
PUT Request
Request body:{ "D":{ "Comments": "Bring your own chips." } }
PUT Response
The standard success/fail response is returned.DELETE Request
Parameters:- None
DELETE Response
The standard success/fail response is returned.Open House Metadata
/<API Version>/listings/openhouses/meta
HTTP Method | Description | Conditional | Notes |
---|---|---|---|
GET | Returns meta data for fields not consistent across all MLSs | 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": [{ "AdditionalInfo": [{ "Hosted By": { "Type": "Character" } }, { "Hosted Phone": { "Type": "Character" } }, { "Area": { "Type": "Character" } } ] }] } }
Listing: Rules Description
Attribute | Data Type | Writeable | Required | Description |
---|---|---|---|---|
Id | Character | No | No | The unique id for the open house. |
ResourceUri | Character | No | No | The URI to the particular open house. |
Date | Character | Yes | Yes | The human readable starting date the open house is scheduled for. Note: For writes, we accept this field either as presented by this service (i.e. in the format "MM/DD/YYYY"), or as a typical Date type |
StartTime | Character | Yes | Yes | The human readable starting time for the open house event. Note: For writes, we accept this field either as presented by this service (i.e. in the format "9:00 am"), or as a typical Timestamp type |
EndTime | Character | Yes | Yes | The human readable ending time for the open house event. Note: For writes, we accept this field either as presented by this service (i.e. in the format "9:00 am"), or as a typical Timestamp type |
Comments | Character | Yes | Yes | Additional information regarding the open house event. |
AdditionalInfo | JSON Object | Yes | No | (Private Only) Additional information custom to the MLS for the open house, in the order of desired presentation. See the metadata service for details. |
Expansions
None.