Returns a list of upcoming television broadcasts of a movie or program.
This request may return a large amount of data. To speed data transmission, do the following:
video/schedule? | video=video cosmoid=cosmoid iguideid=iguideid |
&apikey=apikey&sig=sig&serviceid=serviceid [&format=format] [&offset=offset] [&count=count] [&country=country] [&language=language] [&localeresolution=localeresolution] [&starttime=starttime] [&duration=duration] [&inprogress=inprogress] [©texttype=copytexttype] [&titletype=titletype] [&sourceid=sourceid] [&sourceinclude=sourceinclude] [&sourceexclude=sourceexclude] |
Click to re-sort
Parameter | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apikey | Yes | Access code that authorizes your request for data from Rovi. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
serviceid | Yes | Database ID of a television service. You can get service IDs of local television services with the REST call Listings/Services or the SOAP call GetServices. For US national services, you can use any of the following service IDs:
You can limit a returned schedule with the following optional parameters:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sig | Yes | A calculated, 32-hex-digit authorization code. To perform the calculation, execute the MD5 function on the concatenation of the following three ASCII strings:
Express the alpha hex digits as lower case. Perform the calculation at the time of each request to be sure it's within a five-minute window of the server time. If you're testing the call in a browser, use our online signature generator to perform the calculation. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cosmoid | Conditional | Cosmo database ID for a movie, program, episode, or television series. Cosmo is a database of television information. You can grab Cosmo IDs from responses to the following requests:
Condition: The request must contain just one of these parameters:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
iguideid | Conditional | An ID for a television program used by the i‑Guide™ interactive digital cable TV program guide. You can get i‑Guide IDs from i‑Guide and from responses to the following requests:
Condition: The request must contain just one of these parameters:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
video | Conditional | Title of a movie, television program, or television series, or keywords from the title. This searches for the most popular title with that combination of words. Replace any spaces with plus (+) or percent20 (%20) symbols. Note: This parameter currently returns only US-English results. Support for other countries and languages will be added in the future. Condition: The request must contain just one of these parameters:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
copytexttype | No | Type of description you want returned for the program, movie, or TV series. If you specify a copy type that has no content, no description is returned.
If you do not specify a copy type, the description chosen is based on category, shown below, and the first copy type in the category that is available:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
count | No | Number of items to be returned. The default is zero, which returns all items after the offset. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
country | No | Country the language parameter applies to, stated as a two-character ISO 3166 country code. Default is the default country of the language you specify (US if language is not specified). If an invalid combination of country and language is specified, US English will be returned.
Valid country codes are:
* Includes Wales, Scotland, and Northern Ireland. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duration | No | The number of minutes the schedule will cover, from 1 to 20160. Default is 20160 (14 days).
Note: The schedule is determined by starttime, duration, and inprogress. A duration shorter than 5 minutes may miss shows starting just before or after a half-hour point. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
format | No | Format of the returned data: json or xml. The default is JSON. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
inprogress | No | Whether shows in progress at the time specified for starttime are included in the schedule: true or false. Default is false.
Note: The schedule is determined by starttime, duration, and inprogress. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
language | No | Language of the response data, stated as a two-character ISO 639 language code:
Default is en (English). If content is not available in the language requested, another language is chosen as determined by the Language Fallback Sequence table. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
localeresolution | No | How the language fallback rules should be applied for any content that is not available for the specified language and country. Currently we offer a single value that gives you the option to override the fallback rules and return the the content in the language of the specified Cosmo ID instead:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset | No | Number of items at the start of the available data to skip. The default is zero.
Use count and offset to paginate the data that is available to be returned. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sourceexclude | No | If you specify sourceid to select the television sources to be returned, sourceexclude specifies attributes of the channels in the source ID list that you want to eliminate from the channels returned. The possible values are:
You can specify multiple sourceexclude values in either of the following ways:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sourceid | No | Channel sources to be included in the results. You can get source IDs from responses to a GetServiceDetails request. Note: a single television source may supply content to multiple channels.
You can specify multiple source IDs in either of the following ways:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sourceinclude | No | If you specify sourceid to select the television sources to be returned, sourceinclude specifies an attribute of the channels in the source ID list that you want to include in the list of channels returned. The possible values are:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
starttime | No | Beginning of the time period covered by the schedule, specified as a DateTime value that is between the time of the request and two weeks in the future. The default is the time of the request.
Note: The schedule is determined by duration, inprogress, and starttime. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
titletype | No | Type of program title to return as described in the TitleType table. Most programs do not carry all title types, so we recommend using the default unless another type is required. If a program does not have the type specified, the default title is returned. |
Response | Type | Description |
---|---|---|
build | string | The software release level of the API. |
code | integer | HTTP status code. See the status field for the text part of the code. |
duration | integer | Server processing time in milliseconds. The difference between startTime and endTime. |
endTime | string | When the server sent the response (UTC time). |
messages | Message [ ] | Elements of a multiple HTTP response status message. |
parameters | parameters | The parameters that were included in the request. |
parentIds | parentIds | All of the IDs for the requested movie or program that are recognized by the Video Service. |
serverName | string | Name of the server that processed the request. |
startTime | string | When the server received the request (UTC time). |
status | string | Text part of the HTTP status code, which is shown in the code field. |
view | view | Summary of items returned in a list of items. |
Response | Type | Description |
---|---|---|
airings | VideoAiring [ ] | Broadcasts of the movie or program. |
duration | integer | Number of minutes the broadcast schedule covers. |
locale | string | Language and country code of the response. |
name | string | Name of the television service in less than 50 characters. |
serviceId | integer | Database ID of the television service. |
serviceType | string | Type of television service. |
startDateTime | string | Starting date and time of the broadcast schedule. |
timeZones | TimeZoneInfo [ ] | UTC offset applicable to a television service and when the offset begins and ends. Television broadcast times are returned in UTC time, and you need to apply the offset to calculate the local time. UTC offsets change with daylight savings time. |