Programming Guide APIs

To power rich television programming guides, TMS offers Programming Guide APIs. Through this service, TMS manages a customer’s user accounts and a user’s choice of preferred television providers, and supplies daily refreshes of television listings information to user devices. Accessed via web services using the SOAP method, Programming Guide Web API’s provides efficient XML data for innovative guide applications.

Please contact us for more information and access to complete specifications.

Overview and Technical Introduction

Overview TMSDataDirectOverview.pdf (PDF, 55k) more info

High-level overview of TMSDataDirect:TV and TMSDataDirect:Movies, including the application service components, data management, and hosting services.

Web service
“A web service is a self-describing, self-contained, modular unit of application logic that provides some business functionality to other applications through an Internet connection. Applications access web services via ubiquitous web protocols and data formats, such as HTTP and XML, with no need to worry about how each web service is implemented. Web services can be mixed and matched with other web services to execute a larger workflow or business transaction.” [source]

DataDirect Developer’s Guide DataDirectDevelopersGuide.pdf (v1.2, PDF, 978k, updated 2005-09-27) more info

Technical guidelines intended for developers who wish to build applications interfacing with the TMSDataDirect:TV web services. This document discusses all of the SOAP operations available in the services and their associated SOAP faults, the authentication methods of TMSDataDirect:TV, and the XML data types in returned documents.

Furthermore, the document includes a full set of flow diagrams and discusses the API support in JADD (see below) for each of TMSDataDirect:TV’s web services.

Accessing the Web Services

Standards and Protocols DataDirectProtocols.pdf (v1.6, PDF, 484k, updated 2005-08-31) more info

Technical details of the authentication protocol and SOAP protocol, including all specific operations, used for communication with TMSDataDirect:TV Web services. Provides examples of SOAP requests and provides descriptions of SOAPFaults returned by the service.

Account Management WSDL accountManagement.wsdl (XML, 5k, updated 2005-02-07) more info

Formal description of the messaging capabilities in the Account Management Web service. This document describes the operations available to customers for adding, modifying, and deleting subscribers to TMSDataDirect via a secure transaction. The WSDL also describes error messages returned by the Account Management Web service.

Lineup Management WSDL lineupManagement.wsdl (XML, 8k, updated 2005-02-01) more info

Formal description of the messaging capabilities in the Lineup Management Web service. This document describes the operations available to customer devices for managing lineups and station selection. The WSDL also describes error messages returned by the Lineup Management Web service.

TV Data Delivery WSDL tvDataDelivery.wsdl (XML, 4k, updated 2005-03-24) more info

Formal description of the messaging capabilities in the TV Data Delivery Web service. This document describes the operations available to customer devices for downloading TV data in an eXtensible Television Data (XTVD) document and acknowledging successful receipt of an XTVD document. The WSDL also describes error messages returned by the TV Data Delivery Management Web service.

TMSDataDirect SOAP Operations TMSDataDirect_complete_SOAP_calls.zip (ZIP, 18k, updated 2005-07-26) more info

Complete range of Simple Object Access Protocol (SOAP) calls for interacting with the Account Management, Lineup Management, and TV Data Delivery Web services. Includes requests and responses with full SOAP Envelope and SOAP Body. When a software client consumes a WSDL, these requests will be generated and the corresponding responses returned.

TMSDataDirect SOAP Lineup Examples TMSDataDirect_SOAP_Lineup_Examples.zip (ZIP, 30Kb, updated 2008-09-29) more info

Examples of invoking the varous SOAP calls to interact with the Lineup Managment SOAP service. README file is included that shows the steps involved with selecting and deselecting stations for a lineup. Includes requests and responses with full SOAP Envelope and SOAP Body. When a software client consumes a WSDL, these requests will be generated and the corresponding responses returned.

TMS Front End Clients and APIs

Java Front End for DataDirect (JFEDD): jfedd.zip (v1.6, 904k, updated 2009-09-01) more info

Java example client to perform downloads of XTVD documents. Requires Java 1.5 (or earlier JRE version). THIS EXAMPLE IS PROVIDED "AS-IS" FOR ILLUSTRATIVE PURPOSES ONLY. IT IS PROVIDED TO ILLUSTRATE ONE OF MANY METHODS OF INTERACTING WITH THE XTVD SERVICE.

Java Front End for DataDirect (JFEDD) with Windows JRE: jfedd_windows_jre.zip (v1.6, 16MB, updated 2009-09-01) more info

Java example client with bundled Windows Java runtime environment (JRE) to perform downloads of XTVD documents. This is a significantly larger download than the non-JRE version. The bundled JRE package is the Windows installation executable file. You must run this to install the JRE. The JRE included is version 1.5.0_18. THIS EXAMPLE IS PROVIDED "AS-IS" FOR ILLUSTRATIVE PURPOSES ONLY. IT IS PROVIDED TO ILLUSTRATE ONE OF MANY METHODS OF INTERACTING WITH THE XTVD SERVICE.

JFEDD client documentation JFEDDUserGuide.pdf (v1.2 for JFEDD 1.4+, 112k, updated 2009-09-01) more info

Information on configuring and using JFEDD, along with detailed information on the functionality of the JFEDD client.

Perl Front End for DataDirect (PFEDD): pfedd.zip (5k, updated 2004-02-13) more info

Simple Perl client to perform downloads of XTVD documents. This client consumes the TV Data Delivery WSDL using SOAP::Lite.

Java SDK

Java APIs for DataDirect (JADD): jadd.zip (ZIP, 996k, updated 2005-07-27) more info

Java-based application program interface (API) to the Account Management, Lineup Management, and TV Data Delivery Web services. Description of the API is included the javadocs. JADD is included in JFEDD but also available as a standalone download.

Data and Data Documentation

XTVD Schema tmsxtvd.xsd (XML, 27k, updated 2006-12-20) more info

Formal definition of XTVD documents. See XTVD Schema Definition for human-friendly descriptions.

XTVD Schema Definition (v1.3.7) XTVDSchemaDefinition.pdf (PDF, 216k, updated 2006-12-19) more info

Description and details of the TMS standard Extensible TV Data (XTVD) schema and its relation to the TV Schedules and Channel Lineups data.

SLAM Schema slam.xsd (XML, 21k, updated 2005-02-08) more info

Formal definition of Account Management and Lineup Management documents. See SLAM Schema Definition (coming soon) for human-friendly descriptions.

SLAM Schema Definition (v1.0) SLAMSchemaDefinition.pdf (PDF, 530k, updated 2005-09-15) more info

Description and details of the Subscription Lineup and Account Management (SLAM) XML schema.

XG Schema tmsxg.xsd (XML, 17k, updated 2004-04-12) more info

Formal definition of common data-types used in the TMS schemas for Movie and TV data, also called “XG.”

XG Schema Definition (v1.0) XGSchemaDefinition.pdf (PDF, 380k, updated 2005-09-20) more info

Description and details of the Common Data Types (XG) XML schema.

Sample XTVD File tmsdatadirect_sample.xml (XML, 204k, updated 2005-07-27) more info

Sample one day download for an account with three lineups (Chicago local broadcast, DISH Chicago, and DirecTV Chicago). This XML file displays the normalized structure of TMSDataDirect XTVD data. In addition, the local broadcast lineup includes a digital OTA channel, indicated by the “DT” suffix appended to the callsign.

Release Notes

Release notes detailing the development of the TMSDataDirect:TV web service are available.