Common/video/v1.1/VideoSeason

Jump to: navigation, search

VideoSeason

Contains information about a season of a television series.

Elements

NameTypeDescription
associatedMedia VideoClip [ ] Data for constructing links to previews and trailers that are associated with the season. This element is returned only if the request included the include=all parameter.

Note 1: Your access to this data is governed by your subscription level.

Note 2: Data is currently unavailable for this element.

end string Year the season ended. This element is returned only if the request included the include=all parameter.
episodesUri string Request URL to Video/Info requests for all of the episodes in the season.
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 The season number.
parentalRatings ParentalRating [ ] Parental ratings for the season. This element is returned only if the request included the include=all parameter.

Note: Data is currently unavailable for this element.

seasonInfoUri string The customized Video/Season/Info request URL for information about the season. This element is not returned if the season number is 0.
start string Year the season started. This element is returned only if the request included the include=all parameter.
streamable integer Whether a program is available for streaming: 1 for true or 0 for false. This element is returned only if the request included the include=all parameter.
title string Season title.
totalEpisodes integer Total number of episodes in the season.

XML Response Example

The request for this response included the include=all parameter.
<VideoSeason>
  <number>7</number>
  <title>Season 7</title>
  <start>2010</start>
  <end>2011</end>
  <totalEpisodes>23</totalEpisodes>
  <ids>
    <amgMovieId i:nil="true"/>
    <cosmoId>17971804</cosmoId>
  </ids>
  <episodesUri>http://api.rovicorp.com/v1.1/video/season/7/episodes?format=xml&amp;apikey=4p1k3y&amp;cosmoid=4180581</episodesUri>
  <parentalRatings/>
  <associatedMedia/>
  <streamable>1</streamable>
</VideoSeason>

JSON Response Example

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

JSON Response Example 2

The request for this response included the include=all parameter.
{
   "number":"7",
   "title":"Season 7",
   "start":"2010",
   "end":"2011",
   "totalEpisodes":23,
   "ids":{
      "amgMovieId":null,
      "cosmoId":"17971804"
   },
   "episodesUri":"http:\/\/api.rovicorp.com\/v1.1\/video\/season\/7\/episodes?format=json&apikey=4p1k3y&cosmoid=4180581",
   "parentalRatings":[

   ],
   "associatedMedia":[

   ],
   "streamable":1
}
 
Retrieved from "http://prod-doc.rovicorp.com/mashery/index.php/Common/video/v1.1/VideoSeason"
Personal tools