Content API v0.6.5

Vis som Markdown Sidens .md-fil Åbn i ChatGPT Stil spørgsmål om siden Åbn i Claude Stil spørgsmål om siden

De arrangementer et bibliotek planlægger og udgiver, med tid, sted, målgrupper, pris og den serie de hører til.

3 grupper · 4 operationer · 4 stier · 48 skemaer

Genereret fra content_v0_6_5.yaml · OpenAPI 3.0.0

Implementeres af: Bibliotekssystemet — eller det system der ejer arrangementerne
Kaldes af: Alt der viser bibliotekets program — hjemmeside, app, skærme
Profil af Provider API: 4 af de 54 operationer i Provider API

Content API’et dækker ét område: bibliotekets arrangementer. Et arrangement bærer sine tidspunkter, sin lokation, sine målgrupper, sin pris og den serie det eventuelt indgår i — nok til at et program kan vises et andet sted end der hvor det blev oprettet.

Fladen er lille med vilje: fire operationer over content/event, content/event/series/{seriesId} og konfigurationen.

Sådan integrerer du

Autentificering, base-URL og version-parameteren er de samme som i Provider API’et. Læs GET /configuration/content først — den siger hvad provideren understøtter, før du bygger en visning der forudsætter mere.

Forholdet til Provider API

Content API er en profil af Provider API: alle fire operationer findes også dér, med samme operationId, metode og sti. Den findes for at et system kan udstille sit program uden at implementere resten af Provider API’et — og for at et produkt der kun skal vise arrangementer har en kortere reference at læse.

En detalje der siger noget om kilden: gruppen Content Event er ERKLÆRET her, mens Provider API’et bruger det samme tag uden at erklære det. Grupperne er de samme; det er specifikationens tag-liste der ikke er.

Fælles for operationerne

Disse definitioner refereres af mange operationer. De er dokumenteret ét sted her; en operation viser kun det der er dens eget, plus de koder den kan svare med.

Autentificering

BearerAuth · oauth2 · Flow: clientCredentials · Token-URL: /authentication/oauth2/token

Parametre

version i query · Version · valgfri · bruges af 3 af 4 The version of Open Library the vendor expects to receive, if this version isn't supported by the provider an error code 600 (Unsupported Open Library API version) is returned.
ui_language i query · string · valgfri · bruges af 2 af 4 The UI language the provider will return the content in. All ui language codes should be on this list https://www.loc.gov/marc/languages/

Fejlsvar

HttpCode400 Errors · bruges af 3 af 4 The list of errors.
HttpCode401Bearer Intet indhold i svaret. · bruges af 3 af 4 Bearer token invalid, missing, or expired.
HttpCode404 Intet indhold i svaret. · bruges af 1 af 4 Resource not found.
HttpCode401UnauthorizedOAuthLogin Intet indhold i svaret. · bruges af 0 af 4 Unauthorized login.