V9.Common:Program

Jump to: navigation, search

Program

Contains information about a program.

Elements

NameTypeDescription
Category ProgramCategory Category of television program: news, movie, sports, etc.
CC Boolean Whether the program offers closed captioning: true or false.
Color ColorType Color format of the program.
CopyText String Description of the series, movie, or program in less than 2000 characters. Several types of descriptions (copy types) are available, and the copy type you specify in the request is the first one chosen. If the description for that copy type is empty, or if you do not specify a copy type, the description chosen is based on category, shown below, and the first copy type in the category that is available.

Descriptions may be formatted as text (the default) or as HTML, according to the format specified by the request.

The copy types shown below in each category define a fallback sequence. If a description is not found in one copy type, the next copy type in the list is chosen. If no description is found, nothing is returned.

CategoryCopy Type Fallback Sequence
Movie

1
4
55
54
3
5

Chrono Long
Chrono Short
Synopsis
Short Synopsis
No Cast
Grid
Series Master

3
55
54

No Cast
Synopsis
Short Synopsis
Series Episode

1
55
54
4
5

Chrono Long
Synopsis
Short Synopsis
Chrono Short
Grid
One Time Only

1
55
54
4
5

Chrono Long
Synopsis
Short Synopsis
Chrono Short
Grid
Season

36
38
39

Season description (for select series and seasons)
Critical description (not currently written)
Season essay (not currently written)
CopyTextLanguage String Language of the description returned in the CopyText element.
CopyTextSource CopyTextSource Source of the program description returned in the CopyText element. This property is not returned if no data is available.
Credits ProgramCredit [ ] The list of credits associated with the program.
CuttingPositions Integer [ ] Character positions at which you can end the description returned in the CopyText element. A cutting position is the number of the last character to include, not the first character to cut. Add a period if needed (plus, for a quote, a closing single or double quotation mark).
DataAvailabilityFlags Integer Sum of the bit mask values that indicate what data is available about the movie, series, episode, or program. For example: if Summary and Credits are available, then DataAvailbilityFlags will equal HasSummary + HasCredits (2 + 16) or 18.
1 HasReview
2 HasSummary
4 HasImages
8 HasAwards
16 HasCredits
32 HasVideo
64 HasSimilar
128 HasTVSeason
256 HasTVEpisodes
EpisodeNumber String Episode number of a program in a series in less than 10 characters.
EpisodeTitle String Title of an episode in less than 50 characters. This property is returned only for programs that have episode titles.
IsVideoAvailable Boolean Whether a preview, trailer, or other video content is available for this program.
Keywords String [ ] Localized keywords for the characteristics of a program.
LastAirDate DateTime Last date and time the program aired.
Letterbox Boolean Whether the program is available in letterbox format: true or false.
MasterTitle String Title of a series in less than 256 characters.
MovieRating Rating MPAA rating of a movie. This property is returned only for a movie.
OriginalAirDate DateTime When the program was first broadcast.
ParentalRatings ParentalRating [ ] Parental ratings assigned to the program.
PartNumber Integer Number of a program in a multipart sequence of programs.
PartTotal Integer Total number of parts in a multipart sequence of programs.
ProgramAwards Award [ ] Awards a program has been nominated for or won.
ProgramHandle Handle Program or series identifier. Note: A program may have multiple IDs to cover all of the variants, but has just one primary ID. The response returns only the primary ID for a program, so the ID returned may be different from the ID you requested.
ProgramImages Image [ ] Images associated with the program, 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.
ProgramLanguage String Language of the movie or program.
ProgramType ProgramType Type of program: movie, episode, etc.
ProgramVariant ProgramVariant [ ] Reserved for future use.
ProgramVideoClip VideoClip [ ] Reserved for future use.
ReleaseYear Integer Year the program was released.
Runtime Integer Duration of a program in minutes.
Season String The season an episode of a series was produced in, in less than 10 characters.
SeasonSequence Integer Episode number for the season in broadcast sequence.
SecondaryTitle String Secondary title of the program (usually related to sports programs).
SeriesId String ID of the series if the program is an episode, in less than 10 characters. This property is returned only for programs in a series.
SeriesSequence Integer Episode number for the series in broadcast sequence.
ShowSeasons TVSeason [ ] Seasons of the series, sorted by most recent first.
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.
Subtitled Boolean Whether the program is broadcast with subtitles.
SubtitleLanguage String Language of the subtitles for the program.
Syndicated Boolean Whether the program is syndicated: true or false.
TVObjectId Integer Deprecated program ID with less than 10 characters.
TVRating Rating Television parental rating of the program.
UnsequencedEpisodes Program [ ] Reserved for future use.

XML Response Example

<Program DataAvailabilityFlags="510">
   <ProgramHandle>
      <Id>7903</Id>
      <ProviderId>2</ProviderId>
   </ProgramHandle>
   <TvObjectId>100521</TvObjectId>
   <MasterTitle>The Simpsons</MasterTitle>
   <EpisodeTitle/>
   <CopyText>Matt Groening's subversive, animated satire about Springfield's hapless first family became a cult favorite when it premiered on Fox in 1989 after first being seen in 1987 as a short on 'The Tracey Ullman Show.' That was then; now it's TV longest running comedy. Not since 'The Flintstones' in the '60s has a cartoon series drawn such a large adult audience, and, ay caramba, given us pop-culture expressions for the ages. And in 1999, Time magazine called it the best TV show of the 20th century.</CopyText>
   <Runtime>30</Runtime>
   <ProgramType>Series</ProgramType>
   <Category>Other</Category>
   <Subcategory>animated comedy</Subcategory>
   <ReleaseYear>1989</ReleaseYear>
   <Season/>
   <EpisodeNumber/>
   <PartNumber>0</PartNumber>
   <PartTotal>0</PartTotal>
   <StarRating>0</StarRating>
   <TVRating>None</TVRating>
   <MovieRating/>
   <Subtitled>false</Subtitled>
   <Letterbox>false</Letterbox>
   <CC>true</CC>
   <Color>Color</Color>
   <OriginalAirDate>1989-12-17T00:00:00Z</OriginalAirDate>
   <Syndicated>true</Syndicated>
   <Keywords/>
   <Credits/>
   <ProgramImages/>
   <IsVideoAvailable xsi:nil="true"/>
   <SeasonSequence xsi:nil="true"/>
   <SeriesSequence xsi:nil="true"/>
   <LastAirDate xsi:nil="true"/>
   <CuttingPositions>
      <int>84</int>
      <int>211</int>
      <int>262</int>
      <int>357</int>
      <int>422</int>
   </CuttingPositions>
   <ParentalRatings>
      <ParentalRating>
         <RatingType>US TV</RatingType>
         <Rating>None</Rating>
         <Reasons/>
         <CountryCode>US</CountryCode>
      </ParentalRating>
      <ParentalRating>
         <RatingType>FCTV</RatingType>
         <Rating>8+</Rating>
         <Reasons/>
         <CountryCode>CA</CountryCode>
      </ParentalRating>
      <ParentalRating>
         <RatingType>Age Rating</RatingType>
         <Rating>11</Rating>
         <Reasons/>
         <CountryCode>US</CountryCode>
      </ParentalRating>
      <ParentalRating>
         <RatingType>Family Rating</RatingType>
         <Rating>9</Rating>
         <Reasons/>
         <CountryCode>US</CountryCode>
      </ParentalRating>
      <ParentalRating>
         <RatingType>TV Star Rating</RatingType>
         <Rating>4</Rating>
         <Reasons/>
         <CountryCode>US</CountryCode>
      </ParentalRating>
      <ParentalRating>
         <RatingType>Germany TV</RatingType>
         <Rating>FSK: 3</Rating>
         <Reasons/>
         <CountryCode>DE</CountryCode>
      </ParentalRating>
      <ParentalRating>
         <RatingType>Netherlands TV</RatingType>
         <Rating>6</Rating>
         <Reasons/>
         <CountryCode>NL</CountryCode>
      </ParentalRating>
      <ParentalRating>
         <RatingType>Belgium TV</RatingType>
         <Rating>None</Rating>
         <Reasons/>
         <CountryCode>BE</CountryCode>
      </ParentalRating>
      <ParentalRating>
         <RatingType>Denmark TV</RatingType>
         <Rating>None</Rating>
         <Reasons/>
         <CountryCode>DK</CountryCode>
      </ParentalRating>
   </ParentalRatings>
   <ProgramVariants/>
   <ProgramVideoClips/>
   <ProgramAwards/>
   <ProgramLanguage>English</ProgramLanguage>
   <CopyTextLanguage>English</CopyTextLanguage>
   <ShowSeasons/>
   <SubtitleLanguage/>
   <SecondaryTitle/>
   <UnsequencedEpisodes/>
   <Streamable>1</Streamable>
</Program>

JSON Response Example

JSON responses are available from our REST TV Listings service.
"Program":{
   "DataAvailabilityFlags":"478",
   "ProgramHandle":{
      "Id":"3899277",
      "ProviderId":2
   },
   "TvObjectId":100558,
   "MasterTitle":"Two and a Half Men",
   "EpisodeTitle":"",
   "CopyText":"A hit sitcom built on often-raunchy material, starring Charlie Sheen and, later, Ashton Kutcher begins with the premise of a Malibu bachelor (Sheen) whose life is disrupted when his brother and 10-year-old nephew move in with him. In the ninth season, Kutcher replaces Sheen, playing a billionaire with a broken heart. Briskly written and performed, the sitcom had fun spoofing Charlie Sheen's bad-boy reputation (which ultimately led to his exit from the series) and Jon Cryer's nervous energy.",
   "Runtime":30,
   "ProgramType":"Series",
   "Category":"Other",
   "Subcategory":"comedy",
   "ReleaseYear":2003,
   "Season":"",
   "EpisodeNumber":"",
   "PartNumber":0,
   "PartTotal":0,
   "StarRating":0,
   "TVRating":"TV-14",
   "MovieRating":"",
   "Subtitled":false,
   "Letterbox":false,
   "CC":true,
   "Color":"Color",
   "OriginalAirDate":"2003-09-22T00:00:00Z",
   "Syndicated":true,
   "Keywords":[

   ],
   "Credits":[

   ],
   "ProgramImages":[

   ],
   "IsVideoAvailable":null,
   "SeasonSequence":null,
   "SeriesSequence":null,
   "LastAirDate":null,
   "CuttingPositions":[
      "95",
      "220",
      "230",
      "318",
      "412"
   ],
   "ParentalRatings":[
      {
         "RatingType":"FCTV",
         "Rating":"G",
         "Reasons":"",
         "CountryCode":"CA"
      },
      {
         "RatingType":"Netherlands TV",
         "Rating":"6",
         "Reasons":"",
         "CountryCode":"NL"
      },
      {
         "RatingType":"Norway TV",
         "Rating":"None",
         "Reasons":"",
         "CountryCode":"NO"
      },
      {
         "RatingType":"Ireland TV",
         "Rating":"None",
         "Reasons":"",
         "CountryCode":"IE"
      },
      {
         "RatingType":"Poland TV",
         "Rating":"12",
         "Reasons":"",
         "CountryCode":"PL"
      },
      {
         "RatingType":"Age Rating",
         "Rating":"14",
         "Reasons":"",
         "CountryCode":"US"
      },
      {
         "RatingType":"TV Star Rating",
         "Rating":"2",
         "Reasons":"",
         "CountryCode":"US"
      },
      {
         "RatingType":"Sweden TV",
         "Rating":"None",
         "Reasons":"",
         "CountryCode":"SE"
      },
      {
         "RatingType":"Germany TV",
         "Rating":"FSK: 3",
         "Reasons":"",
         "CountryCode":"DE"
      },
      {
         "RatingType":"Spain TV",
         "Rating":"A",
         "Reasons":"",
         "CountryCode":"ES"
      },
      {
         "RatingType":"US TV",
         "Rating":"TV-14",
         "Reasons":"",
         "CountryCode":"US"
      },
      {
         "RatingType":"Family Rating",
         "Rating":"1",
         "Reasons":"",
         "CountryCode":"US"
      }
   ],
   "ProgramVariants":"",
   "ProgramVideoClips":"",
   "ProgramAwards":[

   ],
   "ProgramLanguage":"English",
   "CopyTextLanguage":"English",
   "ShowSeasons":[

   ],
   "SubtitleLanguage":"",
   "SecondaryTitle":"",
   "UnsequencedEpisodes":"",
   "Streamable":1
}
 
Retrieved from "http://prod-doc.rovicorp.com/mashery/index.php/V9.Common:Program"
Personal tools