Metadane
Do każdego poprawnego wyniku żądania HTTP (bez błędów) dodawane są metadane. W dużym uproszeniu są to dane opisujące dane. Należą one do jednego z trzech głównych elementów zwracanych w opdowiedzi na zapytania (data, errors, meta).
Dostępne są następujące rodzaje metadanych:
@context
count
page
limit
title
url
provider
date-published
date-modified
description
keywords
language
content-type
is-part-of
version
@context
Pole zawiera adres url pod którym znajdują się szczegółowe informację dotyczące schematu dla zwracanego wyniku.
{ "meta": { "@context": "https://api.nfz.gov.pl/app-stats-api-ra/schemas/index-of-tables", ... }, "links": { ... }, "data": [ ... ] }
count
Zasoby zwracające listę wyników (np. zasób /queues/{id}
nie zwróci tej metadanej) są stronicowane,
dlatego w odpowiedzi na te żądania, zwracana jest liczba wszystkich znalezionych wyników w polu count
.
{ "meta": { ... "count": 20, ... }, "links": { ... }, "data": [ ... ] }
page
Tak jak w przypadku count
metadana page
jest zwracana tylko dla zasobów zwracających listę wyników. Określa ona przesunięcie (offset),
w widoku danych.
{ "meta": { ... "page": 2, ... }, "links": { ... }, "data": [ ... ] }
limit
Metadana limit
tak samo jak count
i page
zwracana jest tylko dla zasobów zawierających listę wyników. Określa ona
liczbę wyników zwracanych na jednej stronie.
{ "meta": { ... "limit": 20 ... }, "links": { ... }, "data": [ ... ] }
title
Nazwa zasobu informacyjnego, która umożliwia jego identyfikację.
{ "meta": { ... "title": "streets" ... }, "links": { "first": "/streets?page=1&name=warszawska", "prev": null, "self": "/streets?page=1&name=warszawska", "next": "/streets?page=2&name=warszawska", "last": "/streets?page=9&name=warszawska" }, "data": [ ... ] }
url
Identyfikator lokalizacji do pobrania zasobu informacyjnego w przypadku, gdy stanowi osobny plik.
{ "meta": { ... "url": "https://api.nfz.gov.pl/app-stat-api-pl//schema/queue" ... }, "links": { ... }, "data": [ ... ] }
provider
Opis dostawcy zasobu informacyjnego - Narodowy Fundusz Zdrowia.
{ "meta": { ... "provider": "Narodowy Fundusz Zdrowia" ... }, "links": { ... }, "data": [ ... ] }
date-published
Data i czas publikacji zasobu, z dokładnością do jednej sekundy. Data i czas zgodnie ze standardem ISO-8601.
{ "meta": { ... "date-published": "2019-02-26T10:49:23+01:00" ... }, "links": { ... }, "data": [ ... ] }
date-modified
Data ostatniej modyfikacji zasobu z dokładnością do jednej sekundy. Data i czas zgodnie ze standardem ISO-8601.
{ "meta": { ... "date-published": 2019-02-28T08:16:51+01:00 ... }, "links": { ... }, "data": [ ... ] }
description
Opis zasobu informacyjnego.
{ "meta": { ... "description": "Zasób zwraca pierwszy dostępny termin leczenia dla każdego świadczenia medycznego zgodnie z wybranymi parametrami wyszukiwania. Odpowiedź zawiera szczegółowe informacje oraz listę świadczeń medycznych we właściwej kolejności wyświetlania (według pierwszej dostępnej daty leczenia)" ... }, "links": { ... }, "data": [ ... ] }
keywords
Słowa kluczowe, czyli zestaw słów lub wyrażeń zwięźle opisujących zasób informacyjny.
{ "meta": { ... "keywords": "kolejki,terminy leczenia,Narodowy Fundusz Zdrowia,termin,lekarz,poradnia,przychodnia,leczenie,terminy,wolne terminy" ... }, "links": { ... }, "data": [ ... ] }
language
Określa język zasobu.
{ "meta": { ... "language": "PL" ... }, "links": { ... }, "data": [ ... ] }
content-type
Określa informację o rodzaju zasobu i jego kodowaniu.
https://api.nfz.gov.pl/app-stat-api-pl/queues?province=07
{ "meta": { ... "content-type": "application/json; charset=utf-8" ... }, "links": { ... }, "data": [ ... ] }
is-part-of
Określenie przynależności do grupy np. zasobów.
{ "meta": { ... "is-part-of": "Dane podstawowe" ... }, "links": { ... }, "data": [ ... ] }