Všeobecné informácie

Prístup k API je pomocou adresy /api/<názov prostriedka>/. Pre prístup je potrebné odoslať request cez protokol HTTPS. Návratovou hodnotou je vždy JSON štruktúra.

Prostriedky

Normy

Názov prostriedka: standard

Vyhľadávanie / filtrovanie noriem (GET)

Metóda: GET

Popis: Slúži na vyhľadávanie v normách

Štruktúra requestu

Všetky parametre sú voliteľné, ak nie sú zadané, podľa danej hodnoty sa nefiltruje.

Parameter	Popis
page	Číslo zobrazenej strany, ak nie je zadané zobrazí sa strana 1. Informácia o stránkovaní sa zobrazia vo východzích dátach.
name	Označenie normy bez dátumov a iných znakov (napr. ISO 9001)
valid	Platnosť normy, zadávajte ako číslo. 0 pre neplatné normy, 1 pre platné normy. Pre vyhľadávanie viacerých možností tieto oddeľte medzerou
language	Jazyk normy. Zadávajte ako kód jazyka, napr. en pre anglické normy, cz pre české normy, sk pre slovenské normy. Pre vyhľadávanie viacerých možností tieto oddeľte medzerou, napr. sk,en bude vyhľadávať normy ktoré existujú v slovenskom alebo v anglickom jazyku
svkName	Vyhľadávanie podľa slovenského názvu normy
engName	Vyhľadávanie podľa anglického názvu normy
vydanieSign	Zapne vyhľadávanie podľa dátumu vydania. Používať v kombinácii s vydanieYear a vydanieMonth Povolené hodnoty eq - dátum rovný, gt - dátum väčší ako, lt - dátum menší ako, bw - dátum medzi (okrem vydanieYear a vydanieMonth je potrebné vyplniť aj vydanieYearTo a vydanieMonthTo)
vydanieYear	Ak vyhľadávame normy podľa dátumu vydania, tu sa definuje rok vyhľadávania, správanie záleží od hodnoty vydanieSign
vydanieMonth	Ak vyhľadávame normy podľa dátumu vydania, tu sa definuje mesiac vyhľadávania (ako číslo, 1 pre január, 12 pre december), správanie záleží od hodnoty vydanieSign
vydanieYearTo	Ak vyhľadávame podľa vydanieSign s hodnotou bw, definuje koncovú hodnotu intervalu dátumu vydania (rok), ktorý hľadáme
vydanieMonthTo	Ak vyhľadávame podľa vydanieSign s hodnotou bw, definuje koncovú hodnotu intervalu dátumu vydania (mesiac), ktorý hľadáme
zrusenieSign	Zapne vyhľadávanie podľa dátumu zrušenia. Používať v kombinácii s vydanieYear a vydanieMonth Povolené hodnoty eq - dátum rovný, gt - dátum väčší ako, lt - dátum menší ako, bw - dátum medzi (okrem vydanieYear a vydanieMonth je potrebné vyplniť aj vydanieYearTo a vydanieMonthTo)
zrusenieYear	Ak vyhľadávame normy podľa dátumu zrušenia, tu sa definuje rok vyhľadávania, správanie záleží od hodnoty zrusenieSign
zrusenieMonth	Ak vyhľadávame normy podľa dátumu zrušenia, tu sa definuje mesiac vyhľadávania (ako číslo, 1 pre január, 12 pre december), správanie záleží od hodnoty zrusenieSign
zrusenieYearTo	Ak vyhľadávame podľa zrusenieSign s hodnotou bw, definuje koncovú hodnotu intervalu dátumu zrušenia (rok), ktorý hľadáme
zrusenieMonthTo	Ak vyhľadávame podľa zrusenieSign s hodnotou bw, definuje koncovú hodnotu intervalu dátumu zrušenia (mesiac), ktorý hľadáme
classSign	Vyhľadávanie podľa triediaceho znaku
class	Vyhľadávanie podľa triedy
classGroup	Vyhľadávanie podľa skupiny triedy
ics1	Vyhľadávanie podľa ICS kódu - kód oblasti činnosti
ics2	Vyhľadávanie podľa ICS kódu - kód skupiny
ics3	Vyhľadávanie podľa ICS kódu - kód podskupiny

Príklad requestu

curl -X GET https://example.com/api/standard/?name=iso9001&language=sk

Návratová hodnota

Úspech

V prípade úspechu bude vrátená štruktúra s dátami a stránkovými informáciami so stavovým kódom 200 OK.

Parameter	Typ	Popis
pagination	štruktúra Pagination (pozri sekciu Štruktúry)	informácie o stránkovaní
data	pole so štruktúrami Standard (pozri sekciu Štruktúry)	informácie o normách na stránke

Chyba

Pre viac informácii pozri sekciu Chyby

Štruktúry

Pagination

Parameter	Typ	Popis
page	integer	Súčasná stránka
pageSize	integer	Veľkosť jednej stránky, koľko položiek sa najviac zobrazuje na jednu stránku
dataCount	integer	Celkový počet položiek vyhovujúci hľadanému filtru
pagesCount	integer	Celkový počet stránok pre hľadaný filter
pageDataCount	integer	Počet položiek zobrazených na danej stránke

Standard

Parameter	Typ	Popis
catalogueNo	integer	Katalógové číslo normy
sdName	string	Označenie normy
name	string	Slovenský názov normy
enName	string	Anglický názov normy
url	string	URL adresa normy
classSeq	string	Triediaci znak
dateVyd	string	Dátum vydania vo formáte YYYY-MM-DD alebo prázdny reťazec
dateSchvl	string	Dátum schválenia vo formáte YYYY-MM-DD alebo prázdny reťazec
dateUcin	string	Dátum účinnosti vo formáte YYYY-MM-DD alebo prázdny reťazec
dateZrus	string	Dátum zrušenia vo formáte YYYY-MM-DD alebo prázdny reťazec
dateZv	string	Dátum zverejnenia vo formáte YYYY-MM-DD alebo prázdny reťazec
language	string	Jazyk normy
changes	string	Zmeny normy
urovSprac	string	Úroveň spracovania
isValid	integer	1 ak platná norma, 0 ak zrušená
vestnik	string	Vestník
vestnikNote	string	Poznámka vo Vestníku
standardSubject	string	Predmet normy
pageCount	integer	Počet strán
pageFormat	string	Formát normy
govReg	string	Nariadenie vlády
vestnikHarm	string	Vestník harmonizácie
ics	string	ICS kód normy
replacedStandard	string	Nahradené normy
standardReplacement	string	Nahradzujúce normy
contents	string	Obsah normy
canBuy	integer	1 ak je norma dostupná na predaj v listinnej forme
canBuyOnline	integer	ak je norma dostupná na predaj v elektronickej forme

Chyby

V prípade ak request skončí chybou, bude táto vrátená so štruktúrou a s chybovým stavovým kódom HTTP

Parameter	Typ	Popis
error	string	Popis chyby

Príklady chybových stavových kódov

Statový kód	Popis
400 Bad Request	Request nie je správne formátovaný alebo odoslaný so všetkými požadovanými informáciami a tak ho nie je možné dokončiť. Viac informácii by malo byť v popise chyby
500 Internal Server Error	Interná chyba servera
501 Not Implemented	Funkcionalita, ku ktorej sa snažíte pristúpiť momentálne nie je implementovaná