Listing Virtual Tours
The Virtual Tours sub-service retrieval of URIs to virtual tours associated with a specified listing.
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:
- None
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:
- None
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:
- None
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.