DateTime fields in requests should be formatted according to ISO 8601 standards. DateTimes should be specified in Coordinated Universal Time (UTC), or can be specified in local time with UTC offset. Note that offsets must be adjusted for Daylight Savings Time, when in effect in local timezone.
DateTime fields in responses will be formatted according to ISO 8601 standards, and specified in UTC. To display data in local timezone, UTC offset must be applied to response data.
To specify December 1, 2012, 3pm Eastern Time in request parameters, either of the following formats are valid:
- UTC: 2012-12-01T20:00Z
- Local (EST) with offset: 2012-12-01T15:00-05:00
To specify August 1, 2012, 3pm Eastern Time in request parameters, either of the following formats are valid :
- UTC: 2012-08-01T19:00Z
- Local (EDT) with offset: 2012-12-01T15:00-04:00 (note offset change due to Daylight Savings Time in effect)
The table below defines the sizes associated with Small, Medium, Large, and Master values that are used for the ‘imageSize’ input parameter. The naming convention (h5, v6, v9, etc.) can be seen in image filenames included in responses.
TV banners and Iconics are available in all aspect ratios; other image categories are available in aspect ratios as follows:
- Channel/source logos: 4x3 horizontal
- Banners: all (2x3, 3x4, 4x3, 16x9)
- Iconics: all (2x3, 3x4, 4x3, 16x9)
- Episodics: 4x3 horizontal, 16x9 horizontal
- TV program logos: 4x3 horizontal
- Movie DVD box art: 2x3 vertical
- Movie poster art: 2x3 vertical
- Celebrity headshots: 3x4 vertical
- Cast in character: 3x4 vertical
- Cast ensemble: 4x3 horizontal, 16x9 horizontal
- Sports logos: 4x3 horizontal
TMS provides a set of default channel lineups for US and Canadian timezones. These provide a collection of common stations, and can be used to get scheduling information without prompting users for postal code or a choice of cable/satellite providers. Around 110 stations are included in the US timezone lineup, and around 90 stations in Canada's timezone lineup. These lineup ids can be used to retrieve TV schedule information specific to each timezone.
Here are the available timezone lineupIds:
- USA-DFLTE - eastern time (US)
- USA-DFLTC - central time (US)
- USA-DFLTM - mountain time (US)
- USA-DFLTP - pacific time (US)
- USA-DFLTH - Hawaii time (US)
- USA-DFLTA - Alaska time (US)
- CAN-DFLTEC - eastern time (Canada)
- CAN-DFLTMC - mountain time (Canada)
- CAN-DFLTCC - central time (Canada)
- CAN-DFLTPC - pacific time (Canada)
If an API call results in an error, we will return an HTTP status code in the header fields and in the message-body, if applicable. A response code of 200 (OK) is returned for all requests that are successfully understood and processed. While using our APIs you may receive the following HTTP errors:
HTTP Response Code
200 – OK
Request returned successfully
|400 - Bad Request||Request problem, typically missing or invalid request parameters. Check the response body for more detailed, API-specific error codes (see Error Codes in Response below).|
401 - Unauthorized
The request requires user authentication.
|403 - Forbidden||You have not been granted permission to access the requested method or object.|
|403 - Not Authorized||The API key associated with your request was not recognized or the signature was incorrect.|
|403 - Account Inactive||The API key you are using to access the TMS API has not been approved or has been disabled.|
|403 - Account over Queries per Second Limit||The API key you are using has attempted to access the api too many times in one second.|
|403 - Account Over Rate Limit||The API key you are using has attempted to access the api too many times in the rate limiting period.|
|403 - Rate Limit Exceeded||The service you have requested is over-capacity.|
404 - Not Found
The server has not found anything matching the request URI.
500 - Internal Server Error
The server encountered an unexpected condition which prevented it from fulfilling the request.
504 - Gateway Timeout
The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI (e.g. HTTP, FTP, LDAP) or some other auxiliary server (e.g. DNS) it needed to access in attempting to complete the request.
Error codes which could be returned in the response body are usually indicative of a problem with the request, and accompanied by HTTP status code 400. See chart below for details.
- OnConnect APIs - Documentation
- Gracenote Sports - Scores and Statistics
- On Entertainment Sports APIs
- Data Delivery APIs
- International lineups
- Online Video and Social APIs
- Media Cloud