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: Listing Updates 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: Required Documents 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: Hot Sheet Parameters Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Required Documents 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 Messages News Feed News Feed: Curation News Feed: Events News Feed: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Overlays Overlays: Shapes Portals Portal Groups Portal Groups: Current Portal Groups: Tags Portals: Listing Categories Portals: Metadata Preferences Properties Properties: Clusters Properties Meta: Standard Fields 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
API Explorer
Supporting Documentation
Examples
RESO Web API
RETS
FloPlan
Terms of Use

Listing 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 Notes
IDX Yes No
Public Yes No
VOW Yes No
Portal Yes No
Private Yes Yes Special permission required

More information about roles may be found here.

 

Available Services

Virtual Tours

/<API Version>/listings/{Listing.Id}/virtualtours
/<API Version>/listings/incomplete/{IncompleteListing.Id}/virtualtours

HTTP Method Description Conditional Notes
GET Returns all virtual tours associated with a specified listing No
POST Creates a virtual tour for a specified listing No GroupId is optional. Virtual tours with the same GroupId represent a different Type of the same virtual tour. For example, this should be set to the GroupId of the existing unbranded virtual tour when saving the branded version.
PUT Allows the reordering of virtual tours assocatied with a specified listing No For the global PUT to the listing, currently only the Id attribute is accepted and is currently intended to be used for reordering virtual tours for a listing.
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:

 

GET Response

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

POST Request

Request body:

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

POST Response

The standard success/fail response is returned.

 

PUT Request

Request body:

{
    "D": {
        "VirtualTours": [
            {"Id": "20101213041526458274000000"},
            {"Id": "20101214041526458275000000"},
            {"Id": "20101215041526458276000000"},
            {"Id": "20101216041526458277000000"}
        ]
    }
}
 

PUT Response

The standard success/fail response is returned.

 
 

Virtual Tour

/<API Version>/listings/<Listing.Id>/virtualtours/<Id>
/<API Version>/listings/incomplete/<IncompleteListing.Id>/virtualtours/<Id>

HTTP Method Description Conditional Notes
GET Returns data for a specified virtual tour No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Allows the reordering of virtual tours assocatied with a specified listing No
DELETE Deletes the specified virtual tour No

GET Request

Parameters:

 

GET Response

See the GET request section for for the Virtual Tours service.

PUT Request

Request body:

See the PUT request section for the Virtual Tours service.

 

PUT Response

The standard success/fail response is returned.

 

DELETE Request

Parameters:

 

DELETE Response

The standard success/fail response is returned.

 
 

Virtual Tour Description

Attribute Data Type Writeable Required Description
Id Character No No The unique id for the virtual tour.
ResourceUri Character No No The URI to the particular virtual tour data (not the virtual tour itself).
GroupId Character Yes No The id to link a branded and an unbranded virtual tours.
Name Character Yes Yes The name of the virtual tour.
Uri Character Yes Yes The URI to the particular virtual tour.
Type Character Yes No The type of the virtual tour, either branded or unbranded.
Privacy Character Yes No Either Public or Private (default: Public). This is the desired privacy level of the virtual tour, and is used to determine the CurrentPrivacy attribute.
CurrentPrivacy Character No No Either Public or Private. Private tours will only be available to FBS products, and will only be available for private roles. Use this attribute to determine the active privacy level of the tour.
 

Expansions

None.

 

API Explorer

The API Explorer does not currently support this service.