Listing Videos
This documentation has moved to the Spark Platform website. Please click here to view.
Applicable API Key Roles
This service is available to API keys with private or IDX roles. Within the IDX role, both IDX and Portal permissions may access this service. Listing data is restricted based on the API key and user’s current permission level. For example, IDX API keys will only have access to IDX listings. More information about roles may be found here.
Authentication
Requests must be authenticated according to these instructions or HTTP 401 (Unauthorized) will be returned.
Available Services
Get info for videos on a listing
URI: /<API Version>/listings/XX/videos
XX is a listing ID, such as 20100912153422758914000000 .
HTTP Method | Description | Notes |
---|---|---|
GET | Gets info about videos for a specified listing. | See parameters below |
POST,PUT,DELETE | Returns HTTP 405 (Method Not Allowed) | Not implemented |
GET Request
Parameters:
- None
GET Response
This returns the Listing Video Response Format.
Get info for a single video on a listing
URI: /<API Version>/listings/XX/videos/YY
XX is a listing ID, such as 20100912153422758914000000 .
YY is a video ID, such as 20101222111526876245000000 .
HTTP Method | Description | Notes |
---|---|---|
GET | Gets info about an individual video for a specified listing. | See parameters below |
POST,PUT,DELETE | Returns HTTP 405 (Method Not Allowed) | Not implemented |
GET Request
Parameters:
- None
GET Response
This returns the Listing Video Response Format.
Listing Video Response Format
The response may include multiple videos. This example illustrates the response format for a listing with a single video.
{ "D": { "Success": true, "Results": [ { "ResourceUri": "/listings/20100815153524571646000000/videos/20101213041526458274000000", "Id": "20101213041526458274000000", "Name": "Video name", "Caption": "Caption text", "Type": "branded", "ObjectHtml": "<>" } ] } }
Comments on this entry are closed.