Developer Documentation
Platform Overview
Authentication
API Services
Overview Accounts Accounts: Associations Accounts: Metadata Accounts: Profile Appstore: Users Broker Distributions Broker Tours Consumers Consumers: Linked Agents Contacts Contacts: Activity Contacts: Export Contacts: Tags Contacts: Portal Accounts Developers: Identities Developers: Keys Developers: Authorizations Developers: Billing Summary Developers: Change History Developers: Domains Developers: News Feed Webhooks Developers: Roles Developers: Syndications Developers: Templates Developers: Usage Detail Developers: Usage Summary Devices Flexmls: Email Links Flexmls: Listing Meta Origins Flexmls: Listing Meta Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Mapping Layers Flexmls: Mapping Shapegen IDX IDX Links Listing Carts Listing Carts: Portal/VOW Carts Incomplete Listings Incomplete Listings: Documents Incomplete Listings: Documents Metadata Incomplete Listings: Document Uploads Incomplete Listings: Floor Plans Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Rooms Incomplete Listings: Tickets Incomplete Listings: Units Incomplete Listings: Videos Incomplete Listings: Videos Metadata Incomplete Listings: Virtual Tours Incomplete Listings: Virtual Tours Metadata Listings Listings: Clusters Listings: Documents Listings: Documents Metadata Listings: Floor Plans Listings: FloPlans Listings: Historical Listings: History Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Rooms Listings: Rules Listings: Tour of Homes Listings: Tickets Listings: Units Listings: Validation Listings: Videos Listings: Videos Metadata Listings: Virtual Tours Listings: Virtual Tours Metadata Listing Meta: Custom Fields Listing Meta: Custom Field Groups Listing Meta: Field Order Listing Meta: Field Relations Listing Meta: Property Types Listing Meta: Rooms Listing Meta: Standard Fields Listing Meta: Units Registered Listings Market Statistics News Feed News Feed: Curation News Feed: Events News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Open Houses Overlays Overlays: Shapes Portals Preferences Saved Searches Saved Searches: Provided Saved Searches: Restrictions Saved Searches: Tags Search Templates: Quick Searches Search Templates: Views Search Templates: Sorts Shared Links System Info System Info: Languages System Info: Search Templates
Supporting Documentation
Examples
RESO Web API
RETS
FloPlan
Terms of Use

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
 

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:

 

GET Response

{
  "D": {
    "Results": [{
      "Branding": {
        "Enabled": true,
        "DisplayText" : "text to define branded virtual tours",
        "Roles": ["private", "portal", "vow", "public", "idx"]
      },
      "Privacy": {
        "Default": "Private",
        "Options": ["Public", "Private", "Automatic"],
        "OffMarketStandardStatuses": ["Closed"]
      }
    }],
    "Success": true
  }
}

 
 

Listing Virtual Tours Metadata Description

Attribute Data Type Description
Branding JSON Object Meta data for the Branding attribute on listing virtual tours.
Enabled Boolean if true, branded virtual tours are allowed.
DisplayText Character text to define branded virtual tours.
Roles Character List roles that support branded virtual tours.
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.