Single episode
/episodes/:rootId.xml
/episodes/:tmsId.xml
Returns a single Gracenote Episode entity with metadata including TMS Root Id, TMS ID, title, description, airdate, season, and episode number. Included is a list of videos from OVD providers with metadata allowing API consumers to link to videos related to the requested Episode.
Request Parameters
Parameter |
Mandatory? |
Description |
episode_id |
Yes |
episode identifier; accepts either episode's root ID (numeric) or TMS ID (alphanumeric, beginning with 'EP') |
api_key |
Yes |
24-character key obtained during application registration |
region | No | Two-letter region code (see Accessing International Data). To be used only with TMS ID (alphanumeric, beginning with 'SH', 'MV', 'EP') |
Sample Request 1
Request online video data using episode's rootId.
http://feeds.tmsapi.com/v2/episodes/2873496.xml?api_key=1234567890
Sample Request 2
Request online video data using episode's tmsId.
http://feeds.tmsapi.com/v2/episodes/EP005984700001.xml?api_key=1234567890
Sample Response
<?xml version="1.0" encoding="UTF-8"?>
<ovd version="2.0">
<episode>
<rootId>2873496</rootId>
<tmsId>EP005984700001</tmsId>
<title>Pilot</title>
<airDate>2003-11-02</airDate>
<seasonNumber>1</seasonNumber>
<episodeNumber>1</episodeNumber>
<description>Michael Bluth's (Jason Bateman) eccentric family suffers a reversal of fortune. With Portia de Rossi, Jeffrey Tambor and David Cross.</description>
<videos>
<video>
<id>217271153</id>
<host id="70892">Hulu</host>
<url>http://www.hulu.com/watch/589</url>
<image>http://thumbnails.hulu.com/4/608/9662_512x288_manicured__MNbEak8kGkid2v+aMDrcXQ.jpg</image>
<updatedAt>2012-01-06</updatedAt>
<viewingOptions>
<viewingOption>
<license>subscription</license>
<quality>HD</quality>
</viewingOption>
<viewingOption>
<license>free</license>
<quality>SD</quality>
</viewingOption>
</viewingOptions>
</video>
<!-- ... followed by more videos ... -->
</videos>
</episode>
</ovd>