Dokumentacja API

Protokół OAI-PMH

API umożliwia wyszukiwanie rekordów bibliogaficznych oraz wzorcowych, z użyciem protokołu OAI-PMH. Możliwa jest filtracja wyników, poprzez podanie odpowiednich parametrów zapytania oraz ich wartości. Dostępny format, w których zwracana jest odpowiedź to marc21.

Adresy url zasobów

Tworzenie adresów żądania

Przykładowy adres: /oai/bibs?verb=ListRecords&metadataPrefix=marc21

bibs - typ zasobów
? - symbol po którym podawane są parametry żądania np. id, data utworzenia
verb - wskazuje typ odpowiedzi
metadataPrefix - wskazuje format odpowiedzi
& - symbol oddzielający poszczególne parametry

Parametry żądania

verb

Typ odpowiedzi. Zawiera nazwę czynności wykonanej przez serwis. W zależności od czynności, lista wymaganych parametrów może się różnić. Parametr wymagany.

Dostępne wartości:
  • Identify - zwraca informacje o serwerze. Nie wymaga żadnych dodatkowych parametrów
  • ListIdentifiers - zwraca listę identyfikatorów spełniających określone kryteria
    Parametry opcjonalne: from, until, set, resumptionToken, metadataPrefix
  • ListMetadataFormats - zwraca listę dostępnych formatów
    Parametr opcjonalny: identifier
  • ListSets - zwraca listę dostępnych zbiorów
    Parametry opcjonalne: resumptionToken, metadataPrefix
  • ListRecords - zwraca listę rekordów spełnających określone kryteria
    Parametry opcjonane: from, until, set, resumptionToken
    Parametr wymagany: metadataPrefix
  • GetRecord - zwraca rekord o danym identyfikatorze
    Parametry wymagane: identifier, metadataPrefix
identifier

Identyfikator rekordu

Przykład: 1153387, b11533870, oai:bn.org.pl/b11533870
set

Kod zbioru. Dostępny dla rekordów bibliogaficznych.

Przykład: m
from

Dolna granica przedziału, w którym rekordy zostały utworzone, podawana w formacie ISO 8601.

Przykład: 2000-08-09T12:00:00Z
until

Górna granica przedziału, w którym rekordy zostały utworzone, podawana w formacie ISO 8601.

Przykład: 2016-09-12T11:59:59Z
resumptionToken

Zawiera identyfikator rekordu wraz z parametrami zapytania. Używany w celu paginacji zwróconego wyniku.

Przykład: marc21.f(0000-01-01T22:36:00Z).u(2999-12-30T23:00:00Z):1223940
metadataPrefix

Format odpowiedzi.

Przykład: marc21

Przykładowy wynik zapytania