Listings: Virtual Tours

The Virtual Tours sub-service retrieval of URIs to virtual tours associated with a specified listing.
  1. Supported Roles
  2. Available Services
    1. Virtual Tours
    2. Individual Virtual Tour
  3. Virtual Tour Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads Writes
IDX Yes No
VOW Yes No
Private Yes Yes (special permission required)
More information about roles may be found here.

Available Services

Virtual Tours

URI: /<API Version>/listings/<Listing.Id>/virtualtours

HTTP Method Description Notes
GET Returns all virtual tours associated with a given listing
POST Creates a virtual tour for a given listing
PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:
  • None

GET Response

Example:
{
    "D": {
        "Success": true,
        "Results": [
            {
                "ResourceUri": "/v1/listings/20100815153524571646000000/virtualtours/20101213041526458274000000",
                "Id": "20101213041526458274000000",
                "Name": "VT name",
                "Uri": "http://somethirdpartyvtservice.com/123",
                "Type": "branded"
            }
        ]
    }
}

POST Request

Request body:
{
    "D": {
         "Name": "Tour Name",
         "Uri": "http://www.flexmls.com/tour?id=50",
         "Type": "branded"
    }
}

POST Response

The standard success/fail response is returned.

Virtual Tour

URI: /<API Version>/listings/<listing.Id>/virtualtours/<Id>

HTTP Method Description Notes
GET Returns data for a specified virtual tour
PUT Updates the specified virtual tour information
DELETE Deletes the specified virtual tour
POST Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:
  • None

GET Response

See the GET response section above for the data format.

PUT Request

See the POST request section above for the data format.

PUT Response

The standard success/fail response is returned.

DELETE Request

Parameters:
  • None

DELETE Response

The standard success/fail response is returned.

Virtual Tour Description

Attribute Data Type Description
ResourceUri Character The URI to the particular virtual tour.
Id Character The unique id for the virtual tour.
Name Character The name of the virtual tour.
Uri Character The location of the virtual tour.
Type Character The type of the virtual tour, either branded or unbranded.

Expansions

None.

API Explorer

The API Explorer does not currently support this service.