{"id":939,"date":"2019-06-10T14:52:42","date_gmt":"2019-06-10T14:52:42","guid":{"rendered":"http:\/\/live.ecd-demo.com\/apihelp\/?page_id=939"},"modified":"2025-07-21T17:21:14","modified_gmt":"2025-07-21T17:21:14","slug":"responses","status":"publish","type":"page","link":"https:\/\/apihelp.ecd-demo.com\/index.php\/documentation\/responses\/","title":{"rendered":"CDAPI Responses"},"content":{"rendered":"\n\n<h3 class=\"wp-block-heading\">CDAPI Stores<\/h3>\n\n\n\n\nThe CDAPI has 3 <a href=\"\/index.php\/documentation\/what-does-the-api-contain\/api-stores\/\">stores<\/a>, which between them hold all the metadata that Simply.TV provides to its customers:\n\n\n\n\n<ul class=\"wp-block-list\"><li>Content Instance: This store holds details about series, programs, events etc. The full program hierarchy is explained <a href=\"\/index.php\/documentation\/what-does-the-api-contain\/red-bee-program-hierarchy\/\">here<\/a>.<\/li><li>Contributor: This store holds details about actors, directors etc.<\/li><li>Source: This store holds details about linear channels and VOD catalogs.<\/li><\/ul>\n\n\n\n\nEach store is a collection of JSON documents, with one document per program, contributor etc.\n\n\n\n\n<h3 class=\"wp-block-heading\">The filter request<\/h3>\n\n\n\n\nThe most common request to the CDAPI is via the <a href=\"\/index.php\/documentation\/what-does-the-api-contain\/filters\/\">filter resource<\/a>. Its basic syntax is as follows:\n\n\n\n\n<pre class=\"wp-block-preformatted\">https:\/\/&lt;ApiEndpoint&gt;\/stores-active\/&lt;StoreType&gt;\/filter?filter=&lt;FilterCriteria&gt;&amp;api_key=&lt;ApiKey&gt;<\/pre>\n\n\n\n\nThe payload of the CDAPI&#8217;s response will be an array of JSON documents, which will be a set of documents taken from the specified store that meet the specified criteria.\n\n\n\nAll the documents in one store (and hence all the documents in a response to a filter request) have the same schema, but the schema for the 3 stores is different to reflect the different data they hold. Further explanation can be found by following the relevant link below:\n\n\n\n\n<ul class=\"wp-block-list\"><li><a href=\"\/index.php\/documentation\/responses\/content-instance-documents\/\">Content instance documents<\/a><\/li><li><a href=\"\/index.php\/documentation\/contributor-documents\/\">Contributor documents<\/a><\/li><li><a href=\"\/index.php\/documentation\/responses\/source-documents\/\">Source documents<\/a><\/li><\/ul>\n\n\n\n\n\n<h3 class=\"wp-block-heading\">Other CDAPI Responses<\/h3>\n\n\n\n\nThe API offers several other resources. Some (like <a href=\"\/index.php\/documentation\/what-does-the-api-contain\/entitlements\/\">entitlements<\/a>) give you more precise control over what data is returned; others (like <a href=\"\/index.php\/documentation\/requests\/deleted-documents\/\">deleted-documents<\/a>) support use cases beyond retrieving API data. Details of these requests, together with the responses they produce, can be found on child pages of the <a href=\"\/index.php\/documentation\/requests\/\">CDAPI Requests<\/a> page.\n","protected":false},"excerpt":{"rendered":"<p>CDAPI Stores The CDAPI has 3 stores, which between them hold all the metadata that Simply.TV provides to its customers: Content Instance: This store holds details about series, programs, events etc. The full program hierarchy is explained here. Contributor: This store holds details about actors, directors etc. Source: This store holds details about linear channels [&hellip;]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":279,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-939","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/939","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\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/comments?post=939"}],"version-history":[{"count":1,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/939\/revisions"}],"predecessor-version":[{"id":1494,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/939\/revisions\/1494"}],"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=939"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}