Inheritance

It is possible that a property will occur at multiple levels of the Simply.TV metadata hierarchy, with values specific to that level. For example, Simply.TV may supply:
  • A synopsis that describes a series as a whole.
  • A synopsis that includes the story development specific to a single season.
  • A synopsis that includes the story development specific to a single episode.
As you might expect, the first synopsis will appear in the relevant series document, the second in the relevant season document, and the last in the relevant program document. However, to reduce the number of calls that a client might have to make to obtain all the available metadata about a program or event, and to facilitate effective searching for data across all levels of the hierarchy, each content instance document also includes all of the objects from the entities higher up the program hierarchy. This means that:
  • A season document will include the synopses for the relevant season and the synopses for its parent series.
  • An event document will include the synopses for the relevant program, its parent season and its grandparent series.
Each such object has a hierarchyLevel property that indicates which level the object applies to: 
"searchableTextItems": [
    {
       "hierarchyLevel": "program",
       "type": "synopsis",
       "value": {
          "en": "Jimmy Carr hosts this extended version of the topical comedy panel game. He is joined by team captains Sean Lock and Jon Richardson and a host of guests including Alex Jones, Tinchy Stryder, David O'Doherty and Katherine Ryan"
       }
    },
    {
       "hierarchyLevel": "season",
       "type": "synopsis",
       "value": {
          "en": "The sixteenth series of the popular comedy panel game hosted by comedian Jimmy Carr"
       }
    },
    {
       "hierarchyLevel": "series",
       "type": "synopsis",
       "value": {
          "en": "Topical British comedy panel game hosted by comedian Jimmy Carr, in which panellists answer questions based on public opinion."
       }
    }
 ]
This applies not only to synopses but also to titles, images, tags etc. Several simple properties such as seasonId, seasonNumber and numberOfEpisodes (in season) are also copied down the program hierarchy. These properties only really apply to one specific level. Their name alone should make clear which level that is.