Listings: Tour of Homes

The Tour of Homes sub-resource returns data about upcoming tour of homes scheduled for a listing.

  1. Supported Roles
  2. Available Services
    1. Tour of Homes
    2. Individual Tour of Homes Event
    3. Tour of Homes Metadata
  3. Listings: Tour of Homes Description
  4. Expansions
  5. API Explorer

Supported Roles

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

Available Services

Tour of Homes

/<API Version>/listings/<Listing.Id>/tourofhomes

HTTP Method Description Conditional Notes
GET Returns upcoming tour of homes for a listing No
POST Creates a new tour of home 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/tourofhomes/20101127153422574618000000",
                "Id": "20101127153422574618000000",
                "Date": "10/01/2010",
                "StartTime": "09:00 AM",
                "EndTime": "12:00 PM",
                "Comments": "Free chips!",
                "AdditionalInfo": [
                    {"Hosted By": "Mr. Agent"}, 
                    {"Hosted Phone": "111-222-3333"}, 
                    {"Area": "North Fargo"}
                ],
                "Virtual": false,
                "VirtualUri": null,
                "VirtualDescription": null,
                "VirtualDate": null,
                "VirtualStartTime": null,
                "VirtualEndTime": 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.

Tour of Homes

/<API Version>/listings/<Listing.Id>/tourofhomes/<TourOfHomes.Id>

HTTP Method Description Conditional Notes
GET Returns a specified tour of home record No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Updates an existing tour of home record No
DELETE Deletes a tour of home record No

GET Request

Parameters:
  • None

GET Response

See the GET request section for for the Tour of Homes 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.

Tour of Homes Metadata

/<API Version>/listings/tourofhomes/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"
                  }
              }
          ]
        }]
    }
}

Listings: Tour of Homes Description

Attribute Data Type Writeable Required Description
Id Character No No The unique id for the tour of home.
ResourceUri Character No No The URI to the particular tour of home.
Date Character Yes Yes The human readable starting date the tour of home 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 tour of home 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 tour of home 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 tour of home event.
Virtual Boolean No No If true, this is a virtual tour of homes. See VirtualUri and VirtualDescription for more information.
VirtualUri Character No No The URI where the virtual tour of homes will take place.
VirtualDescription Character No No The description of the virtual event.
VirtualDate Character No No The human readable starting date the virtual tour of homes is scheduled for. Used instead of Date when Virtual is true.
VirtualStartTime Character No No The human readable starting time for the virtual tour of homes event. Used instead of StartTime when Virtual is true.
VirtualEndTime Character No No The human readable ending time for the virtual tour of homes event. Used instead of EndTime when Virtual is true.
AdditionalInfo JSON Object Yes No Additional information custom to the MLS for the tour of home, in the order of desired presentation. See the metadata service for details.

Expansions

None.

API Explorer

The API Explorer does not currently support this service.