Virtual Tours

This documentation has moved to the Spark Platform website. Please click here to view.

The Virtual Tours service allows retrieval of URIs to virtual tours for a specific listing.

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

Applicable API Key Roles

This service is available to API keys with private or IDX roles. Within the IDX role, both IDX and Portal permissions may access this service. Listing data is restricted based on the API key and user’s current permission level. For example, IDX API keys will only have access to IDX listings. 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 info for virtual tours on a listing

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

XX is a listing ID, such as 20100912153422758914000000 .

HTTP Method Description Notes
GET Gets info about virtual 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 Virtual Tour Response Format.

Get info for a single virtual tour on a listing

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

XX is a listing ID, such as 20100912153422758914000000 .
YY is a virtual tour ID, such as 20101222111526876245000000 .

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

Virtual Tour Response Format

The response may include multiple virtual tours. This example illustrates the response format for a listing with a single virtual tour.

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

Comments on this entry are closed.