Listing Videos
The Listing Videos sub-service retrieval of URIs to videos 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
Videos
/<API Version>/listings/<Listing.Id>/videos
/<API Version>/listings/incomplete/<IncompleteListing.Id>/videos
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns all videos associated with a specified listing | No | |
| POST | Creates a video for a specified listing | No | GroupId is optional. Videos with the same GroupId represent a different Type of the same video. For example, this should be set to the GroupId of the existing unbranded video when saving the branded version. |
| PUT | Allows the reordering of videos 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 videos 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/videos/20101213041526458274000000",
"Id": "20101213041526458274000000",
"GroupId": "20201022225107363901000000",
"Name": "Video name",
"Caption": "Caption text",
"Type": "branded",
"ObjectHtml": "<>"
}
]
}
}
POST Request
Request body:
{
"D": {
"GroupId": "20201022225107363901000000",
"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"}
]
}
}
PUT Response
The standard success/fail response is returned.
Video
/<API Version>/listings/<Listing.Id>/videos/<Id>
/<API Version>/listings/incomplete/<IncompleteListing.Id>/videos/<Id>
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns data for a specified video | No | |
| POST | Returns HTTP 405 (Method Not Allowed) | No | Not implemented |
| PUT | Updates the specified video information | No | |
| DELETE | Deletes the specified video | No |
GET Request
Parameters:
- None
GET Response
See the GET request section for for the Videos service.
PUT Request
Request body:
See the PUT request section for the Videos service.
PUT Response
The standard success/fail response is returned.
DELETE Request
Parameters:
- None
DELETE Response
The standard success/fail response is returned.
Videos Description
| Attribute | Data Type | Writeable | Required | Description |
|---|---|---|---|---|
Id |
Character | No | No | The unique id for the video. |
ResourceUri |
Character | No | No | The URI to the particular video data (not the video itself). |
GroupId |
Character | Yes | No | The id to link a branded and an unbranded videos. |
Name |
Character | Yes | Yes | The name of the video. |
Caption |
Character | Yes | No | Text intended as the video's caption. |
Type |
Character | Yes | No | The type of the video, either branded or unbranded. |
ObjectHtml |
Character | Yes | No | The embeddable HTML to display the media. |
Privacy |
Character | Yes | No | Either Public or Private (default: Public). This is the desired privacy level of the video, and is used to determine the CurrentPrivacy attribute. |
CurrentPrivacy |
Character | No | No | Either Public or Private. Private videos 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 video. |
Expansions
None.