• Register

Single Special

/specials/:rootId.xml

/specials/:timsId.xml

Returns a single Gracenote 'Special' program entity with metadata including Root Id, TMS Id, title, description, release year, and run time. Included is a list of videos from OVD providers with metadata allowing API consumers to link to videos related to the requested movie.

Request Parameters

Parameter Mandatory? Description
specialId Yes Special identifier; accepts either root Id (numeric) or TMS ID (alphanumeric, beginning with 'SH')
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 special's rootId.

http://feeds.tmsapi.com/v2/specials/9520617.xml?api_key=123456789

Sample Request 2

Request online video data using special's tmsId.

http://feeds.tmsapi.com/v2/specials/SH016293120000.xml?api_key=123456789

Sample Response

 

<ovd version="2.1">
	<special>
		<rootId>9520617</rootId>
		<tmsId>SH016293120000</tmsId>
		<title>Lady Gaga: On The Edge</title>
		<description>The inspirational story of one of the world's greatest pop stars.</description>
		<airDate>2012-10-09</airDate>
		<videos>
			<video>
				<id>427261800</id>
				<host id="70865">Amazon.com</host>
				<url>http://www.amazon.com/dp/B009NPKROW</url>
				<image>http://ecx.images-amazon.com/images/I/513BpmazP2L._SX320_SY240_.jpg</image>
				<updatedAt>2016-03-22</updatedAt>
				<viewingOptions>
					<viewingOption>
						<license>rental</license>
						<price currency="USD">3.99</price>
						<quality>HD</quality>
					</viewingOption>
				</viewingOptions>
			</video>
			<video>
				<id>427261729</id>
				<host id="70865">Amazon.com</host>
				<url>http://www.amazon.com/dp/B009NNGBKI</url>
				<image>http://ecx.images-amazon.com/images/I/513BpmazP2L._SX320_SY240_.jpg</image>
				<updatedAt>2016-03-22</updatedAt>
				<viewingOptions>
					<viewingOption>
						<license>purchase</license>
						<price currency="USD">6.99</price>
						<quality>SD</quality>
					</viewingOption>
				</viewingOptions>
			</video>
			<video>
				<id>427261726</id>
				<host id="70865">Amazon.com</host>
				<url>http://www.amazon.com/dp/B009NPKPPS</url>
				<image>http://ecx.images-amazon.com/images/I/513BpmazP2L._SX320_SY240_.jpg</image>
				<updatedAt>2016-03-22</updatedAt>
				<viewingOptions>
					<viewingOption>
						<license>rental</license>
						<price currency="USD">2.99</price>
						<quality>SD</quality>
					</viewingOption>
				</viewingOptions>
			</video>
			<video>
				<id>427261527</id>
				<host id="70865">Amazon.com</host>
				<url>http://www.amazon.com/dp/B009NPLEMG</url>
				<image>http://ecx.images-amazon.com/images/I/513BpmazP2L._SX320_SY240_.jpg</image>
				<updatedAt>2016-03-22</updatedAt>
				<viewingOptions>
					<viewingOption>
						<license>purchase</license>
						<price currency="USD">7.99</price>
						<quality>HD</quality>
					</viewingOption>
				</viewingOptions>
			</video>
			<video>
				<id>430711913</id>
				<host id="82658">Verizon Flexview</host>
				<url>https://www.verizon.com/Ondemand/Movies/MovieDetails/Lady%20Gaga%20On%20the%20Edge%20(Unrated)/TVNX0020858201534630</url>
				<updatedAt>2016-07-06</updatedAt>
				<viewingOptions>
					<viewingOption>
						<license>rental</license>
						<price currency="USD">3.99</price>
						<quality>SD</quality>
					</viewingOption>
				</viewingOptions>
			</video>
			<video>
				<id>430712287</id>
				<host id="82658">Verizon Flexview</host>
				<url>https://www.verizon.com/Ondemand/Movies/MovieDetails/Lady%20Gaga%20On%20the%20Edge%20(Unrated)/TVNX0020858201534630</url>
				<updatedAt>2016-07-06</updatedAt>
				<viewingOptions>
					<viewingOption>
						<license>rental</license>
						<price currency="USD">4.99</price>
						<quality>HD</quality>
					</viewingOption>
				</viewingOptions>
			</video>
			<video>
				<id>427288526</id>
				<host id="70901">YouTube</host>
				<url>https://www.youtube.com/movie?v=Z7qgsGY-uO8</url>
				<image>https://i.ytimg.com/vi/Z7qgsGY-uO8/maxresdefault.jpg</image>
				<updatedAt>2015-08-07</updatedAt>
				<viewingOptions>
					<viewingOption>
						<license>purchase</license>
						<quality>SD</quality>
					</viewingOption>
					<viewingOption>
						<license>purchase</license>
						<quality>HD</quality>
					</viewingOption>
				</viewingOptions>
			</video>
		</videos>
	</special>
	<head/>
</ovd>

version 8 as of 2 years ago by bwait