Listings: Videos

The Listing Videos service provides URIs to media associated with a given listing.
  1. Supported Roles
  2. Available Services
    1. Videos
    2. Individual Video
  3. Video Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads? Writes?
IDX Yes No
VOW Yes No
Private Yes Yes (special permission required)
More information about roles may be found here.

Available Services

Videos

URI: /<API Version>/listings/<Listing.Id>/videos

HTTP Method Description Notes
GET Returns all videos associated with a given listing
PUT Allows the reordering of videos assocatied with a given listing
POST Creates a new video for a given listing
DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:
  • None

GET Response

Example:
{
    "D": {
        "Success": true,
        "Results": [
            {
                "ResourceUri": "/v1/listings/20100815153524571646000000/videos/20101213041526458274000000",
                "Id": "20101213041526458274000000",
                "Name": "Video name",
                "Caption": "Caption text",
                "Type": "branded",
                "ObjectHtml": "<>"
            }
        ]
    }
}

POST Request

Request body:
{
    "D": {
         "Name": "Video Name",
         "Caption": "Caption test",
         "Type": "branded",
         "ObjectHtml": "<>"
    }
}

POST Response

The standard success/fail response is returned.

PUT Request

Request body:
{
    "D": {
        "Videos": [
            {"Id": "20101213041526458274000000"},
            {"Id": "20101214041526458275000000"},
            {"Id": "20101215041526458276000000"},
            {"Id": "20101216041526458277000000"}
        ]
    }
}
For the global PUT to the listing, currently only the Id attribute is accepted and is currently intended to be used for reordering videos for a listing.

PUT Response

The standard success/fail response is returned.

Individual Video

URI: /<API Version>/listings/<listing.Id>/videos/<Id>

HTTP Method Description Notes
GET Returns data for a specified video
DELETE Deletes the specified video
PUT Updates the specified video information
POST Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:
  • None

GET Response

See the GET response section above for the data format.

Response Description

PUT Request

See the POST request section above for the data format.

PUT Response

The standard success/fail response is returned.

DELETE Request

Parameters:
  • None

DELETE Response

The standard success/fail response is returned.
Attribute Data Type Description
ResourceUri Character The URI to the particular video.
Id Character The unique id for the video.
Name Character The name of the video.
Caption Character Text intended as the video's caption.
Type Character The type of the video, either branded or unbranded.
ObjectHtml Character The embeddable HTML to display the media.

Expansions

None.

API Explorer

The API Explorer does not currently support this service.