Common/data/v1.1/Airing

Jump to: navigation, search

VideoAiring

Contains information about a television broadcast.

Elements

NameTypeDescription
aspectRatio string Aspect ratio of the television show. Possible values are:
  • Letterbox
  • Unknown
  • 4:3 Letterbox
  • 4:3 Fullscreen
  • 4:3 Unknown
  • 16:9 Letterbox
  • 16:9 Fullscreen
  • 16:9 Unknown
atts integer Sum of the airing attribute bit masks that apply to the broadcast. Mask values are:
ValueMask NameSet if . . .
1CCThe program offers closed captioning.
2DolbyThe program is broadcast in Dolby Digital.
4DSSThe program is broadcast in Digital Speech Standard.
8DVSThe program is broadcast with a video description for the visually impaired. DVS stands for Descriptive Video Service.
16HDThe program is broadcast in high definition.
32IconAvailableA logo is available for the parent network of the channel, identified by the parentNetworkId. All channels under a parentNetworkId use the same logo.
64SAPThe program offers a secondary audio track.
128SportsThe program is a sports program.
256StereoThe program is broadcast on the channel in stereo.
512SubtitledThe program has subtitles.
callLetters string Call letters of the source that provides programming content to the channel, such as MTV2, SHOW, or DISNEY. Limited to fewer than 18 characters.
category ProgramCategory Category of the broadcast.
channel string Channel number the program is broadcast on.
colorType ColorType Color format of the broadcast.
desc 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)

descSource CopyTextSource Source of the program description.
duration integer Length of the program in minutes.
episodeTitle string Title of an episode in less than 50 characters.
hdLevel HighDefinitionLevel The high definition format the program is broadcast in.
ids ids IDs for the movie or program that are recognized by Rovi DVDs or Rovi Video.
parentNetworkId integer Database ID of the network that provides programming to the channel. All channels in a network use the same network logo.
ratings ratings Parental ratings for the movie, program, or television series.
seriesId string ID of the series if the program is an episode.
serviceId integer Database ID of the television service.
showingType ShowingType Type of show.
sourceDisplayName string Display name of the source of the channel content in less than 30 characters.
sourceId integer ID of the source that provides programming content to the channel.
sourceFullName string Full name of the source of the channel content.
sourceName string Display name of the source of the channel content in less than 30 characters.
subcategory string Subcategory of television program: crime drama, animated comedy, etc.
subtitleLanguage string Language of the program subtitles.
time DateTime Date and time of the broadcast, specified as UTC time.
title string Title of the program or, if the program is an episode in a series, the title of the series. Limited to fewer than 256 characters.
type AiringType Type of broadcast.

XML Response Example

<VideoAiring>
  <ids>
    <amgMovieId i:nil="true"/>
    <cosmoId>2946507</cosmoId>
  </ids>
  <time>2011-06-25T20:00:00.0000000Z</time>
  <type>Unknown</type>
  <aspectRatio i:nil="true"/>
  <callLetters>DUSK</callLetters>
  <category>Movie</category>
  <atts>257</atts>
  <channel>83</channel>
  <colorType>Color</colorType>
  <desc>Harrison Ford and Michelle Pfeiffer play a couple whose house appears to be haunted in this Hitchcockian thriller from director Robert Zemeckis (“Cast Away”). Jody: Diana Scarwid. Dr. Drayton: Joe Morton. Warren: James Remar.</desc>
  <descSource i:nil="true"/>
  <duration>180</duration>
  <episodeTitle i:nil="true"/>
  <hdLevel>Unknown</hdLevel>
  <ratings>
    <tv>None</tv>
    <movie>PG-13</movie>
  </ratings>
  <parentNetworkId>0</parentNetworkId>
  <seriesId i:nil="true"/>
  <serviceId>890113</serviceId>
  <showingType>Unknown</showingType>
  <sourceDisplayName>DUSK-E</sourceDisplayName>
  <sourceId>10128</sourceId>
  <sourceFullName>DUSK (East)</sourceFullName>
  <sourceName>DUSK</sourceName>
  <subcategory>mystery &amp; suspense</subcategory>
  <subtitleLanguage i:nil="true"/>
  <title>What Lies Beneath</title>
</VideoAiring>

JSON Response Example

{
   "ids":{
      "amgMovieId":null,
      "cosmoId":"3236816"
   },
   "time":"2011-06-28T00:00:00.0000000Z",
   "type":0,
   "aspectRatio":null,
   "callLetters":"USA",
   "category":"Other",
   "atts":291,
   "channel":"33",
   "colorType":"Color",
   "desc":"A kidnapping investigation links a past case with which Cragen was involved to a 12-year-old (Ian Cronin) whose adoption is deemed illegal. Mark Sanford: Bruce Altman. Robert Cook: David Aaron Baker. Erin Blake: Ellen Parker. Adam Blake: John Sloman. Margaret Talmadge: Celia Weston. Herbert Talmadge: John Seitz. Cragen: Dann Florek. Munch: Richard Belzer. Cabot: Stephanie March.",
   "descSource":null,
   "duration":60,
   "episodeTitle":"Stolen",
   "hdLevel":0,
   "ratings":{
      "tv":"TV-14",
      "movie":null
   },
   "parentNetworkId":101,
   "seriesId":"1745480",
   "serviceId":360861,
   "showingType":0,
   "sourceDisplayName":"USA-W",
   "sourceId":2534,
   "sourceFullName":"USA Network (West)",
   "sourceName":"USA",
   "subcategory":"drama",
   "subtitleLanguage":null,
   "title":"Law & Order: Special Victims Unit"
}
 
Personal tools