Lineup channel listing

/lineups/:lineupId/channels

Get a list of stations and channel positions associated with a specified lineup. Station affiliates will be included where applicable. Responses will be sorted by channel position.

Request Parameters

Parameter

Mandatory?

Description

lineupId Yes LineupId, which can be retrieved using Lineups by postal code.
enhancedCallSign No Boolean (true/false) indicating whether to use display-friendly call signs in response. If true, callSign response field will include display-friendly call signs, where available.
Defaults to false.
imageSize No Valid values are: Sm, Md, Lg, Ms. See Image Sizing for details.
If not specified, defaults to Md.
If requested image size is not available, generic image will be returned.
api_key Yes 24-character key obtained during application registration

Response Body

Response

Description

channel channel number
callSign station call sign (e.g., WCIU);
if enhancedCallSign=true, display-friendly call sign returned where available
stationId TMS-generated id; consistent for station across providers/lineups
affiliateId stationId corresponding to network affiliated stations; 'Independent' may also be noted here
affiliateCallSign network call sign associated with affiliateId, if present and not 'Independent'
preferredImage station logo, if available; see Image Metadata for details

Sample Request

Return information for lineupId USA-NY55899-X, which was acquired by calling /lineups.

http://data.tmsapi.com/v1.1/lineups/USA-NY55899-X/channels?api_key=1234567890

Sample Response  

[
    {
        "channel": "002",
        "callSign": "WCBS",
        "stationId": "11331",
        "affiliateId": "10098",
        "affiliateCallSign": "CBS",
        "preferredImage": {
            "uri": "h3/NowShowing/10098/s10098_h3_aa.png",
            "height": "270",
            "width": "360",
            "primary": "true",
            "category": "Logo"
        }
    },
    {
        "channel": "003",
        "callSign": "WPXN",
        "stationId": "11743",
        "affiliateId": "18633",
        "affiliateCallSign": "ION",
        "preferredImage": {
            "uri": "h3/NowShowing/18633/s18633_h3_aa.png",
            "height": "270",
            "width": "360",
            "primary": "true",
            "category": "Logo"
        }
    },
    {
        "channel": "004",
        "callSign": "WNBC",
        "stationId": "11705",
        "affiliateId": "10991",
        "affiliateCallSign": "NBC",
        "preferredImage": {
            "uri": "h3/NowShowing/10991/s10991_h3_aa.png",
            "height": "270",
            "width": "360",
            "primary": "true",
            "category": "Logo"
        }
    }
]