V1.Metadata.Common: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: Your access to this data is governed by your subscription level.

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 All of the IDs for the movie or program that are, or will be, recognized by the Video Service:
  • iguideId
  • cosmoId
  • amgMovieId

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.
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 Int 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 Int 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/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\/video\/season\/7\/info?format=json&apikey=4p1k3y&cosmoid=4180581",
   "episodesUri":"http:\/\/api.rovicorp.com\/v1\/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\/video\/season\/7\/episodes?format=json&apikey=4p1k3y&cosmoid=4180581",
   "parentalRatings":[

   ],
   "associatedMedia":[

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