Dokumentace WEB API

UPOZORNĚNÍ: jedná se o základní modul API, který může být doplněn o další údaje dle potřeb vaší společnosti - v případě dotazů nás prosím kontaktujte zde.

Metody WEB API pro čtení dat:

Tyto metody umožňují zjistit informace o spisech subjektu se zadaným IČ nebo RČ.
Klikněte na název metody pro zobrazení její popisu.

POST /api/getevents vrací spisy a jejich události pro subjekt se zadaným IČ nebo RČ

Request URL:

https://www.isir.info/api/getevents

Request parametry:

username
uživatelské jméno

password
heslo k uživatelskému účtu

ic
IČ hledaného subjektu. Maximální délka 8 znaků.

rc
RČ hledaného subjektu. Akceptovaný je tvar s lomítkem i bez lomítka. Maximální délka 11 znaků.

firstname
Křestní jméno hledaného subjektu. Kvůli snížení počtu výsledků musí být zadáno společně s některým z parametrů ic, rc, firstname, surname, name, birthdate. Maximální délka 100 znaků.

surname
Příjmení hledaného subjektu. Maximální délka 100 znaků.

name
Celé jméno hledaného subjektu. V případě osoby se jedná o jméno s příjmením a v případě společnosti o její název. Maximální délka 200 znaků.

birthdate
Datum narození hledaného subjektu. Zadává se ve tvaru YYYY-MM-DD (např. 2018-07-30). Maximální a minimální délka 10 znaků.

Alespoň jeden z parametrů ic, rc, surname, name, birthdate musí být zadán.
Parametry jsou spojeny logickým operátorem AND.

Response:

odpověď ve formátu XML:

POST /api/getsubjects vrací spisy (bez událostí) se zadaným IČ nebo RČ

Request URL:

https://www.isir.info/api/getsubjects

Request parametry:

username
uživatelské jméno

password
heslo k uživatelskému účtu

ic
IČ hledaného subjektu. Maximální délka 8 znaků.

rc
RČ hledaného subjektu. Akceptovaný je tvar s lomítkem i bez lomítka. Maximální délka 11 znaků.

firstname
Křestní jméno hledaného subjektu. Kvůli snížení počtu výsledků musí být zadáno společně s některým z parametrů ic, rc, firstname, surname, name, birthdate. Maximální délka 100 znaků.

surname
Příjmení hledaného subjektu. Maximální délka 100 znaků.

name
Celé jméno hledaného subjektu. V případě osoby se jedná o jméno s příjmením a v případě společnosti o její název. Maximální délka 200 znaků.

birthdate
Datum narození hledaného subjektu. Zadává se ve tvaru YYYY-MM-DD (např. 2018-07-30). Maximální a minimální délka 10 znaků.

Alespoň jeden z parametrů ic, rc, surname, name, birthdate musí být zadán.
Parametry jsou spojeny logickým operátorem AND.

Response:

odpověď ve formátu XML:

POST /api/hasrecord zjistí zda má subjekt se zadaným IČ nebo RČ záznam v ISIR

Request URL:

https://www.isir.info/api/hasrecord

Request parametry:

username
uživatelské jméno

password
heslo k uživatelskému účtu

ic
IČ hledaného subjektu. Maximální délka 8 znaků.

rc
RČ hledaného subjektu. Akceptovaný je tvar s lomítkem i bez lomítka. Maximální délka 11 znaků.

firstname
Křestní jméno hledaného subjektu. Kvůli snížení počtu výsledků musí být zadáno společně s některým z parametrů ic, rc, firstname, surname, name, birthdate. Maximální délka 100 znaků.

surname
Příjmení hledaného subjektu. Maximální délka 100 znaků.

name
Celé jméno hledaného subjektu. V případě osoby se jedná o jméno s příjmením a v případě společnosti o její název. Maximální délka 200 znaků.

birthdate
Datum narození hledaného subjektu. Zadává se ve tvaru YYYY-MM-DD (např. 2018-07-30). Maximální a minimální délka 10 znaků.

Alespoň jeden z parametrů ic, rc, surname, name, birthdate musí být zadán.
Parametry jsou spojeny logickým operátorem AND.

Response:

odpověď ve formátu XML:

 

Metody WEB API pro zápis dat:

Tyto metody umožňují zapisovat (importovat nebo mazat) sledované subjekty do uživatelského účtu.
Klikněte na název metody pro zobrazení její popisu.

POST /api/deletesubject odstraní subjekt ze sledovaných subjektů

Request URL:

https://www.isir.info/api/deletesubject

Request parametry:

username
uživatelské jméno

password
heslo k uživatelskému účtu

ic
IČ sledovaného subjektu, který má být smazán

rc
RČ sledovaného subjektu, který má být smazán. Je-li vyplňeno IČ současně s RČ hledá se subjekt, ktorý vyhovuje oběma.

Response:

odpověď ve formátu XML:

POST /api/importsubjects importuje sledované subjekty do uživatelského účtu

Request URL:

https://www.isir.info/api/importsubjects

Request parametry:

username
uživatelské jméno

password
heslo k uživatelskému účtu

subjects
seznam importovaných subjeků ve formátu XML:

Response:

odpověď ve formátu XML:

validní import

import s validačními chybami