V1.Metadata.Common:VideoInfo

Jump to: navigation, search

Video

Information about a movie, TV series, or TV program, plus customized requests for other content that is available through the Video API.

Elements

NameTypeDescription
awards VideoAward [ ] Awards the program has been nominated for or won, returned only if the request specified an include=awards argument.
awardsUri String The customized Video/Awards request, returned only if awards data is available.
cast VideoCast [ ] Cast information and links to images, returned only if the request specified an include=cast argument.
castUri String The customized Video/Cast request, returned only if cast data is available.
category ProgramCategory Category of television program: news, movie, sports, etc.
color ColorType Color format of the program.
crew VideoCrew [ ] Crew information and images, returned only if the request specified an include=crew argument.
crewUri String The customized Video/Crew request, returned only if crew information is available.
duration Integer Duration of a program in minutes.
episodeTitle String Title of the episode in the series.
event VideoEvent [ ] Information about the event shown in the program, returned only if the request specified an include=event argument.
eventUri String The customized Video/Event request, returned only if event information is available.
ids ids All of the IDs for the movie or program that are, or will be, recognized by the Video Service:
  • iguideId
  • cosmoId
  • amgMovieId
images Image [ ] URLs to images associated with the program, returned only if the request specified an include=images argument and your subscription level enables access to images. Images are returned in image type sequence as shown in the Image Order table. If the program is an episode, then episode images appear before images of the series master.
imagesUri String The customized Video/Images request, returned only if images are available.
keywords Keyword [ ] Keywords for the plot structure of a program, returned only if the request specified an include=keywords argument.
keywordsUri String The customized Video/Keywords request, returned only if keywords are available.
lastAirDate DateTime Last date and time the program aired.
masterTitle String Title of the movie, series, or program.
originalAirDate DateTime When the program was first broadcast.
parentalRatings ParentalRating [ ] Parental ratings assigned to the movie or program, returned only if the request specified an include=parentalratings argument.
parentalRatingsUri String The customized Video/ParentalRatings request, returned only if the data is available.
partNumber Integer Number of a program in a multipart sequence of programs.
partTotal Integer Total number of parts in a multipart sequence of programs.
programLanguage String Language of the program.
programType ProgramType Type of program: movie, episode, etc.
releaseYear Integer Year the program was released.
review review A professional review of the movie or program, returned only if the request specified an include=review argument.
reviewUri String The customized Video/Review request, returned only if the data is available.
seasons VideoSeason [ ] Links to all of the information available about seasons and episodes of a TV series, returned only if the request specified an include=seasons argument. The links include the following:
seasonsUri String The customized Video/Seasons request, returned only for a series.
secondaryTitle String Secondary title of the program (usually related to sports programs).
seriesIds seriesIds IDs for the series that the program specified in the request belongs to:
  • seriesId
  • iguideSeriesId
synopsis synopsis A synopsis of the program, returned only if the request specified an include=synopsis argument.
synopsisUri String The customized Video/Synopsis request, returned only if the data is available.
subcategory String Subcategory of television program: crime drama, animated comedy, etc.
syndicated Boolean Whether the program is syndicated: true or false.
themes theme [ ] Topics and circumstances that motivate or fit with the program, returned only if the request specified an include=themes argument.
themesUri String The customized Video/Themes request, returned only if the data is available.
tones tone [ ] Feelings that motivate or fit with the program, returned only if the request specified an include=tones argument.
tonesUri String The customized Video/Tones request, returned only if the data is available.

XML Response Example

<VideoDetail xmlns="com.rovicorp.metadataservice" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <status>ok</status>
  <code>200</code>
  <messages i:nil="true"/>
  <build>Build-Unknown-Label</build>
  <parameters>
    <apiKey>4p1k3y</apiKey>
    <id>19568724</id>
    <format>xml</format>
  </parameters>
  <serverName>tul1cstw1</serverName>
  <startTime>2011-10-17T23:59:06.6577324Z</startTime>
  <endTime>2011-10-17T23:59:07.5639824Z</endTime>
  <duration>906</duration>
  <video>
    <ids>
      <amgMovieId i:nil="true"/>
      <cosmoId>19568724</cosmoId>
      <iguideId>3923800</iguideId>
    </ids>
    <seriesIds>
      <seriesId>3899277</seriesId>
      <iguideSeriesId>3899277</iguideSeriesId>
    </seriesIds>
    <masterTitle>Two and a Half Men</masterTitle>
    <secondaryTitle/>
    <episodeTitle>Nice to Meet You, Walden Schmidt</episodeTitle>
    <category>Other</category>
    <color>Color</color>
    <lastAirDate i:nil="true"/>
    <originalAirDate>2011-09-19T00:00:00Z</originalAirDate>
    <programType>Episode</programType>
    <releaseYear>2011</releaseYear>
    <duration>30</duration>
    <subcategory>comedy</subcategory>
    <syndicated>true</syndicated>
    <programLanguage>English</programLanguage>
    <partNumber>1</partNumber>
    <partTotal>2</partTotal>
    <parentalRatings i:nil="true"/>
    <parentalRatingsUri>http://api.rovicorp.com/v1/video/parentalratings?format=xml&amp;apikey=4p1k3y&amp;cosmoid=19568724</parentalRatingsUri>
    <cast i:nil="true"/>
    <castUri>http://api.rovicorp.com/v1/video/cast?format=xml&amp;apikey=4p1k3y&amp;cosmoid=19568724</castUri>
    <crew i:nil="true"/>
    <crewUri>http://api.rovicorp.com/v1/video/crew?format=xml&amp;apikey=4p1k3y&amp;cosmoid=19568724</crewUri>
    <awards i:nil="true"/>
    <awardsUri i:nil="true"/>
    <images i:nil="true"/>
    <imagesUri>http://api.rovicorp.com/v1/video/images?format=xml&amp;apikey=4p1k3y&amp;cosmoid=19568724</imagesUri>
    <seasons i:nil="true"/>
    <seasonsUri>http://api.rovicorp.com/v1/video/seasons?format=xml&amp;apikey=4p1k3y&amp;cosmoid=19568724</seasonsUri>
    <event i:nil="true"/>
    <eventUri i:nil="true"/>
    <keywords>
      <keywords i:nil="true"/>
      <characteristics i:nil="true"/>
    </keywords>
    <keywordsUri i:nil="true"/>
    <review i:nil="true"/>
    <reviewUri i:nil="true"/>
    <synopsis i:nil="true"/>
    <synopsisUri>http://api.rovicorp.com/v1/video/synopsis?format=xml&amp;apikey=4p1k3y&amp;cosmoid=19568724</synopsisUri>
    <themes i:nil="true"/>
    <themesUri i:nil="true"/>
    <tones i:nil="true"/>
    <tonesUri i:nil="true"/>
  </video>
</VideoDetail>

JSON Response Example

{
   "status":"ok",
   "code":200,
   "messages":null,
   "build":"Build-Unknown-Label",
   "parameters":{
      "apiKey":"4p1k3y",
      "id":"19702209",
      "format":"json"
   },
   "serverName":"tul1cstw4",
   "startTime":"2011-10-17T23:42:04.6249993Z",
   "endTime":"2011-10-17T23:42:09.9376693Z",
   "duration":5312,
   "video":{
      "ids":{
         "amgMovieId":null,
         "cosmoId":"19702209",
         "iguideId":4159178
      },
      "seriesIds":{
         "seriesId":"7903",
         "iguideSeriesId":7903
      },
      "masterTitle":"The Simpsons",
      "secondaryTitle":"",
      "episodeTitle":"The Falcon and the D'Ohman",
      "category":"Other",
      "color":"Color",
      "lastAirDate":null,
      "originalAirDate":"2011-09-25T00:00:00Z",
      "programType":"Episode",
      "releaseYear":2011,
      "duration":30,
      "subcategory":"animated comedy",
      "syndicated":true,
      "programLanguage":"English",
      "partNumber":null,
      "partTotal":null,
      "parentalRatings":null,
      "parentalRatingsUri":"http:\/\/api.rovicorp.com\/v1\/video\/parentalratings?format=json&apikey=4p1k3y&cosmoid=19702209",
      "cast":null,
      "castUri":"http:\/\/api.rovicorp.com\/v1\/video\/cast?format=json&apikey=4p1k3y&cosmoid=19702209",
      "crew":null,
      "crewUri":"http:\/\/api.rovicorp.com\/v1\/video\/crew?format=json&apikey=4p1k3y&cosmoid=19702209",
      "awards":null,
      "awardsUri":null,
      "images":null,
      "imagesUri":"http:\/\/api.rovicorp.com\/v1\/video\/images?format=json&apikey=4p1k3y&cosmoid=19702209",
      "seasons":null,
      "seasonsUri":"http:\/\/api.rovicorp.com\/v1\/video\/seasons?format=json&apikey=4p1k3y&cosmoid=19702209",
      "event":null,
      "eventUri":null,
      "keywords":{
         "keywords":null,
         "characteristics":null
      },
      "keywordsUri":null,
      "review":null,
      "reviewUri":null,
      "synopsis":null,
      "synopsisUri":"http:\/\/api.rovicorp.com\/v1\/video\/synopsis?format=json&apikey=4p1k3y&cosmoid=19702209",
      "themes":null,
      "themesUri":null,
      "tones":null,
      "tonesUri":null
   }
}
 
Retrieved from "http://prod-doc.rovicorp.com/mashery/index.php/V1.Metadata.Common:VideoInfo"
Personal tools