V9.Common:ListingsChannel

Jump to: navigation, search

ListingsChannel

Contains information about a channel in a channel lineup.

Note: To uniquely identify a channel in any channel lineup, use the combination of channel and source ID. Source IDs uniquely identify channels in US national listings, but not in cable and satellite listings, because service providers may broadcast the same source on multiple channels.

Elements

NameTypeDescription
Affiliation Integer Network ID for the source.
AnalogPartnerId String This field is not being populated.
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.
Channel String Number the channel is commonly known by in less than 15 characters. A channel may be specified as:
  • A number
  • A channel.subchannel number (for digital TV)
  • A letter followed by a number (for C-Band satellite)

Note: Channel values are empty for national listings because channels do not apply.

ChannelImages Image [ ] Images of a channel logo.
ChannelLocation String C-Band channel location.
ChannelSchedules ChannelSchedule [ ] Times the source broadcasts on the channel. Returns empty for channels with a Type value of 24-Hours.
DisplayName String Call letters or display name of the source in less than 30 characters.
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.

FullName String Full name of the source broadcasting on the channel.
IconAvailable Boolean Whether an icon is available for the parent network identified by ParentNetworkId: true or false.
Order Integer Preferred sort order of the channel in the list of channels.
ParentNetworkId Integer Database ID of the network that provides programming to the channel. All channels in a network use the same network logo.
ServiceType String Type of television service: analog or digital.
SourceAttributes Integer Sum of the source attribute bit masks that apply to the channel. Mask values are:
ValueMask NameSet if the channel . . .
1HDBroadcasts in high definition.
2MusicOffers music programming.
4PPVOffers pay-per-view broadcasts.
8StetIs a government-access channel with a repeating program schedule.
SourceAttributeTypes SourceAttributeType [ ] Attributes that apply to the source.
SourceId Integer ID of a source that provides programming content to a channel.
SourceType SourceType Type of service that provides the channel content.
TiVoSupported Boolean This property is not currently supported.
Type ChannelType Type of channel.
VirtualChannelNumber String For Digital TV channels, the DTV channel.subchannel number the channel is commonly known by.

XML Response Example

<ListingsChannel SourceId="11110" Channel="2.1" CallLetters="KCBSHD" DisplayName="KCBSHD" SourceType="Broadcast" Type="24-Hours" Order="1" TiVoSupported="true" ParentNetworkId="2" IconAvailable="true" FullName="KCBS HDTV" VirtualChannelNumber="2.1" Affiliation="2165" ServiceType="Digital" SourceAttributes="8">
  <ChannelSchedules/>
  <SourceAttributeTypes>
    <SourceAttributeType>HD</SourceAttributeType>
  </SourceAttributeTypes>
  <ChannelImages>
    <Image>
      <ImageUrl>http://actual-url-concealed.jpg</ImageUrl>
      <ImageUseType xsi:nil="true"/>
      <ImageId>28785</ImageId>
      <ImageTitle>CBS</ImageTitle>
      <ImageCaption>Source Logo</ImageCaption>
      <ObjectId>11110</ObjectId>
      <ObjectType>Source</ObjectType>
      <ObjectName>CBS; CBS</ObjectName>
      <Relevancy>true</Relevancy>
      <ImageCredit>CBS</ImageCredit>
      <ImageCreditDisplay xsi:nil="true"/>
      <ImageCastWeight xsi:nil="true"/>
      <ImageZoomLevel>1</ImageZoomLevel>
      <ImageHeadcount xsi:nil="true"/>
      <ImageType>Station Logo</ImageType>
      <ImageFormat xsi:nil="true"/>
      <ImageHorizontalResolution>248</ImageHorizontalResolution>
      <ImageVerticalResolution>251</ImageVerticalResolution>
      <ImageMaintainAspectFlag xsi:nil="true"/>
      <ImageExpiryDateTime xsi:nil="true"/>
      <LastUpdate>2009-02-05T10:13:15.79Z</LastUpdate>
      <ImageFormatId xsi:nil="true"/>
      <Orientation>Portrait</Orientation>
      <AspectRatio>1:1</AspectRatio>
      <ImageOwner>CBS</ImageOwner>
      <ParentImageId>16786820</ParentImageId>
      <MaxImageScale>100</MaxImageScale>
    </Image>
  </ChannelImages>
  <ChannelLocation/>
  <DvbTriplets/>
</ListingsChannel>

JSON Response Example

JSON responses are available from our REST TV Listings service.
{
   "SourceId":11110,
   "Channel":"2.1",
   "CallLetters":"KCBSHD",
   "DisplayName":"KCBSHD",
   "SourceType":"Broadcast",
   "Type":"24-Hours",
   "Order":1,
   "TiVoSupported":true,
   "ParentNetworkId":2,
   "IconAvailable":true,
   "FullName":"KCBS HDTV",
   "VirtualChannelNumber":"2.1",
   "Affiliation":2165,
   "ServiceType":"Digital",
   "ChannelSchedules":null,
   "SourceAttributeTypes":[
      "HD"
   ],
   "SourceAttributes":8,
   "ChannelImages":[
      {
         "ImageUrl":"http:\/\/actual-url-concealed.jpg",
         "ImageUseType":null,
         "ImageId":28785,
         "ImageTitle":"CBS",
         "ImageCaption":"Source Logo",
         "ObjectId":"11110",
         "ObjectType":"Source",
         "ObjectName":"CBS; CBS",
         "Relevancy":true,
         "ImageCredit":"CBS",
         "ImageCreditDisplay":null,
         "ImageCastWeight":null,
         "ImageZoomLevel":"1",
         "ImageHeadcount":null,
         "ImageType":"Station Logo",
         "ImageFormat":null,
         "ImageHorizontalResolution":248,
         "ImageVerticalResolution":251,
         "ImageMaintainAspectFlag":null,
         "ImageExpiryDateTime":null,
         "LastUpdate":"2009-02-05T10:13:15.79Z",
         "ImageFormatId":null,
         "Orientation":"Portrait",
         "AspectRatio":"1:1",
         "ImageOwner":"CBS",
         "ParentImageId":16786820
      }
   ],
   "ChannelLocation":"",
   "DvbTriplets":null
}
 
Retrieved from "http://prod-doc.rovicorp.com/mashery/index.php/V9.Common:ListingsChannel"
Personal tools