Common/video/v1.1/VideoEpisode

Jump to: navigation, search

VideoEpisode

Contains a Video/Info request for detailed information about an episode in a TV series and, if specified in the request, title information about the episode.

Elements

NameTypeDescription
episodeInfoUri string Customized Video/Info request for information about the episode.
ids ids IDs for the movie or program that are recognized by Rovi DVDs or Rovi Video.

This element is returned only if the request included the include=all parameter.

number string Episode number.
seriesTitle string Title of the television series. This element is returned only if the request included the include=all parameter.
title string Episode title. This element is returned only if the request included the include=all parameter.

XML Response Example

Here's an XML response for a request that included the include=all parameter.
<VideoEpisode>
  <ids>
    <amgMovieId i:nil="true"/>
    <cosmoId>15432459</cosmoId>
  </ids>
  <seriesTitle>The Simpsons</seriesTitle>
  <title>The Simpson&apos;s 138th Show Spectacular</title>
  <number>1</number>
  <episodeInfoUri>http://api.rovicorp.com/v1.1/video/info?format=xml&amp;apikey=4p1k3y&amp;cosmoid=15432459</episodeInfoUri>
</VideoEpisode>

JSON Response Example

The request for this response did not include the include=all parameter.
{
   "number":1,
   "episodeInfoUri":"http:\/\/api.rovicorp.com\/v1.1\/video\/info?format=json&apikey=4p1k3y&cosmoid=15432459"
}

JSON Response Example 2

The request for this response included the include=all parameter.
{
   "ids":{
      "amgMovieId":null,
      "cosmoId":"15432459"
   },
   "seriesTitle":"The Simpsons",
   "title":"The Simpson's 138th Show Spectacular",
   "number":1,
   "episodeInfoUri":"http:\/\/api.rovicorp.com\/v1.1\/video\/info?format=json&apikey=4p1k3y&cosmoid=15432459"
}
 
Personal tools