Data Dictionary

The Data Dictionary is a great resource to quickly find what information and in what tables is certain information is available.  Check out LINQPad and Sesame Data Browsers as useful tools to browse the data.  Make sure to sign up for a developer account and review the services section to different service levels.  To get a test account contact sales.

EntertainmentPrograms Entity
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.
Property		Description
PublishedId		Unique 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.
Title		The title of the Artistic Work. Ex: "Green Lantern, The".  Titles have their articles placed at the end of the string.
DateCreated		The date the EntertainmentProgram was created
DateModified		The 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.
FirstReleasedYear		The original year the program was released.
GameCategoryId		Reference to GameCategory entity. This is used for programs with MediaId 3. Default = -1.
MediaId		Reference to MediaType entity. The MediaId determines the Type of entertainment program the item is. For example: Movie (0), Song (1), TV Series (24), etc.
MusicAlbumTitle		If the mediaId = 3 then the MusicAlbumTitle could be populated.
MuscCategoryId		Reference to MusicCategory entity. This is used for programs with MediaId = 3. Default = -1.
MusicRiaaId		Reference to SongRatings entity. This is used for programs with MediaId = 3. Default = -1.
MusicWarningId		Reference to MusicWarnings entity. This is used for programs with MediaId = 3. Default = -1.
PromotesPublishedId		When 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).
ProprietaryCustomerID		This 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.
StreamLengthInSeconds		The 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.
MovieCategoryId		Reference to MovieCategory entity.  This is used for programs with MediaId = 0 (Movie) or MediaId = 20 (Other). Default = -1.
MovieMpaaId		Reference to MovieMpaa entity. This is used for programs with MediaId = 0 (Movie) or MediaId = 20 (Other). Default = -1. The data defined in this property is for US MPAA Ratings only.
MovieWarningId		Reference to MovieWarning entity. This is used for programs with MediaId = 0 (Movie) or MediaId = 20 (Other). Default = -1. The data defined in this property describes any explicit content found in the Movie as supplied by the Copyrightholder.
BoxOfficeInMillions		If 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.
MediaReceivedDate		In 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.
CountryOfOriginId		Reference to Country entity. This denotes where the Program was primarily made.  The default = -1.
LanguageId		Reference to Language entity. This property describes the primary language spoken in the Program. Default = -1.
OfficialSiteUrl		The URL to the official web site as provided by the CopyrightHolder. Default = ''.
OkToEncodeAndServe		From 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.
IsATitle		Indicates titles with an "A" rating
TagLine		Short description that can be used for SEO purposes. Default is ''.
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.
DisplayTitle		This 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)
NormalizedTitle		This property strips out various characters to make searching more standardized. (BETA)
TvCategoryId		Reference 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.
TVRatingId		Refernce to TvRating entity. This is used for TV Programs and provides the US TV Rating for the program.
HasIvaContent		On rare occasions studios provide links to video content rather than high quality source materials.  Content that points to studio links usually has limited formats and IVA cannot guarantee the quality of delivery.  This property denotes whether IVA is delivering the video for the Default VideoAsset for the program. Default = True.
HasYouTubeContent		When video content is not available from a studio, IVA gathers links to Youtube that can be played in the IVA Flash Player. This property determines if the default VideoAsset is a YouTube video. Default = False.
CopyrightholderId		Reference to Copyrightholder entity. This refers to the company who owns the copyright of the entertainment program.
DirectorId		ID of the Director for Movie, TV, or Other media types.  -1 is default which means it is not specified.
Rank1Day		This 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.
Rank7Day		This 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.
Rank30Day		This 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.
RankAlltime		This 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.

VideoAssets Entity
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.
Property	Description
PublishedId	The unique ID for the VideoAsset. The PublishedId is used to generate links to the Asset using the VIDEO API.
Title	Title or short description of the video asset.
DateCreated	The original date the VideoAsset record was created.
DateModified	The last date the VideoAsset records was changed.
MediaId	Reference to the MediaType entity. This determines the kind of VideoAsset. For example: Movie Trailer, Song, clip, alternate version, etc.
PromotesPublishedId	Every 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.
ProprietaryCustomerId	This 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.
StreamLengthInSeconds	The 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.
MediaReceivedDate	In 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
OkToEncodeAndServe	From 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.
DisplayTitle	This 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)
LastEncodeDate	This 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.
NormalizedTitle	This property strips out various characters to make searching more standardized. (BETA)
LanguageSpokenId	Reference 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.
LanguageSubtitledId	Reference 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.
TargetCountryId	Reference to Country entity. This denotes whether the VideoAsset was made for a specific country. This property is rarely used. The default = -1.
IvaContent	On rare occasions studios provide links to video content rather than high quality source materials.  Content that points to studio links usually has limited formats and IVA cannot guarantee the quality of delivery.  This property denotes whether IVA is delivering the video for the Default VideoAsset for the program. Default = True.
YouTubeContent	When video content is not available from a studio, IVA gathers links to Youtube that can be played in the IVA Flash Player. This property determines if the default VideoAsset is a YouTube video. Default = False.
SourceWidth	The width of the digital master.  Default = -1 when information is not available.
SourceHeight	The height of the digital master. Default = -1 when information is not available.
HdSource	Determines if the digital master's width is greater than 1260 pixels wide (720p HD).
DefaultVideoAsset	Determines if the VideoAsset is the default video played for the EntertainmentProgram denoted by the PromotesPublishedId property.
WarningFlag	This denotes a red band trailer or explicit content.  For most content this is set to false.

Encodes Entity
A collection of Encodes available from IVA to use with the Video API or IVA's HTML5 or Flash Video Players.
Property		Description
PublishedID	Unique ID for the VideoAsset.
StreamingFlavorId	ID for the type of encode.
DateDigitized	The date in which the video was last encoded.
Rate	The Kbps target for the encode. Ex: 450 = 450 Kbps of the combined audio and video tracks bitrate.
FileType	The video format of the encode. Ex: MP4
URL	Placeholder property. This will always be empty.
RemoteURL	True 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.
ProprietaryCustomerId	Used only for Subscribers who use IVA to encode their own content.   The default value is -1 meaning not proprietary.
ID	Unique ID for the encode.

Countries Entity
A collection of every Country and is used to Reference CountryOfOrigin and TargetCountry data.
Property		Description
CountryId	Unique ID for the Country
CountryName	Name of the Country

Descriptions Entity
A collection of descriptions for EntertainmentPrograms.
Property		Description
PublishedId	Unique ID for the Description. Same ID used for the EntertainmentProgram.
Description	Description of the EntertainmentProgram

GameCategories Entity
A collection of genres for Entertainment Programs with MediaID = 3.
Property		Description
Id	Unique ID for the Game Category.
Category	Genre of the game. Games can have only one category.

GameWarnings Entity
A collection of warnings specific to Game Entertainment Programs with MediaID = 1.
Property		Description
Id	Unique ID for the Game Warning.
Warning	Warning messages based on the game content.

ProgramToGameFormatMaps Entity
A collection of Mappings that relates the EntertainmentProgram (mediaid=1 Game) to it's various Game Formats. For example, this enitity is used to get the console platforms for a particular game.
Property		Description
Id	Unique ID for the Game Format Mapping.
PublishedId	The ID of the EntertainmentProgram in the Mapping
GameFormatID	The ID of the matching GameFormat entity.

GameFormats Entity
A collection of Game Formats for Entertainment Programs with MediaID = 1.
Property		Description
Id	Unique ID for the Game Format.
GameFormatName	The console format. Ex: X-Box 360, Sony PS3, etc.

HdTitlePhotos Entity
A collection of screen captures from VideoAssets. IVA strives to have a screen capture for all newly encoded VideoAssets in both 16x9 aspect ration and 4x3 ratio.
Property		Description
PhotoId	Unique ID for the HD Photo.
Width	Width of the title photo (screen capture)
Height	Height of the title photo (screen capture)
ParentId	If the title photo is a derivative (different size) of another, it will have a parentId. Default = NULL
DateCreated	Date the title photo was made.
AspectRatioId	Used to define the width and heigh ratio. Ex: 4x3 or 16x9
PublishedId	PublishedId of the VideoAsset the screen capture was taken.
DefaultTitle	Determines if this screen capture is to be used as the default

IdMaps Entity
A collection of Ids used to map the IVA publishedId to external Ids published on the Web. These IDs found on the web include UPC, IMDB, Netfix and Amazon IDs.
Property		Description
PublishedId		Unique key for the EntertainmentProgram.
Id	Alternate ID that IVA matches to.  These IDs include IMDB, Netflix, UPC, ASIN.
IdType	Specifies the AternateIdType of the item.

Images Entity
A collection of Image Assets that can be used with the Images API. This includes theatrical posters, poster art, game art, and more.  We are currently working on expanding the amount of content available for all our titles.  If you are looking for an image to use with a title or video asset please also see the VideoAssetScreenCaptures Entity.  There will be at least one image for each video asset there.
Property		Description
ImageID		Unique ID for Image asset.
FileSize		The size of the original Image asset.
Width	Width of the Image asset.
Height	Height of the Image asset.
PhotoCredit	Description of photo credit if provided by CopyrightHolder. Default = ''
ShortDescription	Short description of the Image.  Default = ''
TargetCountryId	The CountryId if the Image is specific to a Country. Default = Null.
WarningFlag	Specifies if the Image contains content that may not be suitable for children.  Default = False

ImagesCategories Entity
A collection of Image Assets that can be used with the Images API.
Property		Description
ImageCategoryId		Unique ID for Image category.
ParentCategoryId		ImageCategories can have children. If the ParentCategoryId
Width	Width of the Image asset.
Height	Height of the Image asset.
PhotoCredit	Description of photo credit if provided by CopyrightHolder. Default = ''
ShortDescription	Short description of the Image.  Default = ''
TargetCountryId	The CountryId if the Image is specific to a Country. Default = -1.
WarningFlag	Specifies if the Image contains content that may not be suitable for children.  Default = False

ImagesFileTypes Entity
A collection of ImageFileTypes to determine the file extension and image format. Ex: jpg, png, gif, etc.
Property		Description
ImageFileTypeId		Unique ID for Image FileType.
ImageFileType		The file format of Image Asset. Ex: jpg, png, psd, etc.

ImagesToTitleorPerformerMaps Entity
A collection of mappings to associate the Image Assets to either VideoAssets or Performers or Both.
Property		Description
ImageId		Reference ID to the Images entity.
ImageCategoryId		Reference to the ImageCategory entity.
PublishedId		Reference to the VideoAsset the Image is associated to.
PerformerId		Reference to the Performer entity in the case that the Image is of the performer.
DateAddedDesc		The date the map record was added.

Languages Entity
A collection of Languages used to identify the Language Spoken, Language Subtitled or any other meta data item that needs a language.
Property		Description
LanguageId		Unique ID for the language.
LanguageName		The English description of the language.

Lists Entity
A collection of TitleLists that can be used to generate and display editorial lists.  This entity must be used in conjunction with ListToProgramMaps to see the EntertainmentPrograms in the list.
Property		Description
TitleListId		Unique ID for the list.
TitleList		The name of the list.
DateModified		The date and time the list was last modified.
PageName		String to use to group lists.
Description		A short description of the editorial list.

ListToProgramMaps Entity
A collection of ListToProgramMaps that can be used to generate and display editorial lists.  This entity should be used in conjunction with Lists to see the name and description of the list.
Property		Description
TitleListId		Reference to the Lists Entity.
PublishedId		Reference to either a VideoAsset or EntertainmentProgram.
SortOrder		The order of the list in ascending order.

MediaTypes Entity
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.
Property		Description
MediaId		Unique Id for MediaType
Media		Defines the kinds of Media IVA catalogs.  Media Types can be things like Movies, Scenes, Songs, Video Games, etc.
ReportDisplayOrder		The order of the MediaTypes for display in ascending order.

MovieCategories Entity
A collection of genres for Entertainment Programs with MediaID = 0 or MediaID = 28.
Property		Description
Id		Unique Id for Movie Category
Category		Genres used for Entertainment Programs

MovieRatings Entity
A collection of US theatrical ratings for Entertainment Programs with MediaID = 0 or MediaID = 28.
Property		Description
Id		Unique Id for US Movie Ratings
Rating		US theatrical ratings

PerformerMappingToHdPhotos Entity
A mapping table used to tag or identify performers in HdTitlePhotos Entity.
Property		Description
MappingId		Unique Id for PerformerMappingToHdPhoto
PerformerID		Unique ID for a performer found in the Performers Entity.
DateAdded		The date the PerformerMapping was created.
DefaultPerformer		Specifies that the photo in this mapping is the default image used for a performer. In the event  there is no default specified, the newest image based on the DateAdded is used.

Performers Entity
Performers entity is used for all people and bands associated with Entertainment Programs. This includes, cast, directors and artists.
Property		Description
PerformerID		Unique Id for Performers
LastName		The 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.
FirstName		The first name of a person.
Full Name		The 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.
DateModified		The last date the record has be modified.

PerformerScreenCaptures Entity
IVA captures images for individual performers and provides URLs to the jpg images which are 320 wide x 240 pixels high.
Property		Description
PerformerID		Unique Id for Performers
DateAdded		The date the record was added.
URL		The partial path the the image.

ProgramToPerformerMaps Entity
This entity is used to connect Performers to EntertainmentPrograms entities to allow for display, filtering, and mapping.
Property		Description
PublishedId		Unique ID to identify the Entertainment Program.
PerformerID		Unique Id for Performer associated with the Entertainment Program.
SortOrder		The order to display the performers in the EntertainmentProgram entity.
ID		Unique ID for the Mapping.

ReleaseEvents Entity
IVA captures Release Event information mainly for US theatrical releases but also includes release events for Television and overseas releases.
Property		Description
ID		Unique ID to identify a ReleaseEvent
PublishedID		Unique Id for identifying the associated EntertainmentProgram
ReleaseDate		The date the release event occurs or occurred.
ReleaseTypeId		Unique ID associated with the ReleaseType entity.
ReleaseType		The string value of the associated ReleaseTye entity.  Ex: US Wide Theatrical Release.
ReleaseCountry		The country the release event occurs or occurred.
ReleaseCountryId		The ID used to associate the Country entity.

ReleaseTypes Entity
Lookup table used to identify types of ReleaseEvents.
Property		Description
ID		Unique ID to identify a ReleaseEvent
Type		The kind of Release type. Ex: Wide Theatrical Release, Limited Theatrical Release, DVD release, etc.

SongCategories Entity
The song genre of an EntertainmentProgram with a MediaTypeId = 3.
Property		Description
ID		Unique ID to identify a Song genres or categories.
Category		The music genre of a Song.

SongRatings Entity
The song RIAA when available of an EntertainmentProgram with a MediaTypeId = 3.
Property		Description
ID		Unique ID to identify a Song's RIAA rating.
RIAA		The song's US RIAA rating.

SongWarnings Entity
The song's warning when available of an EntertainmentProgram with a MediaTypeId = 3.
Property		Description
ID		Unique ID to identify a Song's Warning.
RIAA		The warning of content in the song's music video.

TvCategories Entity
A television genre for EntertainmentPrograms with a MediaTypeId = 24, 25, 26, or 27.
Property		Description
ID		Unique ID to identify a TV genre / category.
Category		The category or genre of a Television Series, Episode, or Series.

TvRatings Entity
A television rating for EntertainmentPrograms with a MediaTypeId = 24, 25, 26, or 27.
Property		Description
ID		Unique ID to identify a TV rating.
Rating		The US rating of a Television Series, Episode, or Series.
RatingDescription		The US description of the rating

Copyrightholder Entity
A collection of every Copyrightholder associated with an EntertainmentProgram or VideoAsset Entity.
Property		Description
CopyrightholderId	Unique ID for the Copyrightholder
CopyrightholderName	Name of the Copyrightholder

VideoAssetScreenCaptures Entity
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.
Property		Description
PublishedID		Unique ID of a VideoAsset.
URL		URL to the screen capture associated with the VideoAsset.

 

Special Methods
These special Methods can be useful in certain situations.  The GetHourlyRequests methods can help you diagnose if you are hitting the rate limit set for data requests.  The GetEntertainmentProgramsByPinpointid method is great for finding exactly what you need based on ID's you may already have.  The GetEncodes method is perfect for any customer who is looking for all the information needed to make a link to a trailer.
GetHourlyRequestsForDeveloperId()	Returns the hourly count on the server for the developerID used in the request. Since IVA OData API uses extensive caching, it is likely that the second request will be return a cached result.  We suggest implementing a cache-busting random variable at the end of the URL to ensure an accurate result. Example: http://api.internetvideoarchive.com/1.0/DataService/GetHourlyRequestsForDeveloperId?developerid={your-ID}
GetHourlyRequestsForIpAddress()	Returns the hourly count on the server for the IP address used in the request. Since IVA OData API uses extensive caching, it is likely that the second request will be return a cached result.  We suggest implementing a cache-busting random variable at the end of the URL to ensure an accurate result. Example: http://api.internetvideoarchive.com/1.0/DataService/GetHourlyRequestsForIpAddress?developerid={your-ID}
GetEntertainmentProgramByPinpointId(ID as string, IdType as interger)	This method mimics the Pinpoint API in the original IVA Data API. This method allows users to pass an ID and an dType listed here (http://api.internetvideoarchive.com/1.0/DataService/AlternateIdTypes?developerid={your-id}). The result will be the EntertainmentPrograms that match the ID. Example: http://api.internetvideoarchive.com/1.0/DataService/GetEntertainmentProgramByPinpointId?ID='1756'&IdType=0&developerid={your-ID} For more information including a list of the Alternate ID numbers click here.
GetEncodes()	This method can be used to generate video urls to content that include the Hash Code and Time To Live required for subscribers to make working URLs to content.  Please reference the link below to the article that describes this routine in more detail.
	Generate URL's to video using the IVA OData API 1.0