Skip to main content
Version: s5

Architecture

Overview

Before jumping into examples it is worthwhile briefly mentioning the data architecture of the Sanctuary Health API so everything else makes sense.

Types of content

Sanctuary Health provides different types of content, these are:

  • Post used to represent standalone content
  • CardPack used to represent flashcard style text content
  • Course used to represent organized learning courses from constituent of Post and CardPack
  • Recipe used to represent culinary recipe content
note

Depending on the exact content in your organization's Library it is possible that one or more of these types can be ignored for your integration as no content of that type is selected or desired

Multi-language design

To facilitate multi language support, each of these Parent content types contain language invariant metadata, and Children objects with language specific metadata for the different language translations of the same content.

note

A complete description of each, including associated data, is available in the reference section

Ownership

When confirming content into your organizations library, it is the Parent object that is owned by the organization. Your organization will then have access to all language variations of that content according to your organizations contract with Sanctuary Health.

note

In the case of video media where there may be a native version with dubbing or closed captions, access is granted based on the language of the dubbing or closed captions.