Video API v4
Introduction
This API includes methods to create, retrieve and update video assets.
See also
[Video API v4 - Video Group](Video API v4 - Video Group)
[Video API v4 - Video Series](Video API v4 - Video Series)
General Resource URL
Production Instance | https://api.freewheel.tv/services/v4/videos/{FW_ID}?{parameter1}={query1}&... |
Attributes
Name | Type | Description | Creatable | Updatable | Validations |
---|---|---|---|---|---|
id | FW_ID | ID of the Video in FreeWheel | No | No | |
network_id | Integer | ID of the Video's network | No | No | |
external_id | String | The Video's External ID | Yes | Yes | Must be unique on the network |
secondary_id | String | The Video's secondary ID | Yes | Yes | |
description | String | Description for the Video | Yes | Yes | |
metadata | String | Video metadata | Yes | Yes | |
actor | String | Actor | Yes | Yes | |
director | String | Director | Yes | Yes | |
writer | String | Writer | Yes | Yes | |
producer | String | Producer | Yes | Yes | |
customized_metadata | Custom Data Type 1 | Custom metadata for the Video | Yes | Yes | |
language | String | Language | Yes | Yes | |
rating | ['G', 'PG', 'PG-13', 'R', 'Mature', 'Unrated'] | Video rating. Default value is 'Unrated'. | Yes | Yes | |
title1 | String | Title 1 | Req | Yes | |
title2 | String | Title 2 | Yes | Yes | |
duration | Integer | Video duration | Yes | Yes | |
season | Integer | Season | Yes | Yes | |
asset_aging_date | DateTime | Aging date for the Video | Yes | Yes | |
display_right_start_date | DateTime | Display right start | Yes | Yes | |
display_right_end_date | DateTime | Display right end | Yes | Yes | |
air_dates | DateTime | Air dates | Yes | Yes | |
vod_metadata | String | VOD metadata | Yes | Yes | |
status | ['ACTIVE', 'INACTIVE'] | Video status | Yes | Yes | |
updated_at | DateTime | Last updated time | No | No | |
created_at | DateTime | Created time | No | No |
Custom Data Type 1: customized_metadata
Name | Type | Description | Creatable | Updatable | Validations |
---|---|---|---|---|---|
key | String | Yes | Yes | Unique | |
value | String | Yes | Yes |
JSON sample
{
"customized_metadata":{
"key1":"value1",
"key2":"value2"
}
}
XML Sample
<video>
...
<customized_metadata>
<key_value>
<key>key1</key>
<value>value1</value>
</key_value>
<key_value>
<key>key2</key>
<value>value2</value>
</key_value>
</customized_metadata>
</video>
List Videos [/videos]
List Videos [GET]
page | Integer | Specify the page to return. + Default 1 | |
per_page | Optional | Integer | Specify how many items per page. + Default 10 + Max 100 |
status | (optional, String) - | Specify criteria for filtering by status. + Members + active + inactive | |
external_id | optional | (, String | Specify criteria for filtering by external ID.+ Returns all videos with external ID containing the search string. For example "external_id=abc" will return videos with external IDs "abc" and "abcd" Case-insensitive updated_at: \.\.2019-01-26T13:47:00 (optional, String) - You can use the following syntax to search and sort by updated time. For results:Changed on or before the timestamp, use an ellipsis (..) before the timestamp, e.g., updated_at=..2019-01-26T13:47:00Z Changed on or after the timestamp, use an ellipses (..) after the timestamp, e.g., updated_at=2019-01-26T13:47:00Z.. In descending order of update time, use a minus sign ( - ) prefix before the timestamp e.g., -updated_at=2019-01-26T13:47:00Z * In ascending order of update time, add no prefix. eg., updated_at=2019-01-26T13:47:00Z ` |
sort | Optional | String | Default is ascending order. Minus ("-") indicates descending, e.g., created_at , -created_at . |
Request json
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Response 200 (application/json)
Body
{
"page":1,
"per_page":2,
"total_page":26,
"total_count":52,
"links":[
{
"rel":"self",
"href":"/videos?page=1&per_page=2"
},
{
"rel":"next",
"href":"/videos?page=2&per_page=2"
},
{
"rel":"last",
"href":"/videos?page=26&per_page=2"
}
],
"items":[
{
"id":2141954818,
"title1":"api_v4_video_6_data",
"network_id":1751328505,
"external_id":"",
"description":"",
"rating":"Unrated",
"updated_at":"2016-12-13T15:29:49Z",
"created_at":"2016-12-13T15:29:49Z",
"status":"ACTIVE",
"duration":60,
"content_owner_id":null,
"secondary_ids":[
],
"links":[
{
"rel":"self",
"href":"/videos/2141954818"
},
{
"rel":"parent_video_groups",
"href":"/videos/2141954818/parent_video_groups"
},
{
"rel":"parent_series",
"href":"/videos/2141954818/parent_series"
}
]
},
{
"id":2141954817,
"title1":"api_v4_video_6_without_parent_series_and_VG",
"network_id":1751328505,
"external_id":"",
"description":"",
"rating":"Unrated",
"updated_at":"2016-12-12T18:17:07Z",
"created_at":"2016-12-12T18:17:07Z",
"status":"ACTIVE",
"duration":null,
"content_owner_id":null,
"secondary_ids":[
],
"links":[
{
"rel":"self",
"href":"/videos/2141954817"
},
{
"rel":"parent_video_groups",
"href":"/videos/2141954817/parent_video_groups"
},
{
"rel":"parent_series",
"href":"/videos/2141954817/parent_series"
}
]
}
]
}
Request xml
Headers
Content-Type: application/xml
Accept: application/xml
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Response 200 (application/xml)
Body
<videos page="1" per_page="2" total_page="26" total_count="52">
<links>
<link rel="self" href="/services/v4/videos?page=1&per_page=2"></link>
<link rel="next" href="/services/v4/videos?page=2&per_page=2"></link>
<link rel="last" href="/services/v4/videos?page=26&per_page=2"></link>
</links>
<video>
<id>2141954818</id>
<network_id>1751328505</network_id>
<external_id></external_id>
<title1>api_v4_video_6_data</title1>
<description></description>
<rating>Unrated</rating>
<duration>60</duration>
<status>ACTIVE</status>
<secondary_ids></secondary_ids>
<updated_at>2016-12-13T15:29:49Z</updated_at>
<created_at>2016-12-13T15:29:49Z</created_at>
<links>
<link rel="self" href="/services/v4/videos/2141954818"></link>
<link rel="parent_video_groups" href="/services/v4/videos/2141954818/parent_video_groups"></link>
<link rel="parent_series" href="/services/v4/videos/2141954818/parent_series"></link>
</links>
</video>
<video>
<id>2141954817</id>
<network_id>1751328505</network_id>
<external_id></external_id>
<title1>api_v4_video_6_without_parent_series_and_VG</title1>
<description></description>
<rating>Unrated</rating>
<duration></duration>
<status>ACTIVE</status>
<secondary_ids></secondary_ids>
<updated_at>2016-12-12T18:17:07Z</updated_at>
<created_at>2016-12-12T18:17:07Z</created_at>
<links>
<link rel="self" href="/services/v4/videos/2141954817"></link>
<link rel="parent_video_groups" href="/services/v4/videos/2141954817/parent_video_groups"></link>
<link rel="parent_series" href="/services/v4/videos/2141954817/parent_series"></link>
</links>
</video>
</videos>
Show a Video [/videos/{{video_id}]
Show a Video [GET]
URI Parameter | Required? | Syntax | Description |
---|---|---|---|
id | Required | Integer | The video ID |
Request json
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Response 200 (application/json)
{
"id": 116153335,
"network_id": 97753,
"external_id": "dwa",
"title1": "gy_test",
"title2": "title2",
"description": "description",
"rating": "PG",
"season": 2,
"duration": 20,
"upstream_asset_id": 116153401,
"upstream_network_id": 1,
"mirror_type": "CRD",
"customized_metadata": {
"key1": "value1",
"key2": "value2"
},
"vod_metadata": null,
"metadata": "metadata",
"actor": "actor",
"director": "director",
"writer": "writer",
"producer": "producer",
"asset_aging_date": "2017-02-28T05:00:00Z",
"display_right_start_date": "2018-02-01T05:00:00Z",
"display_right_end_date": "2020-02-29T05:00:00Z",
"status": "ACTIVE",
"secondary_ids": [
"97756",
"74975"
],
"languages": [],
"air_dates": [
"2019-02-12T05:00:00Z",
"2019-02-14T05:00:00Z"
],
"genres": [
"Fantasy"
],
"updated_at": "2017-02-28T07:53:57Z",
"created_at": "2017-02-28T07:42:51Z",
"links": [
{
"rel": "self",
"href": "/services/v4/videos/116153335"
},
{
"rel": "parent_video_groups",
"href": "/services/v4/videos/116153335/parent_video_groups"
},
{
"rel": "parent_series",
"href": "/services/v4/videos/116153335/parent_series"
}
]
}
Request xml
Headers
Content-Type: application/xml
Accept: application/xml
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Response 200 (application/xml)
<video>
<id>116153335</id>
<network_id>97753</network_id>
<external_id>dwa</external_id>
<title1>gy_test</title1>
<title2>title2</title2>
<description>description</description>
<rating>PG</rating>
<season>2</season>
<duration>20</duration>
<upstream_asset_id>116153401</upstream_asset_id>
<upstream_network_id>1</upstream_network_id>
<mirror_type>CRD</mirror_type>
<customized_metadata>
<key_value>
<key>key1</key>
<value>value1</value>
</key_value>
<key_value>
<key>key2</key>
<value>value2</value>
</key_value>
</customized_metadata>
<vod_metadata></vod_metadata>
<metadata>metadata</metadata>
<actor>actor</actor>
<director>director</director>
<writer>writer</writer>
<producer>producer</producer>
<asset_aging_date>2017-02-28T05:00:00Z</asset_aging_date>
<display_right_start_date>2018-02-01T05:00:00Z</display_right_start_date>
<display_right_end_date>2020-02-29T05:00:00Z</display_right_end_date>
<status>ACTIVE</status>
<secondary_ids>
<secondary_id>97756</secondary_id>
<secondary_id>74975</secondary_id>
</secondary_ids>
<languages></languages>
<air_dates>
<air_date>2019-02-12T05:00:00Z</air_date>
<air_date>2019-02-14T05:00:00Z</air_date>
</air_dates>
<genres>
<genre>Fantasy</genre>
</genres>
<updated_at>2017-02-28T07:53:57Z</updated_at>
<created_at>2017-02-28T07:42:51Z</created_at>
<links>
<link rel="self" href="/services/v4/videos/116153335"></link>
<link rel="parent_video_groups" href="/services/v4/videos/116153335/parent_video_groups"></link>
<link rel="parent_series" href="/services/v4/videos/116153335/parent_series"></link>
</links>
</video>
Create a Video [/videos]
Create a Video [POST]
Request json
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Body
{
"external_id": "test112",
"title1": "gy_test",
"title2": "title2",
"description": "description",
"rating": "PG",
"season": 2,
"duration": 20,
"customized_metadata": {
"key1": "value1",
"key2": "value2"
},
"vod_metadata": null,
"metadata": "metadata",
"actor": "actor",
"director": "director",
"writer": "writer",
"producer": "producer",
"asset_aging_date": "2017-02-28T05:00:00Z",
"display_right_start_date": "2018-02-01T05:00:00Z",
"display_right_end_date": "2020-02-29T05:00:00Z",
"status": "ACTIVE",
"secondary_ids": [
"977566",
"749755"
],
"languages": [],
"air_dates": [
"2019-02-12T05:00:00Z",
"2019-02-14T05:00:00Z"
],
"genres": [
"Fantasy"
]
}
Response 201 (application/json)
Headers
Location: /services/v4/videos/116153448
Body
{
"id": 116153448,
"network_id": 97753,
"external_id": "test112",
"title1": "gy_test",
"title2": "title2",
"description": "description",
"rating": "PG",
"season": 2,
"duration": 20,
"mirror_type": null,
"customized_metadata": {
"key1": "value1",
"key2": "value2"
},
"vod_metadata": null,
"metadata": "metadata",
"actor": "actor",
"director": "director",
"writer": "writer",
"producer": "producer",
"asset_aging_date": "2017-02-28T05:00:00Z",
"display_right_start_date": "2018-02-01T05:00:00Z",
"display_right_end_date": "2020-02-29T05:00:00Z",
"status": "ACTIVE",
"secondary_ids": [
"977566",
"749755"
],
"languages": [],
"air_dates": [
"2019-02-12T05:00:00Z",
"2019-02-14T05:00:00Z"
],
"genres": [
"Fantasy"
],
"updated_at": "2017-02-28T08:11:17Z",
"created_at": "2017-02-28T08:11:17Z",
"links": [
{
"rel": "self",
"href": "/services/v4/videos/116153448"
},
{
"rel": "parent_video_groups",
"href": "/services/v4/videos/116153448/parent_video_groups"
},
{
"rel": "parent_series",
"href": "/services/v4/videos/116153448/parent_series"
}
]
}
Request xml
Headers
Content-Type: application/xml
Accept: application/xml
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Body
<video>
<external_id>test_111</external_id>
<title1>gy_test</title1>
<title2>title2</title2>
<description>description</description>
<rating>PG</rating>
<season>2</season>
<duration>20</duration>
<customized_metadata>
<key_value>
<key>key1</key>
<value>value1</value>
</key_value>
<key_value>
<key>key2</key>
<value>value2</value>
</key_value>
</customized_metadata>
<vod_metadata></vod_metadata>
<metadata>metadata</metadata>
<actor>actor</actor>
<director>director</director>
<writer>writer</writer>
<producer>producer</producer>
<asset_aging_date>2017-02-28T05:00:00Z</asset_aging_date>
<display_right_start_date>2018-02-01T05:00:00Z</display_right_start_date>
<display_right_end_date>2020-02-29T05:00:00Z</display_right_end_date>
<status>ACTIVE</status>
<secondary_ids>
<secondary_id>97753</secondary_id>
<secondary_id>57230</secondary_id>
</secondary_ids>
<languages></languages>
<air_dates>
<air_date>2019-02-12T05:00:00Z</air_date>
<air_date>2019-02-14T05:00:00Z</air_date>
</air_dates>
<genres>
<genre>Fantasy</genre>
</genres>
</video>
Response 201 (application/xml)
Headers
Location: /services/v4/videos/116153439
Body
<video>
<id>116153439</id>
<network_id>97753</network_id>
<external_id>test_111</external_id>
<title1>gy_test</title1>
<title2>title2</title2>
<description>description</description>
<rating>PG</rating>
<season>2</season>
<duration>20</duration>
<mirror_type></mirror_type>
<customized_metadata>
<key_value>
<key>key1</key>
<value>value1</value>
</key_value>
<key_value>
<key>key2</key>
<value>value2</value>
</key_value>
</customized_metadata>
<vod_metadata></vod_metadata>
<metadata>metadata</metadata>
<actor>actor</actor>
<director>director</director>
<writer>writer</writer>
<producer>producer</producer>
<asset_aging_date>2017-02-28T05:00:00Z</asset_aging_date>
<display_right_start_date>2018-02-01T05:00:00Z</display_right_start_date>
<display_right_end_date>2020-02-29T05:00:00Z</display_right_end_date>
<status>ACTIVE</status>
<secondary_ids>
<secondary_id>97753</secondary_id>
<secondary_id>57230</secondary_id>
</secondary_ids>
<languages></languages>
<air_dates>
<air_date>2019-02-12T05:00:00Z</air_date>
<air_date>2019-02-14T05:00:00Z</air_date>
</air_dates>
<genres>
<genre>Fantasy</genre>
</genres>
<updated_at>2017-02-28T08:08:12Z</updated_at>
<created_at>2017-02-28T08:08:12Z</created_at>
<links>
<link rel="self" href="/services/v4/videos/116153439"></link>
<link rel="parent_video_groups" href="/services/v4/videos/116153439/parent_video_groups"></link>
<link rel="parent_series" href="/services/v4/videos/116153439/parent_series"></link>
</links>
</video>
Update a Video [/videos/{{video_id}]
Update a Video [PUT]
Request json
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Body
{
"external_id": "test112",
"title1": "gy_test",
"title2": "title2",
"description": "description",
"rating": "PG",
"season": 2,
"duration": 20,
"upstream_asset_id": 12345,
"upstream_network_id": 1,
"mirror_type": "CRD",
"customized_metadata": {
"key1": "value1",
"key2": "value2"
},
"vod_metadata": null,
"metadata": "metadata",
"actor": "actor",
"director": "director",
"writer": "writer",
"producer": "producer",
"asset_aging_date": "2017-02-28T05:00:00Z",
"display_right_start_date": "2018-02-01T05:00:00Z",
"display_right_end_date": "2020-02-29T05:00:00Z",
"status": "ACTIVE",
"secondary_ids": [
"977566",
"749755"
],
"languages": [],
"air_dates": [
"2019-02-12T05:00:00Z",
"2019-02-14T05:00:00Z"
],
"genres": [
"Fantasy"
],
"updated_at": "2017-02-28T07:53:57Z",
"created_at": "2017-02-28T07:42:51Z",
"links": [
{
"rel": "self",
"href": "/services/v4/videos/116153335"
},
{
"rel": "parent_video_groups",
"href": "/services/v4/videos/116153335/parent_video_groups"
},
{
"rel": "parent_series",
"href": "/services/v4/videos/116153335/parent_series"
}
]
}
Response 200 (application/json)
Body
{
"id": 116153448,
"network_id": 97753,
"external_id": "test112",
"title1": "gy_test",
"title2": "title2",
"description": "description",
"rating": "PG",
"season": 2,
"duration": 20,
"upstream_asset_id": 12345,
"upstream_network_id": 1,
"mirror_type": null,
"customized_metadata": {
"key1": "value1",
"key2": "value2"
},
"vod_metadata": null,
"metadata": "metadata",
"actor": "actor",
"director": "director",
"writer": "writer",
"producer": "producer",
"asset_aging_date": "2017-02-28T05:00:00Z",
"display_right_start_date": "2018-02-01T05:00:00Z",
"display_right_end_date": "2020-02-29T05:00:00Z",
"status": "ACTIVE",
"secondary_ids": [
"977566",
"749755"
],
"languages": [],
"air_dates": [
"2019-02-12T05:00:00Z",
"2019-02-14T05:00:00Z"
],
"genres": [
"Fantasy"
],
"updated_at": "2017-02-28T08:11:17Z",
"created_at": "2017-02-28T08:11:17Z",
"links": [
{
"rel": "self",
"href": "/services/v4/videos/116153448"
},
{
"rel": "parent_video_groups",
"href": "/services/v4/videos/116153448/parent_video_groups"
},
{
"rel": "parent_series",
"href": "/services/v4/videos/116153448/parent_series"
}
]
}
Request xml
Headers
Content-Type: application/xml
Accept: application/xml
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Body
<video>
<external_id>test_113</external_id>
<title1>gy_test</title1>
<title2>title2</title2>
<description>description</description>
<rating>PG</rating>
<season>2</season>
<duration>20</duration>
<upstream_asset_id>13213</upstream_asset_id>
<upstream_network_id>1</upstream_network_id>
<mirror_type>CRD</mirror_type>
<customized_metadata>
<key_value>
<key>key1</key>
<value>value1</value>
</key_value>
<key_value>
<key>key2</key>
<value>value2</value>
</key_value>
</customized_metadata>
<vod_metadata></vod_metadata>
<metadata>metadata</metadata>
<actor>actor</actor>
<director>director</director>
<writer>writer</writer>
<producer>producer</producer>
<asset_aging_date>2017-02-28T05:00:00Z</asset_aging_date>
<display_right_start_date>2018-02-01T05:00:00Z</display_right_start_date>
<display_right_end_date>2020-02-29T05:00:00Z</display_right_end_date>
<status>ACTIVE</status>
<secondary_ids>
<secondary_id>97753</secondary_id>
<secondary_id>57230</secondary_id>
</secondary_ids>
<languages></languages>
<air_dates>
<air_date>2019-02-12T05:00:00Z</air_date>
<air_date>2019-02-14T05:00:00Z</air_date>
</air_dates>
<genres>
<genre>Fantasy</genre>
</genres>
<updated_at>2017-02-28T07:53:57Z</updated_at>
<created_at>2017-02-28T07:42:51Z</created_at>
<links>
<link rel="self" href="/services/v4/videos/116153335"></link>
<link rel="parent_video_groups" href="/services/v4/videos/116153335/parent_video_groups"></link>
<link rel="parent_series" href="/services/v4/videos/116153335/parent_series"></link>
</links>
</video>
Response 200 (application/xml)
<video>
<id>116153439</id>
<network_id>97753</network_id>
<external_id>test_113</external_id>
<title1>gy_test</title1>
<title2>title2</title2>
<description>description</description>
<rating>PG</rating>
<season>2</season>
<duration>20</duration>
<upstream_asset_id></upstream_asset_id>
<upstream_network_id>1</upstream_network_id>
<mirror_type></mirror_type>
<customized_metadata>
<key_value>
<key>key1</key>
<value>value1</value>
</key_value>
<key_value>
<key>key2</key>
<value>value2</value>
</key_value>
</customized_metadata>
<vod_metadata></vod_metadata>
<metadata>metadata</metadata>
<actor>actor</actor>
<director>director</director>
<writer>writer</writer>
<producer>producer</producer>
<asset_aging_date>2017-02-28T05:00:00Z</asset_aging_date>
<display_right_start_date>2018-02-01T05:00:00Z</display_right_start_date>
<display_right_end_date>2020-02-29T05:00:00Z</display_right_end_date>
<status>ACTIVE</status>
<secondary_ids>
<secondary_id>97753</secondary_id>
<secondary_id>57230</secondary_id>
</secondary_ids>
<languages></languages>
<air_dates>
<air_date>2019-02-12T05:00:00Z</air_date>
<air_date>2019-02-14T05:00:00Z</air_date>
</air_dates>
<genres>
<genre>Fantasy</genre>
</genres>
<updated_at>2017-02-28T08:08:12Z</updated_at>
<created_at>2017-02-28T08:08:12Z</created_at>
<links>
<link rel="self" href="/services/v4/videos/116153439"></link>
<link rel="parent_video_groups" href="/services/v4/videos/116153439/parent_video_groups"></link>
<link rel="parent_series" href="/services/v4/videos/116153439/parent_series"></link>
</links>
</video>
List Parent Video Group [/videos/{{video_id}/parent_video_groups]
List Parent Video Group [GET]
URI Parameter | Required? | Syntax | Description |
---|---|---|---|
page | Optional | Integer | Specify the current page. Default is 1. |
per_page | Optional | Integer | Specify how many items per page. Default is 10. Maximum is 100. |
Request json
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Response 200 (application/json)
Body
{
"page": 1,
"per_page": 10,
"total_page": 1,
"total_count": 2,
"links": [
{
"rel": "self",
"href": "/services/v4/videos/75527290/parent_video_groups?page=1&per_page=10"
}
],
"items": [
{
"id": 9649447,
"network_id": 97753,
"name": "Patrick Kane wins it late on the backhand",
"description": null,
"status": "ACTIVE",
"updated_at": "2017-02-16T11:09:12Z",
"created_at": "2016-01-18T09:46:29Z",
"links": [
{
"rel": "self",
"href": "/services/v4/video_groups/9649447"
},
{
"rel": "parent_video_groups",
"href": "/services/v4/video_groups/9649447/parent_video_groups"
},
{
"rel": "child_video_groups",
"href": "/services/v4/video_groups/9649447/child_video_groups"
},
{
"rel": "child_series",
"href": "/services/v4/video_groups/9649447/child_series"
},
{
"rel": "child_videos",
"href": "/services/v4/video_groups/9649447/child_videos"
}
]
},
{
"id": 10873597,
"network_id": 97753,
"name": "V|Ent",
"description": null,
"status": "ACTIVE",
"updated_at": "2017-02-16T11:09:49Z",
"created_at": "2017-01-05T05:23:11Z",
"links": [
{
"rel": "self",
"href": "/services/v4/video_groups/10873597"
},
{
"rel": "parent_video_groups",
"href": "/services/v4/video_groups/10873597/parent_video_groups"
},
{
"rel": "child_video_groups",
"href": "/services/v4/video_groups/10873597/child_video_groups"
},
{
"rel": "child_series",
"href": "/services/v4/video_groups/10873597/child_series"
},
{
"rel": "child_videos",
"href": "/services/v4/video_groups/10873597/child_videos"
}
]
}
]
}
Request xml
Headers
Content-Type: application/xml
Accept: application/xml
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Response 200 (application/xml)
Body
<video_groups page="1" per_page="10" total_page="1" total_count="2">
<links>
<link rel="self" href="/services/v4/videos/75527290/parent_video_groups?page=1&per_page=10"></link>
</links>
<video_group>
<id>9649447</id>
<network_id>97753</network_id>
<name>Patrick Kane wins it late on the backhand</name>
<description></description>
<status>ACTIVE</status>
<updated_at>2017-02-16T11:09:12Z</updated_at>
<created_at>2016-01-18T09:46:29Z</created_at>
<links>
<link rel="self" href="/services/v4/video_groups/9649447"></link>
<link rel="parent_video_groups" href="/services/v4/video_groups/9649447/parent_video_groups"></link>
<link rel="child_video_groups" href="/services/v4/video_groups/9649447/child_video_groups"></link>
<link rel="child_series" href="/services/v4/video_groups/9649447/child_series"></link>
<link rel="child_videos" href="/services/v4/video_groups/9649447/child_videos"></link>
</links>
</video_group>
<video_group>
<id>10873597</id>
<network_id>97753</network_id>
<name>V|Ent</name>
<description></description>
<status>ACTIVE</status>
<updated_at>2017-02-16T11:09:49Z</updated_at>
<created_at>2017-01-05T05:23:11Z</created_at>
<links>
<link rel="self" href="/services/v4/video_groups/10873597"></link>
<link rel="parent_video_groups" href="/services/v4/video_groups/10873597/parent_video_groups"></link>
<link rel="child_video_groups" href="/services/v4/video_groups/10873597/child_video_groups"></link>
<link rel="child_series" href="/services/v4/video_groups/10873597/child_series"></link>
<link rel="child_videos" href="/services/v4/video_groups/10873597/child_videos"></link>
</links>
</video_group>
</video_groups>
Update Parent Video Group Relation [/videos/{{video_id}/parent_video_groups]
Update Parent Video Group Relation [PUT]
Request json
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Body
{
"items":[
{"id":123233},
{"id":53535},
{"id":98098098}
]
}
Response 200 (application/json)
Request xml
Headers
Content-Type: application/xml
Accept: application/xml
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Body
<video_groups>
<video_group>
<id>10992679</id>
</video_group>
<video_group>
<id>10992676</id>
</video_group>
</video_groups>
Response 200 (application/xml)
Add Parent Video Group [/videos/{{video_id}/parent_video_groups/{{video_group_id}]
Add Parent Video Group [PUT]
Request json
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Response 200 (application/json)
Request xml
Headers
Content-Type: application/xml
Accept: application/xml
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Response 200 (application/xml)
Remove Parent Video Group [/videos/{{video_id}/parent_video_groups/{{video_group_id}]
Remove Parent Video Group [DELETE]
Request json
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Response 200 (application/json)
Request xml
Headers
Content-Type: application/xml
Accept: application/xml
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Response 200 (application/xml)
List Parent Series [/videos/{{video_id}/parent_series]
List Parent Series [GET]
URI Parameter | Required? | Syntax | Description |
---|---|---|---|
page | Optional | Integer | Specify the current page. Default is 1. |
per_page | Optional | Integer | Specify how many items per page. Default is 10. Maximum is 100. |
Request json
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Response 200 (application/json)
Body
{
"page": 1,
"per_page": 10,
"total_page": 1,
"total_count": 1,
"links": [
{
"rel": "self",
"href": "/services/v4/videos/75527290/parent_series?page=1&per_page=10"
}
],
"items": [
{
"id": 10886874,
"name": "name for min required series by IS post check20170216055803",
"network_id": 97753,
"description": null,
"rating": null,
"status": "ACTIVE",
"updated_at": "2017-02-16T05:59:16Z",
"created_at": "2017-02-16T05:59:16Z",
"links": [
{
"rel": "self",
"href": "/services/v4/series/10886874"
},
{
"rel": "parent_video_groups",
"href": "/services/v4/series/10886874/parent_video_groups"
},
{
"rel": "child_videos",
"href": "/services/v4/series/10886874/child_videos"
}
]
}
]
}
Request xml
Headers
Content-Type: application/xml
Accept: application/xml
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Response 200 (application/xml)
Body
<serieses page="1" per_page="10" total_page="1" total_count="1">
<links>
<link rel="self" href="/services/v4/videos/75527290/parent_series?page=1&per_page=10"></link>
</links>
<series>
<id>10886874</id>
<name>name for min required series by IS post check20170216055803</name>
<network_id>97753</network_id>
<description></description>
<rating></rating>
<status>ACTIVE</status>
<updated_at>2017-02-16T05:59:16Z</updated_at>
<created_at>2017-02-16T05:59:16Z</created_at>
<links>
<link rel="self" href="/services/v4/series/10886874"></link>
<link rel="parent_video_groups" href="/services/v4/series/10886874/parent_video_groups"></link>
<link rel="child_videos" href="/services/v4/series/10886874/child_videos"></link>
</links>
</series>
</serieses>
Add Parent Series [/videos/{{video_id}/parent_series/{{series_id}]
Add Parent Series [PUT]
Request json
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Response 200 (application/json)
Request xml
Headers
Content-Type: application/xml
Accept: application/xml
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Response 200 (application/json)
Remove Parent Series [/videos/{{video_id}/parent_series/{{series_id}]
Remove Parent Series [DELETE]
Request json
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Response 200 (application/json)
Request xml
Headers
Content-Type: application/xml
Accept: application/xml
Authorization: Bearer MY_OAUTH_ACCESS_TOKEN
Response 200 (application/xml)
Updated 5 months ago