API-documentatie

OpenAPI · Swagger

Openbare REST-eindpunten van Missale Online, zonder aanmelding toegankelijk — liturgische kalender, misteksten, Psalter en Vulgata Clementina. Volgens de Frappe-conventie worden alle JSON-antwoorden in { "message": … } verpakt. De machineleesbare specificatie staat op /api/method/liturgia.api.openapi.

Zonder expliciete bronparameters volstaat de taal: elke passage gebruikt de primaire bron en bij een hiaat de ingestelde tweede bron. Ontbreken beide, dan blijft de tekstcel leeg. Het antwoord vermeldt de daadwerkelijk gebruikte bron. Expliciete bronparameters filteren de gepubliceerde uitgave; gasten ontvangen alleen gepubliceerde teksten.

De volgorde van de mis staat in mass_order als een reeks van {part, sequence}. Meerdere lezingen worden afgewisseld met de bijbehorende gebeden en gezangen. form=short kiest op quatertemperzaterdagen de korte vorm; de standaard is long. available_forms vermeldt de toegestane vormen. office_kind maakt onderscheid tussen de dag en het misformulier. Andere missen hebben in de kalendergegevens is_additional_mass=true; hun gebeden zijn geen gedachtenissen.

Schriftverwijzingen in parts[].scripture bevatten nog steeds url en ref. De optionele array passages vermeldt elk deel in leesvolgorde, inclusief overgeslagen verzen en verdere hoofdstukken. Elk deel bevat book, chapter, verse_start, verse_end, url en ref. Versgrenzen zijn inclusief; psalmen gebruiken de Vulgaatnummering. Zonder passages blijft de bestaande verwijzing bruikbaar. Onder get_day staan deze gegevens in mass.

Antwoorden voor gasten mogen worden gecachet. Voorvertoningen voor aangemelde gebruikers worden geleverd met Cache-Control: private, no-store en zijn niet offline beschikbaar.

Gepubliceerde bronnen met content_release gebruiken een vaste tekstversie. content_rows bevat de volledige leesvolgorde en de vertaalstatus per passage; bronvelden en nog niet gemodelleerde aanvullende gegevens blijven leeg.