Listings: Tour of Homes

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

Supported Roles
Available Services
Listings: Tour of Homes Description
Expansions

Supported Roles

Role	Reads	Writes
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 in person 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"}
                ],
                "Livestream": false,
                "LivestreamUri": null,
                "LivestreamDescription": null,
                "LivestreamDate": null,
                "LivestreamStartTime": null,
                "LivestreamEndTime": 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.

All Tour of Homes

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

HTTP Method	Description	Conditional	Notes
GET	Returns all upcoming tour of homes for a listing	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": [
            {
                "ResourceUri":"/v1/listings/20060412165917817933000000/tourofhomes/20200625204311858674000000",
                "Id":"20200625204311858674000000",
                "Date":"",
                "StartTime":"",
                "EndTime":"",
                "Comments":null,
                "Livestream":true,
                "LivestreamDate":"07/01/2020",
                "LivestreamStartTime":"9:00 AM",
                "LivestreamEndTime":"11:00 AM",
                "LivestreamDescription":"This tour is available online!",
                "LivestreamUri":"https://zoom.us/example/livestream/tour"
            },
            {
                "ResourceUri": "/vX/listings/20060412165917817933000000/tourofhomes/20200625204611395980000000",
                "Id": "20200625204611395980000000",
                "Date": "07/01/2020",
                "StartTime": "09:00 AM",
                "EndTime": "12:00 PM",
                "Comments": "See this house in person!",
                "Livestream": false,
                "LivestreamUri": null,
                "LivestreamDescription": null,
                "LivestreamDate": null,
                "LivestreamStartTime": null,
                "LivestreamEndTime": null
            }
        ]
    }
}

Livestream Tour of Homes

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

HTTP Method	Description	Conditional	Notes
GET	Returns upcoming Livestream tour of homes for a listing	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":{
        "Results":[
            {
                "ResourceUri":"/v1/listings/20060412165917817933000000/tourofhomes/20200625204311858674000000",
                "Id":"20200625204311858674000000",
                "Date":"",
                "StartTime":"",
                "EndTime":"",
                "Comments":null,
                "Livestream":true,
                "LivestreamDate":"07/01/2020",
                "LivestreamStartTime":"9:00 AM",
                "LivestreamEndTime":"11:00 AM",
                "LivestreamDescription":"This tour is available online!",
                "LivestreamUri":"https://zoom.us/example/livestream/tour"
            }
        ],
        "Success":true
    }
}

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"
                  }
              }
          ]
        }]
    }
}

Tour of Homes Validation

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

HTTP Method	Description	Conditional	Notes
GET	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
POST	Validates tour of homes data to be created, but does not perform the actual creation.	No
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

POST Request

Request body:

{
    "D": {
        "Comments": "This is a valid tour.",
        "Livestream":true,
        "LivestreamDate":"07/01/2020",
        "LivestreamStartTime":"8:00 am",
        "LivestreamEndTime":"10:00 am",
        "LivestreamDescription":"This tour is available online!",
        "LivestreamUri":"https://zoom.us/example/livestream/tour"
    }
}

POST Response

The standard success/fail response is returned.

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.
`Livestream`	Boolean	No	No	If `true`, this is a livestream tour of homes. See `LivestreamUri` and `LivestreamDescription` for more information.
`LivestreamUri`	Character	No	No	The URI where the livestream tour of homes will take place.
`LivestreamDescription`	Character	No	No	The description of the livestream event.
`LivestreamDate`	Character	No	No	The human readable starting date the livestream tour of homes is scheduled for. Used instead of `Date` when `Livestream` is `true`.
`LivestreamStartTime`	Character	No	No	The human readable starting time for the livestream tour of homes event. Used instead of `StartTime` when `Livestream` is `true`.
`LivestreamEndTime`	Character	No	No	The human readable ending time for the livestream tour of homes event. Used instead of `EndTime` when `Livestream` 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.