Virtual Tours: Metadata

The Virtual Tours Metadata service describes the defined Privacy values for listing virtual tours.

  1. Supported Roles
  2. Available Services
    1. Listing Virtual Tours Metadata
  3. Virtual Tours Metadata 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 No
More information about roles may be found here.

Available Services

Listing Virtual Tours Metadata

/<API Version>/listings/virtualtours/meta
/<API Version>/listings/incomplete/virtualtours/meta

HTTP Method Description Conditional Notes
GET Retrieves the meta data for listing virtual tours 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": [{
      "Privacy": {
        "Default": "Private",
        "Options": ["Public", "Private", "Automatic"],
        "OffMarketStandardStatuses": ["Closed"]
      }
    }],
    "Success": true
  }
}

Listing Virtual Tours Metadata Description

Attribute Data Type Description
Privacy JSON Object Meta data for the Privacy attribute on listing virtual tours.
Default Character The default Privacy setting for virtual tours.
Options Character List The Privacy values users can manually choose when saving or updating a listing virtual tour.
OffMarketStandardStatuses Character List Virtual tours with a Privacy of "Automatic" will have their CurrentPrivacy updated to "Private" when the associated listing changes to one of these standard statuses.

Expansions

None.

API Explorer

Interact with this service using the API Explorer.