Dokumentacja API

Rekordy egzemplarzy

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

Adresy url zasobów

Tworzenie adresów żądania

Przykładowy adres: /api/items.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

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,i10000070
sinceId

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

Przykład: 100
bibId

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

Przykład: 1000005,b10000070
limit

Maksymalna liczba wyświetlonych rekordów

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

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

Przykładowy wynik zapytania

{
  "nextPage": "http://data.bn.org.pl/docs/items/api/items.json?sinceId=1000002",
  "items": [
    {
      "id": 1000001,
      "createdDate": "1997-10-15T07:07:31.000Z",
      "updatedDate": "2016-03-09T21:53:41.000Z",
      "deleted": false,
      "deletedDate": null,
      "bibIds": [
        1000001
      ],
      "callNumber": "1.731.864",
      "location": {
        "code": "bk6",
        "name": "Magazyn Książek"
      },
      "status": {
        "code": "-",
        "display": "-"
      }
    }
  ]
}