Användning av Libris API:er

API-ingången för att lista bestånd är /_findhold och till detta behöver man två parametrar som båda är URI:er.

1. Den bibliografiska postens ID (id)
2. Sigel (library).

Svaret på detta anrop är en URI med postens beståndsuppgifter för sigeln.

Exempel:
/_findhold?id=http://libris.kb.se/bib/1234&library=https://libris.kb.se/library/SEK

API-ingången för att slå samman två poster är /_merge och de parametrar som krävs är id1 och id2 vilket är de två posternas URI:er.

Standardinställningen är att posten med id1 är den som blir kvar efter sammanslagningen. Vill man ändra detta måste parametern promote_id2 till true anges.

För att förhandgranska sammanslagningen skickar man ett GET-anrop till API-ingången. Om man skickar ett POST-anrop genomförs sammanslagningen och posten sparas i databasen. POST-anropet kräver auktorisering och att man skickar sin token i header-taggen Authorization.

API-ingången för att lista beroenden är ”/_dependencies ” och parametern som krävs är ”id” det vill säga postens URI som man skickar med ett GET-anrop. Vad som returneras är en eller flera URI:er som pekar på beroenden som språk, land, katalogiseringstyp mm. Man kan också ange parametern ”relation” för att specificera vilket beroende man vill ha svar på.

Man kan även lägga till parametern ”reverse” - satt true eller false - för att lista vilka beroenden som saknas.

Exempel:
/_dependencies?id=http://libris.kb.se/bib/1234&relation=language&reverse=false

API-ingången för denna funktion är ”/_compilemarc” och kräver två parametrar. Dels ”id” vilket är postens URI samt ”library” vilket är sigelns URI. Då får man en bibliografisk marcpost med sammanslaget bestånd och beståndsinformationen är kodad med ett inledande delfält $5 [Sigel].

Exempel:
/_compilemarc?id=http://libris.kb.se/bib/1234&library=https://libris.kb.se/library/SEK

API-ingången för sökningar internt i XL är /find och parametern för sökfrågan är q.
Frågespråk och sökkoder är samma som i gränssnittet till Libris katalogisering och en närmare beskrivning av dessa hittar du i Libris katalogiseringsgränssnittets sektion Hjälp.

Ytterligare parametrar är _limit vilket är en begränsning av antalet träffar (standardvärde för detta är 200) samt _offset vilket talar om hur många poster i sökresultatet som ska hoppas över. Detta används för bläddring och standarvärdet är 0.

Exempel:
/find?q=tove jansson&_limit=50&_offset=0

API-ingången /_convert  används för att med ett POST-anrop skapa och visa en testkonvertering till MARC21 av ett JSON-LD dokument. Förutom auktorisering så krävs följande header-taggar: Content-type satt till application/ld+json, Accept satt till application/x-marc-json när man postar dokumentet.