Developers
How can we help you?
Linear program groups
Note: Only Mediagenix On-Demand accounts configured for Planning will expose linear program groups in the API.
The linear program group resource represents a planned series to be emitted in a given channel.
This is how a Linear program group looks through the API:
<?xml version="1.0" encoding="UTF-8"?>
<linear-program-group>
<id type="integer">15141</id>
<name>SpongeBob SquarePants: S07</name>
<episodes-selection-type>all</episodes-selection-type>
<episodes-selection></episodes-selection>
<start type="datetime">2022-01-10T06:00:00Z</start>
<frequency>weekly</frequency>
<sequence></sequence>
<repeats>1,2,3,4,5</repeats>
<max-occurrences type="integer">20</max-occurrences>
<notes nil="true"/>
<marked-as-problem type="boolean">false</marked-as-problem>
<tags></tags>
<option-name nil="true"/>
<program-count type="integer">20</program-count>
<created-at type="datetime">2021-07-28T10:56:31Z</created-at>
<updated-at type="datetime">2021-07-28T10:56:31Z</updated-at>
<link rel="self" href="https://movida.bebanjo.net/api/linear_program_groups/15141"/>
<link rel="channel" href="https://movida.bebanjo.net/api/linear_channels/326"/>
<link rel="series" href="https://movida.bebanjo.net/api/title_groups/10024850"/>
<link rel="category" href="https://movida.bebanjo.net/api/linear_categories/69"/>
<link rel="linear_programs" href="https://movida.bebanjo.net/api/linear_program_groups/15141/linear_programs"/>
</linear-program-group>
{
"resource_type": "linear_program_group",
"id": 15141,
"name": "SpongeBob SquarePants: S07",
"episodes_selection_type": "all",
"episodes_selection": "",
"start": "2022-01-10T06:00:00Z",
"frequency": "weekly",
"sequence": "",
"repeats": "1,2,3,4,5",
"max_occurrences": 20,
"notes": null,
"marked_as_problem": false,
"tags": "",
"option_name": null,
"program_count": 20,
"created_at": "2021-07-28T10:56:31Z",
"updated_at": "2021-07-28T10:56:31Z",
"self_link": "https://movida.bebanjo.net/api/linear_program_groups/15141",
"channel_link": "https://movida.bebanjo.net/api/linear_channels/326",
"series_link": "https://movida.bebanjo.net/api/title_groups/10024850",
"category_link": "https://movida.bebanjo.net/api/linear_categories/69",
"linear_programs_link": "https://movida.bebanjo.net/api/linear_program_groups/15141/linear_programs"
}
Valid attributes
-
id
(read only): Mediagenix On-Demand internal identifier of the linear program group. -
name
(read only): the name of the linear program group. -
episodes-selection-type
(read only, optional): if series link is present, the selection kind of catalogue series episodes. Can beall
,except
oronly
. -
episodes-selection
(read only, optional): if series link is present, string defining the sequence of selected programs based on theepisodes_selection_type
and the selected catalogue series. -
start
(read only): timestamp representing when the linear program group starts. -
frequency
(read only): string defining how the program group is scheduled. Can bedaily
,weekly
ormonthly
. -
sequence
(read only, optional): if series link is not present, string defining the sequence of repetitions assigned to the linear program group. -
repeats
(read only, optional): how the program repeats forweekly
ormonthly
frequency. Forweekly
frequency, it’s a list of week days (separated by commas), from0
(for Sunday) to6
(for Saturday). Formonthly
frequency, it’s a list of days (separated by commas), from1
to31
. Fordaily
frequency it’s not present. -
ends-on
(read only, optional): date limit for the linear programs repetition pattern. It is mandatory when themax-occurrences
value is not defined. -
max-occurrences
(read only, optional): integer defining the maximum number of linear programs generated by the program group. It is mandatory when theends-on
value is not defined. -
notes
(read only, optional): plain text with notes added to the linear program group. -
marked-as-problem
(read only): boolean defining if the linear program group was marked as a problem. -
tags
(read only, optional): list of tags assigned to the linear program separated by commas. -
option-name
(read only, optional): the option name where the linear program group belongs. It belongs to the Main option when it is empty. -
program-count
(read only): the number of linear programs generated by the program group. -
created-at
(read only): timestamp representing when the linear program group was created. -
updated-at
(read only): timestamp representing when the linear program group was updated for the last time.
Valid links
-
channel
: The linear channel the linear program belongs to. -
series
: The catalogue series the linear program belongs to. This link is optional. -
category
: The linear category the linear program group belongs to. This link is optional and it is only present when a category is associated. -
linear_programs
: The linear programs that belong to the linear program group.