Get Channel Schedule as XML (Detailed)

Overview

The Schedule XML feed, linked from the Config -> InfoVue Schedule XML, provides detailed information about a channel’s upcoming schedule in XML format. There are a number of options to help narrow down the search.

Parameters

   Parameter    Type Default Description
limit Integer 5 Limit the number of results returned
channel Integer 1 Scope results to only events that appear on this channel
categories Array [] Only show events where the associated content is in the specified category
daypart_start Time Current Time Only return events that start after this time
daypart_end Time 1 Year Only return events that end before this time.
hours Integer 1 Year Only return events that end before this time. (daypart_start + hours)
days Integer 1 Year Only return events that end before this time. (daypart_start + days)
shorter_than Time N/A Only return events that are shorter than the specified duration.
longer_than Time 00:00:00 Only return events that are longer than the specified duration.

Code Examples

* The rest of today’s events
http://myserver/xml/schedule?channel=1&limit=100&daypart_end=23:59:59
* Tomorrow’s events
http://myserver/xml/schedule?channel=2&limit=500&daypart_start=00:00:00&day_offset=1&days=1

Return

This API endpoint will always return a xml parsable response, even if no events are found within the search criteria. Here is some example output.

<schedule>
<title>Channel 1</title>
<description>Broadcast Channel 1</description>
<number>1</number>
<event>
<day>5</day>
<day_padded>05</day_padded>
<month>4</month>
<month_padded>04</month_padded>
<month_name>April</month_name>
<month_name_short>Apr</month_name_short>
<week_day>Wednesday</week_day>
<week_day_short>Wed</week_day_short>
<year>2017</year>
<year_short>17</year_short>
<date>April 05, 2017</date>
<date_short>Apr. 05, 2017</date_short>
<date_num>4/5/2017</date_num>
<date_num_padded>04/05/2017</date_num_padded>
<time_zone>EDT</time_zone>
<start_time>6:30 PM</start_time>
<start_time_padded>06:30 PM</start_time_padded>
<start_am_pm>PM</start_am_pm>
<start_hour>6</start_hour>
<start_hour_padded>06</start_hour_padded>
<start_minute_padded>30</start_minute_padded>
<start_second_padded>00</start_second_padded>
<end_time>7:30 PM</end_time>
<end_time_padded>07:30 PM</end_time_padded>
<end_am_pm>PM</end_am_pm>
<end_hour>7</end_hour>
<end_hour_padded>07</end_hour_padded>
<end_minute_padded>30</end_minute_padded>
<end_second_padded>00</end_second_padded>
<duration_hours>01</duration_hours>
<duration_minutes>00</duration_minutes>
<duration_seconds>00</duration_seconds>
<duration_in_minutes>60</duration_in_minutes>
<program>Some Program</program>
<episode>Some Episode</episode>
<description>Some Description</description>
<next_air_day>5</next_air_day>
<next_air_day_padded>05</next_air_day_padded>
<next_air_month>4</next_air_month>
<next_air_month_padded>04</next_air_month_padded>
<next_air_month_name>April</next_air_month_name>
<next_air_month_name_short>Apr</next_air_month_name_short>
<next_air_week_day>Wednesday</next_air_week_day>
<next_air_week_day_short>Wed</next_air_week_day_short>
<next_air_year>2017</next_air_year>
<next_air_year_short>17</next_air_year_short>
<next_air_date>April 05, 2017</next_air_date>
<next_air_date_short>Apr. 05, 2017</next_air_date_short>
<next_air_date_num>4/5/2017</next_air_date_num>
<next_air_date_num_padded>04/05/2017</next_air_date_num_padded>
<next_air_time_zone>EDT</next_air_time_zone>
<next_air_start_time>8:30 PM</next_air_start_time>
<next_air_start_time_padded>08:30 PM</next_air_start_time_padded>
<next_air_start_am_pm>PM</next_air_start_am_pm>
<next_air_start_hour>8</next_air_start_hour>
<next_air_start_hour_padded>08</next_air_start_hour_padded>
<next_air_start_minute_padded>30</next_air_start_minute_padded>
<next_air_start_second_padded>00</next_air_start_second_padded>
<next_air_end_time>9:30 PM</next_air_end_time>
<next_air_end_time_padded>09:30 PM</next_air_end_time_padded>
<next_air_end_am_pm>PM</next_air_end_am_pm>
<next_air_end_hour>9</next_air_end_hour>
<next_air_end_hour_padded>09</next_air_end_hour_padded>
<next_air_end_minute_padded>30</next_air_end_minute_padded>
<next_air_end_second_padded>00</next_air_end_second_padded>
</event>
</schedule>

in Config TabIV FAQs

Related Articles