Dokumentacja API

API umożliwia wyszukiwanie rekordów wzorcowych. 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

Tworzenie adresów żądania

Przykładowy adres: /api/institutions/authorities.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 "a" oraz cyfrę kontrolną.

Przykład: 2,10,1,a10000008
sinceId

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

Przykład: 100
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
name

Nazwa: deskryptor osobowy, korporatywny lub impreza.

Przykład: Neumann, Hartwig
Pola Marc: 100|abcd, 110|abndc, 111|andce, 400|abcd, 410|abndce, 411|andce, 700|abcd, 710|abndc, 711|andce
corporateBody

Typ ciała zbiorowego

Przykład: Agencje prasowe
Pola Marc: 368|a
jurisdiction

Typ jednostki geograficznej

Przykład: Jeziora
Pola Marc: 368|b
titleOfPerson

Inny atrybut deskryptora lub tytuł związany z deskryptorem

Przykład: Wojewodowie
Pola Marc: 368|cd
fieldOfActivity

Obszar działalności

Przykład: Nauki humanistyczne
Pola Marc: 372|a
associatedGroup

Afiliacja

Przykład: Uniwersytet Jagielloński
Pola Marc: 373|a
occupation

Zajęcie/zawód

Przykład: Historycy
Pola Marc: 374|a
title

Tytuł

Przykład: Kochanie, zabiłam nasze koty
Pola Marc: 100|tmnprlsko, 110|tmprlsko, 111|tplsk, 130|amnprlsko, 400|tmnprlsko, 410|tmprlsko, 411|tplsk, 430|amnprlskof, 700|tmnprlsko, 710|tmprlsko, 711|tplsk, 730|amnprlsko
subject

Temat: deskryptor przedmiotowy, formy/rodzaju/gatunku, geograficzny lub dziedzinowy

Przykład: Powieść
Pola Marc: 148|a, 150|a, 151|a, 155|a, 368|abcd, 370|abcefg, 372|a, 373|a, 374|a, 376|a, 380|a, 382|an, 383|abe, 385|a, 386|a, 448|a, 450|a, 451|a, 455|a, 548|a, 748|a, 750|a, 751|a, 755|a
placeOfBirth

Miejsce urodzenia

Przykład: Kraków (woj. małopolskie)
Pola Marc: 370|a
placeOfDeath

Miejsce śmierci

Przykład: Warszawa (woj. mazowieckie)
Pola Marc: 370|b
dateOfBirth

Data urodzenia

Przykład: 1931
Pola Marc: 046|f
dateOfDeath

Data śmierci

Przykład: 1961
Pola Marc: 046|g
operationStartDate

Data rozpoczęcia działalności

Przykład: 1945
Pola Marc: 046|q
operationEndDate

Data zakończenia działalności

Przykład: 1945
Pola Marc: 046|r
activityStartDate

Data początkowa aktywności

Przykład: 1945
Pola Marc: 046|s
activityEndDate

Data końcowa aktywności

Przykład: 1960
Pola Marc: 046|t
geographicAreaCode

Kod jednostki geograficznej

Przykład: an-us-mi
Pola Marc: 043|c
additionalInformation

Informacje dodatkowe

Przykład: Wystawy sztuki
Pola Marc: 368|abcd
relatedPlace

Miejsce związane

Przykład: Radzimyn, Poland
Pola Marc: 370|abcefg
address

Miejsce/adres siedziby

Przykład: Marszałkowska 45
Pola Marc: 370|e, 371|abcdem
gender

Płeć

Przykład: kobieta
Pola Marc: 375|a (mapowane do j. polskiego)
languageAssociated

Język związany z deskryptorem

Przykład: English
Pola Marc: 377|a (mapowane do j. polskiego)
formOfWork

Forma dzieła

Przykład: Powieść
Pola Marc: 380|a
mediumOfPerformance

Środek wykonawczy

Przykład: Pianino
Pola Marc: 382|abdenprstv
numericDesignationOf
MusicalWork

Oznaczenie numeryczne dzieła muzycznego

Przykład: F. I, 22-25
Pola Marc: 383|abcde
key

Tonacja

Przykład: D major
Pola Marc: 384|a
audience

Odbiorca

Przykład: Dzieci
Pola Marc: 385|a
creator

Twórca/współtwórca

Przykład: Dzieci
Pola Marc: 386|a
timePeriodOfCreation

Czas powstania dzieła

Przykład: 1701-1800
Pola Marc: 388|a

Przykładowy wynik zapytania

      
        02602nz  a2200673n  4500001001500000005001700015008004100032009001700073010001700090024004000107035001400147035002300161040001500184043001100199046001500210100004200225368002900267368002500296370011000321370003700431372006500468373002800533373005300561374007700614375001500691377002300706400002600729400003300755400002200788400002200810400002300832400003200855400002200887400002600909400002900935400002600964400002700990400002101017400001801038400002001056400002701076400002901103400003901132400002501171400002501196400002401221670005701245670008501302670007901387670006801466670010401534670008801638670007801726670006801804670001301872670001301885670002001898670001001918a000000117829420190614175248.6050120n||aznnnaabn          |a aaa    | 9810648280405606  ap 20044078787 ahttp://viaf.org/viaf/883440672viaf  aa11782948  a(PL)a0000001178294  aWA NcWA N  cPLcCH  f1902g19951 aBocheński, Józef Mariad(1902-1995)  dProfesorowies1934t1995  dRektorzys1964t1966  aCzuszów (woj. małopolskie, pow. proszowicki, gm. Pałecznica)bFryburg (Szwajcaria)cPolskacSzwajcaria  fFryburg (Szwajcaria)s1945t1995  aLogikaaHistoria filozofiiaSzkolnictwo wyższeaMonastycyzm  aDominikanies1927t1995  aUniwersytet we Fryburgu (Szwajcaria)s1945t1995  aHistorycyaPracownicy naukowiaNauczyciele akademiccyaKapelani wojskowi  a12iso5218  apolagerafreaita1 aBocheński, Józef M.1 aBocheński, Innocenty Józef1 aBocheński, I. M.1 aBocheński, J. M.1 aBocheński, Józef1 aBocheński, Innocenty Maria1 aBocheński, Josef1 aBocheński, Joseph M.1 aBocheński, Innocenzo M.0 aO. Bogusław Prawdota1 aBochenski, Jozef Maria1 aBochenski. I. M.1 aMiche, Józef1 aMiche, Giuseppe1 aBocheński I. M. O. P.1 aBocheński, Innocenty M.1 aBocheński, Józef Innocenty Maria1 aBocheński, J. I. M.1 aBochenski, Joseph M.1 aPrawdota, Bogusław  aO patriotyzmie / I. M. Bocheński. - Warszawa, 1989.  aDe virtute militari : zarys etyki wojskowej / J. M. Bocheński. - Kraków, 1993.  aLewica, religia, sowietologia / Józef Maria Bocheński. - Warszawa, 1996.  aFilozofia bolszewicka / Józef Miche [pseud.]. - Włochy, 1946.  aW kierunku formalizacji tomistycznej teodycei / Innocenty M. Bocheński [et al.]. - Warszawa, 1980.  aKazania i przemówienia. T. 2 / Józef Innocenty Maria Bocheński. - Kraków, 2005.  aMarxismus-Leninismus / Joseph M. Bochenski. - München ; Wien, cop. 1973.  aO liturgji dominikańskiej / Bogusław Prawdota. - Lwów, 1936.  aDuch.'85  aEPop.'91  aNepPWN. - 1995.  aBUKUL