Dokumentacja API

Rekordy wzorcowe

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/meshes/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 medyczny

Przykład: Aldehyd glicerynowy 2,3-dihydroksypropanon Glyceraldehyde
Pola Marc: 150|axyzv, 151|axyzv, 155|axyzv, 180|axyzv, 450|axyzv, 451|axyzv, 455|axyzv, 472|axyzv, 480|axyzv

Przykładowy wynik zapytania

      
        00644nz  a2200253   4500001001500000005001700015008004100032009001700073010001700090035002300107035002500130035001200155040001800167072002600185072002000211150002400231450002700255472001900282550001400301550002800315550001600343670001400359910001700373a100000005054420220929170041.0011120 ||aacnnbaba          |a ana    |c9811168236505606  am 2005811000  a(PL)a1000000050544  a(NUKAT)vtls003417637  aD005985  aDNLMdPOZN 59  aD09.x546.x894.x449  aD02.x047.x587  aAldehyd glicerynowy  a2,3-dihydroksypropanon  aGlyceraldehyde  wgaTriozy  wha3-fosfogliceraldehyd  wgaAldehydy  aMeSH 2015  am 2005811000