Open Houses

This documentation has moved to the Spark Platform website. Please click here to view.

The Listing Open Houses API allows open house data for a specific listing to be retrieved.

  1. Applicable API Key Roles
  2. Authentication
  3. Available Services
    1. Get open houses for a listing
    2. Get info for a single open house on a listing
  4. Listing Open House Response Format

Applicable API Key Roles

This service is available to API keys with private or IDX roles. Within the IDX role, both IDX and Portal permissions may access this service. Listing data is restricted based on the API key and user’s current permission level. For example, IDX API keys will only have access to IDX listings. More information about roles may be found here.

Authentication

Requests must be authenticated according to these instructions or HTTP 401 (Unauthorized) will be returned.

Available Services

Get open houses for a listing

URI: /<API Version>/listings/XX/openhouses

XX is a listing ID, such as 20100912153422758914000000 .

HTTP Method Description Notes
GET Gets open houses for a specified listing. See parameters below
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:

  • None

GET Response

This returns the Listing Open House Response Format.

Get info for a single open house on a listing

URI: /<API Version>/listings/XX/openhouses/YY

XX is a listing ID, such as 20100912153422758914000000 .
YY is an open house ID, such as 20101021122556875222000000 .

HTTP Method Description Notes
GET Gets info about an individual open house for a specified listing. See parameters below
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:

  • None

GET Response

This returns the Listing Open House Response Format.

Listing Open House Response Format

Below is a sample 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"
            },
            {
                "ResourceUri": "/vX/listings/20060412165917817933000000/openhouses/20101127153422174618000000",
                "Id": "20101127153422174618000000",
                "Date": "10/08/2010",
                "StartTime": "09:00 AM",
                "EndTime": "12:00 PM"
            }
        ]
    }
}

Comments on this entry are closed.