Listings: Open Houses

The Open Houses sub-resource returns data about upcoming open houses scheduled for a listing.
  1. Supported Roles
  2. Available Services
    1. Open Houses
    2. Individual Open House
  3. Open House Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads? Writes?
IDX Yes No
VOW Yes No
Private Yes No
More information about roles may be found here.

Available Services

Open Houses

URI: /<API Version>/listings/<Listing.Id>/openhouses

HTTP Method Description Notes
GET Returns upcoming open houses for a listing
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:
  • None

GET Response

Example:
{
    "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
            }
        ]
    }
}

Individual Open House

URI: /<API Version>/listings/<Listing.Id>/openhouses/<Id>

HTTP Method Description Notes
GET Return information about a specified openhouse
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:
  • None

GET Response

See the GET response section above for the data format.

Response Description

Attribute Data Type Description
ResourceUri Character The URI to the particular open house.
Id Character The unique id for the open house.
Date Character The human readable starting date the open house is scheduled for.
StartTime Character The human readable starting time for the open house event.
EndTime Character The human readable ending time for the open house event.
Comments Character Additional information regarding the open house event.

Expansions

None.

API Explorer

The API Explorer does not currently support this service.