V9.Common:ListingsAiring

Jump to: navigation, search

ListingsAiring

Contains information about a scheduled program.

Elements

NameTypeDescription
AiringTime DateTime The time the program will be broadcast, specified in UTC time.
AiringType AiringType Type of broadcast.
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.
Color ColorType Color format of the broadcast.
CC Boolean Whether the program offers closed captioning: true or false.
Channel String Channel number the program is broadcast on.
Copy 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)

CopyTextSource CopyTextSource Source of the program description returned in the CopyText element. This property is not returned if no data is available.
Dolby Boolean Whether the program is broadcast in Dolby Digital 5.1: true or false.
DSS Boolean Whether the program is broadcast in Dolby Surround Sound (DSS): true or false.
Duration Integer Length of the program in minutes.
DvbTriplets DvbTriplet [ ] Digital Video Broadcasting (DVB) identifier, a commonly used identifier for European cable providers, satellite providers, and regional digital networks.

Notes: This property is now deprecated and will be removed in a future update. This property is not returned for REST requests.

DVS Boolean Whether the program is broadcast with a video description for the visually impaired: true or false. DVS stands for Descriptive Video Service.
EpisodeTitle String Title of an episode in less than 50 characters. This property is returned only for programs that have episode titles.
HD Boolean Whether the program is broadcast in high definition: true or false.
HDLevel HighDefinitionLevel The high definition format the program is broadcast in.
IconAvailable Boolean Whether an icon is available for the parent network identified by ParentNetworkId: true or false.
InstanceId Integer Broadcast date in YYYYMMDD format. Returned as an ID only for episodes without episode information.
Letterbox Boolean Whether the program is available in letterbox format: true or false.
MovieRating Rating MPAA rating of a movie. This property is returned only for a movie.
ParentNetworkId Integer Database ID of the network that provides programming to the channel. All channels in a network use the same network logo.
ProgramId String ID for the program in less than 10 characters.
ProgramImage ProgramImage URL to an image associated with the program.

Returned only for a GetLinearSchedule request that specified a program image format ID in the request.

SAP Boolean Whether the program offers a secondary audio track: true or false.
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.
ServiceId Integer Database ID of the television service.
ShowingType ShowingType Type of show.
SL Boolean Whether the program offers sign language: true or false.
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.
SourceLongName String Full name of the source of the channel content.
Sports Boolean Whether the program is a sports show: true or false.
Stereo Boolean Whether the program is broadcast on the channel in stereo: true or false.
Subcategory String Subcategory of television program: crime drama, animated comedy, etc.
Subtitles Boolean Whether the program offers subtitles: true or false.
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.
TiVoSupported Boolean This property is not currently supported.
TVRating Rating Television parental rating of the program.
TVObjectId String Deprecated program ID with less than 10 characters. This property is not returned if the ID is not available.
UnknownInstance Boolean Whether episode information is unknown: true or false.
UPId String A secondary identifier for programs that have the same program ID. This property is not returned if an ID is not available.

XML Response Example

<ListingsAiring>
   <ProgramId>19131002</ProgramId>
   <SeriesId>21985</SeriesId>
   <InstanceId xsi:nil="true"/>
   <UnknownInstance>false</UnknownInstance>
   <UPId>autofill</UPId>
   <Title>Judge Judy</Title>
   <Copy>Ownership of a dog is disputed.</Copy>
   <AiringTime>2011-03-01T23:00:00Z</AiringTime>
   <Duration>30</Duration>
   <Color>Color</Color>
   <AiringType>New</AiringType>
   <ShowingType>Unknown</ShowingType>
   <CC>true</CC>
   <LetterBox>false</LetterBox>
   <Stereo>true</Stereo>
   <HD>false</HD>
   <SAP>false</SAP>
   <TVRating>TV-G</TVRating>
   <Dolby>false</Dolby>
   <DSS>false</DSS>
   <HDLevel>HD Level Unknown</HDLevel>
   <Sports>false</Sports>
   <DVS>false</DVS>
   <Category>Other</Category>
   <Subcategory>reality</Subcategory>
   <SourceId>696</SourceId>
   <Channel>2</Channel>
   <CallLetters>KCBS</CallLetters>
   <SourceDisplayName>KCBS</SourceDisplayName>
   <SourceLongName>KCBS</SourceLongName>
   <TiVoSupported>true</TiVoSupported>
   <ParentNetworkId>2</ParentNetworkId>
   <IconAvailable>true</IconAvailable>
   <ServiceId>360861</ServiceId>
   <DvbTriplet/>
   <ProgramImage ImageUrl="http://actual-url-concealed.jpg" ImageFormatId="37"/>
   <SL>false</SL>
   <Subtitles>false</Subtitles>
</ListingsAiring>

JSON Response Example

JSON responses are available from our REST TV Listings service.
{
  "ProgramId":"19131002",
  "SeriesId":"21985",
  "InstanceId":"",
  "UnknownInstance":"false",
  "UPId":"autofill",
  "Title":"Judge Judy",
  "Copy":"Ownership of a dog is disputed.",
  "AiringTime":"2011-03-01T23:00:00Z",
  "Duration":"30",
  "Color":"Color",
  "AiringType":"New",
  "ShowingType":"Unknown",
  "CC":"true",
  "LetterBox":"false",
  "Stereo":"true",
  "HD":"false",
  "SAP":"false",
  "TVRating":"TV-G",
  "Dolby":"false",
  "DSS":"false",
  "HDLevel":"HD Level Unknown",
  "Sports":"false",
  "DVS":"false",
  "Category":"Other",
  "Subcategory":"reality",
  "SourceId":"696",
  "Channel":"2",
  "CallLetters":"KCBS",
  "SourceDisplayName":"KCBS",
  "SourceLongName":"KCBS",
  "TiVoSupported":"true",
  "ParentNetworkId":"2",
  "IconAvailable":"true",
  "ServiceId":"360861",
  "SL": "false",
  "Subtitles": "false"
}
 
 
 
Personal tools