Series airings
/series/:seriesId/airings
Returns schedule information for all episodes of a specific series. Schedule information can be requested up to 14 days in advance, for a maximum period of 14 days from start date.
Response data will be sorted by airing dateTime. Metadata will vary based upon program types. See Program metadata for listing of possible program types and associated detailed metadata.
Request Parameters
Parameter |
Mandatory? |
Description |
seriesId |
Yes |
seriesId, which can be retrieved by calling /programs API. |
lineupId |
Yes |
LineupId, which can be retrieved by calling /lineups API. |
startDateTime |
Yes |
DateTime to begin schedule information, specified in ISO 8601 format. |
endDateTime |
No |
DateTime to end schedule information, specified in ISO 8601 format. |
includeDetail | No | Boolean (true/false) indicating whether to include program details with each airing. Defaults to false. |
imageSize |
No |
Valid values are: Sm, Md, Lg, Ms. See Image Sizing for details. |
imageAspectTV |
No |
Requested aspect ratio (horizontal by vertical) for TV show images |
imageText |
No |
Boolean indicating preference for image types with text (banners) or without text (iconics). If requested preference is not available, image selection will continue to next type (banner/iconic), before finally returning generic if no image found. Defaults to true for text preference. |
descriptionLang |
No |
Filter series airings based on the specified description language. Use IETF language tags (2-letter abbreviations, with optional 2-letter region extensions). |
api_key |
Yes |
24-character key obtained during application registration |
Response Body
Response |
Type |
Description |
Progam airings |
Airing [ ] |
Schedule and program information for series airings, up to a 24-hour period, on any station in specified lineup. |
Sample Request
http://data.tmsapi.com/v1.1/series/185044/airings?lineupId=USA-NC32461-X&startDateTime=2015-02-14T10:00Z&includeDetail=true&api_key=1234567890
Sample Response
[
{
"startTime":"2015-02-14T11:00Z",
"endTime":"2015-02-14T12:00Z",
"duration":60,
"qualifiers":[ "Stereo", "CC" ],
"channels":[ "101" ],
"program":{
"tmsId":"EP006883590062",
"rootId":"3056254",
"seriesId":"185044",
"subType":"Series",
"title":"House",
"episodeTitle":"Insensitive",
"origAirDate":"2007-02-13",
"titleLang":"en",
"descriptionLang":"en",
"entityType":"Episode",
"genres":[ "Drama", "Mystery", "Medical" ],
"shortDescription":"House determines that a patient has a rare condition that makes her completely insensitive to pain."
},
"stationId":"11207",
"station":{
"stationId":"11207",
"callSign":"USA",
"channel":"101",
"preferredImage":{
"width":"360",
"height":"270",
"uri":"h3/NowShowing/11207/s11207_h3_aa.png",
"category":"Logo",
"primary":"true"
}
}
},
... additional airings ...
]