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 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 for an explanation.
Primary Objects
The 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.
Object name
Data provided by object
accessServiceAttributes
e.g. whether the content features subtitles for the hard of hearing
Various images related to the program, including HTTP URLs from which those images can be downloaded
internalIds
Simply.TV generated IDs for the program, the relevant instance of the program and some associated entities
nonSearchableTextItems
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.)
otherAttributes
e.g. whether the event is live or is a repeat
programAwards
Awards won by the program, e.g. Oscars, BAFTAs
qualityRatings
Critical scoring of the program, e.g. number of stars
relatedMaterial
HTTP links to external web pages about the program, e.g. IMDB
rights (optional)
Indicates what rights a viewer has to view or record the program content in various scenarios
searchableTextItems
Synopses for the program. (CDAPI requests can be made that will return a list of programs whose searchableTextItems contain a specific phrase.)
searchableTitles
Titles for the relevant program and (where appropriate) its parent series
tags
Simply.TV assigned genre and similar tags
thirdPartyIds
IDs supplied by parties other than Simply.TV
videoAttributes
e.g. whether the event is broadcast in HD or SD
Some data structures are used within several of the above objects – see here for an explanation of how to interpret those data structures.
Other attributes of the program – those that can be expressed as a single value, e.g. year of production – are provided as separate JSON properties within the content instance object.
