Listings: Virtual Tours
The Virtual Tours sub-service retrieval of URIs to virtual tours associated with a specified listing.
- Supported Roles
- Available Services
- Virtual Tours
- Individual Virtual Tour
- Virtual Tour Description
- Expansions
- API Explorer
Supported Roles
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 |
Notes |
GET |
Returns all virtual tours associated with a given listing |
|
POST |
Creates a virtual tour for a given listing |
|
PUT,DELETE |
Returns HTTP 405 (Method Not Allowed) |
Not implemented |
GET Request
Parameters:
GET Response
Example:
{
"D": {
"Success": true,
"Results": [
{
"ResourceUri": "/v1/listings/20100815153524571646000000/virtualtours/20101213041526458274000000",
"Id": "20101213041526458274000000",
"Name": "VT name",
"Uri": "http://somethirdpartyvtservice.com/123",
"Type": "branded"
}
]
}
}
POST Request
Request body:
{
"D": {
"Name": "Tour Name",
"Uri": "http://www.flexmls.com/tour?id=50",
"Type": "branded"
}
}
POST 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 |
Notes |
GET |
Returns data for a specified virtual tour |
|
PUT |
Updates the specified virtual tour information |
|
DELETE |
Deletes the specified virtual tour |
|
POST |
Returns HTTP 405 (Method Not Allowed) |
Not implemented |
GET Request
Parameters:
GET Response
See the
GET response section above for the data format.
PUT Request
See the
POST request section above for the data format.
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 |
Description |
ResourceUri |
Character |
The URI to the particular virtual tour. |
Id |
Character |
The unique id for the virtual tour. |
Name |
Character |
The name of the virtual tour. |
Uri |
Character |
The location of the virtual tour. |
Type |
Character |
The type of the virtual tour, either branded or unbranded. |
Expansions
None.
API Explorer
The API Explorer does not currently support this service.