Gracenote-TMS-Baseline Integration

This documentation will show you how to link Gracenote/TMS/Basline ID’s to IVA movie and TV trailers.  Use the method below to ingest the data about our videos and match to your existing ID’s, then use the IVA Video API and the video assets published ID to get the video.

To access trailers for movie and TV titles from the IVA catalog, email IVA Client Services with your Developer ID. (You must be a client of IVA.)  After verifying your ID, IVA will expose ID’s  for Gracenote/TMS/Baseline for your account.

Data Matching

Step One:  Use the query below (Example 1) to return results for all programs and videos in IVA’s catalog. Each video is associated with a program (movie or TV title).  Select the “Alternate ID” for each program to match TMS ID’s and the corresponding TMS record. We recommend storing this video asset information for future programming.

Step Two:  Set up a schedule to get new and updated records.  (See Example 2.)

 

Example 1

API Ingest Query: http://api.internetvideoarchive.com/2.0/DataService/EntertainmentPrograms()?$filter=Publishedid gt -1&$skip=0&$top=500&$expand=AlternateIds/AlternateIdType, VideoAssets, Director, Description, ProgramToPerformerMaps/Performer, VideoAssets/Encodes, VideoAssets/VideoAssetScreenCapture, RelatedEntertainmentPrograms/RelatedEntertainmentPrograms/RelatedEntertainmentPrograms, VideoAssets/LanguageSpoken, VideoAssets/LanguageSubtitled, VideoAssets/MediaType, VideoAssets/CountryTarget&format=json&developerid=[yourid] 

The API only returns 500 results at a time so you will need to add paging and/or additional filtering.

Example 2

API Update Query:http://api.internetvideoarchive.com/2.0/DataService/VideoAssets()?$filter=DateModified gt datetime'2015-03-12T10:14:41.5235012-04:00'&$orderby=DateModified desc&$skip=0&$top=500&$expand=EntertainmentProgram/AlternateIds/AlternateIdType, LanguageSpoken, LanguageSubtitled, MediaType, CountryTarget, VideoAssetScreenCapture, EntertainmentProgram/ProgramToPerformerMaps/Performer, Encodes, EntertainmentProgram/Director&format=json&developerid=[yourID] 

Update the date to go back to the last time you updated and add paging as needed.

For more information and examples see IVA’s OData API documentation.

Response Example


{
odata.metadata: "http://api.internetvideoarchive.com/2.0/DataService/$metadata#EntertainmentPrograms",
value: [
{
VideoAssets: [
{
LanguageSpoken: {
LanguageId: 2,
LanguageName: "Spanish"
},
LanguageSubtitled: {
LanguageId: -1,
LanguageName: ""
},
CountryTarget: {
CountryId: 20,
CountryName: "Spain"
},
VideoAssetScreenCapture: {
PublishedID: 103898,
URL: "http://content.internetvideoarchive.com/content/photos/9320/103898_079.jpg"
},
MediaType: {
MediaId: 20,
Media: "Movie Alternate Version",
ReportDisplayOrder: 0
},
Encodes: [
{
PublishedId: 103898,
StreamingFlavorId: 24,
DateDigitized: "2014-12-04T11:15:00",
rate: 750,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=750&publishedid=103898",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "103898-24"
},
{
PublishedId: 103898,
StreamingFlavorId: 25,
DateDigitized: "2014-12-04T11:13:45",
rate: 2500,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=2500&publishedid=103898",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "103898-25"
},
{
PublishedId: 103898,
StreamingFlavorId: 26,
DateDigitized: "2014-12-04T11:17:22",
rate: 8000,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=8000&publishedid=103898",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "103898-26"
},
{
PublishedId: 103898,
StreamingFlavorId: 28,
DateDigitized: "2014-12-04T11:16:17",
rate: 80,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=80&publishedid=103898",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "103898-28"
},
{
PublishedId: 103898,
StreamingFlavorId: 29,
DateDigitized: "2014-12-04T11:15:52",
rate: 212,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=212&publishedid=103898",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "103898-29"
},
{
PublishedId: 103898,
StreamingFlavorId: 30,
DateDigitized: "2014-12-04T11:15:26",
rate: 450,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=450&publishedid=103898",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "103898-30"
},
{
PublishedId: 103898,
StreamingFlavorId: 31,
DateDigitized: "2014-12-04T11:14:27",
rate: 1500,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=1500&publishedid=103898",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "103898-31"
},
{
PublishedId: 103898,
StreamingFlavorId: 40,
DateDigitized: "2014-12-04T11:13:04",
rate: 600,
URL: "see video api documentation",
FileType: "adapt",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "103898-40"
}
],
Publishedid: 103898,
Title: "FAST & FURIOUS 7 (SPANISH TRAILER 1)",
DateCreated: "2014-12-04T11:06:00",
DateModified: "2014-12-04T11:20:00",
MediaId: 20,
PromotesPublishedId: 769190,
ProprietaryCustomerID: -1,
StreamLengthinseconds: 141,
MediaReceivedDate: "2014-12-04T11:06:15",
ExpirationDate: null,
OkToEncodeAndServe: true,
DisplayTitle: "Fast & Furious 7 (Spanish Trailer 1)",
NormalizedTitle: "fast and furious seven",
LanguageSpokenId: 2,
LanguageSubtitledId: -1,
TargetCountryId: 20,
HasContent: true,
SourceWidth: 1920,
SourceHeight: 796,
HdSource: "true",
DefaultVideoAsset: "false",
LastEncodeDate: "2014-12-04T11:17:22",
Sequence: -1,
OverallSequence: -1,
WarningFlag: false,
AllowAds: true,
RequiresIvaPlayer: false,
CopyrightholderId: 19181
},
{
LanguageSpoken: {
LanguageId: 0,
LanguageName: "English"
},
LanguageSubtitled: {
LanguageId: -1,
LanguageName: ""
},
CountryTarget: {
CountryId: -1,
CountryName: ""
},
VideoAssetScreenCapture: {
PublishedID: 140663,
URL: "http://content.internetvideoarchive.com/content/photos/9463/140663_120.jpg"
},
MediaType: {
MediaId: 20,
Media: "Movie Alternate Version",
ReportDisplayOrder: 0
},
Encodes: [
{
PublishedId: 140663,
StreamingFlavorId: 24,
DateDigitized: "2015-03-06T09:56:34",
rate: 750,
URL: "http://video.internetvideoarchive.net/player.aspx?cmd=6&fmt=4&videokbrate=750&publishedid=140663",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "140663-24"
},
{
PublishedId: 140663,
StreamingFlavorId: 25,
DateDigitized: "2015-03-06T09:54:12",
rate: 2500,
URL: "http://video.internetvideoarchive.net/player.aspx?cmd=6&fmt=4&videokbrate=2500&publishedid=140663",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "140663-25"
},
{
PublishedId: 140663,
StreamingFlavorId: 26,
DateDigitized: "2015-03-06T10:02:25",
rate: 8000,
URL: "http://video.internetvideoarchive.net/player.aspx?cmd=6&fmt=4&videokbrate=8000&publishedid=140663",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "140663-26"
},
{
PublishedId: 140663,
StreamingFlavorId: 28,
DateDigitized: "2015-03-06T09:59:22",
rate: 80,
URL: "http://video.internetvideoarchive.net/player.aspx?cmd=6&fmt=4&videokbrate=80&publishedid=140663",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "140663-28"
},
{
PublishedId: 140663,
StreamingFlavorId: 29,
DateDigitized: "2015-03-06T09:58:28",
rate: 212,
URL: "http://video.internetvideoarchive.net/player.aspx?cmd=6&fmt=4&videokbrate=212&publishedid=140663",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "140663-29"
},
{
PublishedId: 140663,
StreamingFlavorId: 30,
DateDigitized: "2015-03-06T09:57:36",
rate: 450,
URL: "http://video.internetvideoarchive.net/player.aspx?cmd=6&fmt=4&videokbrate=450&publishedid=140663",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "140663-30"
},
{
PublishedId: 140663,
StreamingFlavorId: 31,
DateDigitized: "2015-03-06T09:55:29",
rate: 1500,
URL: "http://video.internetvideoarchive.net/player.aspx?cmd=6&fmt=4&videokbrate=1500&publishedid=140663",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "140663-31"
},
{
PublishedId: 140663,
StreamingFlavorId: 40,
DateDigitized: "2015-03-06T09:52:21",
rate: 600,
URL: "see video api documentation",
FileType: "adapt",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "140663-40"
}
],
Publishedid: 140663,
Title: "FURIOUS 7: PLANE DROP (TV SPOT)",
DateCreated: "2015-03-06T09:34:00",
DateModified: "2015-03-06T10:10:00",
MediaId: 20,
PromotesPublishedId: 769190,
ProprietaryCustomerID: -1,
StreamLengthinseconds: 165,
MediaReceivedDate: "2015-03-06T09:34:15",
ExpirationDate: null,
OkToEncodeAndServe: true,
DisplayTitle: "Furious 7: Plane Drop (TV Spot)",
NormalizedTitle: "furious seven plane drop",
LanguageSpokenId: 0,
LanguageSubtitledId: -1,
TargetCountryId: -1,
HasContent: true,
SourceWidth: 1920,
SourceHeight: 1080,
HdSource: "true",
DefaultVideoAsset: "false",
LastEncodeDate: "2015-03-06T10:02:25",
Sequence: -1,
OverallSequence: -1,
WarningFlag: false,
AllowAds: true,
RequiresIvaPlayer: false,
CopyrightholderId: 237
},
{
LanguageSpoken: {
LanguageId: 0,
LanguageName: "English"
},
LanguageSubtitled: {
LanguageId: -1,
LanguageName: ""
},
CountryTarget: {
CountryId: -1,
CountryName: ""
},
VideoAssetScreenCapture: {
PublishedID: 241216,
URL: "http://content.internetvideoarchive.com/content/photos/8308/769190_112.jpg"
},
MediaType: {
MediaId: 20,
Media: "Movie Alternate Version",
ReportDisplayOrder: 0
},
Encodes: [
{
PublishedId: 241216,
StreamingFlavorId: 24,
DateDigitized: "2014-11-01T18:28:11",
rate: 750,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=750&publishedid=241216",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "241216-24"
},
{
PublishedId: 241216,
StreamingFlavorId: 25,
DateDigitized: "2014-11-01T18:27:04",
rate: 2500,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=2500&publishedid=241216",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "241216-25"
},
{
PublishedId: 241216,
StreamingFlavorId: 26,
DateDigitized: "2014-11-01T18:30:11",
rate: 8000,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=8000&publishedid=241216",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "241216-26"
},
{
PublishedId: 241216,
StreamingFlavorId: 28,
DateDigitized: "2014-11-01T18:29:09",
rate: 80,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=80&publishedid=241216",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "241216-28"
},
{
PublishedId: 241216,
StreamingFlavorId: 29,
DateDigitized: "2014-11-01T18:28:51",
rate: 212,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=212&publishedid=241216",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "241216-29"
},
{
PublishedId: 241216,
StreamingFlavorId: 30,
DateDigitized: "2014-11-01T18:28:32",
rate: 450,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=450&publishedid=241216",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "241216-30"
},
{
PublishedId: 241216,
StreamingFlavorId: 31,
DateDigitized: "2014-11-01T18:27:43",
rate: 1500,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=1500&publishedid=241216",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "241216-31"
},
{
PublishedId: 241216,
StreamingFlavorId: 40,
DateDigitized: "2014-11-01T19:47:52",
rate: 600,
URL: "see video api documentation",
FileType: "adapt",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "241216-40"
}
],
Publishedid: 241216,
Title: "FURIOUS 7 (TRAILER 1)",
DateCreated: "2015-02-05T08:56:00",
DateModified: "2015-02-05T09:16:00",
MediaId: 20,
PromotesPublishedId: 769190,
ProprietaryCustomerID: -1,
StreamLengthinseconds: 155,
MediaReceivedDate: "2015-02-05T08:56:13.54",
ExpirationDate: null,
OkToEncodeAndServe: true,
DisplayTitle: "Furious 7 (Trailer 1)",
NormalizedTitle: "",
LanguageSpokenId: 0,
LanguageSubtitledId: -1,
TargetCountryId: -1,
HasContent: true,
SourceWidth: 1280,
SourceHeight: 530,
HdSource: "true",
DefaultVideoAsset: "false",
LastEncodeDate: "2014-11-01T18:30:11",
Sequence: -1,
OverallSequence: -1,
WarningFlag: false,
AllowAds: true,
RequiresIvaPlayer: false,
CopyrightholderId: 237
},
{
LanguageSpoken: {
LanguageId: 0,
LanguageName: "English"
},
LanguageSubtitled: {
LanguageId: -1,
LanguageName: ""
},
CountryTarget: {
CountryId: -1,
CountryName: ""
},
VideoAssetScreenCapture: {
PublishedID: 390116,
URL: "http://content.internetvideoarchive.com/content/photos/9389/390116_019.jpg"
},
MediaType: {
MediaId: 20,
Media: "Movie Alternate Version",
ReportDisplayOrder: 0
},
Encodes: [
{
PublishedId: 390116,
StreamingFlavorId: 24,
DateDigitized: "2015-02-03T09:44:36",
rate: 750,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=750&publishedid=390116",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "390116-24"
},
{
PublishedId: 390116,
StreamingFlavorId: 25,
DateDigitized: "2015-02-03T09:44:14",
rate: 2500,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=2500&publishedid=390116",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "390116-25"
},
{
PublishedId: 390116,
StreamingFlavorId: 26,
DateDigitized: "2015-02-03T09:45:26",
rate: 8000,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=8000&publishedid=390116",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "390116-26"
},
{
PublishedId: 390116,
StreamingFlavorId: 28,
DateDigitized: "2015-02-03T09:44:58",
rate: 80,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=80&publishedid=390116",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "390116-28"
},
{
PublishedId: 390116,
StreamingFlavorId: 29,
DateDigitized: "2015-02-03T09:44:51",
rate: 212,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=212&publishedid=390116",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "390116-29"
},
{
PublishedId: 390116,
StreamingFlavorId: 30,
DateDigitized: "2015-02-03T09:44:44",
rate: 450,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=450&publishedid=390116",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "390116-30"
},
{
PublishedId: 390116,
StreamingFlavorId: 31,
DateDigitized: "2015-02-03T09:44:26",
rate: 1500,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=1500&publishedid=390116",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "390116-31"
},
{
PublishedId: 390116,
StreamingFlavorId: 40,
DateDigitized: "2015-02-03T09:44:01",
rate: 600,
URL: "see video api documentation",
FileType: "adapt",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "390116-40"
}
],
Publishedid: 390116,
Title: "FURIOUS 7: FAST (BIG GAME SPOT)",
DateCreated: "2015-02-02T08:57:00",
DateModified: "2015-02-03T09:46:00",
MediaId: 20,
PromotesPublishedId: 769190,
ProprietaryCustomerID: -1,
StreamLengthinseconds: 62,
MediaReceivedDate: "2015-02-03T09:40:52",
ExpirationDate: null,
OkToEncodeAndServe: true,
DisplayTitle: "Furious 7: Fast (Big Game Spot)",
NormalizedTitle: "furious seven fast",
LanguageSpokenId: 0,
LanguageSubtitledId: -1,
TargetCountryId: -1,
HasContent: true,
SourceWidth: 1280,
SourceHeight: 528,
HdSource: "true",
DefaultVideoAsset: "false",
LastEncodeDate: "2015-02-03T09:45:26",
Sequence: -1,
OverallSequence: -1,
WarningFlag: false,
AllowAds: true,
RequiresIvaPlayer: false,
CopyrightholderId: 237
},
{
LanguageSpoken: {
LanguageId: 0,
LanguageName: "English"
},
LanguageSubtitled: {
LanguageId: -1,
LanguageName: ""
},
CountryTarget: {
CountryId: 4,
CountryName: "Australia"
},
VideoAssetScreenCapture: {
PublishedID: 395472,
URL: "http://content.internetvideoarchive.com/content/photos/9430/395472_018.jpg"
},
MediaType: {
MediaId: 20,
Media: "Movie Alternate Version",
ReportDisplayOrder: 0
},
Encodes: [
{
PublishedId: 395472,
StreamingFlavorId: 24,
DateDigitized: "2015-02-19T10:48:59",
rate: 750,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=750&publishedid=395472",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "395472-24"
},
{
PublishedId: 395472,
StreamingFlavorId: 25,
DateDigitized: "2015-02-19T10:47:15",
rate: 2500,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=2500&publishedid=395472",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "395472-25"
},
{
PublishedId: 395472,
StreamingFlavorId: 26,
DateDigitized: "2015-02-19T10:52:56",
rate: 8000,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=8000&publishedid=395472",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "395472-26"
},
{
PublishedId: 395472,
StreamingFlavorId: 28,
DateDigitized: "2015-02-19T10:51:16",
rate: 80,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=80&publishedid=395472",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "395472-28"
},
{
PublishedId: 395472,
StreamingFlavorId: 29,
DateDigitized: "2015-02-19T10:50:31",
rate: 212,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=212&publishedid=395472",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "395472-29"
},
{
PublishedId: 395472,
StreamingFlavorId: 30,
DateDigitized: "2015-02-19T10:49:45",
rate: 450,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=450&publishedid=395472",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "395472-30"
},
{
PublishedId: 395472,
StreamingFlavorId: 31,
DateDigitized: "2015-02-19T10:48:08",
rate: 1500,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=1500&publishedid=395472",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "395472-31"
},
{
PublishedId: 395472,
StreamingFlavorId: 40,
DateDigitized: "2015-02-19T10:46:17",
rate: 600,
URL: "see video api documentation",
FileType: "adapt",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "395472-40"
}
],
Publishedid: 395472,
Title: "FURIOUS 7 (AUSTRALIAN TRAILER 2)",
DateCreated: "2015-02-19T10:21:00",
DateModified: "2015-02-19T11:01:00",
MediaId: 20,
PromotesPublishedId: 769190,
ProprietaryCustomerID: -1,
StreamLengthinseconds: 158,
MediaReceivedDate: "2015-02-19T10:21:29",
ExpirationDate: null,
OkToEncodeAndServe: true,
DisplayTitle: "Furious 7 (Australian Trailer 2)",
NormalizedTitle: "furious seven",
LanguageSpokenId: 0,
LanguageSubtitledId: -1,
TargetCountryId: 4,
HasContent: true,
SourceWidth: 1920,
SourceHeight: 1080,
HdSource: "true",
DefaultVideoAsset: "false",
LastEncodeDate: "2015-02-19T10:52:56",
Sequence: -1,
OverallSequence: -1,
WarningFlag: false,
AllowAds: true,
RequiresIvaPlayer: false,
CopyrightholderId: 19181
},
{
LanguageSpoken: {
LanguageId: 0,
LanguageName: "English"
},
LanguageSubtitled: {
LanguageId: -1,
LanguageName: ""
},
CountryTarget: {
CountryId: -1,
CountryName: ""
},
VideoAssetScreenCapture: {
PublishedID: 769190,
URL: "http://content.internetvideoarchive.com/content/photos/9399/769190_048.jpg"
},
MediaType: {
MediaId: 0,
Media: "Movie",
ReportDisplayOrder: 0
},
Encodes: [
{
PublishedId: 769190,
StreamingFlavorId: 24,
DateDigitized: "2015-02-05T09:14:04",
rate: 750,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=750&publishedid=769190",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "769190-24"
},
{
PublishedId: 769190,
StreamingFlavorId: 25,
DateDigitized: "2015-02-05T09:13:08",
rate: 2500,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=2500&publishedid=769190",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "769190-25"
},
{
PublishedId: 769190,
StreamingFlavorId: 26,
DateDigitized: "2015-02-05T09:15:12",
rate: 8000,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=8000&publishedid=769190",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "769190-26"
},
{
PublishedId: 769190,
StreamingFlavorId: 28,
DateDigitized: "2015-02-05T09:15:09",
rate: 80,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=80&publishedid=769190",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "769190-28"
},
{
PublishedId: 769190,
StreamingFlavorId: 29,
DateDigitized: "2015-02-05T09:14:48",
rate: 212,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=212&publishedid=769190",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "769190-29"
},
{
PublishedId: 769190,
StreamingFlavorId: 30,
DateDigitized: "2015-02-05T09:14:26",
rate: 450,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=450&publishedid=769190",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "769190-30"
},
{
PublishedId: 769190,
StreamingFlavorId: 31,
DateDigitized: "2015-02-05T09:13:36",
rate: 1500,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=1500&publishedid=769190",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "769190-31"
},
{
PublishedId: 769190,
StreamingFlavorId: 40,
DateDigitized: "2015-02-05T09:12:35",
rate: 600,
URL: "see video api documentation",
FileType: "adapt",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "769190-40"
}
],
Publishedid: 769190,
Title: "FURIOUS 7",
DateCreated: "2013-04-17T11:23:00",
DateModified: "2015-03-13T09:58:00",
MediaId: 0,
PromotesPublishedId: 769190,
ProprietaryCustomerID: -1,
StreamLengthinseconds: 172,
MediaReceivedDate: "2015-02-05T08:56:13",
ExpirationDate: null,
OkToEncodeAndServe: true,
DisplayTitle: "Furious 7",
NormalizedTitle: "furious seven",
LanguageSpokenId: 0,
LanguageSubtitledId: -1,
TargetCountryId: -1,
HasContent: true,
SourceWidth: 1280,
SourceHeight: 532,
HdSource: "true",
DefaultVideoAsset: "true",
LastEncodeDate: "2015-02-05T09:15:12",
Sequence: -1,
OverallSequence: -1,
WarningFlag: false,
AllowAds: true,
RequiresIvaPlayer: false,
CopyrightholderId: 237
},
{
LanguageSpoken: {
LanguageId: 10,
LanguageName: "German"
},
LanguageSubtitled: {
LanguageId: -1,
LanguageName: ""
},
CountryTarget: {
CountryId: 9,
CountryName: "Germany"
},
VideoAssetScreenCapture: {
PublishedID: 941778,
URL: "http://content.internetvideoarchive.com/content/photos/9320/941778_094.jpg"
},
MediaType: {
MediaId: 20,
Media: "Movie Alternate Version",
ReportDisplayOrder: 0
},
Encodes: [
{
PublishedId: 941778,
StreamingFlavorId: 24,
DateDigitized: "2014-12-04T11:25:11",
rate: 750,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=750&publishedid=941778",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "941778-24"
},
{
PublishedId: 941778,
StreamingFlavorId: 25,
DateDigitized: "2014-12-04T11:23:51",
rate: 2500,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=2500&publishedid=941778",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "941778-25"
},
{
PublishedId: 941778,
StreamingFlavorId: 26,
DateDigitized: "2014-12-04T11:28:09",
rate: 8000,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=8000&publishedid=941778",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "941778-26"
},
{
PublishedId: 941778,
StreamingFlavorId: 28,
DateDigitized: "2014-12-04T11:26:26",
rate: 80,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=80&publishedid=941778",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "941778-28"
},
{
PublishedId: 941778,
StreamingFlavorId: 29,
DateDigitized: "2014-12-04T11:26:03",
rate: 212,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=212&publishedid=941778",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "941778-29"
},
{
PublishedId: 941778,
StreamingFlavorId: 30,
DateDigitized: "2014-12-04T11:25:37",
rate: 450,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=450&publishedid=941778",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "941778-30"
},
{
PublishedId: 941778,
StreamingFlavorId: 31,
DateDigitized: "2014-12-04T11:24:37",
rate: 1500,
URL: "http://www.videodetective.net/player.aspx?cmd=6&fmt=4&videokbrate=1500&publishedid=941778",
FileType: "mp4",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "941778-31"
},
{
PublishedId: 941778,
StreamingFlavorId: 40,
DateDigitized: "2014-12-04T11:22:33",
rate: 600,
URL: "see video api documentation",
FileType: "adapt",
RemoteURL: "false",
ProprietaryCustomerId: -1,
ID: "941778-40"
}
],
Publishedid: 941778,
Title: "FAST & FURIOUS 7 (GERMAN TRAILER 1)",
DateCreated: "2014-12-04T11:08:00",
DateModified: "2014-12-04T11:40:00",
MediaId: 20,
PromotesPublishedId: 769190,
ProprietaryCustomerID: -1,
StreamLengthinseconds: 141,
MediaReceivedDate: "2014-12-04T11:08:40",
ExpirationDate: null,
OkToEncodeAndServe: true,
DisplayTitle: "Fast & Furious 7 (German Trailer 1)",
NormalizedTitle: "fast and furious seven",
LanguageSpokenId: 10,
LanguageSubtitledId: -1,
TargetCountryId: 9,
HasContent: true,
SourceWidth: 1920,
SourceHeight: 800,
HdSource: "true",
DefaultVideoAsset: "false",
LastEncodeDate: "2014-12-04T11:28:09",
Sequence: -1,
OverallSequence: -1,
WarningFlag: false,
AllowAds: true,
RequiresIvaPlayer: false,
CopyrightholderId: 19181
}
],
Description: {
PublishedId: 769190,
ItemDescription: "Continuing the global exploits in the unstoppable franchise built on speed, Vin Diesel, Paul Walker and Dwayne Johnson lead the returning cast of Fast & Furious 7. James Wan directs this chapter of the hugely successful series that also welcomes back favorites Michelle Rodriguez, Jordana Brewster, Tyrese Gibson, Chris “Ludacris” Bridges, Elsa Pataky and Lucas Black. They are joined by international action stars new to the franchise including Jason Statham, Djimon Hounsou, Tony Jaa, Ronda Rousey and Kurt Russell."
},
ProgramToPerformerMaps: [
{
Performer: {
PerformerID: 10967,
LastName: "Diesel",
FirstName: "Vin",
FullName: "Vin Diesel",
Datemodified: "2011-09-07T18:32:33",
NormalizedName: "vin diesel"
},
PublishedId: 769190,
PerformerID: 10967,
SortOrder: 0,
ID: "769190-10967"
},
{
Performer: {
PerformerID: 11006,
LastName: "Walker",
FirstName: "Paul",
FullName: "Paul Walker",
Datemodified: "2011-09-07T19:34:46",
NormalizedName: "paul walker"
},
PublishedId: 769190,
PerformerID: 11006,
SortOrder: 2,
ID: "769190-11006"
},
{
Performer: {
PerformerID: 15637,
LastName: "Brewster",
FirstName: "Jordana",
FullName: "Jordana Brewster",
Datemodified: "2011-09-07T18:16:23",
NormalizedName: "jordana brewster"
},
PublishedId: 769190,
PerformerID: 15637,
SortOrder: 4,
ID: "769190-15637"
},
{
Performer: {
PerformerID: 15804,
LastName: "Rodriguez",
FirstName: "Michelle",
FullName: "Michelle Rodriguez",
Datemodified: "2011-09-07T19:19:22",
NormalizedName: "michelle rodriguez"
},
PublishedId: 769190,
PerformerID: 15804,
SortOrder: 3,
ID: "769190-15804"
},
{
Performer: {
PerformerID: 23985,
LastName: "Gibson",
FirstName: "Tyrese",
FullName: "Tyrese Gibson",
Datemodified: "2011-09-07T18:41:29",
NormalizedName: "tyrese gibson"
},
PublishedId: 769190,
PerformerID: 23985,
SortOrder: 5,
ID: "769190-23985"
},
{
Performer: {
PerformerID: 748,
LastName: "Johnson",
FirstName: "Dwayne",
FullName: "Dwayne Johnson",
Datemodified: "2011-09-07T18:51:27",
NormalizedName: "dwayne johnson"
},
PublishedId: 769190,
PerformerID: 748,
SortOrder: 1,
ID: "769190-748"
}
],
AlternateIds: [
{
AlternateIdType: {
ID: 80,
IdType: "TMS Root ID",
RequiredLength: -1
},
PublishedId: 769190,
ID: "10679969",
IDType: 80,
Score: 200,
DateAdded: "2015-02-02T08:32:06"
},
{
AlternateIdType: {
ID: 11,
IdType: "TMS",
RequiredLength: -1
},
PublishedId: 769190,
ID: "MV005640180000",
IDType: 11,
Score: 200,
DateAdded: "2015-02-02T08:32:06"
},
{
AlternateIdType: {
ID: 11,
IdType: "TMS",
RequiredLength: -1
},
PublishedId: 769190,
ID: "MV006602760000",
IDType: 11,
Score: 200,
DateAdded: "2015-01-30T09:12:14"
},
PublishedId: 769190,
ID: "tt2820852",
IDType: 12,
Score: 200,
DateAdded: "2015-01-31T03:58:26"
}
],
Director: {
PerformerID: 23973,
LastName: "Wan",
FirstName: "James",
FullName: "James Wan",
Datemodified: "2011-09-07T19:35:03",
NormalizedName: "james wan"
},
RelatedEntertainmentPrograms: [ ],
Publishedid: 769190,
Title: "FURIOUS 7",
DateCreated: "2013-04-17T11:23:00",
DateModified: "2015-03-13T09:58:00",
FirstReleasedYear: 2015,
GameCategoryId: -1,
GameWarningId: -1,
MediaId: 0,
SongAlbumTitle: "",
SongCategoryId: -1,
SongRiaaId: -1,
SongWarningId: -1,
PromotesPublishedId: -1,
ProprietaryCustomerID: -1,
StreamLengthinseconds: 172,
MovieCategoryId: 1,
MovieMpaaId: 5,
MovieWarningId: -1,
BoxOfficeInMillions: -1,
MediaReceivedDate: "2015-02-05T08:56:13",
ExpirationDate: null,
CountryOforiginId: 0,
LanguageId: 0,
OfficialSiteUrl: "",
OkToEncodeAndServe: true,
IsATitle: true,
Sequence: -1,
OverallSequence: -1,
DisplayTitle: "Furious 7",
NormalizedTitle: "furious seven",
TvCategoryid: -1,
TvRatingId: -1,
CopyrightholderId: 237,
DirectorId: 23973,
Rank1Day: 32,
Rank7Day: 1000000,
Rank30Day: 41,
RankAllTime: 859
}
]
}

Response Data Dictionary

The API response above consists of multiple entities and their properties from our OData API. The dictionary below lists those entities and their properties.

VideoAssets Entity (OData 2.0)

A collection of promotional videos for Entertainment Programs. This collection consists of trailers, music videos, game trailers, clips, scenes, television promos and any other promotional video asset IVA offers. All of these VideoAssets relate directly to a single EntertainmentProgram using the PromotesPublishedId property. Additionally, one VideoAsset per EntertainmentProgram is specified as the Default video asset.
PropertyDescription
PublishedidThe unique ID for the VideoAsset. The PublishedId is used to generate links to the Asset using the VIDEO API.
TitleTitle or short description of the video asset.
DateCreatedThe original date the VideoAsset record was created.
DateModifiedThe last date the VideoAsset records was changed.
MediaIdReference to the MediaType entity. This determines the kind of VideoAsset. For example: Movie Trailer, Song, clip, alternate version, etc.
PromotesPublishedIdEvery VideoAsset has an EntertainmentProgram as a parent to identify what the promotional Video Asset is about. The PromotesPublishedId will contain the PublishedId of the parent EntertainmentProgram entity.
ProprietaryCustomerIDThis defines the owner of the content.  This property only  applies to subscription customers who use IVA for encoding content. Otherwise, this property will always be -1.
StreamLengthinsecondsThe length is seconds of the VideoAsset. This is useful to distinguish whether IVA serves the VideoAsset or if it is available via the YouTube plugin in the IVA Flash player.  Default = -1.
MediaReceivedDateIn the event that IVA gets video materials either on tape or digital files, the MediaReceivedDate is populated upon receipt.  This can be used to query for the newest videos available. Default = NULL
 ExpirationDate Some video content is provided to IVA with an expiration date where a video asset is no longer allowed to be viewed online.  This field will contain a date for the Default VideoAsset if an expiration date is set. Otherwise, the expiration date will be NULL.
OkToEncodeAndServeFrom time to time, content owners need to restrict a video from being displayed. This boolean property is used to disable content from being served from IVA servers. Default = True.
DisplayTitleThis property is a user friendly formatted version of the Title property. Ex: ROCK, THE would have a DisplayTitle of The Rock.  Default is ”.  This field is only populated when necessary.(BETA)
LastEncodeDateThis property represents the date the SOURCE file (digital master) for all of the encodes was made.  When IVA creates new encodes for specific devices, we use the digital master file as the source. This date would not change unless IVA replaces the digital source file with a new one.
NormalizedTitleThis property strips out various characters to make searching more standardized. (BETA)
LanguageSpokenIdReference to Language entity. This property describes the primary language spoken in the VideoAsset which is not particularly the same as the Language as the EntertainmentProgram. This property is especially useful for localizing video content in other countries in combination with TargetCountry property.  Default = -1.
LanguageSubtitledIdReference to Language entity. This property describes the primary language subtitled in the VideoAsset which is not particularly the same as the Language as the EntertainmentProgram. This property is especially useful for localizing video content in other countries in combination with TargetCountry property.  When the video asset does not have subtitles, this property is set to -1.  Default = -1.
TargetCountryIdReference to Country entity. This denotes whether the VideoAsset was made for a specific country. This property is rarely used. The default = -1.
SourceWidthThe width of the digital master.  Default = -1 when information is not available.
SourceHeightThe height of the digital master. Default = -1 when information is not available.
HdSourceDetermines if the digital master’s width is greater than 1260 pixels wide (720p HD).
DefaultVideoAssetDetermines if the VideoAsset is the default video played for the EntertainmentProgram denoted by the PromotesPublishedId property.
WarningFlagThis denotes a red band trailer or explicit content.  For most content this is set to false.
AllowAdsThis property was added to fulfill a requirement by certain copyright holders that want to disallow ads in front of their content but is rarely used.  Default = True
RequiresIVAPlayerThis property was added to allow programmers to easily identify content that can only be played through IVA’s Cross Platform Player and cannot be used with our Video API.  There is no additional charge for this content.
CopyrightholderIdThis is not a new property to IVA but was not previously a part of the video assets entity.  This Id allows developers and IVA identify copyright holders of individual assets.
HasContentThis new property denotes that there is content for this video asset.  (Boolean)
Sequence This property is used primarily used for Television Seasons and Television Episodes to order child elements. Default = -1.
OverallSequence This property is used primarily for Television Episodes to identify the sequence of the episode in the entire series. Default = -1.

VideoAssetScreenCaptures Entity (OData 1.0/2.0)

A collection of image URLs related to or taken from a VideoAsset. These images are taken from the video asset as a screen grab or photo still. At least one image is selected for every video asset to be used as the thumbnail.
PropertyDescription
PublishedIDUnique ID of a VideoAsset.
URLURL to the screen capture associated with the VideoAsset.

Languages Entity (OData 1.0/2.0)

A collection of Languages used to identify the Language Spoken, Language Subtitled or any other meta data item that needs a language.
PropertyDescription
LanguageIdUnique ID for the language.
LanguageNameThe English description of the language.

MediaTypes Entity (OData 1.0/2.0)

A collection of MediaTypes to define the type of Entertainment Program or VideoAsset. Different properties of the EntertainmentProgram or VideoAsset are populated based on the MediaType. For example, the Director property is unique to Movies, Other, and TV. Another example is VideogameCategory which is populated for MediaType Game.
PropertyDescription
MediaIdUnique Id for MediaType
MediaDefines the kinds of Media IVA catalogs. Media Types can be things like Movies, Scenes, Songs, Video Games, etc.
ReportDisplayOrderThe order of the MediaTypes for display in ascending order.

Encodes Entity (OData 1.0/2.0)

A collection of Encodes available from IVA to use with the Video API or IVA’s HTML5 or Flash Video Players.
PropertyDescription
PublishedIdUnique ID for the VideoAsset.
StreamingFlavorIdID for the type of encode.
DateDigitizedThe date in which the video was last encoded.
rateThe Kbps target for the encode. Ex: 450 = 450 Kbps of the combined audio and video tracks bitrate.
FileTypeThe video format of the encode. Ex: MP4
URLContains either a URL for the asset without a customerID or "see video api documentation"
RemoteURLTrue or False. Determines if the content is redirecting to another server for delivery. The overwhelming majority of encodes are ‘false’, meaning they are not being served from a 3rd party. Note: Content not served from IVA is free of charge and not included in the GB billing reports.
ProprietaryCustomerIdUsed only for Subscribers who use IVA to encode their own content. The default value is -1 meaning not proprietary.
IDUnique ID for the encode.

EntertainmentPrograms Entity (OData 2.0)

A collection of artistic works that IVA has classified as either a Movie, Television Series, Television Season, Television Episode, Game, Song or Other. The specific artistic work can be filtered using the MediaType property of the EntertainmentProgram object returned from the collection.
PropertyDescription
PublishedIdUnique key for the table and the ID Internet Video Archive uses to reference both entertainment programs and Video Assets. Every Asset has a unique PublishedID.
TitleThe title of the Artistic Work. Ex: “Green Lantern, The”. Titles have their articles placed at the end of the string.
DateCreatedThe date the EntertainmentProgram was created.
DateModifiedThe last time the record or any of it’s related data has been modified. This includes but is not limited to adding alternate Ids, new encodes, new VideoAssets added, cast changes, etc.
FirstReleasedYearThe original year the program was released.
GameCategoryIdReference to GameCategory entity. This is used for programs with MediaId 1. Default = -1.
MediaIdReference to MediaType entity. The MediaId determines the Type of entertainment program the item is. For example: Movie (0), Song (3), TV Series (24), etc.
SongAlbumTitleIf the mediaId = 3 then the MusicAlbumTitle could be populated.
SongCategoryIdReference to MusicCategory entity. This is used for programs with MediaId = 3. Default = -1.
SongRiaaIdReference to SongRatings entity. This is used for programs with MediaId = 3. Default = -1.
SongWarningIdReference to MusicWarnings entity. This is used for programs with MediaId = 3. Default = -1.
PromotesPublishedIdWhen a Program is a child of another Program, it’s PromotesPublishedId will contain the PublishedId of it’s parent. This is particularly useful for Televion Seasons (with Television Series parents) or Television Episodes (with Television Season parents).
ProprietaryCustomerIDThis defines the owner of the content. This property only applies to subscription customers who use IVA for encoding content. Otherwise, this property will always be -1.
StreamLengthinsecondsThe length is seconds of the Default VideoAsset for the Entertainment Program. This is useful to distinguish whether IVA has a VideoAsset for the particular Entertainment Program. Default = -1.
MovieCategoryIdReference to MovieCategory entity. This is used for programs with MediaId = 0 (Movie) or MediaId = 20 (Movie Alternate Version). Default = -1.
MovieMpaaIdReference to MovieMpaa entity. This is used for programs with MediaId = 0 (Movie) or MediaId = 20 (Movie Alternate Version). Default = -1. The data defined in this property is for US MPAA Ratings only.
MovieWarningIdReference to MovieWarning entity. This is used for programs with MediaId = 0 (Movie) or MediaId = 20 (Movie Alternate Version). Default = -1. The data defined in this property describes any explicit content found in the Movie as supplied by the Copyrightholder.
BoxOfficeInMillionsIf the movie was available in US theaters, IVA captures the total grossing Boxoffice dollars in millions. Ex: 24 would mean $24 million gross in US box office.
MediaReceivedDateIn the event that IVA gets video materials either on tape or digital files, the MediaReceivedDate is populated upon receipt. This can be used to query for the newest videos available. Default = NULL
ExpirationDateSome video content is provided to IVA with an expiration date where a video asset is no longer allowed to be viewed online. This field will contain a date for the Default VideoAsset if an expiration date is set. Otherwise, the expiration date will be NULL.
CountryOfOriginIdReference to Country entity. This denotes where the Program was primarily made. The default = -1.
LanguageIdReference to Language entity. This property describes the primary language spoken in the Program. Default = -1.
OfficialSiteUrlThe URL to the official web site as provided by the CopyrightHolder. Default = ”.
OkToEncodeAndServeFrom time to time, content owners need to restrict a video from being displayed. This boolean property is used to disable content from being served from IVA servers. Default = True.
IsATitleIndicates titles with an “A” rating
SequenceThis property is used primarily used for Television Seasons and Television Episodes to order child elements. Default = -1.
OverallSequenceThis property is used primarily for Television Episodes to identify the sequence of the episode in the entire series. Default = -1.
DisplayTitleThis property is a user friendly formatted version of the Title property. Ex: ROCK, THE would have a DisplayTitle of The Rock. Default is ”. This field is only populated when necessary.(BETA)
NormalizedTitleThis property strips out various characters to make searching more standardized. (BETA)
TvCategoryidReference to TvCategory entity. This is used for Programs with MediaID 24 (TV Series), 25 (TV Show), 26 (TV Season) and 27 (TV Episode). This property provides Television Genres for the program.
TvRatingIdRefernce to TvRating entity. This is used for TV Programs and provides the US TV Rating for the program.
CopyrightholderIdReference to Copyrightholder entity. This refers to the company who owns the copyright of the entertainment program.
DirectorIdID of the Director for Movie, TV, or Other media types. -1 is default which means it is not specified.
Rank1DayThis is the overall rank based on views over the last 1 day period. Rank is in ascending order where rank 1 is the top most viewed entertainment program. For Programs that do not have a ranking, the default value is 1000000. Programs are not ranked when they do not make it into the top 100 most viewed for a day.
Rank7DayThis is the overall rank based on views over the last 7 day period. Rank is in ascending order where rank 1 is the top most viewed entertainment program. For Programs that do not have a ranking, the default value is 1000000. Programs are not ranked when they do not make it into the top 100 most viewed for a day.
Rank30DayThis is the overall rank based on views over the last 30 day period. Rank is in ascending order where rank 1 is the top most viewed entertainment program. For Programs that do not have a ranking, the default value is 1000000. Programs are not ranked when they do not make it into the top 100 most viewed for a day.
RankAllTimeThis is the overall rank based on all recorded views. Rank is in ascending order where rank 1 is the top most viewed entertainment program. For Programs that do not have a ranking, the default value is 1000000. Programs are not ranked when they do not make it into the top 100 most viewed for a day.
GameWarningIdThis ID is used for programs with Games (MediaId = 1) to identify what warning is associated with it. Default = -1

Descriptions Entity (OData 1.0/2.0)

A collection of descriptions for EntertainmentPrograms.
PropertyDescription
PublishedIdUnique ID for the Description. Same ID used for the EntertainmentProgram.
ItemDescriptionDescription of the EntertainmentProgram

ProgramToPerformerMaps Entity (OData 1.0/2.0)

This entity is used to connect Performers to EntertainmentPrograms entities to allow for display, filtering, and mapping.
PropertyDescription
PublishedIdUnique ID to identify the Entertainment Program.
PerformerIDUnique Id for Performer associated with the Entertainment Program.
SortOrderThe order to display the performers in the EntertainmentProgram entity.
IDUnique ID for the Mapping.

Performers Entity (OData 1.0/2.0)

Performers entity is used for all people and bands associated with Entertainment Programs. This includes, cast, directors and artists.
PropertyDescription
PerformerIDUnique Id for Performers
LastNameThe last name of the person OR the name of a Band or Group. When a person has one name, the last name property should be used. For ex: Cher.
FirstNameThe first name of a person.
FullNameThe concatenated firstname property and lastname property with a space in between. Ex: trim(FirstName + ‘ ‘ + LastName). Important: Leading Articles should be place at the end of the string. Ex: Rolling Stones, The.
DatemodifiedThe last date the record has be modified.
NormalizedNameA standardized version of the actor's full name

Alternate ID's Entity (OData 2.0)

The Alternate ID's Entity contains all the 3rd party ID matches to IVA's entertainment program ID's. By default, users have access to the following ID's: EIDR, Fandango, Freebase, IMDB, The Movie DB, and UPC. Access to any other 3rd party ID is restricted and requires permission from the data provider and IVA.


Expand this entity in your API call from the entertainment program.
PropertyDescription
PublishedIdThe published ID of the matching entertainment program.
IDThe 3rd party ID IVA has matched.
IDTypeThe ID number of the corresponding ID type from the Alternate ID Types Entity.
ScoreNo longer used
DateAddedDate when we matched the ID to the entertainment program.

Alternate ID Types Entity (OData 2.0)

The Alternate ID Types Entity contains information about the 3rd Party ID's that IVA captures and matches to its entertainment programs. The entity contains the name and ID number of the 3rd party data provider as well as the required length of the ID expected by the API. The following 3rd party data is provided by default: EIDR, Fandango, Freebase, IMDB, Movie DB, UPC .Some data providers ID's are not exposed by default and need special permission to access.
PropertyDescription
IDThis ID corresponds to the ID type and can be used when filtering the API for specific ID types.
IdTypeTells you what each ID is.
RequiredLengthLets you know how many characters the API expects each ID to be.

 

Related Entertainment Programs

The response above contains “Related Entertainment Programs”. These frequently contain video assets for TV.  A TV series can have multiple video assets associated with it, including videos promoting the series itself, a particular season of the series, or a specific episode of a season. See our video on Traversing TV for a more in-depth look at how IVA’s TV database is structured.

Additional Data

For additional data and and examples, see IVA’s full OData API 2.0 documentation.

Next Steps

You now have IVA’s Published ID’s mapped to your program data. Use these Published ID’s with IVA’s Video API and your own player to playback the videos. For more information on our video formats see our documentation.