Reference / Sources

Prayer books

List the available editions and read the offices, features and preferences each book carries.

Liturgical structure

The catalogue identifies each book by code and reports language, jurisdiction, available offices and compatible preferences. The English BCP 1662, for instance, exposes its lectionary variants as options of the same book.

GET/api/v1/prayer_books

Response excerpt200 OK

{
  "data": [
    {
      "id": "loc_2015",
      "code": "loc_2015",
      "name": "IEAB - 2015",
      "full_name": "IEAB - 2015",
      "description": "LOC atual da IEAB, parte de uma nova geração de Livros de Oração",
      "language": "pt-BR",
      "jurisdiction": "Igreja Episcopal Anglicana do Brasil",
      "year": 2015,
      "thumbnail_url": "https://caminhoanglicano.com.br/locs/thumbs/loc-2015.png",
      "pdf_url": "https://caminhoanglicano.com.br/locs/pdfs/loc-2015.pdf",
      "supports_family_rite": true,
      "available_offices": ["morning", "midday", "evening", "compline"],
      "office_definitions": {
        "standard": [
          { "key": "morning", "name": "Matutino" }
        ],
        "family": [
          { "key": "morning", "name": "De Manhã" }
        ]
      },
      "is_recommended": true,
      "premium_required": false,
      "is_accessible": true
    }
  ]
}

Per-book preferences

The options are not hardcoded in the client. Read the book's preference catalogue to build the controls and send only values the API accepts.

GET/api/v1/prayer_books/:prayer_book_code/preferences

Example — BCP 1662

{
  "prayer_book_id": "loc_1662_en",
  "categories": [
    {
      "key": "daily_office",
      "preferences": [
        {
          "key": "lectionary_variant",
          "type": "select_one",
          "default_value": "original_1662",
          "options": [
            { "value": "original_1662", "is_default": true },
            { "value": "revised_1871", "is_default": false },
            { "value": "revised_1922", "is_default": false }
          ]
        }
      ]
    }
  ]
}

Note: the three tables of the BCP 1662 are variants of the same book (loc_1662_en), not separate books. The psalm_translation preference also appears in that catalogue, with the options bible_version and coverdale.

Field reference

Field	Description
id / code	Unique identifier of the book (e.g. loc_2015).
jurisdiction	The authorising ecclesiastical body (church, diocese or province).
thumbnail_url	Link to the book's cover thumbnail.
image_url	Link to the main cover image, when available.
pdf_url	Link to the official PDF of the prayer book.
available_offices	Technical list of the offices the book contains (morning, midday, evening, compline).
supports_family_rite	Whether the book offers the family forms of the office.
office_definitions	Friendly names for each office across the different modes of prayer.
is_recommended	Whether this is the suggested default book for the language.
premium_required	If true, access requires a premium account in the Estêvão app.
is_accessible	Whether the book is available at the current key's access level.
preferences	The catalogue returned by /prayer_books/:prayer_book_code/preferences, with the type, default and options of each preference.