Developers
How can we help you?
Title group
A title group is exactly that, a group of titles. Currently in Mediagenix On-Demand there are two types: Series and Collections
Series
Note: This resource links can be expanded using the expand option except the blackouts, rights and denied rights links.
This is generally a season, and a title can only belong to one series. A title that belongs to a series is an episode. An example would be “Season 1 of CSI: Crime Scene Investigation”. A specific episode (say, where Grissom, through a long shot extrapolation discovers who the killer was), can only belong to one season at a time. Hmmm… Ok, bad example.
It looks like this (notice the title-group-type
):
<?xml version="1.0" encoding="UTF-8"?>
<title-group>
<id type='integer'>180</id>
<name>CSI: Crime Scene Investigation</name>
<external-id>14320</external-id>
<title-group-type>series</title-group-type>
<season-number>1</season-number>
<season-reference-id>Winter</season-reference-id>
<tags>Action,Drama</tags>
<acl-hash><view@everyone> <edit@team#141> <contribute@user#38></acl-hash>
<link rel="self" href="https://movida.bebanjo.net/api/title_groups/180"/>
<link rel="titles" href="https://movida.bebanjo.net/api/title_groups/180/titles"/>
<link rel="schedule" href="https://movida.bebanjo.net/api/title_groups/180/schedule"/>
<link rel="images" href="https://movida.bebanjo.net/api/title_groups/180/images"/>
<link rel="metadata" href="https://movida.bebanjo.net/api/title_groups/180/metadata"/>
<link rel="blackouts" href="https://movida.bebanjo.net/api/title_groups/180/blackouts"/>
<link rel="rights" href="https://movida.bebanjo.net/api/title_groups/180/rights"/>
<link rel="denied_rights" href="https://movida.bebanjo.net/api/title_groups/180/denied_rights"/>
<link rel="rules" href="https://movida.bebanjo.net/api/title_groups/180/rules"/>
<link rel="clips" href="https://movida.bebanjo.net/api/title_groups/180/clips"/>
<link rel="note" href="https://movida.bebanjo.net/api/title_groups/180/note"/>
<link rel="external_ids" href="https://movida.bebanjo.net/api/title_groups/180/external_ids"/>
<link rel="creator" href="https://movida.bebanjo.net/api/users/38"/>
</title-group>
{
"resource_type": "title_group",
"id": 180,
"name": "CSI: Crime Scene Investigation",
"external_id": "14320",
"title_group_type": "series",
"season_number": 1,
"season_reference_id": "Winter",
"tags": "Action,Drama",
"acl_hash": "<view@everyone> <edit@team#141> <contribute@user#38>",
"self_link": "https://movida.bebanjo.net/api/title_groups/180",
"titles_link": "https://movida.bebanjo.net/api/title_groups/180/titles",
"schedule_link": "https://movida.bebanjo.net/api/title_groups/180/schedule",
"images_link": "https://movida.bebanjo.net/api/title_groups/180/images",
"metadata_link": "https://movida.bebanjo.net/api/title_groups/180/metadata",
"blackouts_link": "https://movida.bebanjo.net/api/title_groups/180/blackouts",
"rights_link": "https://movida.bebanjo.net/api/title_groups/180/rights",
"denied_rights_link": "https://movida.bebanjo.net/api/title_groups/180/denied_rights",
"rules_link": "https://movida.bebanjo.net/api/title_groups/180/rules",
"clips_link": "https://movida.bebanjo.net/api/title_groups/180/clips",
"note_link": "https://movida.bebanjo.net/api/title_groups/180/note",
"external_ids_link": "https://movida.bebanjo.net/api/title_groups/180/external_ids",
"creator_link": "https://movida.bebanjo.net/api/users/38"
}
Collections
Note: This resource links can be expanded using the expand option except the blackouts, rights and denied rights links.
A collection is a group of titles of any type (episodes
, features
, ads
, promos
…). A title can belong or not to one or many collections. Like this, Mediagenix On-Demand enables its users to package titles of different series together so that they can be scheduled on VoD. An example would be “CSI: Trilogy”, an special that contains three episodes, one from each strand (Vegas, Miami and New York). Those episodes belong to their specific series, but they can be packaged in various ways.
It looks like this:
<title-group>
<id type='integer'>215</id>
<name>CSI: Trilogies</name>
<external-id>2637610</external-id>
<title-group-type>title_group</title-group-type>
<tags>Action,Drama</tags>
<acl-hash><view@everyone> <edit@team#141> <contribute@user#38></acl-hash>
<link rel="self" href="https://movida.bebanjo.net/api/title_groups/215"/>
<link rel="titles" href="https://movida.bebanjo.net/api/title_groups/215/titles"/>
<link rel="schedule" href="https://movida.bebanjo.net/api/title_groups/215/schedule"/>
<link rel="images" href="https://movida.bebanjo.net/api/title_groups/215/images"/>
<link rel="metadata" href="https://movida.bebanjo.net/api/title_groups/215/metadata"/>
<link rel="rules" href="https://movida.bebanjo.net/api/title_groups/215/rules"/>
<link rel="collection_entries" href="https://movida.bebanjo.net/api/title_groups/215/collection_entries"/>
<link rel="clips" href="https://movida.bebanjo.net/api/title_groups/215/clips"/>
<link rel="note" href="https://movida.bebanjo.net/api/title_groups/215/note"/>
<link rel="external_ids" href="https://movida.bebanjo.net/api/title_groups/215/external_ids"/>
<link rel="creator" href="https://movida.bebanjo.net/api/users/38"/>
</title-group>
{
"resource_type": "title_group",
"id": 215,
"name": "CSI: Trilogies",
"external_id": "2637610",
"title_group_type": "title_group",
"tags": "Action,Drama",
"acl_hash": "<view@everyone> <edit@team#141> <contribute@user#38>",
"self_link": "https://movida.bebanjo.net/api/title_groups/215",
"titles_link": "https://movida.bebanjo.net/api/title_groups/215/titles",
"schedule_link": "https://movida.bebanjo.net/api/title_groups/215/schedule",
"images_link": "https://movida.bebanjo.net/api/title_groups/215/images",
"metadata_link": "https://movida.bebanjo.net/api/title_groups/215/metadata",
"rules_link": "https://movida.bebanjo.net/api/title_groups/215/rules",
"collection_entries_link": "https://movida.bebanjo.net/api/title_groups/215/collection_entries",
"clips_link": "https://movida.bebanjo.net/api/title_groups/215/clips",
"note_link": "https://movida.bebanjo.net/api/title_groups/215/note",
"external_ids_link": "https://movida.bebanjo.net/api/title_groups/215/external_ids",
"creator_link": "https://movida.bebanjo.net/api/users/38"
}
The creator
link is pointing to the user creator of the title group, and the link will only be present if the creator of the title group is a regular user, and not an API user. This link is visible only for Mediagenix On-Demand accounts configured for User Permissions.
Title group attributes
id
(required): Mediagenix On-Demand internal identifier of the title group. It shouldn’t be provided in the creation of the resource, because Mediagenix On-Demand will assign that value.name
(required): the name of the title group.external-id
(optional): the identifier of the title group in the external system. If provided, it has to be unique in the scope of the company.title-group-type
(required): the type of title group. Possible values are “series” (for series) and “title_group” (for collections).season-number
(optional): the season number as described above; only visible if thetitle-group-type
is “series” and the season number in series feature is enabled for the company.season-reference-id
(optional): the season reference id as described above; only visible if thetitle-group-type
is “series” and the season number in series feature is enabled for the company. It is an alphanumeric value that allows non-unique and non sequential season numbering, for example “Winter” or “Spring”. When a value is present, it is used for season naming, like “SWinter” or “SSpring”, instead of the normal “S01” that makes use of theseason_number
value.-
tags
(optional): the tags as a list separated by commas of the title group. acl-hash
(optional): a string representation of user permissions assigned to the title group. This property can be updated only by API users, adding or removing permissions from the list as needed.- Pattern:
<permissionName@subjectType#subjectId>
- Example:
<contribute@team#101> <edit@everyone> <view@user#123>
Each user permission representation const of 3 parts:
permissionName
: the name of the Permission resource.subjectType
: the type of the subject being granted with permissions. Allowed values: “user” for User, “team” for Team and “everyone” when it makes reference to all users of the BeBnanjo account.subjectId
: the Mediagenix On-Demand internal identifier of the subject.
This attribute is only present for Mediagenix On-Demand accounts configured for User Permissions.
- Pattern:
Get a list of all title groups in the current account
Title groups are linked from the root of the API, through the link identified with the rel="title_groups"
attribute:
<?xml version="1.0" encoding="UTF-8"?>
<movida>
<!-- ... -->
<link rel="title_groups" href="https://movida.bebanjo.net/api/title_groups">
</movida>
{
// ...
"title_groups_link": "https://movida.bebanjo.net/api/title groups",
// ...
}
Following that link, we can fetch the list of title groups in the current account.
Note: the list may be large as pagination is not available at the moment.
$ curl --digest -u robot_user:password https://movida.bebanjo.net/api/title_groups
$ curl --digest -u robot_user:password -H "Accept: application/json" https://movida.bebanjo.net/api/title_groups
<?xml version='1.0' encoding='utf-8' ?>
<title-groups type="array">
<title-group>
<id type='integer'>1</id>
<name>Sunrise</name>
<external-id>23450</external-id>
<title-group-type>series</title-group-type>
<season-number>1</season-number>
<season-reference-id>Winter</season-reference-id>
<tags>Action,Drama</tags>
<acl-hash><view@everyone> <edit@team#141> <contribute@user#38></acl-hash>
<link rel="self" href="https://movida.bebanjo.net/api/title_groups/1"/>
<link rel="titles" href="https://movida.bebanjo.net/api/title_groups/1/titles"/>
<link rel="schedule" href="https://movida.bebanjo.net/api/title_groups/1/schedule"/>
<link rel="images" href="https://movida.bebanjo.net/api/title_groups/1/images"/>
<link rel="metadata" href="https://movida.bebanjo.net/api/title_groups/1/metadata"/>
<link rel="blackouts" href="https://movida.bebanjo.net/api/title_groups/1/blackouts"/>
<link rel="rights" href="https://movida.bebanjo.net/api/title_groups/1/rights"/>
<link rel="denied_rights" href="https://movida.bebanjo.net/api/title_groups/1/denied_rights"/>
<link rel="rules" href="https://movida.bebanjo.net/api/title_groups/1/rules"/>
<link rel="clips" href="https://movida.bebanjo.net/api/title_groups/1/clips"/>
<link rel="note" href="https://movida.bebanjo.net/api/title_groups/1/note"/>
<link rel="external_ids" href="https://movida.bebanjo.net/api/title_groups/1/external_ids"/>
<link rel="creator" href="https://movida.bebanjo.net/api/users/38"/>
</title-group>
<title-group>
<id type='integer'>2</id>
<name>Peppa Pig: S02</name>
<external-id>31893</external-id>
<title-group-type>series</title-group-type>
<season-number>2</season-number>
<season-reference-id>Summer</season-reference-id>
<tags>Action,Drama</tags>
<acl-hash><view@everyone> <edit@team#141> <contribute@user#43></acl-hash>
<link rel="self" href="https://movida.bebanjo.net/api/title_groups/2"/>
<link rel="titles" href="https://movida.bebanjo.net/api/title_groups/2/titles"/>
<link rel="schedule" href="https://movida.bebanjo.net/api/title_groups/2/schedule"/>
<link rel="images" href="https://movida.bebanjo.net/api/title_groups/2/images"/>
<link rel="metadata" href="https://movida.bebanjo.net/api/title_groups/2/metadata"/>
<link rel="blackouts" href="https://movida.bebanjo.net/api/title_groups/2/blackouts"/>
<link rel="rights" href="https://movida.bebanjo.net/api/title_groups/2/rights"/>
<link rel="denied_rights" href="https://movida.bebanjo.net/api/title_groups/2/denied_rights"/>
<link rel="rules" href="https://movida.bebanjo.net/api/title_groups/2/rules"/>
<link rel="clips" href="https://movida.bebanjo.net/api/title_groups/2/clips"/>
<link rel="note" href="https://movida.bebanjo.net/api/title_groups/2/note"/>
<link rel="external_ids" href="https://movida.bebanjo.net/api/title_groups/2/external_ids"/>
<link rel="creator" href="https://movida.bebanjo.net/api/users/43"/>
</title-group>
<!-- ... -->
</title-groups>
{
"entries": [
{
"resource_type": "title_group",
"id": 1,
"name": "Sunrise",
"external_id": "23450",
"title_group_type": "series",
"season_number": 1,
"season_reference_id": "Winter",
"tags": "Action,Drama",
"acl_hash": "<view@everyone> <edit@team#141> <contribute@user#38>",
"self_link": "https://movida.bebanjo.net/api/title_groups/1",
"titles_link": "https://movida.bebanjo.net/api/title_groups/1/titles",
"schedule_link": "https://movida.bebanjo.net/api/title_groups/1/schedule",
"images_link": "https://movida.bebanjo.net/api/title_groups/1/images",
"metadata_link": "https://movida.bebanjo.net/api/title_groups/1/metadata",
"blackouts_link": "https://movida.bebanjo.net/api/title_groups/1/blackouts",
"rights_link": "https://movida.bebanjo.net/api/title_groups/1/rights",
"denied_rights_link": "https://movida.bebanjo.net/api/title_groups/1/denied_rights",
"rules_link": "https://movida.bebanjo.net/api/title_groups/1/rules",
"clips_link": "https://movida.bebanjo.net/api/title_groups/1/clips",
"note_link": "https://movida.bebanjo.net/api/title_groups/1/note",
"external_ids_link": "https://movida.bebanjo.net/api/title_groups/1/external_ids",
"creator_link": "https://movida.bebanjo.net/api/users/38"
},
{
"resource_type": "title_group",
"id": 2,
"name": "Peppa Pig: S02",
"external_id": "31893",
"title_group_type": "series",
"season_number": 2,
"season_reference_id": "Summer",
"tags": "Action,Drama",
"acl_hash": "<view@everyone> <edit@team#141> <contribute@user#43>",
"self_link": "https://movida.bebanjo.net/api/title_groups/2",
"titles_link": "https://movida.bebanjo.net/api/title_groups/2/titles",
"schedule_link": "https://movida.bebanjo.net/api/title_groups/2/schedule",
"images_link": "https://movida.bebanjo.net/api/title_groups/2/images",
"metadata_link": "https://movida.bebanjo.net/api/title_groups/2/metadata",
"blackouts_link": "https://movida.bebanjo.net/api/title_groups/2/blackouts",
"rights_link": "https://movida.bebanjo.net/api/title_groups/2/rights",
"denied_rights_link": "https://movida.bebanjo.net/api/title_groups/2/denied_rights",
"rules_link": "https://movida.bebanjo.net/api/title_groups/2/rules",
"clips_link": "https://movida.bebanjo.net/api/title_groups/2/clips",
"note_link": "https://movida.bebanjo.net/api/title_groups/2/note",
"external_ids_link": "https://movida.bebanjo.net/api/title_groups/2/external_ids",
"creator_link": "https://movida.bebanjo.net/api/users/43"
},
// ...
]
}
Valid attributes
You can filter the list of title groups returned using the following attributes:
external_id
: this filter can be used in two ways:- Filtering by default external_id: if the
external_id_type
parameter is not included, returns only the title group with the default external ID, if any. - Filtering by external_id with a specified type: if the additional parameter
external_id_type
is provided, returns the title group that has the givenexternal_id
associated with the specified type.
- Filtering by default external_id: if the
external_id_type
: Returns only the title groups with the specified external ID type, if any.
Get a specific title group
This is a good way to recover information about a specific title_group
. We recommend that you use its full URL as the ID that you store in your systems, if you ever need to re-access it. Following the previous example:
$ curl --digest -u robot_user:password https://movida.bebanjo.net/api/title_groups/2
$ curl --digest -u robot_user:password -H "Accept: application/json" https://movida.bebanjo.net/api/title_groups/2
<?xml version='1.0' encoding='utf-8' ?>
<title-group>
<id type='integer'>2</id>
<name>Peppa Pig: S02</name>
<external-id>11512</external-id>
<title-group-type>series</title-group-type>
<season-number>2</season-number>
<season-reference-id>Summer</season-reference-id>
<tags>Action,Drama</tags>
<acl-hash><view@everyone> <edit@team#141> <contribute@user#38></acl-hash>
<link rel="self" href="https://movida.bebanjo.net/api/title_groups/2"/>
<link rel="titles" href="https://movida.bebanjo.net/api/title_groups/2/titles"/>
<link rel="schedule" href="https://movida.bebanjo.net/api/title_groups/2/schedule"/>
<link rel="images" href="https://movida.bebanjo.net/api/title_groups/2/images"/>
<link rel="metadata" href="https://movida.bebanjo.net/api/title_groups/2/metadata"/>
<link rel="blackouts" href="https://movida.bebanjo.net/api/title_groups/2/blackouts"/>
<link rel="rights" href="https://movida.bebanjo.net/api/title_groups/2/rights"/>
<link rel="denied_rights" href="https://movida.bebanjo.net/api/title_groups/2/denied_rights"/>
<link rel="rules" href="https://movida.bebanjo.net/api/title_groups/2/rules"/>
<link rel="clips" href="https://movida.bebanjo.net/api/title_groups/2/clips"/>
<link rel="note" href="https://movida.bebanjo.net/api/title_groups/2/note"/>
<link rel="external_ids" href="https://movida.bebanjo.net/api/title_groups/2/external_ids"/>
<link rel="creator" href="https://movida.bebanjo.net/api/users/38"/>
</title-group>
{
"resource_type": "title_group",
"id": 2,
"name": "Peppa Pig: S02",
"external_id": "11512",
"title_group_type": "series",
"season_number": 2,
"season_reference_id": "Summer",
"tags": "Action,Drama",
"acl_hash": "<view@everyone> <edit@team#141> <contribute@user#38>",
"self_link": "https://movida.bebanjo.net/api/title_groups/2",
"titles_link": "https://movida.bebanjo.net/api/title_groups/2/titles",
"schedule_link": "https://movida.bebanjo.net/api/title_groups/2/schedule",
"images_link": "https://movida.bebanjo.net/api/title_groups/2/images",
"metadata_link": "https://movida.bebanjo.net/api/title_groups/2/metadata",
"blackouts_link": "https://movida.bebanjo.net/api/title_groups/2/blackouts",
"rights_link": "https://movida.bebanjo.net/api/title_groups/2/rights",
"denied_rights_link": "https://movida.bebanjo.net/api/title_groups/2/denied_rights",
"rules_link": "https://movida.bebanjo.net/api/title_groups/2/rules",
"clips_link": "https://movida.bebanjo.net/api/title_groups/2/clips",
"note_link": "https://movida.bebanjo.net/api/title_groups/2/note",
"external_ids_link": "https://movida.bebanjo.net/api/title_groups/2/external_ids",
"creator_link": "https://movida.bebanjo.net/api/users/38"
}
Remember you can use the expand me some nodes trick if you want to, for instance, find out what is the schedule of a particular title_group
.
$ curl --digest -u robot_user:password https://movida.bebanjo.net/api/title_groups/2?expand=schedule,schedulings
$ curl --digest -u robot_user:password -H "Accept: application/json" https://movida.bebanjo.net/api/title_groups/2?expand=schedule,schedulings
This would expand the rel="schedule"
link, and then would also expand the rel="schedulings"
link inside the schedule, yielding something like:
<?xml version='1.0' encoding='utf-8' ?>
<title-group>
<id type='integer'>2</id>
<name>Peppa Pig: S02</name>
<external-id>11523</external-id>
<title-group-type>series</title-group-type>
<season-number>2</season-number>
<season-reference-id>Summer</season-reference-id>
<tags>Action,Drama</tags>
<acl-hash><view@everyone> <edit@team#141> <contribute@user#38></acl-hash>
<link rel="self" href="https://movida.bebanjo.net/api/title_groups/2"/>
<link rel="titles" href="https://movida.bebanjo.net/api/title_groups/2/titles"/>
<link rel="schedule" href="https://movida.bebanjo.net/api/title_groups/2/schedule">
<schedule>
<link rel="schedulings" href="https://movida.bebanjo.net/api/title_groups/2/schedule/schedulings">
<schedulings type="array">
<scheduling>
<id type="integer">13707733</id>
<put-up type="datetime">2021-12-01T00:00:00-08:00</put-up>
<take-down type="datetime">2021-12-31T23:59:00-08:00</take-down>
<scheduling-type>archive</scheduling-type>
<rights-status>no_rights</rights-status>
<rights-status-calculating type="boolean">false</rights-status-calculating>
<workflow-status>completed</workflow-status>
<tags></tags>
<external-id nil="true"/>
<automatic-asset-selection type="boolean">false</automatic-asset-selection>
<link rel="self" href="https://movida.bebanjo.net/api/schedulings/13707733"/>
<link rel="title_group" href="https://movida.bebanjo.net/api/title_groups/2"/>
<link rel="title" href="https://movida.bebanjo.net/api/titles/73"/>
<link rel="conflicts" href="https://movida.bebanjo.net/api/schedulings/13707733/conflicts"/>
<link rel="platform" href="https://movida.bebanjo.net/api/platforms/4770"/>
<link rel="workflow" href="https://movida.bebanjo.net/api/schedulings/13707733/workflow"/>
<link rel="metadata" href="https://movida.bebanjo.net/api/schedulings/13707733/metadata"/>
</scheduling>
</schedulings>
</link>
<link rel="title_group" href="https://movida.bebanjo.net/api/title_groups/2"/>
</schedule>
</link>
<link rel="images" href="https://movida.bebanjo.net/api/title_groups/2/images"/>
<link rel="metadata" href="https://movida.bebanjo.net/api/title_groups/2/metadata"/>
<link rel="blackouts" href="https://movida.bebanjo.net/api/title_groups/2/blackouts"/>
<link rel="rights" href="https://movida.bebanjo.net/api/title_groups/2/rights"/>
<link rel="denied_rights" href="https://movida.bebanjo.net/api/title_groups/2/denied_rights"/>
<link rel="rules" href="https://movida.bebanjo.net/api/title_groups/2/rules"/>
<link rel="clips" href="https://movida.bebanjo.net/api/title_groups/2/clips"/>
<link rel="note" href="https://movida.bebanjo.net/api/title_groups/2/note"/>
<link rel="external_ids" href="https://movida.bebanjo.net/api/title_groups/2/external_ids"/>
<link rel="creator" href="https://movida.bebanjo.net/api/users/38"/>
</title-group>
{
"resource_type": "title_group",
"id": 2,
"name": "Peppa Pig: S02",
"external_id": "11523",
"title_group_type": "series",
"season_number": 2,
"season_reference_id": "Summer",
"tags": "Action,Drama",
"acl_hash": "<view@everyone> <edit@team#141> <contribute@user#38>",
"self_link": "https://movida.bebanjo.net/api/title_groups/2",
"titles_link": "https://movida.bebanjo.net/api/title_groups/2/titles",
"schedule_link": "https://movida.bebanjo.net/api/title_groups/2/schedule",
"schedule": {
"resource_type": "schedule",
"schedulings_link": "https://movida.bebanjo.net/api/title_groups/2/schedule/schedulings",
"schedulings": {
"entries": [
{
"resource_type": "scheduling",
"id": 13707733,
"put_up": "2021-12-01T00:00:00-08:00",
"take_down": "2021-12-31T23:59:00-08:00",
"scheduling_type": "archive",
"rights_status": "no_rights",
"rights_status_calculating": false,
"workflow_status": "completed",
"tags": "",
"external_id": null,
"automatic_asset_selection": false,
"self_link": "https://movida.bebanjo.net/api/schedulings/13707733",
"title_group_link": "https://movida.bebanjo.net/api/title_groups/2",
"title_link": "https://movida.bebanjo.net/api/titles/73",
"conflicts_link": "https://movida.bebanjo.net/api/schedulings/13707733/conflicts",
"platform_link": "https://movida.bebanjo.net/api/platforms/4770",
"workflow_link": "https://movida.bebanjo.net/api/schedulings/13707733/workflow",
"metadata_link": "https://movida.bebanjo.net/api/schedulings/13707733/metadata"
}
]
},
"title_group_link": "https://movida.bebanjo.net/api/title_groups/2"
},
"images_link": "https://movida.bebanjo.net/api/title_groups/2/images",
"metadata_link": "https://movida.bebanjo.net/api/title_groups/2/metadata",
"blackouts_link": "https://movida.bebanjo.net/api/title_groups/2/blackouts",
"rights_link": "https://movida.bebanjo.net/api/title_groups/2/rights",
"denied_rights_link": "https://movida.bebanjo.net/api/title_groups/2/denied_rights",
"rules_link": "https://movida.bebanjo.net/api/title_groups/2/rules",
"clips_link": "https://movida.bebanjo.net/api/title_groups/2/clips",
"note_link": "https://movida.bebanjo.net/api/title_groups/2/note",
"external_ids_link": "https://movida.bebanjo.net/api/title_groups/2/external_ids",
"creator_link": "https://movida.bebanjo.net/api/users/38"
}
Get a list of all titles on a title group
To return of all titles for a title group, it would go like this (please note that at the moment, pagination is not default):
$ curl --digest -u robot_user:password https://movida.bebanjo.net/api/title_groups/41/titles?pagination=true
$ curl --digest -u robot_user:password -H "Accept: application/json" https://movida.bebanjo.net/api/title_groups/41/titles?pagination=true
And would yield something like:
<?xml version='1.0' encoding='utf-8' ?>
<titles type="array">
<total-entries>64</total-entries>
<link rel="next" href="https://movida.bebanjo.net/api/title_groups/41/titles?pagination=true&page=2"/>
<title>
<id type="integer">73</id>
<title>E01, Episode 1</title>
<name>Episode 1</name>
<episode-number type="integer">1</episode-number>
<external-id>C5147630001</external-id>
<title-type>episode</title-type>
<tags>Action,Drama</tags>
<acl-hash><view@everyone> <edit@team#141> <contribute@user#38></acl-hash>
<link rel="self" href="https://movida.bebanjo.net/api/titles/73"/>
<link rel="schedule" href="https://movida.bebanjo.net/api/titles/73/schedule"/>
<link rel="availability_windows" href="https://movida.bebanjo.net/api/titles/73/availability_windows"/>
<link rel="series" href="https://movida.bebanjo.net/api/title_groups/41"/>
<link rel="images" href="https://movida.bebanjo.net/api/titles/73/images"/>
<link rel="metadata" href="https://movida.bebanjo.net/api/titles/73/metadata"/>
<link rel="external_ids" href="https://movida.bebanjo.net/api/titles/73/external_ids"/>
<link rel="creator" href="https://movida.bebanjo.net/api/users/38"/>
</title>
<title>
<id type="integer">74</id>
<title>E02, Episode 2</title>
<name>Episode 2</name>
<episode-number type="integer">1</episode-number>
<external-id>C5147630002</external-id>
<title-type>episode</title-type>
<tags>Action,Drama</tags>
<acl-hash><view@everyone> <edit@team#141> <contribute@user#43></acl-hash>
<link rel="self" href="https://movida.bebanjo.net/api/titles/74"/>
<link rel="schedule" href="https://movida.bebanjo.net/api/titles/74/schedule"/>
<link rel="availability_windows" href="https://movida.bebanjo.net/api/titles/74/availability_windows"/>
<link rel="series" href="https://movida.bebanjo.net/api/title_groups/41"/>
<link rel="images" href="https://movida.bebanjo.net/api/titles/74/images"/>
<link rel="metadata" href="https://movida.bebanjo.net/api/titles/74/metadata"/>
<link rel="external_ids" href="https://movida.bebanjo.net/api/titles/74/external_ids"/>
<link rel="creator" href="https://movida.bebanjo.net/api/users/43"/>
</title>
<!-- ... -->
</titles>
{
"total_entries": 64,
"next_link": "https://movida.bebanjo.net/api/title_groups/41/titles?page=2&pagination=true",
"entries": [
{
"resource_type": "title",
"id": 73,
"name": "Episode 1",
"episode_number": 1,
"title": "E01, Episode 1",
"external_id": "C5147630001",
"title_type": "episode",
"tags": "Action,Drama",
"acl_hash": "<view@everyone> <edit@team#141> <contribute@user#38>",
"self_link": "https://movida.bebanjo.net/api/titles/73",
"schedule_link": "https://movida.bebanjo.net/api/titles/73/schedule",
"linear_schedulings_link": "https://movida.bebanjo.net/api/titles/73/linear_schedulings",
"availability_windows_link": "https://movida.bebanjo.net/api/titles/73/availability_windows",
"series_link": "https://movida.bebanjo.net/api/title_groups/10111962",
"title_groups_link": "https://movida.bebanjo.net/api/titles/73/title_groups",
"licensor_link": "https://movida.bebanjo.net/api/licensors/114",
"images_link": "https://movida.bebanjo.net/api/titles/73/images",
"assets_link": "https://movida.bebanjo.net/api/titles/73/assets",
"metadata_link": "https://movida.bebanjo.net/api/titles/73/metadata",
"clips_link": "https://movida.bebanjo.net/api/titles/73/clips",
"note_link": "https://movida.bebanjo.net/api/titles/73/note",
"external_ids_link": "https://movida.bebanjo.net/api/titles/73/external_ids",
"creator_link": "https://movida.bebanjo.net/api/users/38"
},
{
"resource_type": "title",
"id": 74,
"name": "Episode 2",
"episode_number": 2,
"title": "E02, Episode 2",
"external_id": "C5147630002",
"title_type": "episode",
"tags": "Action,Drama",
"acl_hash": "<view@everyone> <edit@team#141> <contribute@user#43>",
"self_link": "https://movida.bebanjo.net/api/titles/74",
"schedule_link": "https://movida.bebanjo.net/api/titles/74/schedule",
"linear_schedulings_link": "https://movida.bebanjo.net/api/titles/74/linear_schedulings",
"availability_windows_link": "https://movida.bebanjo.net/api/titles/74/availability_windows",
"series_link": "https://movida.bebanjo.net/api/title_groups/10111962",
"title_groups_link": "https://movida.bebanjo.net/api/titles/74/title_groups",
"licensor_link": "https://movida.bebanjo.net/api/licensors/114",
"images_link": "https://movida.bebanjo.net/api/titles/74/images",
"assets_link": "https://movida.bebanjo.net/api/titles/74/assets",
"metadata_link": "https://movida.bebanjo.net/api/titles/74/metadata",
"clips_link": "https://movida.bebanjo.net/api/titles/74/clips",
"note_link": "https://movida.bebanjo.net/api/titles/74/note",
"external_ids_link": "https://movida.bebanjo.net/api/titles/74/external_ids",
"creator_link": "https://movida.bebanjo.net/api/users/43"
},
// ...
]
}
Note: With enabled pagination, only 50 titles will be included in each page by default. But you can override this default by using the
per_page
parameter. Thetotal-entries
attribute will indicate the total number of entries and the linksrel="next"
andrel="prev"
should be used to get the next and the previous pages so you can navigate for all the titles for a title group.
Valid attributes
-
pagination
: Note that by default, this is not paginated endpoint. If you want to enable pagination you need to provide the pagination parameter with a value of “true”. -
per_page
: Number of elements returned in each page. The maximum value allowed is 200 and the default is 50. Only effective with enabled pagination. -
page
: Number of the page you want to be returner. Only effective with enabled pagination.
Note: This is a paginated endpoint for the Title resource. By default, only 50 Titles will be included in each page but you can override this default by using the per_page parameter. The
total-entries
attribute will indicate the total number of entries and the linksrel="next"
andrel="prev"
should be used to get the next and the previous pages so you can navigate for all the Titles for a title group.
Creating title groups
Creating new title groups is easy, you just have to post a title group resource (like the ones you get when retrieving title groups) to the URL of a link
whose rel
is title_groups
, like the one you’ll find in the API root:
$ curl --digest -u robot_user:password https://movida.bebanjo.net/api
$ curl --digest -u robot_user:password -H "Accept: application/json" https://movida.bebanjo.net/api
<?xml version="1.0" encoding="UTF-8"?>
<movida>
<!-- ... -->
<link rel="title_groups" href="https://movida.bebanjo.net/api/title_groups"/>
<!-- ... -->
</movida>
{
// ...
"title_groups_link": "https://movida.bebanjo.net/api/title_groups",
// ...
}
The only required field is the name of the title group, all the rest of the fields are optional (but remember that title-group-type
defaults to title_group
).
So we can create a new empty title group just like this (we’ll be using curl’s @
option, which reads data to be posted from a file):
$ cat title_group.xml
$ cat title_group.json
<title-group>
<name>The Best War Movies</name>
</title-group>
{
"name": "The Best War Movies"
}
$ curl --digest -u robot_user:password -H "Content-Type: application/xml" -X POST -d @title_group.xml "https://movida.bebanjo.net/api/title_groups"
$ curl --digest -u robot_user:password -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d @title_group.json "https://movida.bebanjo.net/api/title_groups"
<?xml version="1.0" encoding="UTF-8"?>
<title-group>
<id type="integer">4</id>
<name>The Best War Movies</name>
<external-id nil="true"/>
<title-group-type>title_group</title-group-type>
<tags></tags>
<acl-hash nil="true"></acl-hash>
<link rel="self" href="https://movida.bebanjo.net/api/title_groups/4"/>
<link rel="titles" href="https://movida.bebanjo.net/api/title_groups/4/titles"/>
<link rel="schedule" href="https://movida.bebanjo.net/api/title_groups/4/schedule"/>
<link rel="images" href="https://movida.bebanjo.net/api/title_groups/4/images"/>
<link rel="metadata" href="https://movida.bebanjo.net/api/title_groups/4/metadata"/>
<link rel="rules" href="https://movida.bebanjo.net/api/title_groups/4/rules"/>
<link rel="collection_entries" href="https://movida.bebanjo.net/api/title_groups/4/collection_entries"/>
<link rel="clips" href="https://movida.bebanjo.net/api/title_groups/4/clips"/>
<link rel="note" href="https://movida.bebanjo.net/api/title_groups/4/note"/>
<link rel="external_ids" href="https://movida.bebanjo.net/api/title_groups/4/external_ids"/>
</title-group>
{
"resource_type": "title_group",
"id": 4,
"name": "The Best War Movies",
"external_id": null,
"title_group_type": "title_group",
"tags": "",
"acl_hash": null,
"self_link": "https://movida.bebanjo.net/api/title_groups/4",
"titles_link": "https://movida.bebanjo.net/api/title_groups/4/titles",
"schedule_link": "https://movida.bebanjo.net/api/title_groups/4/schedule",
"images_link": "https://movida.bebanjo.net/api/title_groups/4/images",
"metadata_link": "https://movida.bebanjo.net/api/title_groups/4/metadata",
"rules_link": "https://movida.bebanjo.net/api/title_groups/4/rules",
"collection_entries_link": "https://movida.bebanjo.net/api/title_groups/4/collection_entries",
"clips_link": "https://movida.bebanjo.net/api/title_groups/4/clips",
"note_link": "https://movida.bebanjo.net/api/title_groups/4/note",
"external_ids_link": "https://movida.bebanjo.net/api/title_groups/4/external_ids"
}
In the case of a series, we just need to add the proper type
:
$ cat series.xml
$ cat series.json
<title-group>
<name>IT Crowd</name>
<title-group-type>series</title-group-type>
</title-group>
{
"name": "IT Crowd",
"title_group_type": "series"
}
$ curl --digest -u robot_user:password -H "Content-Type: application/xml" -X POST -d @series.xml "https://movida.bebanjo.net/api/title_groups"
$ curl --digest -u robot_user:password -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d @series.json "https://movida.bebanjo.net/api/title_groups"
<?xml version="1.0" encoding="UTF-8"?>
<title-group>
<id type="integer">6</id>
<name>IT Crowd</name>
<external-id nil="true"></external-id>
<title-group-type>series</title-group-type>
<season-number>1</season-number>
<season-reference-id>Winter</season-reference-id>
<tags></tags>
<acl-hash nil="true"></acl-hash>
<link rel="titles" href="https://movida.bebanjo.net/api/title_groups/6/titles"/>
<link rel="schedule" href="https://movida.bebanjo.net/api/title_groups/6/schedule"/>
<link rel="self" href="https://movida.bebanjo.net/api/title_groups/6"/>
<link rel="metadata" href="https://movida.bebanjo.net/api/title_groups/6/metadata"/>
<link rel="images" href="https://movida.bebanjo.net/api/title_groups/6/images"/>
<link rel="clips" href="https://movida.bebanjo.net/api/title_groups/6/clips"/>
<link rel="external_ids" href="https://movida.bebanjo.net/api/title_groups/6/external_ids"/>
</title-group>
{
"resource_type": "title_group",
"id": 6,
"name": "IT Crowd",
"external_id": null,
"title_group_type": "series",
"tags": "",
"acl_hash": null,
"self_link": "https://movida.bebanjo.net/api/title_groups/6",
"titles_link": "https://movida.bebanjo.net/api/title_groups/6/titles",
"schedule_link": "https://movida.bebanjo.net/api/title_groups/6/schedule",
"images_link": "https://movida.bebanjo.net/api/title_groups/6/images",
"metadata_link": "https://movida.bebanjo.net/api/title_groups/6/metadata",
"blackouts_link": "https://movida.bebanjo.net/api/title_groups/6/blackouts",
"rights_link": "https://movida.bebanjo.net/api/title_groups/6/rights",
"denied_rights_link": "https://movida.bebanjo.net/api/title_groups/6/denied_rights",
"rules_link": "https://movida.bebanjo.net/api/title_groups/6/rules",
"clips_link": "https://movida.bebanjo.net/api/title_groups/6/clips",
"note_link": "https://movida.bebanjo.net/api/title_groups/6/note",
"external_ids_link": "https://movida.bebanjo.net/api/title_groups/6/external_ids"
}
Creating series with episodes
In the case of a series, you can include the episodes and create them all together with the series. It can be done in a similar fashion to expanding the titles
link when fetching a series:
$ cat series.xml
$ cat series.json
<title-group>
<name>IT Crowd</name>
<title-group-type>series</title-group-type>
<external-id>12300000</external-id>
<season-number>1</season-number>
<season-reference-id>Winter</season-reference-id>
<link rel="titles">
<titles type="array">
<title>
<name>Episode 1</name>
<episode-number>1</episode-number>
<external-id>12300001</external-id>
<title-type>episode</title-type>
</title>
<title>
<name>Episode 2</name>
<episode-number>2</episode-number>
<external-id>12300002</external-id>
<title-type>episode</title-type>
</title>
<title>
<name>Episode 3</name>
<episode-number>3</episode-number>
<external-id>12300003</external-id>
<title-type>episode</title-type>
</title>
</titles>
</link>
</title-group>
{
"resource_type": "title_group",
"name": "IT Crowd",
"external_id": "12300000",
"title_group_type": "series",
"season_number": 1,
"season_reference_id": "Winter",
"titles": {
"entries": [
{
"name": "Episode 1",
"episode_number": "1",
"external_id": "12300001",
"title_type": "episode"
},
{
"name": "Episode 2",
"episode_number": "2",
"external_id": "12300002",
"title_type": "episode"
},
{
"name": "Episode 3",
"episode_number": "3",
"external_id": "12300003",
"title_type": "episode"
}
]
}
}
$ curl --digest -u robot_user:password -H "Content-Type: application/xml" -X POST -d @series.xml "https://movida.bebanjo.net/api/title_groups?expand=titles"
$ curl --digest -u robot_user:password -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d @series.json "https://movida.bebanjo.net/api/title_groups?expand=titles"
<?xml version="1.0" encoding="UTF-8"?>
<title-group>
<id type="integer">9</id>
<name>IT Crowd</name>
<external-id>12300000</external-id>
<title-group-type>series</title-group-type>
<season-number>1</season-number>
<season-reference-id>Winter</season-reference-id>
<tags></tags>
<acl-hash nil="true"></acl-hash>
<link rel="titles" href="https://movida.bebanjo.net/api/title_groups/9/titles">
<titles type="array">
<title>
<id type="integer">13</id>
<name>Episode 1</name>
<episode-number type="integer">1</episode-number>
<title>E01, Episode 1</title>
<external-id>12300001</external-id>
<title-type>episode</title-type>
<tags></tags>
<acl-hash nil="true"></acl-hash>
<link rel="self" href="https://movida.bebanjo.net/api/titles/13"/>
<link rel="schedule" href="https://movida.bebanjo.net/api/titles/13/schedule"/>
<link rel="linear_schedulings" href="https://movida.bebanjo.net/api/titles/13/linear_schedulings"/>
<link rel="availability_windows" href="https://movida.bebanjo.net/api/titles/13/availability_windows"/>
<link rel="series" href="https://movida.bebanjo.net/api/title_groups/9"/>
<link rel="title_groups" href="https://movida.bebanjo.net/api/titles/13/title_groups"/>
<link rel="licensor" href="https://movida.bebanjo.net/api/licensors/3"/>
<link rel="images" href="https://movida.bebanjo.net/api/titles/13/images"/>
<link rel="assets" href="https://movida.bebanjo.net/api/titles/13/assets"/>
<link rel="metadata" href="https://movida.bebanjo.net/api/titles/13/metadata"/>
<link rel="clips" href="https://movida.bebanjo.net/api/titles/13/clips"/>
<link rel="credits" href="https://movida.bebanjo.net/api/titles/13/credits"/>
<link rel="note" href="https://movida.bebanjo.net/api/titles/13/note"/>
<link rel="external_ids" href="https://movida.bebanjo.net/api/titles/13/external_ids"/>
</title>
<title>
<id type="integer">14</id>
<name>Episode 2</name>
<episode-number type="integer">2</episode-number>
<title>E02, Episode 2</title>
<external-id>12300002</external-id>
<title-type>episode</title-type>
<tags></tags>
<acl-hash nil="true"></acl-hash>
<link rel="self" href="https://movida.bebanjo.net/api/titles/14"/>
<link rel="schedule" href="https://movida.bebanjo.net/api/titles/14/schedule"/>
<link rel="linear_schedulings" href="https://movida.bebanjo.net/api/titles/14/linear_schedulings"/>
<link rel="availability_windows" href="https://movida.bebanjo.net/api/titles/14/availability_windows"/>
<link rel="series" href="https://movida.bebanjo.net/api/title_groups/9"/>
<link rel="title_groups" href="https://movida.bebanjo.net/api/titles/14/title_groups"/>
<link rel="licensor" href="https://movida.bebanjo.net/api/licensors/3"/>
<link rel="images" href="https://movida.bebanjo.net/api/titles/14/images"/>
<link rel="assets" href="https://movida.bebanjo.net/api/titles/14/assets"/>
<link rel="metadata" href="https://movida.bebanjo.net/api/titles/14/metadata"/>
<link rel="clips" href="https://movida.bebanjo.net/api/titles/14/clips"/>
<link rel="credits" href="https://movida.bebanjo.net/api/titles/14/credits"/>
<link rel="note" href="https://movida.bebanjo.net/api/titles/14/note"/>
<link rel="external_ids" href="https://movida.bebanjo.net/api/titles/14/external_ids"/>
</title>
<title>
<id type="integer">15</id>
<name>Episode 3</name>
<episode-number type="integer">3</episode-number>
<title>E03, Episode 3</title>
<external-id>12300003</external-id>
<title-type>episode</title-type>
<tags></tags>
<acl-hash nil="true"></acl-hash>
<link rel="self" href="https://movida.bebanjo.net/api/titles/15"/>
<link rel="schedule" href="https://movida.bebanjo.net/api/titles/15/schedule"/>
<link rel="linear_schedulings" href="https://movida.bebanjo.net/api/titles/15/linear_schedulings"/>
<link rel="availability_windows" href="https://movida.bebanjo.net/api/titles/15/availability_windows"/>
<link rel="series" href="https://movida.bebanjo.net/api/title_groups/9"/>
<link rel="title_groups" href="https://movida.bebanjo.net/api/titles/15/title_groups"/>
<link rel="licensor" href="https://movida.bebanjo.net/api/licensors/3"/>
<link rel="images" href="https://movida.bebanjo.net/api/titles/15/images"/>
<link rel="assets" href="https://movida.bebanjo.net/api/titles/15/assets"/>
<link rel="metadata" href="https://movida.bebanjo.net/api/titles/15/metadata"/>
<link rel="clips" href="https://movida.bebanjo.net/api/titles/15/clips"/>
<link rel="credits" href="https://movida.bebanjo.net/api/titles/15/credits"/>
<link rel="note" href="https://movida.bebanjo.net/api/titles/15/note"/>
<link rel="external_ids" href="https://movida.bebanjo.net/api/titles/15/external_ids"/>
</title>
</titles>
</link>
<link rel="schedule" href="https://movida.bebanjo.net/api/title_groups/9/schedule"/>
<link rel="self" href="https://movida.bebanjo.net/api/title_groups/9"/>
<link rel="metadata" href="https://movida.bebanjo.net/api/title_groups/9/metadata"/>
<link rel="images" href="https://movida.bebanjo.net/api/title_groups/9/images"/>
<link rel="clips" href="https://movida.bebanjo.net/api/title_groups/9/clips"/>
<link rel="external_ids" href="https://movida.bebanjo.net/api/title_groups/9/external_ids"/>
</title-group>
{
"resource_type": "title_group",
"id": 9,
"name": "IT Crowd",
"external_id": "12300000",
"title_group_type": "series",
"season_number": 1,
"season_reference_id": "Winter",
"tags": "",
"acl_hash": null,
"titles_link": "https://movida.bebanjo.net/api/title_groups/9/titles",
"titles": {
"entries": [
{
"resource_type": "title",
"id": 13,
"name": "Episode 1",
"episode_number": 1,
"title": "E01, Episode 1",
"external_id": "12300001",
"title_type": "episode",
"tags": "",
"acl_hash": null,
"self_link": "https://movida.bebanjo.net/api/titles/13",
"schedule_link": "https://movida.bebanjo.net/api/titles/13/schedule",
"linear_schedulings_link": "https://movida.bebanjo.net/api/titles/13/linear_schedulings",
"availability_windows_link": "https://movida.bebanjo.net/api/titles/13/availability_windows",
"series_link": "https://movida.bebanjo.net/api/title_groups/215",
"title_groups_link": "https://movida.bebanjo.net/api/titles/13/title_groups",
"licensor_link": "https://movida.bebanjo.net/api/licensors/3",
"images_link": "https://movida.bebanjo.net/api/titles/13/images",
"assets_link": "https://movida.bebanjo.net/api/titles/13/assets",
"metadata_link": "https://movida.bebanjo.net/api/titles/13/metadata",
"clips_link": "https://movida.bebanjo.net/api/titles/13/clips",
"credits_link": "https://movida.bebanjo.net/api/titles/13/credits",
"note_link": "https://movida.bebanjo.net/api/titles/13/note",
"external_ids_link": "https://movida.bebanjo.net/api/titles/13/external_ids"
},
{
"resource_type": "title",
"id": 14,
"name": "Episode 2",
"episode_number": 2,
"title": "E02, Episode 2",
"external_id": "12300002",
"title_type": "episode",
"tags": "",
"acl_hash": null,
"self_link": "https://movida.bebanjo.net/api/titles/14",
"schedule_link": "https://movida.bebanjo.net/api/titles/14/schedule",
"linear_schedulings_link": "https://movida.bebanjo.net/api/titles/14/linear_schedulings",
"availability_windows_link": "https://movida.bebanjo.net/api/titles/14/availability_windows",
"series_link": "https://movida.bebanjo.net/api/title_groups/215",
"title_groups_link": "https://movida.bebanjo.net/api/titles/14/title_groups",
"licensor_link": "https://movida.bebanjo.net/api/licensors/3",
"images_link": "https://movida.bebanjo.net/api/titles/14/images",
"assets_link": "https://movida.bebanjo.net/api/titles/14/assets",
"metadata_link": "https://movida.bebanjo.net/api/titles/14/metadata",
"clips_link": "https://movida.bebanjo.net/api/titles/14/clips",
"credits_link": "https://movida.bebanjo.net/api/titles/14/credits",
"note_link": "https://movida.bebanjo.net/api/titles/14/note",
"external_ids_link": "https://movida.bebanjo.net/api/titles/14/external_ids"
},
{
"resource_type": "title",
"id": 15,
"name": "Episode 3",
"episode_number": 3,
"title": "E03, Episode 3",
"external_id": "12300003",
"title_type": "episode",
"tags": "",
"acl_hash": null,
"self_link": "https://movida.bebanjo.net/api/titles/15",
"schedule_link": "https://movida.bebanjo.net/api/titles/15/schedule",
"linear_schedulings_link": "https://movida.bebanjo.net/api/titles/15/linear_schedulings",
"availability_windows_link": "https://movida.bebanjo.net/api/titles/15/availability_windows",
"series_link": "https://movida.bebanjo.net/api/title_groups/215",
"title_groups_link": "https://movida.bebanjo.net/api/titles/15/title_groups",
"licensor_link": "https://movida.bebanjo.net/api/licensors/3",
"images_link": "https://movida.bebanjo.net/api/titles/15/images",
"assets_link": "https://movida.bebanjo.net/api/titles/15/assets",
"metadata_link": "https://movida.bebanjo.net/api/titles/15/metadata",
"clips_link": "https://movida.bebanjo.net/api/titles/15/clips",
"credits_link": "https://movida.bebanjo.net/api/titles/15/credits",
"note_link": "https://movida.bebanjo.net/api/titles/15/note",
"external_ids_link": "https://movida.bebanjo.net/api/titles/15/external_ids"
}
]
},
"schedule_link": "https://movida.bebanjo.net/api/title_groups/9/schedule",
"images_link": "https://movida.bebanjo.net/api/title_groups/9/images",
"metadata_link": "https://movida.bebanjo.net/api/title_groups/9/metadata",
"blackouts_link": "https://movida.bebanjo.net/api/title_groups/9/blackouts",
"rights_link": "https://movida.bebanjo.net/api/title_groups/9/rights",
"denied_rights_link": "https://movida.bebanjo.net/api/title_groups/9/denied_rights",
"rules_link": "https://movida.bebanjo.net/api/title_groups/9/rules",
"credits_link": "https://movida.bebanjo.net/api/title_groups/9/credits",
"clips_link": "https://movida.bebanjo.net/api/title_groups/9/clips",
"note_link": "https://movida.bebanjo.net/api/title_groups/9/note",
"external_ids_link": "https://movida.bebanjo.net/api/title_groups/9/external_ids"
}
Updating and deleting title groups
As our introduction to REST APIs page suggests, you can update and delete title groups issuing PUT
and DELETE
requests to each title groups URL:
$ cat series.xml
$ cat series.json
<title-group>
<name>IT Crowd Season 1</name>
</title-group>
{
"name": "IT Crowd Season 1"
}
$ curl --digest -u robot_user:password -H "Content-Type: application/xml" -X PUT -d @series.xml "https://movida.bebanjo.net/api/title_groups/9"
$ curl --digest -u robot_user:password -H "Content-Type: application/json" -H "Accept: application/json" -X PUT -d @series.json "https://movida.bebanjo.net/api/title_groups/9"
<?xml version="1.0" encoding="UTF-8"?>
<title-group>
<id type="integer">9</id>
<name>IT Crowd Season 1</name>
<external-id>12300000</external-id>
<title-group-type>series</title-group-type>
<season-number>1</season-number>
<season-reference-id>Winter</season-reference-id>
<tags></tags>
<acl-hash nil="true"></acl-hash>
<link rel="titles" href="https://movida.bebanjo.net/api/title_groups/9/titles"/>
<link rel="schedule" href="https://movida.bebanjo.net/api/title_groups/9/schedule"/>
<link rel="self" href="https://movida.bebanjo.net/api/title_groups/9"/>
<link rel="metadata" href="https://movida.bebanjo.net/api/title_groups/9/metadata"/>
<link rel="images" href="https://movida.bebanjo.net/api/title_groups/9/images"/>
<link rel="clips" href="https://movida.bebanjo.net/api/title_groups/9/clips"/>
<link rel="external_ids" href="https://movida.bebanjo.net/api/title_groups/9/external_ids"/>
</title-group>
{
"resource_type": "title_group",
"id": 9,
"name": "IT Crowd Season 1",
"external_id": null,
"title_group_type": "series",
"season_number": 1,
"season_reference_id": "Winter",
"tags": "",
"acl_hash": null,
"self_link": "https://movida.bebanjo.net/api/title_groups/9",
"titles_link": "https://movida.bebanjo.net/api/title_groups/9/titles",
"schedule_link": "https://movida.bebanjo.net/api/title_groups/9/schedule",
"images_link": "https://movida.bebanjo.net/api/title_groups/9/images",
"metadata_link": "https://movida.bebanjo.net/api/title_groups/9/metadata",
"blackouts_link": "https://movida.bebanjo.net/api/title_groups/9/blackouts",
"rights_link": "https://movida.bebanjo.net/api/title_groups/9/rights",
"denied_rights_link": "https://movida.bebanjo.net/api/title_groups/9/denied_rights",
"rules_link": "https://movida.bebanjo.net/api/title_groups/9/rules",
"clips_link": "https://movida.bebanjo.net/api/title_groups/9/clips",
"note_link": "https://movida.bebanjo.net/api/title_groups/9/note",
"external_ids_link": "https://movida.bebanjo.net/api/title_groups/9/external_ids"
}
$ curl --digest -u robot_user:password -H "Content-Type: application/xml" -X DELETE "https://movida.bebanjo.net/api/title_groups/9"
$ curl --digest -u robot_user:password -H "Accept: application/json" -X DELETE "https://movida.bebanjo.net/api/title_groups/9"
If the type of the title group removed is series, then associated episodes will also be removed.
Title groups and brands
Title Groups (both series and collections) can optionally belong to a brand.
This is how a title group belonging to a brand will look like in the API (notice the additional link rel="brand"
only present when the Title Group belongs to a Brand):
<?xml version="1.0" encoding="UTF-8"?>
<title-group>
<id type="integer">9</id>
<name>IT Crowd</name>
<external-id nil="true"/>
<title-group-type>series</title-group-type>
<season-number type="integer">1</season-number>
<season-reference-id>Winter</season-reference-id>
<tags></tags>
<acl-hash nil="true"></acl-hash>
<link rel="self" href="https://movida.bebanjo.net/api/title_groups/9"/>
<link rel="titles" href="https://movida.bebanjo.net/api/title_groups/9/titles"/>
<link rel="schedule" href="https://movida.bebanjo.net/api/title_groups/9/schedule"/>
<link rel="images" href="https://movida.bebanjo.net/api/title_groups/9/images"/>
<link rel="brand" href="https://movida.bebanjo.net/api/brands/75936"/>
<link rel="metadata" href="https://movida.bebanjo.net/api/title_groups/9/metadata"/>
<link rel="blackouts" href="https://movida.bebanjo.net/api/title_groups/9/blackouts"/>
<link rel="rights" href="https://movida.bebanjo.net/api/title_groups/9/rights"/>
<link rel="denied_rights" href="https://movida.bebanjo.net/api/title_groups/9/denied_rights"/>
<link rel="rules" href="https://movida.bebanjo.net/api/title_groups/9/rules"/>
<link rel="clips" href="https://movida.bebanjo.net/api/title_groups/9/clips"/>
<link rel="note" href="https://movida.bebanjo.net/api/title_groups/9/note"/>
<link rel="external_ids" href="https://movida.bebanjo.net/api/title_groups/9/external_ids"/>
</title-group>
{
"resource_type": "title_group",
"id": 9,
"name": "IT Crowd Season 1",
"external_id": "12300000",
"title_group_type": "series",
"season_number": 1,
"season_reference_id": "Winter",
"tags": "",
"acl_hash": null,
"self_link": "https://movida.bebanjo.net/api/title_groups/9",
"titles_link": "https://movida.bebanjo.net/api/title_groups/9/titles",
"schedule_link": "https://movida.bebanjo.net/api/title_groups/9/schedule",
"images_link": "https://movida.bebanjo.net/api/title_groups/9/images",
"brand_link": "https://movida.bebanjo.net/api/brands/75936",
"metadata_link": "https://movida.bebanjo.net/api/title_groups/9/metadata",
"blackouts_link": "https://movida.bebanjo.net/api/title_groups/9/blackouts",
"rights_link": "https://movida.bebanjo.net/api/title_groups/9/rights",
"denied_rights_link": "https://movida.bebanjo.net/api/title_groups/9/denied_rights",
"rules_link": "https://movida.bebanjo.net/api/title_groups/9/rules",
"clips_link": "https://movida.bebanjo.net/api/title_groups/9/clips",
"note_link": "https://movida.bebanjo.net/api/title_groups/9/note",
"external_ids_link": "https://movida.bebanjo.net/api/title_groups/9/external_ids"
}
You can make a Title Group belong to a Brand using the API just by including the link rel="brand"
pointing to an existing Brand when you create or update the Title Group as described earlier in this page.
Alternatively, you can POST the XML/JSON representation of a Series or a Collection to the link rel="series"
or rel="collections"
of an existing Brand. The new Series or Collection created will belong to that Brand.
To remove an existing title group from a brand, the link node in XML payload should look like this: <link rel="brand" href=""/>