{"id":66,"date":"2017-02-14T21:44:35","date_gmt":"2017-02-14T21:44:35","guid":{"rendered":"http:\/\/live.ecd-demo.com\/apihelp\/?page_id=66"},"modified":"2025-07-21T16:35:57","modified_gmt":"2025-07-21T16:35:57","slug":"what-does-the-api-contain","status":"publish","type":"page","link":"https:\/\/apihelp.ecd-demo.com\/index.php\/documentation\/what-does-the-api-contain\/","title":{"rendered":"What does the API Contain"},"content":{"rendered":"<h3>Overview<\/h3>\n<p>The Simply.TV Content Discovery API (CDAPI) provides a comprehensive, powerful and flexible toolset in order to obtain:<\/p>\n<ul>\n<li>Rich program metadata for both linear and non-linear video (Video on Demand (VoD)\/catch-up TV catalogues) content<\/li>\n<li>Contributor Information<\/li>\n<li>Rating<\/li>\n<li>Awards<\/li>\n<li>Images<\/li>\n<li>Trailers<\/li>\n<li>Station\/Source Information<\/li>\n<li>Sports Information<\/li>\n<li>3rd Party Sites (Wikipedia, IMDB, Rotten Tomatoes etc)<\/li>\n<\/ul>\n<p>Please read the data model page to get a <strong><a href=\"\/index.php\/documentation\/reference\/data-model\/\">full list<\/a><\/strong>.<\/p>\n<h3>List of stores<\/h3>\n<ul>\n<li>Source<\/li>\n<li>ContentInstance\n<ul>\n<li>Event<\/li>\n<li>Program<\/li>\n<li>Series<\/li>\n<li>Season<\/li>\n<\/ul>\n<\/li>\n<li>Contributor<\/li>\n<\/ul>\n<p><a href=\"http:\/\/apihelp.ecd-demo.com\/index.php\/documentation\/what-does-the-api-contain\/api-stores\/\">Find more<\/a> information about list of stores<\/p>\n<h3>API At a Glance<\/h3>\n<ul>\n<li>Annotations<\/li>\n<li>Entitlements<\/li>\n<li>Contexts<\/li>\n<li><a href=\"\/index.php\/documentation\/what-does-the-api-contain\/filters\/\">Filters<\/a><\/li>\n<li>Attributes<\/li>\n<li><a href=\"\/index.php\/documentation\/what-does-the-api-contain\/search\/\">Search<\/a><\/li>\n<li>Cross-API Connections (3rd Party APIs)<\/li>\n<\/ul>\n<h3>Most Common Attributes<\/h3>\n\n<table id=\"tablepress-1\" class=\"tablepress tablepress-id-1 table-cols-3\">\n<thead>\n<tr class=\"row-1 odd\">\n\t<th class=\"column-1\">Property<\/th><th class=\"column-2\">Content<\/th><th class=\"column-3\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr class=\"row-2 even\">\n\t<td class=\"column-1\">contentInstanceType<\/td><td class=\"column-2\">Content Instance Type<\/td><td class=\"column-3\">Type of Content being described. List of available values: \u201cseries\u201d , \u201cseason\u201d , \u201cmultipartProgram\u201d , \u201cprogram\u201d , \u201cprogramVariation\u201d , \u201cevent\u201d , \u201cvodPackage\u201d<\/td>\n<\/tr>\n<tr class=\"row-3 odd\">\n\t<td class=\"column-1\">eventType \u2013 \u201cvod\u201d<\/td><td class=\"column-2\">Event type vod<\/td><td class=\"column-3\">Content is avaliable on VOD. If eventType is \u201cvod\u201d then this contentInstance document relates to \u201cvod\u201d content.<\/td>\n<\/tr>\n<tr class=\"row-4 even\">\n\t<td class=\"column-1\">eventType \u2013 \u201clinear\u201d<\/td><td class=\"column-2\">Event type Linear<\/td><td class=\"column-3\">Content is avaliable on linear. If eventType is \u201cLinear\u201d then this contentInstance document relates to \u201cLinear\u201d content.<\/td>\n<\/tr>\n<tr class=\"row-5 odd\">\n\t<td class=\"column-1\">lastModifiedDate (or lastModifiedDateTime)<\/td><td class=\"column-2\">Last modified date<\/td><td class=\"column-3\">\tLatest modified date of the document.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<!-- #tablepress-1 from cache -->\n\n<table id=\"tablepress-2\" class=\"tablepress tablepress-id-2 table-cols-3\">\n<thead>\n<tr class=\"row-1 odd\">\n\t<th class=\"column-1\">Property<\/th><th class=\"column-2\">Content<\/th><th class=\"column-3\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr class=\"row-2 even\">\n\t<td class=\"column-1\">sourceId<\/td><td class=\"column-2\">Source ID<\/td><td class=\"column-3\">Ericsson source ID - a primary key which uniquely identifies a sourceId in the Ericsson Source Linking Structure of source document. <\/td>\n<\/tr>\n<tr class=\"row-3 odd\">\n\t<td class=\"column-1\">seriesId<\/td><td class=\"column-2\">Series ID<\/td><td class=\"column-3\">Ericsson unique series ID \u2013 a primary key which uniquely identifies a series in the Ericsson Group Linking structure (series \u2013 season \u2013 episode)<\/td>\n<\/tr>\n<tr class=\"row-4 even\">\n\t<td class=\"column-1\">seasonId<\/td><td class=\"column-2\">Season ID<\/td><td class=\"column-3\">Ericsson unique season ID \u2013 a primary key which uniquely identifies a season in the Ericsson Group Linking structure (series \u2013 season \u2013 episode)<\/td>\n<\/tr>\n<tr class=\"row-5 odd\">\n\t<td class=\"column-1\">eventId<\/td><td class=\"column-2\">Event ID<\/td><td class=\"column-3\">Ericsson unique event ID to represent a particular broadcast of a program (Ericsson\u2019s unique ID for the event)<\/td>\n<\/tr>\n<tr class=\"row-6 even\">\n\t<td class=\"column-1\">multiPartProgramId<\/td><td class=\"column-2\">Multi part program ID<\/td><td class=\"column-3\">Ericsson multipart program ID for programs which comes in parts (for example part 1 and 2)<\/td>\n<\/tr>\n<tr class=\"row-7 odd\">\n\t<td class=\"column-1\">programId<\/td><td class=\"column-2\">Program ID<\/td><td class=\"column-3\">Ericsson unique program ID \u2013 a primary key which uniquely identifies a program<\/td>\n<\/tr>\n<tr class=\"row-8 even\">\n\t<td class=\"column-1\">programVariationId<\/td><td class=\"column-2\">Program variation ID<\/td><td class=\"column-3\">Only used by some broadcasters to identify variations of episodes.<br \/>\n<\/td>\n<\/tr>\n<tr class=\"row-9 odd\">\n\t<td class=\"column-1\">seriesLinkId<\/td><td class=\"column-2\">Series Link ID\t<\/td><td class=\"column-3\">Ericsson series linking based on the broadcast of episodes regardless of the Group Linking structure. An Ericsson unique ID for a series link<br \/>\n<\/td>\n<\/tr>\n<tr class=\"row-10 even\">\n\t<td class=\"column-1\">splitInstanceId<\/td><td class=\"column-2\">Split Event ID\t<\/td><td class=\"column-3\">Split event ID enabling programs split by another event to be linked. eg a movie interrupted by the news<br \/>\n<\/td>\n<\/tr>\n<tr class=\"row-11 odd\">\n\t<td class=\"column-1\">description (broadcasterId)\t<\/td><td class=\"column-2\">Broadcaster ID\t<\/td><td class=\"column-3\">Ericsson ID associated with a broadcaster (for example BBC, ITV)<br \/>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<!-- #tablepress-2 from cache -->\n","protected":false},"excerpt":{"rendered":"<p>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 [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":279,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-66","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/66","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/comments?post=66"}],"version-history":[{"count":2,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/66\/revisions"}],"predecessor-version":[{"id":1485,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/66\/revisions\/1485"}],"up":[{"embeddable":true,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/279"}],"wp:attachment":[{"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/media?parent=66"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}