Returns up to 14 days of schedule information for a specific program. If specified TMS ID corresponds to a series, all episodes airing within dateTime range will be returned.
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
tmsId
Yes
TMS ID, unique program identifier, obtained from APIs returning schedule or program information
lineupId
Yes
LineupId, which can be retrieved by calling /lineups API.
startDateTime
Yes
DateTime to start schedule information, specified in ISO 8601 format. Must be no more than 14 days after current dateTime. See DateTime documentation for formatting information.
endDateTime
No
DateTime to end schedule information, specified in ISO 8601 format. Must be no more than 14 days after startDateTime. If not specified, defaults to 3 hours after startDateTime. See DateTime documentation for formatting information.
includeDetail
No
Boolean (true/false) indicating whether to include program details with each airing. Defaults to false.
imageSize
No
Small, medium, large, master sizes are available. 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.
imageAspectTV
No
Requested aspect ratio (horizontal by vertical) for TV show images.Valid values are: 2x3, 3x4, 4x3, 16x9 If not specified, defaults to 2x3 If requested aspect ratio is not available, generic image will be returned.
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.
api_key
Yes
24-character key obtained during application registration
Response Body
Response
Type
Description
Progam airings
Airing [ ]
Schedule and program information for all airings of program, up to a 24-hour period, on any station in specified lineup.
[ { "startTime":"2015-02-10T00:30Z", "endTime":"2015-02-10T01:00Z", "duration":30, "qualifiers":["Stereo","CC"], "channels":["1206"], "program":{ "tmsId":"EP012800400009", "rootId":"8386441", "seriesId":"8130329", "subType":"Series", "title":"Mike & Molly", "episodeTitle":"Mike's New Boots", "origAirDate":"2010-11-15", "titleLang":"en", "descriptionLang":"en", "entityType":"Episode", "genres":["Sitcom"], "longDescription":"Molly becomes jealous when Mike introduces her as his friend to a woman who is flirting with him.", "shortDescription":"Molly becomes jealous when Mike introduces her as his friend to a woman who is flirting with him.", "episodeNum":9, "seasonNum":1, "topCast":["Billy Gardell","Melissa McCarthy","Reno Wilson"], "directors":["James Burrows"], "ratings":[{"code":"TV14","body":"USA Parental Rating"}], "preferredImage":{ "width":"240","height":"360", "uri":"assets/p8130329_b_v5_aa.jpg", "category":"Banner-L1", "text":"yes","primary":"true", "tier":"Series" } }, "stationId":"15569", "station":{ "stationId":"15569", "callSign":"WRAZ", "affiliateCallSign":"FOX", "affiliateId":"10212", "channel":"1206", "preferredImage":{ "width":"360","height":"270", "uri":"h3/NowShowing/10212/s10212_h3_aa.png", "category":"Logo", "primary":"true" } } }, { "startTime":"2015-02-10T01:30Z", "endTime":"2015-02-10T02:00Z", "duration":30, "qualifiers":["Stereo","New","CC"], "channels":["1209"], "program":{ "tmsId":"EP012800400102", "rootId":"11367792", "seriesId":"8130329", "subType":"Series", "title":"Mike & Molly", "episodeTitle":"Hack to the Future", "origAirDate":"2015-02-09", "titleLang":"en", "descriptionLang":"en", "entityType":"Episode", "genres":["Sitcom"], "longDescription":"When her publisher requests that a provocative change be made to her book, Molly is faced with a dilemma.", "shortDescription":"Molly's publisher requests that a provocative change be made to her book.", "episodeNum":9, "seasonNum":5, "topCast":["Billy Gardell","Melissa McCarthy","Reno Wilson"], "directors":["David Trainer"], "ratings":[{"code":"TV14","body":"USA Parental Rating"}], "preferredImage":{ "width":"240", "height":"360", "uri":"assets/p8130329_b_v5_aa.jpg", "category":"Banner-L1", "text":"yes", "primary":"true", "tier":"Series" } }, "stationId":"11809", "station":{ "stationId":"11809", "callSign":"WRAL", "affiliateCallSign":"CBS", "affiliateId":"10098", "channel":"1209", "preferredImage":{ "width":"360", "height":"270", "uri":"h3/NowShowing/10098/s10098_h3_aa.png", "category":"Logo", "primary":"true" } } }, ... additional airings ... ]
