Content API v0.6.6

Vis som Markdown Sidens .md-fil llms.txt Alle sider, for AI-verktøy Åpne i ChatGPT Still spørsmål om siden Åpne i Claude Still spørsmål om siden

Arrangementene et bibliotek 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_6.yaml · OpenAPI 3.0.0 Hent OpenAPI-filen

Implementeres av: Bibliotekssystemet — API-et kan også implementeres for seg
Kalles av: Tjenester som viser bibliotekets program — nettsted, app, skjermer
Profil av Provider API: 4 av de 57 operasjonene i Provider API

Content API-et dekker ett område: bibliotekets arrangementer. Et arrangement bærer tidspunktene sine, lokasjonen sin, målgruppene sine, prisen sin og serien det eventuelt inngår i.

Det er fire operasjoner: arrangementene (GET /content/event), arrangementene i en serie (GET /content/event/series/{seriesId}), innholdskonfigurasjonen og versjonen.

Slik integrerer du

Autentisering, base-URL og version-parameteren er de samme som i Provider API-et, og spesifikasjonen erklærer de samme to scopene som Search API-et, read og write. Start med GetContentConfiguration (GET /configuration/content) — den forteller hvilke brukergrensesnittspråk innholdet finnes på.

Forholdet til Provider API

Content API er en profil av Provider API-et: alle fire operasjonene finnes også der, med samme operationId, metode og sti. Det kan implementeres selvstendig, slik at et system kan stille programmet sitt til rådighet uten resten av Provider API-et.

Felles for operasjonene

Disse definisjonene deles av API-ets 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.