Format of an API 20131021 lineup response

Post Reply
rkulagow
SD Staff
Posts: 915
Joined: Tue Aug 14, 2007 3:15 pm

Format of an API 20131021 lineup response

Post by rkulagow » Fri Feb 07, 2014 1:06 pm

When requesting a station mapping, the returned JSON will consist of:

"map": mandatory. An array of stationID / channel pairs. Both are strings. For a cable or satellite lineup, you'll see:
"map": [
{
"stationID": "74348",
"channel": "001"
},
{
"stationID": "11299",
"channel": "002"
},
...
]

For an over-the-air antenna lineup, it will look like this:
{
"map": [
{
"stationID": "20454",
"uhfVhf": 12,
"atscMajor": 2,
"atscMinor": 1
},
{
"stationID": "25020",
"uhfVhf": 28,
"atscMajor": 4,
"atscMinor": 1
},

stationID:mandatory
uhfVhf: optional
atscMajor: optional.
atscMinor: If atscMajor exists, then atscMinor must exist.

An analog station should contain a uhfVhf frequency, but no ATSC major/minor.

"stations": mandatory. An array containing:
name - mandatory. Indicates the name of the station.
callsign - mandatory.
affiliate - optional.
broadcaster - optional. An array containing information about the broadcaster:
  • city
    state
    postalcode
    country
language - optional. The station language.
logo - optional. an array containing
  • URL - where to download the .png file from
    dimension - dimension of the graphic
stationID: mandatory. An integer cast as a string. (Stringified for future feature)

"stations": [
{
"name": "XFINITY On Demand",
"callsign": "OND",
"affiliate": "Cablecast",
"broadcaster": {
"city": "Philadelphia",
"state": "PA",
"postalcode": "19019",
"country": "United States"
},
"language": "English",
"stationID": "74348"
},
{
"name": "WBBM",
"callsign": "WBBM",
"affiliate": "CBS Affiliate",
"broadcaster": {
"city": "Chicago",
"state": "IL",
"postalcode": "60611",
"country": "United States"
},
"language": "English",
"stationID": "11299"
},
...
{
"name": "ABC Family",
"callsign": "ABCF",
"affiliate": "Satellite",
"broadcaster": {
"city": "Burbank",
"state": "CA",
"postalcode": "91521",
"country": "United States"
},
"language": "English",
"logo": {
"URL": "https://s3.amazonaws.com/schedulesdirec ... _h3_aa.png",
"dimension": "w=360px|h=270px"
},
"stationID": "10093"
},
...
]


metadata: mandatory. An array containing
lineup - mandatory. The lineup identifier.
modified - mandatory. Last modified date of this lineup. Used by client to refresh a lineup if necessary
transport - mandatory. String indicating how this lineup is delivered.
"metadata": [
{
"lineup": "USA-IL57303-X",
"modified": "2014-02-06T22:02:18Z",
"transport": "Cable"
}
]

rkulagow
SD Staff
Posts: 915
Joined: Tue Aug 14, 2007 3:15 pm

Re: Format of an API 20131021 lineup response

Post by rkulagow » Fri Feb 28, 2014 2:20 pm

Update metadata field of a lineup response. It will include the lineup identifier.

rkulagow
SD Staff
Posts: 915
Joined: Tue Aug 14, 2007 3:15 pm

Re: Format of an API 20131021 lineup response

Post by rkulagow » Wed Apr 30, 2014 7:15 am

Update response to include example of Antenna response.

Post Reply