Tour of Homes

The Listing Tour of Homes API allows tour of homes data for a specific listing to be retrieved.

  1. Applicable API Key Roles
  2. Authentication
  3. Available Services
    1. Get tours for a listing
    2. Get info for a single tour on a listing
  4. Listing Tour of Homes Response Format

Applicable API Key Roles

This service is available to API keys with private roles. IDX roles (including both IDX and portal permissions) may not access this service. Listing data is restricted based on the API key and user’s current permission level. 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 tours for a listing

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

XX is a listing ID, such as 20100912153422758914000000 .

HTTP Method Description Notes
GET Gets tours 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 Tour of Homes Response Format.

Get info for a single tour on a listing

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

XX is a listing ID, such as 20100912153422758914000000 .
YY is an tour of homes ID, such as 20101021122556875222000000 .

HTTP Method Description Notes
GET Gets info about an individual tour of home 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 Tour of Homes Response Format.

Listing Tour of Homes Response Format

Below is a sample response.  If the MLS has any of additional tour of homes fields enabled within flexmls, those fields will show up in the response in the AdditionalInfo attribute, like the following example response shows.

{
    "D": {
        "Success": true,
        "Results": [
            {
                "ResourceUri": "/vX/listings/20060412165917817933000000/tourofhomes/20101127153422574618000000",
                "Id": "20101127153422574618000000",
                "Date": "10/01/2010",
                "StartTime": "09:00 AM",
                "EndTime": "12:00 PM",
                "AdditionalInfo": [{"Hosted By": "Joe Smith"}, {"Host Phone": "123-456-7890"}, {"Tour Area": "North-Central"}]
            },
            {
                "ResourceUri": "/vX/listings/20060412165917817933000000/tourofhomes/20101127153422174618000000",
                "Id": "20101127153422174618000000",
                "Date": "10/08/2010",
                "StartTime": "09:00 AM",
                "EndTime": "12:00 PM",
                "AdditionalInfo": [{"Hosted By": "Joe Smith"}, {"Host Phone": "123-456-7890"}, {"Tour Area": "North-Central"}]
            }
        ]
    }
}

Comments on this entry are closed.