Returns Video/Info requests for episodes in a season of a TV series. An optional argument includes episode titles in the response.
video/season/season/episodes? | video=video cosmoid=cosmoid iguideid=iguideid |
&apikey=apikey&sig=sig [&format=format] [&offset=offset] [&count=count] [&country=country] [&language=language] [&include=include] |
Click to re-sort
Parameter | Required | Description | |
---|---|---|---|
apikey | Yes | Access code that authorizes your request for data from Rovi. | |
season | Yes | Season number of the television series. | |
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 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 series used by the i‑Guide™ interactive digital cable TV program guide. You can get i‑Guide IDs from responses to the following requests:
Condition: The request must contain just one of these parameters:
| |
video | Conditional | Name of a television series. This returns the top search result for that name. 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:
| |
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. The current release of the API supports only US. | |
format | No | Format of the returned data: json or xml. The default is JSON. | |
include | No | Specify include=all to include title information for each episode in the response. | |
language | No | Language of the response data. This request supports only en (English). | |
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. |
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 |
---|---|---|
episodes | VideoEpisode [ ] | Video/Info requests for the episodes specified in the request and, if requested, information about the episodes. |