Listings: Tour of Homes

The Tour of Homes sub-resource returns data about upcoming tour events scheduled for a listing.
  1. Supported Roles
  2. Available Services
    1. Tour of Homes
    2. Individual Tour of Homes event
  3. Response Description
  4. Expansions
  5. API Explorer

Supported Roles

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

Available Services

Tour of homes

URI: /v1/listings/<Listing.Id>/tourofhomes

HTTP Method Description Notes
GET Return all upcoming tours 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": [
            {
                "AdditionalInfo": [
                    {"Hosted By": "Mr. Agent"}, 
                    {"Hosted Phone": "111-222-3333"}, 
                    {"Area": "North Fargo"}
                ], 
                "Comments": "First listing tour", 
                "Date": "05/14/2012", 
                "Id": "20120509194700383011000000", 
                "ResourceUri": "/vX/listings/20000612234839640464000000/tourofhomes/20120509194700383011000000", 
                "StartTime": "12:00 PM", 
                "EndTime": "5:00 PM"
            }        
        ]
    }
}

Individual Tour of Homes event

URI: /v1/listings/<Listing.Id>/tourofhomes/<Id>

HTTP Method Description Notes
GET Return information about a specific tour of homes event
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:
  • None

Response Format

See the GET response section above for the data format.

Response Description

Attribute Data Type Description
ResourceUri Character The URI to the particular event.
Id Character The unique id for the event.
Date Character The human readable starting date the event is scheduled for.
StartTime Character The human readable starting time for the event.
EndTime Character The human readable ending time for the event.
AdditionalInfo:Hosted By Character Name of the tour host.
AdditionalInfo:Hosted Phone Character Contact phone for the tour host.
AdditionalInfo:Area Character Listing area that the tour is taking place.

Expansions

None.

API Explorer

The API Explorer does not currently support this service.