What does the API Contain
Overview
The Simply.TV Content Discovery API (CDAPI) provides a comprehensive, powerful and flexible toolset in order to obtain:
- Rich program metadata for both linear and non-linear video (Video on Demand (VoD)/catch-up TV catalogues) content
- Contributor Information
- Rating
- Awards
- Images
- Trailers
- Station/Source Information
- Sports Information
- 3rd Party Sites (Wikipedia, IMDB, Rotten Tomatoes etc)
Please read the data model page to get a full list.
List of stores
- Source
- ContentInstance
- Event
- Program
- Series
- Season
- Contributor
Find more information about list of stores
API At a Glance
Most Common Attributes
| Property | Content | Description |
|---|---|---|
| contentInstanceType | Content Instance Type | Type of Content being described. List of available values: “series” , “season” , “multipartProgram” , “program” , “programVariation” , “event” , “vodPackage” |
| eventType – “vod” | Event type vod | Content is avaliable on VOD. If eventType is “vod” then this contentInstance document relates to “vod” content. |
| eventType – “linear” | Event type Linear | Content is avaliable on linear. If eventType is “Linear” then this contentInstance document relates to “Linear” content. |
| lastModifiedDate (or lastModifiedDateTime) | Last modified date | Latest modified date of the document. |
| Property | Content | Description |
|---|---|---|
| sourceId | Source ID | Ericsson source ID - a primary key which uniquely identifies a sourceId in the Ericsson Source Linking Structure of source document. |
| seriesId | Series ID | Ericsson unique series ID – a primary key which uniquely identifies a series in the Ericsson Group Linking structure (series – season – episode) |
| seasonId | Season ID | Ericsson unique season ID – a primary key which uniquely identifies a season in the Ericsson Group Linking structure (series – season – episode) |
| eventId | Event ID | Ericsson unique event ID to represent a particular broadcast of a program (Ericsson’s unique ID for the event) |
| multiPartProgramId | Multi part program ID | Ericsson multipart program ID for programs which comes in parts (for example part 1 and 2) |
| programId | Program ID | Ericsson unique program ID – a primary key which uniquely identifies a program |
| programVariationId | Program variation ID | Only used by some broadcasters to identify variations of episodes. |
| seriesLinkId | Series Link ID | Ericsson series linking based on the broadcast of episodes regardless of the Group Linking structure. An Ericsson unique ID for a series link |
| splitInstanceId | Split Event ID | Split event ID enabling programs split by another event to be linked. eg a movie interrupted by the news |
| description (broadcasterId) | Broadcaster ID | Ericsson ID associated with a broadcaster (for example BBC, ITV) |