Content API v0.6.5

Vis som Markdown Sidens .md-fil Åpne i ChatGPT Still spørsmål om siden Åpne i Claude Still spørsmål om siden

Arrangementene et bibliotek planlegger og publiserer, med tid, sted, målgrupper, pris og serien de hører til.

3 grupper · 4 operasjoner · 4 stier · 48 skjemaer

Generert fra content_v0_6_5.yaml · OpenAPI 3.0.0

Implementeres av: Bibliotekssystemet — eller systemet som eier arrangementene
Kalles av: Alt som viser bibliotekets program — nettsted, app, skjermer
Profil av Provider API: 4 av de 54 operasjonene i Provider API

Content API-et dekker ett område: bibliotekets arrangementer. Et arrangement bærer tidspunktene sine, lokasjonen, målgruppene, prisen og serien det eventuelt inngår i — nok til at et program kan vises et annet sted enn der det ble opprettet.

Flaten er liten med vilje: fire operasjoner over content/event, content/event/series/{seriesId} og konfigurasjonen.

Slik integrerer du

Autentisering, base-URL og version-parameteren er de samme som i Provider API-et. Les GET /configuration/content først — den sier hva provideren støtter, før du bygger en visning som forutsetter mer.

Forholdet til Provider API

Content API er en profil av Provider API: alle fire operasjonene finnes også der, med samme operationId, metode og sti. Den finnes for at et system skal kunne stille programmet sitt til rådighet uten å implementere resten av Provider API-et — og for at et produkt som bare skal vise arrangementer, har en kortere referanse å lese.

En detalj som sier noe om kilden: gruppen Content Event er DEKLARERT her, mens Provider API-et bruker den samme taggen uten å deklarere den. Gruppene er de samme; det er spesifikasjonens tag-liste som ikke er det.

Felles for operasjonene

Disse definisjonene refereres av mange operasjoner. De er dokumentert ett sted her; en operasjon viser bare det som er dens eget, pluss kodene den kan svare med.

Autentisering

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

Parametere

version i query · Version · valgfri · brukes av 3 av 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 · brukes av 2 av 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/

Feilsvar

HttpCode400 Errors · brukes av 3 av 4 The list of errors.
HttpCode401Bearer Ikke noe innhold i svaret. · brukes av 3 av 4 Bearer token invalid, missing, or expired.
HttpCode404 Ikke noe innhold i svaret. · brukes av 1 av 4 Resource not found.
HttpCode401UnauthorizedOAuthLogin Ikke noe innhold i svaret. · brukes av 0 av 4 Unauthorized login.