Sports
Team airings
/sports/team/
Returns up to 14 days of schedule information for one or more teams, for a specific lineupId. Optional parameter 'includeDetail' allows basic control of program metadata returned. Parameters for startDateTime and endDateTime should be specified on the hour or half-hour (e.g., 2:00 or 2:30, instead of 2:05 or 2:53) for best performance. Response data will be sorted by startTime. Programs already in progress at startDateTime will be included in response data.
Request Parameters
| Parameter | Mandatory? | Description |
|---|---|---|
| teamBrandId | Yes | One or more teamBrandIds (comma-separated) for which to return schedule information. This ID can be obtained using Teams by organization or Teams by university API. |
| lineupId | Yes | LineupId for which to return team airing information. This ID can be obtained using Lineups by zipcode API. |
| startDateTime | Yes | DateTime to begin schedule information, specified in ISO 8601 format. Must be no more than 14 days after current dateTime. See DateTime documentation for tips on formatting. |
| 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 tips on formatting. |
| includeDetail | No | Boolean (true/false) indicating whether to include program details with each airing. Defaults to false. If false, program metadata will include only program ids. |
| 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. |
| api_key | Yes | 24-character key obtained during application registration |
Response Body
When includeDetail=false, shaded fields are omitted from response.
| Response | Description |
|---|---|
| airings | Collection of program and schedule information, each with the following info: |
| program | Object with the following properties: |
| tmsId | TMS-generated 14-character alphanumeric identifier for program record; first 2 characters generally identify program type (MV=movie, SH=show/series, EP=episode, SP=sports event) |
| rootId | numeric identifier used to connect related program records with different title language, description language, and versions |
| seriesId | numeric identifier corresponding to rootId of series' main program record; all episode records of a single series will have same seriesId; omitted when program is not related to a series |
| organizationId | The ID for the related organization |
| sportsId | The ID for the related sport |
| subType | Program subType. One of the following values: Feature Film, Short Film, TV Movie, Miniseries, Series, Special, Sport event, Sports non-event, Paid Programming, Theatre Event |
| genres | Comma-separated list of movie genres (e.g., Romance, Horror, Comedy) |
| season | Season metadata |
| content | The description of the season; "2014-2015" for example. |
| type | The season type; Pre, Reg and Post |
| title | program title; for sports records, this indicates sport and organization, where applicable (e.g., NBA Basketball) |
| titleLang | 2-letter language abbreviation code (e.g., 'en'=English, 'sp'=Spanish) |
| shortDescription | program description, maximum 100 characters; not widely used for sports events |
| descriptionLang | 2-letter language abbreviation code (e.g., 'en'=English, 'sp'=Spanish), when shortDescription returned |
| genres | comma-separated list of program genres (e.g., Basketball, Football) |
| eventTitle | for team events, states team matchup and location (e.g., Kansas at Missouri) |
| gameDate | format is yyyy-mm-dd |
| preferredImage | Program image, if available; see Image Metadata for details |
| teams | team metadata |
| name | team name |
| teamBrandId | Resource identifier for team |
| isHome | Included only when true; indicates event played at home venue |
| entityType | Type of program: sports |
| startTime | specified in UTC, offset must be applied for display in local time |
| endTime | specified in UTC, offset must be applied for display in local time |
| duration | Duration of program, in minutes (endTime-startTime) |
| ratings | Ratings metadata, if available |
| body | Ratings body; for TV programs, typically will be USA Parental Rating |
| code | Ratings code; e.g., TVY, TVG |
| qualifiers | comma-separated list of program qualifiers/notes (e.g., CC, Stereo, Live, New, Subject to Blackout) |
| channels | comma-separated list of channel numbers |
| station | station metadata |
| callSign | station call sign (e.g., WCIU) |
| stationId | TMS-generated id; consistent for station across providers/lineups |
| preferredImage | Station logo, if available; see Image Metadata for details |
Sample Request
Return airings for two teams (77,429) within next 3 hours on specified lineup (USA-NC32461-X).
Code
Sample Response
Code
Last modified on