Data Model
Data Model
The table below lists elments within the API’s data model.
Download richer and version (Excel spreadsheet) here (right click and save).
| PRODUCT NAME | PRODUCT DESCRIPTION |
|---|---|
| Content Instance Type | The objects type name. |
| Event Type | Indicates the type of event. If eventType is “Linear” then this event relates to “Linear” content. If eventType is “Vod” then this event relates to “Vod” content. |
| Last Modified Date | The date and time when the object was last modified. |
| Internal IDs | Set of IDs to uniquely identify objects in the Simply.TV metadata specification |
| Source ID | Unique ID of the source providing the event. |
| Series ID | Unique series ID, a primary key which uniquely identifies a series in the Simply.TV Group Linking structure. |
| Season ID | Unique season ID, a primary key which uniquely identifies a season in the Simply.TV Group Linking structure. |
| Event ID | Unique event ID to represent a particular event (e.g. Broadcast or VOD asset) of a program. |
| Program ID | Unique program ID, a primary key which uniquely identifies a program. |
| Multipart Program ID | Multipart program ID for programs which come in parts, e.g. part 1 and 2 of a documentary. |
| Program Variation ID | Unique program variation ID that identifies program variations, e.g. VOD CP specific program information or alternative program variations editorially created by Simply.TV. |
| Series Link ID | Unique series linking ID to allow series linking based on the broadcast of episodes regardless of the Group Linking structure. |
| Split Instance ID | Split event ID enabling programs split by another event to be linked, e.g. a movie interrupted by the news. |
| Broadcaster ID | Unique ID associated with a broadcaster. |
| Merged Event ID | Unique merged event ID. |
| Titles | Various titles for each type of metadata level (e.g. Program and Series titles). |
| Program Title | The full official program/movie title. |
| Multipart Program Title | The full multipart program title. |
| Program Variation Title | The full program variation title. |
| Season Title | The title of the particular season. A field which preserves a consistent season title when broadcasters or VOD CPs do not. |
| Season Variation Title | The title of the particular season variation. |
| Series Title | The title of the series. |
| Series Variation Title | The title of the series variation. |
| Synopsis | Various synopsises for each type of metadata level (e.g. Program and Series synopsis). |
| Program Synopsis | An informative synopsis about the program content. |
| Multipart Program Synopsis | An informative synopsis about the program content. |
| Program Variation Synopsis | An informative synopsis about the program content. |
| Season Synopsis | An informative synopsis about the season content. |
| Season Variation Synopsis | An informative synopsis about the season content. |
| Series Synopsis | An informative synopsis about the series content. |
| Series Variation Synopsis | An informative synopsis about the series content. |
| Third Party IDs | IDs from 3rd parties (e.g. Broadcaster Event ID) available as part of the Simply.TV metadata. |
| Broadcaster Event ID | Event ID provided by broadcaster. |
| DVB Event ID | Event ID as found in DVB-SI stream. |
| Published Start Date and Time | The published start and date time of the program. |
| Published End Date and Time | The published end and date time of the program. |
| Published Duration | Calculated duration. The difference between the published start and published end times, i.e. the length of the slot in which the programme sits. |
| Scheduled Start Date and Time | The scheduled start date and time of the program. The second-accurate start date and time from the broadcaster’s scheduling system. |
| Scheduled End Date and Time | The scheduled end date and time of the program. The second-accurate end date and time from the broadcaster’s scheduling system. |
| Scheduled Duration | Calculated duration based on the schedule information. The second-accurate duration of the event. |
| Net Duration | Net duration of the program, net of mid program advert breaks. |
| Last In Season | Last episode in a season flag. the “Last in Season” is a flag indicating the Last Episode in a “Series – Season – Episode” hierarchy. |
| Number Of Seasons In Series | Total number of seasons in a series delivered using the Simply.TV Group Linking structure. |
| Episode Number | The number of the episode within a season delivered using the Simply.TV Group Linking structure. |
| Season Number | The number of the season within a series delivered using the Simply.TV Group Linking structure. |
| Episode Airing Sequence Number | A value indicating the numerical representation of the episodes chronological airing within the season. |
| Episodic Secondary Identifier Number | A value indicating a secondary identifier of the episodic content. |
| Series Premiere | Series premier flag. A flag indicating the program is the first episode of a new series. |
| Season Premiere | Season premier flag. A flag indicating the program is the first episode of a returning series following its season finale. |
| Premium Content | An indication that a specific piece of content is premium level. |
| Number Of Episodes | Total number of episodes in a season delivered using the Simply.TV Group Linking structure. It is the the number of episodes in a particular Series (up to 25; not relevant to long-running Series) |
| Multi Part Program Sequence Number | The number of the part. |
| Multi Part Program Number Of Parts | The total planned number of parts In a multi part program. |
| Year Of Production | The year of production of a movie, series or program. |
| Original Airing Source Name | Name of the channel to air program first in Simply.TV database. |
| Original Airing Source Aliases | Aliases of the channel to air program first in Simply.TV database. |
| Original Airing Date and Time | The first known date and time of broadcast available in Simply.TV database. |
| Access Service Attributes | Access services related attributes. |
| Subtitles | A flag indicating the availability of subtitles. |
| Subtitle Language | The language of the text used in the subtitles. |
| Hard of Hearing Subtitles | A flag indicating the availability of hard of hearing subtitles. |
| Hard of Hearing Subtitles Language | The language of the text used in the hard of hearing subtitles. |
| Audio Description | A flag indicating the availability of audio description. Audio description is additional verbal commentary of visuals during TV programs, on DVDs, at live performances and at cinema presentations. It can include descriptions of different visual elements, including scenes, actions, settings, and costumes. |
| Audio Description Language | The actual language for the audio description. |
| Spoken Subtitles | A flag indicating the availability of spoken subtitles. |
| Spoken Subtitles Language | The language of the text used in the spoken subtitles. |
| Signed | A flag indicating the presence of a sign language. |
| Signed Language | The actual sign language for the hard-of-hearing. |
| Audio Attributes | Audio related attributes. |
| Sound Mix Type | Sound mix type as provided by broadcaster or VOD CP. |
| Language | The language of the spoken audio track available for this program. |
| Original Language | The original language of the spoken audio track for this program. |
| Dubbed | Boolean flag to indicate a dubbed audio track for this program. |
| Video Attributes | Video related attributes. |
| Aspect Ratio | A designation indicating the proportional relationship between video width and its height. |
| Video Definition | Attribute specifiying the definition the video in encoded in. |
| Other Attributes | Other attributes not related to access service, audio or video. |
| Live | A flag indicating a live event, e.g. a sport event, concert or special event. |
| Repeat | A designation that denotes if a program has or has not aired previously. |
| New | An brodcaster/VOD CP source specific attribute indicating a new event. |
| Event Status | |
| Age Ratings | Parental rating information. |
| Quality Ratings | Quality rating information |
| Tags | Tag based classification (e.g. Genres, Subgenres, Content Tags, Mood, etc.). |
| Genres | Genres (e.g. Children’s, Documentary, Drama Series, Sport, etc.) that together with subgenres sum up the primary theme. |
| SubGenres | Sub categorisation are applied to identify the most popular subcategories (e.g. Nature, war documentaries, comedy or western movies, etc.) to set together with the genres the primary theme. |
| Topic / Parent Topic | Parent topics classifiying content taga into areas. |
| ContentTags | Content specific tags to drive recommendations by tagging the main genre, subgenres and the main topics. |
| DVBGenre | Genres mapped to the DVB (Digital Video Broadcasters) genre space. |
| Mood | |
| Countries Of Origin | Production countries for movies. |
| Release Dates | Release dates for movies. |
| Distributors | Distributor information. |
| Contributions | List of contributions (actors, directors, etc.). |
| Person Awards | Awards given to a person. |
| Program Awards | Award given to a program. |
| Images | Images associated and related metadata. |
| Rights | Event level rights information. |
| Pricing | Event level pricing information. |
| Streams | Streams related information. |
| Related Material | Related material (e.g. IMDB pages, Twitter handles, etc.). |
| Twitter Handle | |
| Wikipedia Page | |
| Official Website | |
| IMDB Page | |
| Source | Source information |