{"id":975,"date":"2019-06-10T16:00:16","date_gmt":"2019-06-10T16:00:16","guid":{"rendered":"http:\/\/live.ecd-demo.com\/apihelp\/?page_id=975"},"modified":"2025-07-21T17:23:52","modified_gmt":"2025-07-21T17:23:52","slug":"content-instance-documents","status":"publish","type":"page","link":"https:\/\/apihelp.ecd-demo.com\/index.php\/documentation\/responses\/content-instance-documents\/","title":{"rendered":"Content Instance Documents"},"content":{"rendered":"\nA contentinstance<\/em> document can represent any object in the Simply.TV metadata hierarchy<\/a> – series, programs, events etc. The same JSON schema applies to every level of the hierarchy, although a minority of properties are only relevant to certain levels (e.g. the publishedStartDateTime property is only relevant to events).\n\n\n\nThe JSON schema is designed so that you don’t need to query every level of the hierarchy to get all of the data that relates to a program or event – see here<\/a> for an explanation.\n\n\n\n\n

Primary Objects <\/h3>\n\n\n\n\nThe following table provides a summary of the primary objects within a contentinstance document. The object name column includes some links to other pages describing individual objects in more detail. For a full list of the properties that may be provided please see the schema file contentInstance_schema.json.\n\n\n\n
\n\n
Object name<\/strong><\/td>Data provided by object<\/strong><\/td><\/tr>
accessServiceAttributes<\/td>e.g. whether the content features subtitles for the hard of hearing<\/td><\/tr>
ageRatings<\/a><\/td>Restrictions on viewing by children under a certain age<\/td><\/tr>
audioAttributes<\/td>e.g. the primary spoken language within the content<\/td><\/tr>
contributions<\/td>The actors and directors of the program<\/td><\/tr>
countriesOfOrigin<\/td>Countries of origin for the production of the program<\/td><\/tr>
distributors<\/td>The organization that distributed the movie<\/td><\/tr>
images<\/a><\/td>Various images related to the program, including HTTP URLs from which those images can be downloaded<\/td><\/tr>
internalIds<\/td>Simply.TV generated IDs for the program, the relevant instance of the program and some associated entities<\/td><\/tr>
nonSearchableTextItems<\/td>Further synopses for the program. (Excluded from searches for a specific phrase, typically because they are abbreviated versions of searchableTextItems and including them in the search would create unhelpful duplication.)<\/td><\/tr>
otherAttributes<\/td>e.g. whether the event is live or is a repeat<\/td><\/tr>
programAwards<\/td>Awards won by the program, e.g. Oscars, BAFTAs<\/td><\/tr>
qualityRatings<\/td>Critical scoring of the program, e.g. number of stars<\/td><\/tr>
relatedMaterial<\/td>HTTP links to external web pages about the program, e.g. IMDB<\/td><\/tr>
rights (optional)<\/td>Indicates what rights a viewer has to view or record the program content in various scenarios<\/td><\/tr>
searchableTextItems<\/td>Synopses for the program. (CDAPI requests can be made that will return a list of programs whose searchableTextItems contain a specific phrase.)<\/td><\/tr>
searchableTitles<\/td>Titles for the relevant program and (where appropriate) its parent series<\/td><\/tr>
tags<\/td>Simply.TV assigned genre and similar tags<\/td><\/tr>
thirdPartyIds<\/td>IDs supplied by parties other than Simply.TV<\/td><\/tr>
videoAttributes<\/td>e.g. whether the event is broadcast in HD or SD<\/td><\/tr><\/tbody><\/table>\n\n<\/figure>\n\n\n\nSome data structures are used within several of the above objects – see here<\/a> for an explanation of how to interpret those data structures.\n\n\n\nOther attributes of the program \u2013 those that can be expressed as a single value, e.g. year of production \u2013 are provided as separate JSON properties within the content instance object.\n","protected":false},"excerpt":{"rendered":"

A contentinstance document can represent any object in the Simply.TV metadata hierarchy – series, programs, events etc. The same JSON schema applies to every level of the hierarchy, although a minority of properties are only relevant to certain levels (e.g. the publishedStartDateTime property is only relevant to events). The JSON schema is designed so that […]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":939,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-975","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/975","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=975"}],"version-history":[{"count":1,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/975\/revisions"}],"predecessor-version":[{"id":1496,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/975\/revisions\/1496"}],"up":[{"embeddable":true,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/939"}],"wp:attachment":[{"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/media?parent=975"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}