Search

Tools

Bookmark This Page

Video/Season/0/Info

Returns Video/Info requests for unsequenced episodes in a TV series—episodes that, for one reason or another, have not been assigned to a season. An optional argument includes episode titles in the response.

Syntax

video/season/0/info?

video=video
cosmoid=cosmoid
iguideid=iguideid

&apikey=apikey&sig=sig [&format=format] [&offset=offset] [&count=count] [&country=country] [&language=language] [&include=include]

Request Example 1

Request Video/Info requests to the unsequenced episodes of The Simpsons.

http://api.rovicorp.com/data/v1/video/season/0/info?apikey=apikey&sig=sig&video=the+simpsons

Request Example 2

Request Video/Info requests to just the first two unsequenced episodes.

http://api.rovicorp.com/data/v1/video/season/0/info?apikey=apikey&sig=sigcosmoid=7903&count=2

Request Example 3

Request Video/Info requests to just the first two unsequenced episodes and include titles of each episode.

http://api.rovicorp.com/data/v1/video/season/0/info?apikey=apikey&sig=sigcosmoid=7903&count=2&
include=all

Request Example 4

Request an XML response to Request Example 3.

http://api.rovicorp.com/data/v1/video/season/0/info?apikey=apikey&sig=sigcosmoid=7903&count=2&
include=all&format=xml

Request Parameters

Click to re-sort

Parameter Required Description

apikey Yes Access code that authorizes your request for data from Rovi.

sig

Yes

A calculated authorization code. To perform the calculation, execute the MD5 function on the concatenation of the following three strings:

Your API key.
The secret key you received with your API key.
The Unix time. Unix time is a timestamp supported in most development environments, and is generally defined as the number of seconds since January 1, 1970 00:00:00 GMT.

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

Yes

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:

video
cosmoid
iguideid

iguideid

Conditional

A 24-bit program 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
cosmoid
iguideid

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:

video
cosmoid
iguideid

count

Number of items to be returned. The default is zero, which returns all items after the offset.

Use count and offset to paginate the response.

country No Country of the language of the response. 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

Number of items at the start of the returned list to skip. The default is zero.

Use count and offset to paginate the response.

Response

Response Header

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	List of the parameters 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 that is shown in the code field.
view	view	Summary of items returned in a list of items.

Response for Video/Season/0/Info

Response	Type	Description
episodes	VideoEpisode [ ]	Video/Info requests for unsequenced episodes as specified in the request and, if requested, information about the episodes.

Response Example 1

Here's the response to Request Example 2. It is formatted with extra spaces and carriage returns to make it easy to read.

{
   "status":"ok",
   "code":200,
   "messages":null,
   "build":"1.6.1.12",
   "parameters":{
      "apiKey":"4p1k3y",
      "id":"7903",
      "offset":0,
      "count":2
   },
   "view":{
      "offset":0,
      "count":2,
      "total":50
   },
   "serverName":"tul1cssw3",
   "startTime":"2011-08-09T19:36:31.8846061Z",
   "endTime":"2011-08-09T19:36:31.9002305Z",
   "duration":15,
   "parentIds":{
      "cosmoId":"7903"
   },
   "episodes":[
      {
         "episodeInfoUri":"http:\/\/api.rovicorp.com\/v1\/video\/info?format=json&apikey=4p1k3y&cosmoid=616928"
      },
      {
         "episodeInfoUri":"http:\/\/api.rovicorp.com\/v1\/video\/info?format=json&apikey=4p1k3y&cosmoid=619847"
      }
   ]
}

Response Example 2

Here's the response to Request Example 3, which included the include=all parameter.

{
   "status":"ok",
   "code":200,
   "messages":null,
   "build":"1.6.1.12",
   "parameters":{
      "apiKey":"4p1k3y",
      "id":"7903",
      "offset":0,
      "count":2,
      "include":"all"
   },
   "view":{
      "offset":0,
      "count":2,
      "total":50
   },
   "serverName":"tul1cssw3",
   "startTime":"2011-08-09T19:49:59.3535981Z",
   "endTime":"2011-08-09T19:49:59.3692225Z",
   "duration":15,
   "parentIds":{
      "cosmoId":"7903"
   },
   "episodes":[
      {
         "ids":{
            "amgMovieId":null,
            "cosmoId":"616928"
         },
         "seriestitle":"The Simpsons",
         "title":"Bart Genius",
         "episodeInfoUri":"http:\/\/api.rovicorp.com\/v1\/video\/info?format=json&apikey=4p1k3y&cosmoid=616928"
      },
      {
         "ids":{
            "amgMovieId":null,
            "cosmoId":"619847"
         },
         "seriestitle":"The Simpsons",
         "episodeInfoUri":"http:\/\/api.rovicorp.com\/v1\/video\/info?format=json&apikey=4p1k3y&cosmoid=619847"
      }
   ]
}

XML Response Example

Here's the response to Request Example 4.

<VideoEpisodes xmlns="com.rovicorp.metadataservice" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <status>ok</status>
  <code>200</code>
  <messages i:nil="true"/>
  <build>1.6.1.12</build>
  <parameters>
    <apiKey>4p1k3y</apiKey>
    <id>7903</id>
    <offset>0</offset>
    <count>2</count>
    <include>all</include>
    <format>xml</format>
  </parameters>
  <view>
    <offset>0</offset>
    <count>2</count>
    <total>50</total>
  </view>
  <serverName>tul1cssw4</serverName>
  <startTime>2011-08-09T20:04:16.4071334Z</startTime>
  <endTime>2011-08-09T20:04:16.4227583Z</endTime>
  <duration>15</duration>
  <parentIds>
    <cosmoId>7903</cosmoId>
  </parentIds>
  <episodes>
    <VideoEpisode>
      <ids>
        <amgMovieId i:nil="true"/>
        <cosmoId>616928</cosmoId>
      </ids>
      <seriestitle>The Simpsons</seriestitle>
      <title>Bart Genius</title>
      <episodeInfoUri>http://api.rovicorp.com/v1/video/info?format=xml&amp;apikey=4p1k3y&amp;cosmoid=616928</episodeInfoUri>
    </VideoEpisode>
    <VideoEpisode>
      <ids>
        <amgMovieId i:nil="true"/>
        <cosmoId>619847</cosmoId>
      </ids>
      <seriestitle>The Simpsons</seriestitle>
      <episodeInfoUri>http://api.rovicorp.com/v1/video/info?format=xml&amp;apikey=4p1k3y&amp;cosmoid=619847</episodeInfoUri>
    </VideoEpisode>
  </episodes>
</VideoEpisodes>

V1.MetaData.VideoService.Video:Season0

Topics

Search

TOOLBOX

Tools

Video/Season/0/Info

Syntax

Request Example 1

Request Example 2

Request Example 3

Request Example 4

Request Parameters

Response

Response Header

Response for Video/Season/0/Info

Response Example 1

Response Example 2

XML Response Example

See Also

Personal tools