Program (REST API)

Module description	REST API	EzCaster XML-RPC API	Rrplay XML-RPC API

Queries to control the Program module.

Command Execution

POST http://<IP_ADDR>:7901/pgm?channel=<N>&command=<cmd>

Parameter description:

POST – HTTP POST query.

<IP_ADDR> – server IP address.

<N> - Program service sequence number (starts with 1).

<cmd> - command to be sent. Supported commands:

“scte104_timesignal” - generate SCTE-104 with TimeSignal type. The query body must contain an XML-description of the generated message (see “time_signal.xml” example).

Retrieving AsRun

Query to get a report on executed broadcast events (AsRun log). The query returns an XML-document.

GET http://<IP_ADDR>:7901/as_run?module_id=<N>[&max_count=M][&datetime=YYYY-MM-DDTHH:MM:SS]

Parameter description:

GET – HTTP GET query.

<IP_ADDR> – server IP address.

module_id – Program EzCaster service sequence number (starts with 1). Each channel reserves 16 values. Examples (including reserved ones):

For Program 1 - 1-16 (where 1 - PG 1 MAIN LAYER, 2 - LAY2, etc.),

For Program 2 - 17-32 (where 17 - PG 2 MAIN LAYER, 18 - LAY2, etc.),

and so on.

max_count – filter by the number of records displayed from the end of the list (show the last M records);

datetime – filter by the time of playout start (output records with the start_time value greater than the one specified in this field). Time is specified in the YYYY-MM-DDTHH:MM:SS format.

Example of a query to the server:

http://localhost:7901/as_run?module_id=1&max_count=3&datetime=2018-03-28T13:29:00

Example of a server response:

<AsRun request_time=”2018-03-28T13:30:38.839"> <BroadCasted_Clip uri="CityViews2 HD"> <Attr name="title">CityViews2 HD</Attr> <Attr name="start_time">2018-03-28T13:29:04.560</Attr> <Attr name="end_time">2018-03-28T13:29:57.160</Attr> <Attr name="duration">00:00:52:15</Attr> <Attr name="onair"/> </BroadCasted_Clip> <BroadCasted_Clip uri="Robots 1"> <Attr name="title">Robots 1</Attr> <Attr name="start_time">2018-03-28T13:29:57.160</Attr> <Attr name="end_time">2018-03-28T13:30:24.160</Attr> <Attr name="duration">00:00:27:00</Attr> <Attr name="onair"/> </BroadCasted_Clip> <BroadCasted_Clip uri="Robots 2"> <Attr name="title">Robots 2</Attr> <Attr name="start_time">2018-03-28T13:30:24.160</Attr> <Attr name="end_time">2018-03-28T13:30:36.120</Attr> <Attr name="duration">00:00:11:24</Attr> <Attr name="onair"/> </BroadCasted_Clip> </AsRun>