Dokumentacja API

API umożliwia wyszukiwanie rekordów bibliograficznych. Możliwa jest filtracja wyników, poprzez podanie odpowiednich parametrów zapytania oraz ich wartości. Dostępne formaty, w których zwracana jest odpowiedź to xml, json, marcxml i marc.

Adresy url zasobów

Bilbioteka Narodowa

/api/institutions/bibs.xml - format xml
/api/institutions/bibs.json - format json
/api/institutions/bibs.marcxml - format marcxml
/api/institutions/bibs.marc - format marc (ISO 2709:1996)

Połączone katalogi

/api/networks/bibs.xml - format xml
/api/networks/bibs.json - format json
/api/networks/bibs.marcxml - format marcxml
/api/networks/bibs.marc - format marc (ISO 2709:1996)

Tworzenie adresów żądania

Przykładowy adres: /api/institutions/bibs.json?limit=20&sinceId=2

.json - wskazuje format odpowiedzi
? - symbol po którym podawane są parametry żądania np. id, data utworzenia
& - symbol oddzielający poszczególne parametry

Zapytanie w trybie logicznym

Zapytanie w trybie logicznym pozwala na zastosowanie dodatkowych operatorów w obrębie pola:

operator LUB: hello | world
operator NIE: hello -world
hello !world
grupowanie: ( hello world )

Przykładowe zapytanie wykorzystujące wszystkie operatory: ( cat -dog ) | ( cat -mouse)

Przyjmuje się, że zawsze występuje domniemany operator I, więc zapytanie "hello world" w rzeczywistości oznacza "hello & world".

Operator LUB ma większy priorytet niż I, więc "looking for cat | dog | mouse" oznacza "looking for ( cat | dog | mouse )" a nie "(looking for cat) | dog | mouse".

Zapytania takie jak "-dog", które niejawnie zawierają wszystkie rekordy z kolekcji nie mogą być wykonane ze względów technicznych i wydajnościowych.

By aktywować zapytanie w trybie logicznym należy dodać parametr boolean=true do zapytania.

Parametry żądania

id

Identyfikatory rekordów, liczby naturalne, z możliwością ich podawania po przecinku. Mogą zawierać prefix "b" oraz cyfrę kontrolną.

Przykład: 2,10,1,b10000008

sinceId

Identyfikator rekordu, od którego zaczynać mają się wyszukiwane rekordy

Przykład: 100

kind

Typ materiału - określony typ zbiorów bibliotecznych

Możliwe wartości: książka, artykuł, nuty, mapa, film, audiobook, nagrania dźwiękowe, starodruk, dokument elektroniczny, e-book, obiekt trójwymiarowy, czasopismo, rękopis, druk ulotny, fotografia, grafika, rysunek

Przykład: książka

limit

Maksymalna liczba wyświetlonych rekordów

Wartość domyślna: 10
Wartość maksymalna: 100

Przykład: 24

boolean

Zapytanie w trybie logicznym. Więcej informacji

Wartość domyślna: false
Wartość aktywująca: true

Przykład: true

deleted

Zapytanie o rekordy usunięte.

Wartość domyślna: false
Wartość aktywująca: true

Przykład: true

createdDate

Przedział czasu, w którym rekordy zostały utworzone, podawany w formacie ISO 8601

Przykład: 2000-08-09T12:00:00Z,2016-09-12T11:59:59Z

updatedDate

Przedział czasu, w którym rekordy zostały zaktualizowane, podawany w formacie ISO 8601

Przykład: 2010-09-09T12:00:00Z,2016-09-12T11:59:59Z

placeOfPublication

Miejsce wydania

Przykład: Polska
Pola Marc: 751|a, 752|ad, 260|a, 044|a mapowane do j. naturalnego, 044|a mapowane do j. naturalnego oraz 008 (od 15 do 17 znaku) mapowane do j. naturalnego

author

Autor

Przykład: Myśliwski, Wiesław|d(1932- )
Pola Marc: 100|abcd, 110|abndc, 111|andce, 700|abcd, 710|abndc, 720|a, 760|a, 762|a, 765|a, 767|a, 770|a, 772-777|a, 780|a, 785|a, 787|a, 800|abcd, 810|abndc, 811|andce

location

Lokalizacja

Przykład: National Geographic Society
Pola Marc: 850|a, 852|aj

publisher

Wydawca

Przykład: Wydawnictwo Czarne
Pola Marc: 710|a tylko jeżeli 710|4 = pbl, 260|b

udc

Uniwersalny numer klasyfikacji dziesiętnej

Przykład: 971.1/.2
Pola Marc: 080|ax, 084|a

isbnIssn

Międzynarodowy Znormalizowany Numer Książki lub Międzynarodowy Znormalizowany Numer Wydawnictwa Ciągłego

Przykład: 0491001304
Pola Marc: 020|az, 022|ayz, 024|az, 028|ab, 490|x, 773|x

title

Tytuł

Przykład: Pani Bovary
Pola Marc: 130|amnprlsko, 210|ab, 222|ab, 240|amnprlso, 242|abnpy, 245|abnp, 246|abnp, 247|abnpf, 505|t, 534|t, 700|tmnprlskof, 710|tmnprlskof, 711|tnplskfv, 730|amnprlskof, 740|a, 760|st, 762|st, 765|t, 767|st, 770|st, 772|st, 773|st, 774|st, 775|st, 776|st, 777|st, 780|st, 785|st, 787|st, 800|tmnprlskofv, 810|tmnprlskofv, 811|tnplskfv, 830|amnprlskofv

subject

Temat

Przykład: Pies przewodnik
Pola Marc: 600|abcd, 610|a, 611|andc, 650|a

subjectPlace

Temat: miejsce

Przykład: Wrocław (woj. dolnośląskie)
Pola Marc: 651|a

subjectTime

Temat: czas

Przykład: 1352
Pola Marc: 045|bc, 648|a

subjectWork

Temat: dzieło

Przykład: Melancholia
Pola Marc: 630|alnp, 600|t, 610|t, 611|t

language

Język publikacji

Przykład: polski

domain

Dziedzina i ujęcie

Przykład: Edukacja i pedagogika
Pola Marc: 658|a

formOfWork

Forma i typ

Przykład: Komiksy i książki obrazkowe
Pola Marc: 380|a

genre

Gatunek dzieła

Przykład: Haiku
Pola Marc: 655|a

timePeriodOfCreation

Czas powstania dzieła

Przykład: 1954
Pola Marc: 046|klop

audienceGroup

Grupa odbiorców

Przykład: Dzieci
Pola Marc: 385|a

demographicGroup

Przynależność kulturowa

Przykład: Literatura polska
Pola Marc: 386|a

nationalBibliography Number

Numer bibliografii narodowej

Przykład: B67-25185
Pola Marc: 015|a

publicationYear

Rok wydania

Przykład: 2010
Pola Marc: 008 (od 8 do 11 znaku)

languageOfOriginal

Język oryginału

Przykład: polski
Pola Marc: 041|h jeżeli brak to 008 (od 36 do 38 znaku) mapowane na j. polski

Przykładowy wynik zapytania

      
        01936nam a2200553 i 4500001001500000005001700015008004100032009001700073015001800090020002600108035002300134035003600157035001400193035002100207035002300228040001500251041001300266046000900279080002600288080002100314084000700335100005200342245011200394246004600506246001900552260004400571300003000615336002700645337005100672338002800723380001400751380001000765380002700775385005700802385005700859386005400916388001400970490002800984650004601012650002301058655003101081655001901112658002601131658002001157710004801177830002701225852006601252852006401318b000000547456720190615020702.0170313s2016    pl           |000 f eng  9910183786705606  aPB 2017/11847  a9788365646156czł 29  a991005435579705066  a(PL-WaBN)b54745676-48omnis_nlop  ab54745676  a(OCoLC)995786118  a(PL)b0000005474567  aWA NcWA N1 aenghger  k1870  a811.111:811.162.1'374  a821.112.2(436)-3  a181 aSacher-Masoch, Leopold vond(1836-1895).eAutor10aVenus in furs =bWenus w futrze : z podręcznym słownikiem angielsko-polskim /cLeopold von Sacher-Masoch.1 iTytuł oryginału:aVenus im Peltz,f187031aWenus w futrze  aRuda Śląska :bZe Słownikiem,c2016.  a276, [1] strona ;c21 cm.  aTekstbtxt2rdacontent  aBez urządzenia pośredniczącegobn2rdamedia  aWoluminbnc2rdacarrier  aKsiążki  aProza  aPublikacje dydaktyczne  mPoziom nauczaniaaB2 (poziom biegłości językowej)  mPoziom nauczaniaaC1 (poziom biegłości językowej)  mPrzynależność kulturowaaLiteratura austriacka1 a1801-19001 aZe Słownikiem. Erotica 7aJęzyk angielski (przedmiot szkolny)2DBN 7aSadomasochizm2DBN 7aMateriały pomocnicze2DBN 7aPowieść2DBN  aEdukacja i pedagogika  aJęzykoznawstwo2 aWydawnictwo [ze słownikiem].eWydawca4pbl 0aZe Słownikiem (seria)  822486879590005066j1h3.014.665 AbBN_PLp30001024554488cbk1  822486879620005066j1h2.956.574bBN_PLp30001024554471cbk8