Airing Metadata
|
Field / object |
Type |
Notes |
|
program |
program metadata; where available, 'includeDetail' parameter can be used to expand or restrict program metadata |
|
|
startTime |
DateTime |
specified in UTC, offset must be applied for display in local time |
| endTime | DateTime | specified in UTC, offset must be applied for display in local time |
| ratings | Rating [ ] | ratings body, code and subrating (e.g., body=MPAA, code=PG-13 subrating=Language|Dialog); provided for US and Canadian ratings boards and subrating. Not available for all airings. |
| qualifiers | string [ ] | comma-separated list of program qualifiers/notes (e.g., CC, Stereo, Live, New, HDTV); see Schedule Qualifiers for more information |
| channels | string [ ] | comma-separated list of channels on which this program airing will appear |
| duration | number | defined as the schedule window duration of the program; in minutes and includes commercial time |
| station | Station | object with the following properties: |
| callSign | string | station call letters (e.g., WGN) |
| stationId | string | numeric station identifier |
| preferredImage | Image | station logo, if available; otherwise, generic logo |
Example 1 - Episode Airing
{
"startTime":"2015-02-07T15:00Z",
"endTime":"2015-02-07T15:30Z",
"duration":30,
"channels":["296"],
"stationId":"12131",
"ratings":[{ "body":"USA Parental Rating", "code":"TVPG" }],
"program":{
"tmsId":"EP017123260076",
"rootId":"10593558",
"seriesId":"9843808",
"subType":"Series",
"title":"Teen Titans Go!",
"episodeTitle":"Brain Food; In and Out",
"origAirDate":"2014-03-12",
"titleLang":"en",
"descriptionLang":"en",
"entityType":"Episode",
"genres":["Children", "Adventure", "Animated"],
"longDescription":"Beast Boy makes the other Titans dumber so that he can be the \"smart one\"; when he infiltrates Hive Tower to destroy it, Robin gets distracted by its awesomeness.",
"shortDescription":"Beast Boy makes the other Titans dumber; Robin infiltrates Hive Tower.",
"episodeNum":22,
"seasonNum":1,
"topCast":["Scott Menville","Hynden Walch","Tara Strong"],
"preferredImage":{
"width":"240", "height":"360",
"uri":"assets/p9843808_b_v5_ab.jpg",
"category":"Banner-L1",
"text":"yes", "primary":"true",
"tier":"Series"
}
}
}
Example 2 - Movie Airing
{
"startTime":"2015-02-14T01:00Z",
"endTime":"2015-02-14T03:00Z",
"duration":120,
"qualifiers":["Stereo"],
"channels":["885"],
"stationId":"11779",
"ratings":[{ "body":"USA Parental Rating", "code":"TV14" }],
"program":{
"tmsId":"MV003903400000",
"rootId":"9127377",
"subType":"Feature Film",
"title":"Safety Not Guaranteed",
"releaseYear":2012,
"releaseDate":"2012-01-22",
"titleLang":"en",
"descriptionLang":"en",
"entityType":"Movie",
"genres":["Comedy"],
"longDescription":"A disaffected magazine intern (Aubrey Plaza) befriends an unusual guy (Mark Duplass), who is looking for a partner to accompany him on a trip back through time.",
"shortDescription":"A magazine intern (Aubrey Plaza) befriends a guy (Mark Duplass) who aspires to travel back in time.",
"topCast":["Aubrey Plaza", "Mark Duplass", "Jake M. Johnson"],
"directors":[ "Colin Trevorrow" ],
"qualityRating":{"ratingsBody":"TMS", "value":"3" },
"preferredImage":{
"width":"240",
"height":"360",
"caption":{ "content":"Safety Not Guaranteed (2012)", "lang":"en" },
"uri":"assets/p9127377_p_v5_aa.jpg",
"category":"Poster Art",
"text":"yes", "primary":"true"
}
}
}
Example 3 - Sports Airing
{
"startTime": "2016-05-24T14:00Z",
"endTime": "2016-05-24T17:00Z",
"duration": 180,
"qualifiers": ["Subject to blackout"],
"channels": ["331"],
"program": {
"tmsId": "SP003376400000",
"rootId": "12532569",
"seriesId": "191273",
"organizationId": "17",
"sportsId": "58",
"teams": [{
"teamBrandId": "7",
"name": "Cincinnati Reds"
}, {
"teamBrandId": "15",
"name": "Los Angeles Dodgers",
"isHome": true
}],
"subType": "Sports event",
"title": "MLB Baseball",
"eventTitle": "Cincinnati Reds at Los Angeles Dodgers",
"releaseYear": 2016,
"releaseDate": "2016-05-23",
"origAirDate": "2016-05-23",
"gameDate": "2016-05-23",
"gameTime": "19:00:00-07:00",
"gameTimeZone": "Pacific Observing",
"titleLang": "en",
"descriptionLang": "en",
"entityType": "Sports",
"genres": ["Baseball"],
"longDescription": "From Dodger Stadium in Los Angeles.",
"shortDescription": "From Dodger Stadium in Los Angeles.",
"season": {
"content": "2016",
"type": "Reg"
},
"preferredImage": {
"width": "240",
"height": "360",
"uri": "http://demo.tmsimg.com/assets/p191273_b_v5_af.jpg",
"category": "Banner-LO",
"text": "yes",
"primary": "true",
"tier": "Sport"
}
},
"stationId": "87023",
"station": {
"stationId": "87023",
"callSign": "SNLA",
"preferredImage": {
"uri": "http://demo.tmsimg.com/sources/generic/generic_sources_h3.png"
},
"channel": "331"
}
},