Common/video/v1.1/VideoEntity

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

ResponseTypeDescription
associatedAlbums AssociatedAlbum [ ] Albums associated with the movie or program, returned only if the request specified an include=associatedalbums argument.
associatedAlbumsUri string The customized Video/AssociatedAlbums request, returned only if associated albums are available.
associatedTracks AssociatedTrack [ ] Songs associated with the movie or program, returned only if the request specified an include=associatedtracks argument.
associatedTracksUri string The customized Video/AssociatedTracks request, returned only if associated songs are available.
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.
clip null Reserved for future use.
clipUri string The customized Video/Clip request, returned only if video clips are available.
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 IDs for the movie or program that are recognized by Rovi DVDs or Rovi Video.
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 keywords 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.
moods VideoMood [ ] Terms that describe expressive characteristics of the movie or program, returned only if the request specified an include=moods argument.
moodsUri string The customized Video/Moods request, returned only if the data is available.
movieRating Rating Local film rating of a movie.
mpaaRating Rating MPAA rating of a movie.
originalAirDate DateTime When the program was first broadcast.
originalTitle string Original title of the movie or program in fewer than 256 characters.
originCountries string [ ] Countries of origin as recognized by different legal jurisdictions. Principal locations of the companies or individuals that produced the movie or program and its accompanying material, such as scripts, synopses, shot lists, inventory lists, publicity material, production records, etc.
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.
programLanguageCode string Language of the program title, synopsis, and keywords in the response, stated as a two-character ISO 639 language code.
programType ProgramType Type of program: movie, episode, etc.
related related Related movies or programs, returned only if the request specified an include=related argument.
relatedUri string The customized Video/Related request, returned only if the data is available.
releaseYear integer Year the program was released.
requestedId string The ID in the request that applies to this response object.
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.
schedule schedule Upcoming television broadcasts of the program, returned only if the request specified the serviceid and include=schedule arguments.
scheduleUri string The customized Video/Schedule request, returned only if serviceid is specified in the request and the movie or program is appearing in an upcoming broadcast on the television service.
seasonNumber integer For an episode in a TV series, the season of the TV series that the episode is in.
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:
seasonSequence integer For an episode in a TV series, the episode number in the season, counting from the first episode of the season.
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
seriesSequence integer For an episode in a TV series, the episode number in the series, counting from the first episode of the TV series.
starRating integer Rovi editorial rating of the program.
streamable integer Whether a program is available for streaming: 1 for true or 0 for false.
subcategory string Subcategory of television program: crime drama, animated comedy, etc.
syndicated Boolean Whether the program is syndicated: true or false.
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.
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.
tvRating Rating Local television rating of the program.
web web Internet information resources about a movie or TV program, returned only if the request specified an include=web argument.
webUri string The customized Video/Web request, returned only if the data is available.

XML Response Example

<Video>
  <ids>
        <amgMovieId i:nil="true" />
        <cosmoId>55394</cosmoId>
        <iguideId>55394</iguideId>
  </ids>
  <seriesIds i:nil="true" />
  <copyText>Blockbuster sequel with Arnold Schwarzenegger protecting a teen (Edward Furlong) from a rival cyborg. Sarah: Linda Hamilton. T-1000: Robert Patrick. Dr. Silberman: Earl Boen. Dyson: Joe Morton. Tarissa: S. Epatha Merkerson. Directed and co-written by James Cameron.</copyText>
  <copyTextLanguage>English</copyTextLanguage>
  <copyTextSource i:nil="true" />
  <cuttingPositions>124,148,174,193,223</cuttingPositions>
  <masterTitle>Terminator 2: Judgment Day</masterTitle>
  <secondaryTitle />
  <category>Movie</category>
  <color>Color</color>
  <lastAirDate i:nil="true" />
  <originalAirDate i:nil="true" />
  <programType>Movie</programType>
  <releaseYear>1991</releaseYear>
  <duration>136</duration>
  <subcategory>sci-fi</subcategory>
  <syndicated>false</syndicated>
  <programLanguage>English</programLanguage>
  <partNumber i:nil="true" />
  <partTotal i:nil="true" />
  <streamable>1</streamable>
  <movieRating>R</movieRating>
  <parentalRatings>
        <ParentalRating>
          <ratingType>Austria TV</ratingType>
          <rating>16</rating>
          <reasons
                xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
        </ParentalRating>
        <ParentalRating>
          <ratingType>Belgium TV</ratingType>
          <rating>12</rating>
          <reasons
                xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
        </ParentalRating>
        <ParentalRating>
          <ratingType>Finland TV</ratingType>
          <rating>K15</rating>
          <reasons
                xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
        </ParentalRating>
        <ParentalRating>
          <ratingType>France TV</ratingType>
          <rating>12</rating>
          <reasons
                xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
        </ParentalRating>
        <ParentalRating>
          <ratingType>Germany TV</ratingType>
          <rating>FSK: 16</rating>
          <reasons
                xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
        </ParentalRating>
        <ParentalRating>
          <ratingType>MPAA</ratingType>
          <rating>R</rating>
          <reasons
                xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <a:string>SL</a:string>
                <a:string>V</a:string>
          </reasons>
        </ParentalRating>
        <ParentalRating>
          <ratingType>OFRB</ratingType>
          <rating>NR</rating>
          <reasons
                xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <a:string>BV</a:string>
                <a:string>FS</a:string>
                <a:string>CL</a:string>
          </reasons>
        </ParentalRating>
        <ParentalRating>
          <ratingType>RCQ</ratingType>
          <rating>13+</rating>
          <reasons
                xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
        </ParentalRating>
        <ParentalRating>
          <ratingType>Spain TV</ratingType>
          <rating>18</rating>
          <reasons
                xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
        </ParentalRating>
        <ParentalRating>
          <ratingType>United Kingdom TV</ratingType>
          <rating>15</rating>
          <reasons
                xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
        </ParentalRating>
        <ParentalRating>
          <ratingType>US TV</ratingType>
          <rating>None</rating>
          <reasons
                xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
        </ParentalRating>
  </parentalRatings>
  <starRating>3</starRating>
  <tvRating>None</tvRating>
  <mpaaRating>R</mpaaRating>
  <cast i:nil="true" />
  <castUri>http://localhost/v1.1/video/cast?format=xml&amp;apikey=1&amp;cosmoid=55394
  </castUri>
  <crew i:nil="true" />
  <crewUri>http://localhost/v1.1/video/crew?format=xml&amp;apikey=1&amp;cosmoid=55394
  </crewUri>
  <awards i:nil="true" />
  <awardsUri>http://localhost/v1.1/video/awards?format=xml&amp;apikey=1&amp;cosmoid=55394
  </awardsUri>
  <images i:nil="true" />
  <imagesUri>http://localhost/v1.1/video/images?format=xml&amp;apikey=1&amp;cosmoid=55394
  </imagesUri>
  <clip i:nil="true" />
  <clipUri>http://localhost/v1.1/video/clip?format=xml&amp;apikey=1&amp;cosmoid=55394
  </clipUri>
  <seasons i:nil="true" />
  <seasonsUri i:nil="true" />
  <variants i:nil="true" />
  <variantsUri>http://localhost/v1.1/video/variants?format=xml&amp;apikey=1&amp;cosmoid=55394
  </variantsUri>
  <schedule i:nil="true" />
  <scheduleUri i:nil="true" />
  <event i:nil="true" />
  <eventUri i:nil="true" />
  <keywords i:nil="true" />
  <keywordsUri>http://localhost/v1.1/video/keywords?format=xml&amp;apikey=1&amp;cosmoid=55394
  </keywordsUri>
  <moods i:nil="true" />
  <moodsUri>http://localhost/v1.1/video/moods?format=xml&amp;apikey=1&amp;cosmoid=55394
  </moodsUri>
  <related i:nil="true" />
  <relatedUri>http://localhost/v1.1/video/related?format=xml&amp;apikey=1&amp;cosmoid=55394
  </relatedUri>
  <themes i:nil="true" />
  <themesUri>http://localhost/v1.1/video/themes?format=xml&amp;apikey=1&amp;cosmoid=55394
  </themesUri>
  <tones i:nil="true" />
  <tonesUri>http://localhost/v1.1/video/tones?format=xml&amp;apikey=1&amp;cosmoid=55394
  </tonesUri>
  <requestedId>55394</requestedId>
</Video>

JSON Response Example

The following example has been formatted with extra spaces and carriage returns to make it easy to read.
{
  "ids":{
        "amgMovieId":null,
        "cosmoId":"55394",
        "iguideId":55394
  },
  "seriesIds":null,
  "copyText":"Blockbuster sequel with Arnold Schwarzenegger protecting a teen (Edward Furlong) from a rival cyborg. Sarah: Linda Hamilton. T-1000: Robert Patrick. Dr. Silberman: Earl Boen. Dyson: Joe Morton. Tarissa: S. Epatha Merkerson. Directed and co-written by James Cameron.",
  "copyTextLanguage":"English",
  "copyTextSource":null,
  "cuttingPositions":"124,148,174,193,223",
  "masterTitle":"Terminator 2: Judgment Day",
  "secondaryTitle":"",
  "category":"Movie",
  "color":"Color",
  "lastAirDate":null,
  "originalAirDate":null,
  "programType":"Movie",
  "releaseYear":1991,
  "duration":136,
  "subcategory":"sci-fi",
  "syndicated":false,
  "programLanguage":"English",
  "partNumber":null,
  "partTotal":null,
  "streamable":1,
  "movieRating":"R",
  "parentalRatings":[
        {
          "ratingType":"Austria TV",
          "rating":"16",
          "reasons":[
               
          ]
        },
        {
          "ratingType":"Belgium TV",
          "rating":"12",
          "reasons":[
               
          ]
        },
        {
          "ratingType":"Finland TV",
          "rating":"K15",
          "reasons":[
               
          ]
        },
        {
          "ratingType":"France TV",
          "rating":"12",
          "reasons":[
               
          ]
        },
        {
          "ratingType":"Germany TV",
          "rating":"FSK: 16",
          "reasons":[
               
          ]
        },
        {
          "ratingType":"MPAA",
          "rating":"R",
          "reasons":[
                "SL",
                "V"
          ]
        },
        {
          "ratingType":"OFRB",
          "rating":"NR",
          "reasons":[
                "BV",
                "FS",
                "CL"
          ]
        },
        {
          "ratingType":"RCQ",
          "rating":"13+",
          "reasons":[
               
          ]
        },
        {
          "ratingType":"Spain TV",
          "rating":"18",
          "reasons":[
               
          ]
        },
        {
          "ratingType":"United Kingdom TV",
          "rating":"15",
          "reasons":[
               
          ]
        },
        {
          "ratingType":"US TV",
          "rating":"None",
          "reasons":[
               
          ]
        }
  ],
  "starRating":3,
  "tvRating":"None",
  "mpaaRating":"R",
  "cast":null,
  "castUri":"http:\/\/localhost\/v1.1\/video\/cast?format=json&apikey=1&cosmoid=55394",
  "crew":null,
  "crewUri":"http:\/\/localhost\/v1.1\/video\/crew?format=json&apikey=1&cosmoid=55394",
  "awards":null,
  "awardsUri":"http:\/\/localhost\/v1.1\/video\/awards?format=json&apikey=1&cosmoid=55394",
  "images":null,
  "imagesUri":"http:\/\/localhost\/v1.1\/video\/images?format=json&apikey=1&cosmoid=55394",
  "clip":null,
  "clipUri":"http:\/\/localhost\/v1.1\/video\/clip?format=json&apikey=1&cosmoid=55394",
  "seasons":null,
  "seasonsUri":null,
  "variants":null,
  "variantsUri":"http:\/\/localhost\/v1.1\/video\/variants?format=json&apikey=1&cosmoid=55394",
  "schedule":null,
  "scheduleUri":null,
  "event":null,
  "eventUri":null,
  "keywords":null,
  "keywordsUri":"http:\/\/localhost\/v1.1\/video\/keywords?format=json&apikey=1&cosmoid=55394",
  "moods":null,
  "moodsUri":"http:\/\/localhost\/v1.1\/video\/moods?format=json&apikey=1&cosmoid=55394",
  "related":null,
  "relatedUri":"http:\/\/localhost\/v1.1\/video\/related?format=json&apikey=1&cosmoid=55394",
  "themes":null,
  "themesUri":"http:\/\/localhost\/v1.1\/video\/themes?format=json&apikey=1&cosmoid=55394",
  "tones":null,
  "tonesUri":"http:\/\/localhost\/v1.1\/video\/tones?format=json&apikey=1&cosmoid=55394",
  "requestedId":"55394"
}
 
Retrieved from "http://prod-doc.rovicorp.com/mashery/index.php/Common/video/v1.1/VideoEntity"
Personal tools