Profile: program-episode

Profile Schema

A program-episode is a document representing an episode of a program. Unlike podcast episodes (which typically represent a single segment of audio), program-episode documents have a collection of links to their story documents, which together make up a single “episode”. The story documents in an episode’s collection can also be referred to as “program segments”.

program-episodes are related to their program via collection links. The full “program” tree is represented below.

Program Tree

Structure

The program-episode profile requires that the document also list the aggregation profile in its profile list; the aggregation profile provides further validation constraints.

The profile specifies the following attributes:

Name Type Required? Explanation
showDate String Yes A single date in RFC3339 full-date format indicating the day on which this episode was broadcast OR rebroadcast

Example program-episode document

{
  "id": "12345",
  "profiles": [
    {
      "href": "/v1/profiles/program-episode",
      "rels": [
        "type"
      ]
    },
    {
      "href": "/v1/profiles/aggregation"
    },
    {
      "href": "/v1/profiles/document"
    }
  ],

  "showDate": "2021-01-01",

  "items": [
    {
      "href": "/v1/documents/1111"
    },
    {
      "href": "/v1/documents/2222"
    },
    {
      "href": "/v1/documents/3333"
    },
    {
      "href": "/v1/documents/4444"
    }
  ]
}

© 2024 npr