API přístup

API je určeno pro práci s kauzami a jejich vyhledávání v Centrální Evidenci Exekucí. Pro přístup do API je nutné kontaktovat podporu na helpdesk@ceecr.cz.

Nové CEE API verze 4.0 nabízí plnohodnotnou komplexní práci se sytémem centrální evidence exekucí, přes rozhraní API a výměnu datových informací v jednoduchém, standardizovaném formátu JSON . Přístup do API je poskytován bezplatně na základě schválení žádosti zaslané v registraci, zaslené formulářem uvedeným níže. Některé metody API, jako například vyhledávání a zobrazení detailních informací o kauze jsou zpoplatněny dle aktuálního ceníku. Částka je odečítána z vašeho předplaceného kreditu. Každý API klíč musí být navázaný na uživatelský účet v centrální evidenci exekucí. Pokud nemáte svůj uživatelský účet, můžete si jej bezplatně zaregistrovat. Uživatelé, kteří jsou zároveň soudní exekutoři musí požádat administrátora o přepnutí uživatelského účtu do účtu s oprávněním soudního exekutora.

Každá kancelář soudního exekutora může mít neomezené množství uživatelských účtů - které jsou přiřazené ke kanceláři. API klíč je navázán vždy na konkrétní uživatelský účet, ze kterého je následně odečítán kredit. Správce kanceláře může spravovat všechny úživatele ve své kanceláři a libovolně přesouvat kredit mezi jejich účty.

Registrace API

Changelog

  • 25. 08. 2020 [V3] Použítí API KEY z API verze 4 ve starém API verze 3 vyhodí chybovou hlášku o nekompatibilitě.
  • 25. 08. 2020 [V3] Odstranění podpory pro API verze 3. Dokumentace nyní k dispozici pouze pro API verze 4.
  • 08. 02. 2020 [V3] Odstranění podpory metod /geocodeaddress, /ruiantoaddress.
  • 28. 01. 2020 [V4] Výstup z API nyní escapuje Unicode a lomítka.
  • 28. 01. 2020 [V4] Odstranění podpory parametru callback pro spuštění kódu pomocí techniky JSONP.
  • 21. 01. 2020 [V3] [V4] Nový typ dokumentu: Pravomocné nařízení likvidace dědictví. Číselník dokumentu je 1406.
  • 21. 01. 2020 [V4] Metoda /documenttypelist nyní vrací nové, upravené popisky dokumentů.
  • 21. 01. 2020 [V3] [V4] Nový typ ukočení: Úmrtí povinného – povinný zemřel, exekuční řízení není zastaveno, ale čeká se, zda dojde ke změně v důsledku dědění, po rozhodnutí o procesním nástupnictví exekutor zapíše nového povinného. Číselník ukončení je 1305.
  • 21. 01. 2020 [V4] Metoda /completiontypelist nyní vrací nové, upravené popisky ukočení.
  • 30. 04. 2019 [V3] Odebrána metoda DELETE
  • 29. 01. 2018 [V3] Nová metoda /validatesubject a objekt výstupu data.errors pro některé metody viz chyby, vyjímky, vyrování.
  • 21. 01. 2017 [V3] Nová metoda /ruiantoaddress pro převod kódu ADM z RÚIAN na infomrace o adrese
  • 23. 10. 2016 [V3] Nová metoda /geocodeaddress pro dohledání adresy z RÚIAN
  • 27. 03. 2016 [V3] Při vkládání nebo změně FO, je možné poslat paramer gender s hodnotou M (muž) nebo F (žena) pro určení pohlaví povinného. Pokud není poslán, určí se z rodného čísla. Pokud osoba nemá rodné číslo - nebo z rodného čísla nelze rozpoznat pohlaví je tato položka povinná u fyzických osob.
  • 04. 03. 2016 [V3] Nově pokud /insert vloží kauzu a stejná kauza u kanceláře již existuje, bude stará kauza automaticky deaktivována.
  • 03. 03. 2016 [V3] Neaktivní kauzy s datem založení starším než 30 dní jsou nyní automaticky přesouvány do archivu.
  • 12. 02. 2016 [V3] Ve všech metodách byla vypnuta validace rodného čísla a IČ.
  • 05. 02. 2016 [V3] Ve všech metodách kromě /search byla vypnuta validace rodného čísla.
  • 03. 02. 2016 [V3]Parametr /insert nový parametr "foreigner" vkládání rodných čísel cizinců (také pro /updatesubject, /addsubjecttocause).
  • 03. 02. 2016 [V3] Parametr /search nový parametr "foreigner" pro vyhledávání cizinců.
  • 22. 01. 2016 [V3] Parametr /insert one_time_price nyní může být "0" pro vyjádření nulové jistiny.
  • 28. 11. 2015 [V3] Přidána metoda /completiontypelist pro seznam povolených typů ukončení.
  • 10. 11. 2015 [V3] U metod /insertcompletion a /insertdocument lze nově místo pole ID povinných poslat hodnotu all a systém automaticky přiřadí požadavek všem aktivním povinným.
  • 10. 11. 2015 [V3] Z důvodu přetížení serveru jsme zavedli limit na jeden evidenční dotaz za jednu sekundu.
  • 20. 10. 2015 [V3] Přidání nového typu dotazu - evidenční dotaz
  • 14. 10. 2015 [V3] HTTP POST nyní akceptuje nejen form-data ale i application/json, vizte ukázku
  • 04. 10. 2015 [V3] U metody /search je nová položka search_reason
  • 04. 10. 2015 [V3] U metody /insert a /update je nová položka software_version
  • 27. 09. 2015 [V3] Zneplatnění metod /removesubjectfromcause a /removedocumentfromcause
  • 26. 09. 2015 [V3] Přidána nová metoda /insertcompletion
  • 26. 09. 2015 [V3] Upraveny datumy u kauzy, documents je povinná položka pro /insert a /addsubjecttocause, documents se váže na subject
  • 21. 09. 2015 [V3] Přidány nové metody /courtlist, /documenttypelist
  • 13. 08. 2015 [V3] Přidány nové metody /me, /colleagues
  • 30. 07. 2015 [V3] Metoda /mine nyní vrací pouze kauzy, které jsou spojené s přiřazeným exekutorským účtem, nikoliv celou kanceláří. Pro zobrazení kauz z celé kanceláře je zde nová metoda /myoffice
  • 01. 07. 2015 [V3] Vydána verze 3.0.0

Metody verze 3

Podpora této verze API byla ukočena - použijte API verze 4. Pro více informací kontaktujte technickou podporu na podpora@ceecr.cz. Přístup k původnímu API bude definitivně ukončen do konce roku 2020.

Hlavní změny ve verzi 4.0

Tato dokumentace je pro API verze 4, které rozšiřuje současné metody o nové parametry a mění některé položky.

Nová URL pro API

  • Nové API je dostupné na: https://www.ceecr.cz/api/v4
  • Původní API je dostupné na https://www.ceecr.cz/api do doby než bude vypnuto.
  • Testovací prostřední na https://www.ceecr.cz/api/test reflektuje API v3 a bude vypnuto spolu s původní verzi API. Nová verze API rozhodne použití mezi testovacím a produkčním prostředí na základě vašeho Tokenu.

Nekompatibilita API KEY se starou verzí

  • Použití API KEY v novém API automaticky zneplatní jeho použití ve starším API.
  • Chcete-li dohromady staré i nové API, je potřeba mít vygenerované dva různé API KEY. Jeden pro novou verzi a druhou pro verzi 3.0.0.
  • Nikdy nepoužívejte API KEY z verze 3.0.0 v novějších verzích, dojde k jeho automatickému upgradu novější verzi a zneplatní se pro použití ve 3.0.0.

Úprava JSON výstupu z API

  • API nově escapuje unicode znaky a lomítka na výstupu! Na vstupu zůstává vše dle původní specifikace.
  • Odstraněna podpora parametru callback pro spuštění funkce pomocí techniky JSONP.

Úprava HTTP kódu výstupu z API

  • HTTP kód vrací nově 500 Internal Server Error v případě chyby! Oproti starší verzi, která vracela vždy 200 OK, bez ohledu na to, zda byla metoda správně provedena či ne.

Metody typu update nyní vyžadují zaslání celého payloadu.

  • Při použití metod typu update nyní zasílejte všechny údaje nejenom ty, které chcete změnit.

Změny číslování kódu některých chybových hlášení.

  • Některé chybové hlášky jsou nyní přečíslované a jejich číselné chyby začínají nově 400XXX (tedy ve na způsob bad request + kód).

NULL jako string nyní nenuluje záznamy.

  • Zaslání NULL jako string, nyní nevynuluje záznam ale uloží NULL jako "NULL". Chcete-li vynulovat parametr, zašlete jej prázdný.

Vypnutí automatické archivace duplicitních kauz

Při pokusu vložit do systému kauzu s již existující spisovou značkou bude nově vyhozena chyba namísto automatické archivace původní kauzy.

Odstranění metody /ruiantoaddress a /geocodeaddress

Z důvodu povinného použití adresy ve fomátu kódu ADM, jsou geokódovací služby odstraněny z důvodu předpokládaného nadužití těchto služeb a tedy přetěžování serveru. Prosíme, použijte geokódovací službu CÚZK nebo veřejně dostupný seznam adres, pro vybudování vlastní geokódovací služby.

Změna metody /addsubjecttocause

  • Rodné číslo je povinným parametrem pro povinné, kteří nejsou cizinci. Zadávejte vždy bez lomítka a pouze rodné číslo. Jiný identifikátor v tomto parametru není přípustný.
  • Povinní, musí mít vždy uvedené datum narození.
  • Nový parametr foreigner, povinný pro cizince bez rodného čísla vždy v kombinaci s datumem narození.
  • Možnost označení povinného jako povinného v insolvenci.

Změna metody zadávání spisové značky

  • Zadání spisové značky je nyní rozděleno na 3 samostatné parametry. Číslo exekutora, spisová značka za EX, rok. Neplatně zadaný formát ex čísla vyhodí chybové hlášení.

Úpravy pojmenování číselníků

  • Číselník 13XX a 14XX nyní vrací popis v souladu s vyhláškou. Doplněno o nové číselníky.

Přidání oprávněného

  • Systém nyní umožňuje vložit oprávněného Do doby účinnosti změn právních předpisů je toto pole nepovinné.

Přidání aktuálně vymáhané částky

  • Systém nyní umožňuje vložit aktuálně vymáhanou částku a datum, ke kterému je aktuální. Do doby účinnosti změn právních předpisů je toto pole nepovinné.

Přidána možnost spojovat spisy

  • Systém nyní umožňuje vložit kauzu tak, aby byla dohledána návazonost na předchozí historickou spisovou značku.

Metody

Tato dokumentace je pro připravované API verze 4, které rozšiřuje současné metody o nové parametry a mění některé položky. Datum spuštění tohoto API bude ohlášeno v prvním čtvrtletí 2020. Podpora původního API verze 3 bude ukončena během roku 2020.

Obecné

Všechny metody API (kromě metody /api/auth) je nutné vždy zavolat s takzvaným tokenem. Bezpečnostní token je alfanumerický řetězec, který koncový klient obdrží po prvotní autorizaci, metodou /api/auth. Token je možné na straně klienta uložit v jakékoliv lokální paměti a dále pak předávat pomocí HTTP metody GET. Po dobu platnosti bezpečnostního tokenu, je možné (a vhodné) jej používat pro všechny související serverové requesty aniž by bylo nutné opětovné přihlášování do systému.

Kód Název Info
5404 Metoda %s neexistuje v CEE API. Při volání neexistující metody.
Tato metoda již není podporována. Při volání nepodporované metody.
5573 Tuto metodu nelze použít protože váš API účet nemá nastavena požadovaná oprávnění. Při volání metody s nedostatečným oprávněním.

/auth

Metoda pro získání tokenu je zavolána s parametry api_key a api_secret, následně je uživateli vrácen token pro práci s API. Konkrétní token je platný vždy pouze pro tu IP adresu, ze které jej systém žádán a zároveň je limitovaný platností tokenu. Tato platnost je uvedenav návratové hodnotě valid_till. Jakmile token expiruje je nutné opět si požádat o nový.

GET /api/auth?api_key=foo&api_secret=bar
# validní zpracování
{"status":200,"data":{"token_value":"#rjZZzT#cb9ev","valid_for":"119.119.119.1","valid_till":"2015-03-15"}}

# chyba
{"status":500,"data":{"code":5503,"message":"Invalid API key or secret! You have tried 1 from 10 untill your IP address will be banned for 60 seconds.","datetime":"2015-07-14 19:26:48"}}
Název Metoda Typ Povinný Info
api_key GET string Váš API key
api_secret GET string Váš API secret
Název Typ Info
token_value string Autorizační token pro použití v dalších metodách
valid_for string IP adresa pro kterou je daný autorizační token platný
valid_till string Datum a čas do kterého je autorizační token platný
Kód Název Info
5501 Chybí API KEY!
5502 Chybí API SECRET!
5503 Vaše IP adresa %s byla zablokována po %s neúspěšných z %s povolených pokusech o přihlášení.
5503 Chybný API KEY nebo SECRET. Vyčerpali jste %s pokusů z %s povolených než bude vaše IP adresa zablokována na %s sekund.
5504 Váš API přístup byl vypnut administrátorem.
5504 Tento API přístup není připojený k žádnému uživatelovi v systému.

/validatetoken

Tato metoda jednoduše vyhodí chybovou hlášku pokud je token neplatný. Samotatný token se k validaci přidává pomocí parametru token předaný metodou GET.

Tato metoda je interně volaná jako součást všech metod vyžadujících API Token.

GET api/validatetoken?token=__API_TOKEN__

# validní zpracovaní
{"status":200,"data":{"valid_for":"127.0.0.1","valid_till":"2015-07-14 20:25:22"}}

# chyba
{"status":500,"data":{"code":5006,"message":"Your token is invalid.","datetime":"2015-03-16 20:20:11"}}
Název Metoda Typ Povinný Info
token GET string Váš token, který jste získali metodou /api/auth
Název Typ Info
valid_for string IP adresa pro kterou je daný autorizační token platný
valid_till string Datum a čas do kterého je autorizační token platný
Kód Název Info
5505 Chybí API TOKEN určený pro validaci.
5506 Váš API TOKEN není platný!
5507 Váš API TOKEN není platný pro IP adresu %s. Při volání metody z jiné, než povolené IP adresy.
5508 Platnost tohoto API TOKENU byla ukončena k %s. Při volání metody po skončení platnosti tokenu.

/credit

Tato metoda vrací aktuální výši kreditu.

GET api/credit?token=__API_TOKEN__
# validní zpracovaní
{"status":200,"data":{"zbyva_dotazu":{"placenych":23441,"free":925},"credit":"23441.00"},"dataSource":"test"}
Název Metoda Typ Povinný Info
token GET string Váš token, který jste získali metodou /api/auth
Název Typ Info
zbyva_dotazu object
zbyva_dotazu.placenych int Počet zbývajících placených dotazů
zbyva_dotazu.free int [pouze pro exekutory] Počet zbývajících FREE dotazů
credit decimal Suma předplaceného kreditu v CZK

/me

Tato metoda slouží k vypsání záladních informací o vašem účtu

GET /api/me?token=__API_TOKEN__

Výstupem je JSON objekt ve formátu

{"status":200,"data":{"user_level_slovem":"Uživatel","user_login":"JanNovak", ... },"dataSource":"test"}
Název Metoda Typ Povinný Info
token GET string Váš token, který jste získali metodou /api/auth
Název Typ Info
user_id string Unikátní identifikátor uživatele v systému
user_login string Uživatelské jméno
user_jmeno string Jméno
user_prijmeni string Příjmení
user_level string Úroveň uživatelského účtu
user_level_slovem string Popis úrovně uživatelského účtu
user_kancelar string Identifikátor uživatelské kanceláře
user_aktivni string Informace o tom, zda je uživatel aktivní (1 = ANO, 0 = NE)
api_level string Úroveň API účtu
price_for_search decimal Cena za vyhledávání
price_for_detail decimal Cena za zobrazení detailu
credit decimal Aktuální výše předplaceného kreditu
free_dotazy int Aktuální výše free dotazů

/mine

Tato metoda slouží k vypsání všech kauz, které jsou přiřazené k vašemu exekutorskému účtu.

GET /api/mine?token=__API_TOKEN__

Výstupem je JSON objekt ve formátu cause_id : EX číslo

{"status":200,"data":{"y4": "111EX1111/2015", "8G": "888EX808080/80", ... },"dataSource":"test"}
Název Metoda Typ Povinný Info
token GET string Váš token, který jste získali metodou /api/auth
{"ID": "EX číslo", ...}
Název Typ Info
ID string Unikátní identifikátor kauzy v systému
EX číslo string Spisová značka kauzy (např. 111EX1111/2015)
Kód Název Info
5510 Tento uživatelský účet v systému nemá nastavena žádná exekutorská oprávnění! Metoda je pouze pro exekutorské účty.
5530 V systému nejsou evidovány žádné vaše kauzy.

/myoffice

Tato metoda slouží k vypsání všech kauz, které jsou přiřazené k vaší kanceláři.

GET /api/myoffice?token=__API_TOKEN__

Výstupem je JSON objekt ve formátu cause_id : {EX číslo, id uživatele, jméno uživatele}

{"status":200,"data":{"6D": {"ex_number": "132EX123456/15", "user_id": 1, "user_name": "Jan Novák"}, ... },"dataSource":"test"}
Název Metoda Typ Povinný Info
token GET string Váš token, který jste získali metodou /api/auth
{"6D": {"ex_number": "132EX123456/15", "user_id": 1, "user_name": "Jan Novák"}, ... }
Název Typ Info
cause_id object ID kauzy jako klíč
ex_number string Spisová značka kauzy
user_id string Číselný identifikátor uživatele kterému patří tato kauza
user_name string Jméno uživatele, kterému patří tato kauza (
Kód Název Info
5522 Uživatelský účet v systému, ke kterému je připojen tento API přístup není v žádné exekutorské kanceláři. Metoda je pouze pro exekutorské účty.
5523 Ve vaší exekutorské kanceláři (#%s) se nenachází žádné kauzy.

/colleagues

Tato metoda vypíše uživatele vaší kanceláře

GET /api/colleagues?token=__API_TOKEN__

Výstupem je JSON objekt ve formátu

{"status":200,"data":[{"id": "5", "name": "Petr Polárkáč"},{"id": "4","name": "Rudolf Šlambera"},...], "dataSource":"test"}
Název Metoda Typ Povinný Info
token GET string Váš token, který jste získali metodou /api/auth
Název Typ Info
object
.id string Unikátní identifikátor uživatele v systému
.name string Celé jméno uživatele
Kód Název Info
5522 Uživatelský účet v systému, ke kterému je připojen tento API přístup není v žádné exekutorské kanceláři. Metoda je pouze pro exekutorské účty.

/search

Vyhledávání v kauzách probíhá pomocí metody search, které jsou předány parametry dotazu. Ten může hledat v databázi fyzických a právnických osob na základě rodného čísla, data narození, jména a příjmení, u právnických osob pomocí názvu obchodní firmy nebo IČ. Pro získání nejpřesnějšího výsledku doporučujeme užívat především rodné číslo nebo IČ v případě právnických osob.

Podporované vyhledávací parametry:
  • ico - pro vyhledání subjektu podla čísla IČO
  • rc - pro vyhledávání podle rodného čísla
  • name + person = P - pro vyhledávání podle jména firmy (je třeba zadat co nejveětší část názvu, např. hodnotu spol. systém nepovolí vyhledat)
  • name + address - pro vyhledávání subjektu podle jména/názvu firmy a adresy
  • name + birth - pro vyhledávání podle jména a data narození (datum narození ve formátu YYYY-MM-DD)
  • ex_cislo - pro vyhledávání podle spisové značky

Lze doplnit parametr person, který může nabývat pouze hodnoty P (právnická osoba) nebo F (fyzická osoba).

Pokud jde o exekutorský účet, který má aktivované free dotazy, lze použít parametr use_free pro jejich využití. Povolené hodnoty: true, record.

Při bezplatné lustraci (například při použití free dotazů, nebo u speciálních uživatelských účtů), je nutné uvést důvod pro bezplatnou lustraci v parametru reason.
GET /api/search?token=__API_TOKEN__&name=Jan%20Novák&birth=2000-01-01&person=F # fyzická osoba podle jména a data narození
GET /api/search?token=__API_TOKEN__&name=Jan%20Novák&address=Kaprova%206%2C%20110%2000%2C%20Praha%201&person=F # podle jména a adresy
GET /api/search?token=__API_TOKEN__&rc=8611251124&person=F # fyzická osoba podle rodného čísla
GET /api/search?token=__API_TOKEN__&ico=123456789&person=P # právnická osoba podle IČ
GET /api/search?token=__API_TOKEN__&name=Maso%20Uzeniny%20Novák%20s.r.o.&person=P #právnická osoba podle názvu

# ukázka použítí free dotazu (pouze pro exekutorské úřady a speciální typ uživatelů)
# v případě použití free dotazů je třeba odeslat parametr use_free s hodnotou true a parametr reason kde je nutné uvést důvod použití free dotazů
GET /api/search?token=__API_TOKEN__&rc=8611251124&person=F&use_free=true&reason=důvod # fyzická osoba podle rodného čísla

# Vyhledávání v rodných číslech nebo identifikátorech cizinců
GET /api/search?token=__API_TOKEN__&rc=SK123ABC&person=F&cizinec=1

Výstupem bude objekt ve formátu JSON, jehož jednotlivé objekety jsou rozepsané v tabulce na kartě Parametry výstupu.

# nalezené záznamy
{"status":200,
 "data":[{
   "subjects":[{
	 "subject_id":"12345",
	 "typ_osoby":"F",
	 "jmeno":"Jan Novák",
	 "datum_narozeni":"1980-08-08",
	 "ic":null,
	 "adresa":"Kaprova 6, 110 00 Praha 1"
	 }],
   "subject_count":"1"
   "ex_cislo":"888EX808080/88",
   "cause_id":"Ln4zjM",
   "datetime_zalozeni":"2007-10-09",
   "datetime_zapisu":"2007-10-09",
   "posledni_uprava":"Nařízení exekuce"
   },{
   "subjects":[{
	 "subject_id":"12345",
	 "typ_osoby":"F",
	 "jmeno":"Jan Novák",
	 "datum_narozeni":"1980-08-08",
	 "ic":null,
	 "adresa":"Dělnická 805, 280 02 Kolín"
   }],
   "subject_count":"1"
   "ex_cislo":"888EX808080/89",
   "cause_id":"8Rxq7B",
   "datetime_zalozeni":"2008-10-09",
   "datetime_zapisu":"2008-10-09",
   "posledni_uprava":"Nařízení exekuce"
   }
 ],
 "dataSource":"test",
 "info":{
   "search":{"type":"rc","query":"__HLEADANY_RETEZEC__"}
   "zbyva_dotazu":{"placenych":83,"free":100},
   "cena":{"zaplaceno":"bezplatný testovací dotaz","kredit":"4980.00","free":"100"},
   "debug":{"found":4,"elapsed":0.19468712806702}
 }
}

# prázdný výsledek
{"status":200,
 "data":[],
  "dataSource":"test",
  "info":{
	"search":{"type":"rc","query":"__HLEADANY_RETEZEC__"}
	"zbyva_dotazu":{"placenych":93,"free":0},
	"cena":{"zaplaceno":"bezplatný testovací dotaz","kredit":"5580.00","free":"0"},
	"debug":{"found":0,"elapsed":0.082875728607178}
   }
}

Uživatelé, kteří jsou v systému evidování jako exekutoři mohou zobrazovat detail kauz, které jsou přiřazené k jejich vlastní exekutorské kanceláři bezplatně - za použití FREE dotazu. Z jejich účtu je odečten 1 FREE kredit za jedno vyhledání nebo jedno zobrazení detailu. V případě, že se pokusíte zobrazit kauzu, která není vaše, bude vám stržen kredit nebo free dotazy.

... "cena":{"zaplaceno":"bezplatný dotaz","kredit":"589680.00","free":"90"}, ...

Pokud chcete využít free kredity (pouze pro účty úrovně exekutor a správce exekutorské kanceláře), musíte přidat parametry use_free a reason pro uvedení důvodu hledání:

GET ... &use_free=true&reason=__URL_ENCODED_MESSAGE__ ...

Pokud chce exekutor zjistit data ke své kauze, může použít evidenční dotaz na api/search a api/detail - parametr use_free nastaví na hodnotu record

Pro tento typ dotazu je do vyhledávání přidán parametr příslušnosti kauzy k úřadu uživatele.

Tento typ dotazu je časově limitován - server jej povoluje pouze jednou za 1 sec. z jedné IP adresy (nutná ochrana přetížení serveru z důvodu četnosti těchto dotazů)

GET ... &use_free=record ...
... "cena":{"zaplaceno":"bezplatný evidenční dotaz" ...
Název Metoda Typ Povinný Info
token GET string Váš token, který jste získali metodou /api/auth
ico GET int Vyplňte pro vyhledání subjektu přes IČO - všechny ostatní parametry hledání budou ignorovány.
rc GET string Vyplňte pro vyhledání subjektu přes RČ nebo v případě cizince, jiný identifikátor. Rodná čísla zadávejte bez lomítka. Ostatní parametry budou ignorovány.
name GET string Jméno fyzické osoby nebo název firmy
address GET string Adresa subjektu
birth GET string Datum narození subjektu ve formátu YYYY-MM-DD
ex_cislo GET string Vyhledávání podle spisové značky (měla by odpovídat regulárnímu výrazu /^\d{3}EX(?!0)\d{1,6}\/\d{2}/ - 3 čísla, "EX", 1-6 čísel, "/", 2 čísla)
person GET enum("P","F") Upřesnění o jaký typ subjektu se jedná zda o [P]právnickou nebo [F]yzickou osobu
reason GET string [pouze pro exekutory] Povinné, při vyhledávání pomocí FREE, RECORD a bezplatných lustrací ze speciálních uživatelských účtu. Zadejte důvod pro užití bezplatného vyhledávání jako hodnotu tohoto parametru.
use_free GET enum("true","record") [pouze pro exekutory] Umožní použít místo placeného dotazu FREE kredit nebo RECORD (evidenční) dotaz.
Název Typ Info
subjects object
subjects.subject_id string Identifikátor subjektu v kauze
subjects.typ_osoby string P - právnická, F - fyzická osoba
subjects.jmeno string Celé jméno fyzické osoby nebo název právnické osoby
subjects.typ_osoby string Datum narození u fyzické osoby ve formátu YYYY-MM-DD
subjects.ico string IČO (Deprecated: subjects.ic)
subjects.adresa string Adresa trvalého bydliště fyzické osoby nebo sídlo právnické osoby
subject_count string Počet subjektů v kauze
ex_cislo string EX číslo - spisová značka kauzy
cause_id string Unikátní identifikátor kauzy v systému, vždy string i když je někdy na první pohled číslo!
datetime_zalozeni string Datum, které se vygeneruje automaticky při vložení kauzy do systému
datetime_upravy string Datum poslední úpravy kauzy
posledni_uprava string Název posledního vloženého dokumentu ke kauze
info object
info.search object
info.search.type string Klíč podle kterého byl provedené vyhledávání (rc, ico, ex_cislo ...)
info.search.query string Hodnota klíče, podle kterého byl provedené vyhledávání
info.zbyva_dotazu object
info.zbyva_dotazu.placenych int Počet placených dotazů, které můžete uskutečnit na základě vašeho kreditu
info.zbyva_dotazu.free int [pouze pro exekutory] Počet FREE dotazů, které můžete uskutečnit na základě vašeho počtu FREE dotazů
info.zbyvajici_kredit string Aktuální výše zbývajícího kreditu
info.cena object
info.cena.zaplaceno string Cena za uskutečněné vyhledávání
info.cena.kredit string Aktuální výše zbývajícího kreditu
info.debug object
info.debug.found int Počet nalezených kauz
Kód Název Info
5557 Nepovolený znak v rodném čísle/indetifikačním čísle cizince, povolené jsou pouze znaky A-Z, číslice, podtržítko, pomlčka, mezera Při vyhledávní dle rodného čísla s chybným rodným číslem nebo identifikčním číslem cizince.
5557 Rodné číslo/Identifikační číslo cizince nemůže mít více znaků než 12. Při vyhledávní dle rodného čísla s chybným rodným číslem nebo identifikčním číslem cizince.
5545 Typ subjektu může být pouze P (právnická) nebo F (fyzická) osoba. Při volání bez nebo se špatným parametrem person.
5517 Není úplně jasné co přesně chcete vyhledat. Systém nepochopil ze zadaných parametrů váš dotaz. Při volání bez požadovaných parametrů.
5494 Nemůžete vyhledávat protože nemáte dostatečný kredit!
5492 Název společnosti musí mít nějméně 4 znaky, jinak musíte subjekt vyhledat přes IČ.
5492 Název společnosti bez označení právní formy společnosti musí mít nějméně 4 znaky, jinak musíte vyhledat subjekt přes IČ. Při vyhledávání podle jména firmy.

/detail

Tato metoda slouží pro vypsání detailu jednotlivých kauz. Vstupním parametrem je cause_id, získanýnapříklad z metody /search, viz předchozí ukázka. Tento unikátní řetězec je pak vstupním parametrem.

GET /api/detail?token=__API_TOKEN__&cause_id=__HASH_ID_KAUZY__

Výstupem je JSON objekt, jehož objekty jsou popsány v tabulce níže.

# nalezené záznamy

{"status":200,
 "data":[{
   "cause_id":"MPVWx",
   "datetime_zalozeni":"2008-10-09",
   "datetime_vlozeni":null,
   "datetime_zapisu":null,
   "id_exekutora":00,
   "id_kancelare":00,
   "jmeno_kancelare":"__NAZEV_KANCELARE__",
   "ex_cislo":"888EX88/88",
   "one_time_price":"78682.00",
   "regular_price":null,
   "monetary_description":"s přísl.",
   "nonmonetary_description":null,
   "subjects":[{
     "subject_id":12345,
     "typ_osoby":"F",
     "jmeno":"Jan Novák",
     "datum_narozeni":"1980-08-08",
     "ic":null,
     "adresa":"Kaprova 6, 110 00 Praha 1"
     }],
   "documents":[{
     "document_id":12345,
     "subjects": [12345],
     "document_type_id":1401,
     "document_type_description":"Nařízení exekuce",
     "id_soudu":80,
     "jmeno_soudu":"OS Uherské Hradiště",
     "spisova_znacka_soudu":"EXNc 8888/2005",
     "document_vydano":"2005-01-18",
     "document_vlozeno":"2007-10-09",
     "document_modified":null,
     "text":null
     }]
   }],
 "dataSource":"regular",
 "info":{
   "search":{"type":"cause_id","query":"MPVWx"},
   "zbyva_dotazu":{"placenych":58,"free":null},
   "cena":{"zaplaceno":"60.00 CZK","kredit":"3480.00"},
   "debug":{"found":1}
 }
}
Podobně jako u metody /api/search je možné použít pro zobrazení vlastních dokumentů, nebo i jiných FREE kredit. V případě použítí FREE kreditu je nutné taktéž poslat důvod použítí FREE kreditu pro zobrazení detailu této kauzy v parametru reason.
Název Metoda Typ Povinný Info
token GET string Váš token, který jste získali metodou /api/auth
cause_id GET string Id kauzy
reason GET string [pouze pro exekutory] Povinné, při vyhledávání pomocí FREE, RECORD a bezplatných lustrací ze speciálních uživatelských účtu. Zadejte důvod pro užití bezplatného vyhledávání jako hodnotu tohoto parametru.
use_free GET enum("true","record") [pouze pro exekutory] Pro zobrazení detailu za použití FREE nebo RECORD kreditu.
Název Typ Info
cause_id int Unikátní identifikátor kauzy v systému, vždy string i když je někdy na první pohled číslo!
datetime_zalozeni string Datum, které se vygeneruje automaticky při vložení kauzy do systému
datetime_vlozeni string Datum, které exekutoři sami vkládají do systému (datum generování externím systémem)
datetime_zapisu string Datum, které si exekutoři sami vkládají do systému (datum prvního vložení kauzy do systému)
id_exekutora int Identifikátor exekutora v systému centrální evidence exekucí
id_kancelare int Identifikátor exekutorského úřadu v systému centrální evidence exekucí
jmeno_kancelare string Název exekutorského úřadu
ex_cislo string EX číslo - spisová značka kauzy
one_time_price string Jednorázová peněžitá povinnost
regular_price string Pravidelně splácená peněžitá povinnost
monetary_description string Popis peněžité povinnosti
nonmonetary_description string Popis nepeněžité povinnosti
subjects object
subjects.subject_id int Unikátní identifikátor subjektu
subjects.typ_osoby string P - právnická, F - fyzická osoba
subjects.jmeno string Celé jméno fyzické osoby nebo název právnické osoby
subjects.datum_narozeni string Datum narození u fyzické osoby ve formátu YYYY-MM-DD
subjects.ico string IČO (Deprecated: subjects.ic)
subjects.adresa string Adresa trvalého bydliště fyzické osoby nebo sídlo právnické osoby
documents object
documents.document_id int Unikátní identifikátor dokumentu v systému
documents.subjects array[int] Pole se subject_id (identifikátor subjektu v systému), pro které je platný výše uvedený dokument
documents.document_type_id int Číselné označení typu dokumentu
documents.document_type_description string Slovní označení typu dokumentu
documents.id_soudu int Číselné označení soudu, který vydal výše uvedený dokument
documents.jmeno_soudu string Název soudu, který vydal výše uvedený dokument
documents.spisova_znacka_soudu string Spisová značka soudu, který vydal výše uvedený dokument
documents.document_vydano string Datum, kdy uvedený soud vydal dokument
documents.document_vlozeno string Datum vložení dokumentu do centrální evidence exekucí
documents.document_modified string Datum poslední úpravy dokumentu v centrální evidenci exekucí
documents.text string Popis nebo doplňující informace k dokumentu
info object
info.search.type string Klíč podle kterého byl provedené vyhledávání (rc, ico, ex_cislo ...)
info.search.query string Hodnota klíče, podle kterého byl provedené vyhledávání
info.zbyva_dotazu.placenych int Počet placených dotazů, které můžete uskutečnit na základě vašeho kreditu
info.zbyva_dotazu.free int [pouze pro exekutory] Počet FREE dotazů, které můžete uskutečnit na základě vašeho počtu FREE dotazů
info.zbyvajici_kredit string Aktuální výše zbývajícího kreditu
info.cena.zaplaceno string Cena za uskutečněné vyhledávání
info.cena.kredit string Aktuální výše zbývajícího kreditu
info.debug.found int Počet nalezených kauz
Kód Název Info
5525 Chybí id kauzy, odeslané v parametru cause_id.
5574 Hash k dekódování (%s) je neplatný. Při požadavku na neexistující kauzu.

/insert

Tato metoda slouží k vložení nového záznamu do centrální evidence

# vstupní pole pro POST
array(
  'datum_ukonceni' => 'YYYY-MM-DD HH:II:SS', // datum a čas, kdy byla kauza ukončena
  'datum_vlozeni' => 'YYYY-MM-DD HH:II:SS',  // datum a čas, kdy bylo generováno
  'datum_zapisu' => 'YYYY-MM-DD HH:II:SS',   // datum a čas, kdy bylo poprvé vloženo do systému CEE
  'ex_cislo_preffix' => 'int(3)'   // povinná položka - prefix před EX
  'ex_cislo_number' => 'int(1,6)' // povinná položka - číslo kauzy hned za EX
  'ex_cislo_suffix' => 'int(2)'    // povinná položka - suffix za lomítkem
  'one_time_price' => 'decimal(15,2)', // povinná alespoň jedna z one_time_price, regular_price, monetary_description
  'regular_price' => 'decimal(15,2)',
  'monetary_description' => 'string',
  'nonmonetary_description' => 'string',
  'current_price_value' => 'decimal(15,2)', // aktuálně vymáhaná částka
  'current_price_date' => 'YYYY-MM-DD HH:ii:ss',
  'merged_cause_code' => 'string',
  'merged_date' => 'YYYY-MM-DD HH:II:SS', // datum a čas, kdy byla kauza sloučena
  'software_version' = 'string', // verze software, ktery provedl import pres API
  'subject' => array( // povinná položka
    array(
      'subject_type' => 'char', // povinná položka - typ subjektu - P = právnická osoba, F = fyzická osoba
      'legal_name' => 'string', // povinná položka - jméno subjektu - fyzická osoba musí mít alespoň 2 slova
      'birthdate' => 'YYYY-MM-DD', // povinná položka pro fyzickou osobu
      'rc' => 'integer(9|10)', // povinná položka pro fyzickou osobu
      'ico' => 'string', // povinná položka pro právnickou osobu
      'adresa' => 'string',
      'address_code' => 'int', // povinná položka pro necizince - RUIAN kod adresniho mista
      'gender' => 'char(F|M)' // nepovinná položka pro FO, F = žena, M = muž, jinak bude určeno z RČ
      'foreigner' => 'int' // 1/0 - zda se jedná o cizince a nebo ne
    )
  ),
  'documents' => array( // povinná položka - automaticky navázaná na všechny subjekty z tohoto requestu
    array(
      'id_soudu' => 'integer', // povinná položka
      'spisova_znacka_soudu' => 'string', // povinná položka
      'type' => 'integer', // povinná položka - číslo podle typu dokumentu - 140[1-5]
      'document_vydano' => 'YYYY-MM-DD', // povinná položka
      'popis_dokumentu' => 'string',
    )
  ),
  'eligible' => array( // nepovinná položka oprávněného
    array(
      'subject_type' => 'char', // povinná položka - typ subjektu - P = právnická osoba, F = fyzická osoba
      'legal_name' => 'string', // povinná položka - jméno subjektu - fyzická osoba musí mít alespoň 2 slova
      'birthdate' => 'YYYY-MM-DD', // povinná položka pro fyzickou osobu
      'ico' => 'string', // povinná položka pro právnickou osobu
      'adresa' => 'string',
      'address_code' => 'int', // povinná položka pro necizince - RUIAN kod adresniho mista
      'foreigner' => 'int' // 1/0 - zda se jedná o cizince a nebo ne
    )
  ),
);
Název Metoda Typ Povinný Info
datum_ukonceni POST string Datum a čas ukončení kauzy (YYYY-MM-DD)
datum_vlozeni POST string Datum a čas vygenerování kauzy Vašim softwarem (YYYY-MM-DD)
datum_zapisu POST string Datum a čas, kdy byla kauza poprvé voložena do CEE (YYYY-MM-DD)
ex_cislo_preffix POST string EX číslo - spisová značka kauzy: číslo před EX
ex_cislo_number POST string EX číslo - spisová značka kauzy: číslo za EX
ex_cislo_suffix POST string EX číslo - spisová značka kauzy: číslo za lomítkem
one_time_price POST string Částka; Jednorázová peněžitá povinnost, povinná buď z one_time_price, regular_price, monetary_description
regular_price POST string Částka; Pavidelná peněžitá povinnost, povinná buď z one_time_price, regular_price, monetary_description
monetary_description POST string Popis peněžité povinnosti
nonmonetary_description POST string Popis nepeněžité povinnosti
current_price_value POST number Aktuálně vymáhaná částka
current_price_date POST string Datum aktualizace částky (YYYY-MM-DD)
merged_cause_code POST string Cause_id sloučené kauzy
merged_date POST string Datum a čas sloučení kauzy (YYYY-MM-DD HH:ii:ss)
software_version POST string Název a verze softwaru, který provedl import přes API
subject POST object Objekt obsahující pole (array) s povinnými
subject.[].subject_type POST string P - právnická, F - fyzická osoba
subject.[].legal_name POST string Jméno subjektu
subject.[].birthdate POST string Datum narození subjektu, povinné pouze u fyzických osob (YYYY-MM-DD HH:ii:ss)
subject.[].rc POST string Rodné číslo bez lomítka, případně identifikátor cizince.
subject.[].ico POST string IČ, povinné u právnických osob
subject.[].adresa POST string Adresa trvalého bydliště nebo sídlo právnické osoby - pouze pro cizince ve spojení s parametrem foreigner!
subject.[].address_code POST string Kód adresního místa (ADM) z RUIAN s trvalým bydlištěm nebo sídlo právnické osoby.
subject.[].gender POST string Pohlaví u fyzickách osob, jinak bude určeno z rodného čísla, F = žena, M = muž
subject.[].foreigner POST int 1 jde o cizince, 0 subject není cizinec
documents POST object Objekt obsahující pole s dokumenty vztahující se ke kauze
documents[].id_soudu POST int ID soudu, který vydal daný dokument podle číselníku CEE
documents[].spisova_znacka_soudu POST string Soudní spisová značka dokumentu
documents[].type POST int Typ dokumentu, podle číselníku CEE
documents[].document_vydano POST string Datum vydání dokumentu soudem
documents[].popis_dokumentu POST string Popis dokumentu
Název Typ Info
data object
data.cause_id string Unikátní identifikátor kauzy v systému - pozor je vždy string i když obsahuje pouze samá čísla!
data.ex_number string Složená spisová značka kauzy
data.subject_id array[int] Unikátní identifikátor subjektu v systému
data.document_id array[int] Unikátní identifikátor dokumentu v systému
data.message string Zpráva s informací o vložení kauzy do systému
Kód Název Info
4000352 Kauza s EX číslem %s již existuje! Při pokus o vložení kauzy s EX číslem, které již v DB je.
4000302 EX číslo není ve správném formátu! Číslo musí odpovídat tomuto výrazu: ^\\d{3}EX(?!0)\\d{1,6}\\/\\d{2}. Při nesprávném složení EX čísla (neodpovídá regulárnímu výrazu a nebo chbí některá část)
4000XXX XXX je povinnou položkou. Chybí nějaká povinná položka.

/addsubjecttocause

Tato metoda slouží k vložení dalšího subjektu k existující kauze.

# vstupní pole pro POST
array(
  'subject_type' => 'char', // povinná položka - typ subjektu - P = právnická osoba, F = fyzická osoba
  'legal_name' => 'string', // povinná položka - jméno subjektu - fyzická osoba musí mít alespoň 2 slova
  'birthdate' => 'YYYY-MM-DD',
  'rc' => 'integer',
  'ico' => 'string',
  'adresa' => 'string',
  'address_code' => 'int', // povinná položka pro necizince - RUIAN kod adresniho mista
  'gender' => 'char(F|M)', // nepovinná položka pro FO, F = žena, M = muž, jinak bude určeno z RČ
  'foreigner' => 'int' // 1/0 - zda se jedná o cizince a nebo ne
  'documents' => array( // povinná položka
    array(
      'id_soudu' => 'integer', // povinná položka, pokud je typ dokumentu 1402 nebo 1403
      'spisova_znacka_soudu' => 'string', // povinná položka, pokud je typ dokumentu 1402 nebo 1403
      'type' => 'integer', // povinná položka - číslo podle typu dokumentu - 140[1-5]
      'document_vydano' => 'YYYY-MM-DD', // povinná položka
      'popis_dokumentu' => 'string'
    )
  )
);
Název Metoda Typ Povinný Info
subject_type POST string P - právnická, F - fyzická osoba
legal_name POST string Jméno subjektu
birthdate POST string Datum narození subjektu, povinné pouze u fyzických osob (YYYY-MM-DD)
rc POST string Rodné číslo bez lomítka nebo identifikátor cizince, povinné u fyzických osob
ico POST string IČ, povinné u právnických osob
address_code POST string Kód adresního místa (ADM) z RUIAN s trvalým bydlištěm nebo sídlo právnické osoby.
adresa POST string Adresa trvalého bydliště nebo sídlo právnické osoby
gender POST string Pohlaví u fyzickách osob, jinak bude určeno z rodného čísla, F = žena, M = muž
foreigner POST int 1 subject je cizinec, 0 subject není cizinec
documents POST object Objekt obsahující pole s dokumenty vztahující se ke kauze
documents[].id_soudu POST string ID soudu, který vydal daný dokument podle číselníku CEE
documents[].spisova_znacka_soudu POST string Soudní spisová značka dokumentu
documents[].type POST string Typ dokumentu, podle číselníku CEE
documents[].document_vydano POST string Datum vydání dokumentu soudem
documents[].popis_dokumentu POST string Popis dokumentu
documents[].subjects POST array nebo string Pole obsahující seznam subjektů, pro které je platný tento dokument v pořadí v jakém byly zadány v objektu subjects. Viz příklad nebo hodnota "all", pokud je dokument platný pro všechny subjekty v kauze.
Název Typ Info
data object
cause_id string Unikátní identifikátor kauzy v systému - pozor je vždy string i když obsahuje pouze samá čísla!
subject_id string Unikátní identifikátor subjektu v systému
document_id array[int] Unikátní identifikátor dokumentů v systému
message string Zpráva s informací o vložení povinného do systému

/addeligibletocause

Tato metoda slouží k vložení dalšího oprávněného k existující kauze.

# vstupní pole pro POST
array(
  'subject_type' => 'char', // povinná položka - typ subjektu - P = právnická osoba, F = fyzická osoba
  'legal_name' => 'string', // povinná položka - jméno subjektu - fyzická osoba musí mít alespoň 2 slova
  'birthdate' => 'YYYY-MM-DD',
  'ico' => 'string',
  'adresa' => 'string',
  'address_code' => 'int', // povinná položka pro necizince - RUIAN kod adresniho mista
  'foreigner' => 'int' // 1/0 - zda se jedná o cizince a nebo ne
);
Název Metoda Typ Povinný Info
subject_type POST string P - právnická, F - fyzická osoba
legal_name POST string Jméno subjektu
birthdate POST string Datum narození subjektu, povinné pouze u fyzických osob (YYYY-MM-DD)
ico POST string IČ, povinné u právnických osob
address_code POST string Kód adresního místa (ADM) z RUIAN s trvalým bydlištěm nebo sídlo právnické osoby.
adresa POST string Adresa trvalého bydliště nebo sídlo právnické osoby
foreigner POST int 1 subject je cizinec, 0 subject není cizinec
Název Typ Info
data object
cause_id string Unikátní identifikátor kauzy v systému - pozor je vždy string i když obsahuje pouze samá čísla!
eligible_id string Unikátní identifikátor oprávněného v systému
message string Zpráva s informací o vložení povinného do systému

/insertdocument

Tato metoda slouží k vložení nového dokumentu k existující kauze

# vstupní pole pro POST
array(
  'id_soudu' => 'integer', // povinná položka, pokud se jedná o typ 1402 nebo 1403
  'spisova_znacka_soudu' => 'string', // povinná položka, pokud se jedná o typ 1402 nebo 1403
  'type' => 'integer', // povinná položka - číslo podle typu dokumentu - 140[1-5]
  'document_vydano' => 'YYYY-MM-DD', // povinná položka
  'popis_dokumentu' => 'string',
  'subjects' => array('integer',...) // povinná položka - seznam subjektů, ke kterým se dokument váže, nebo hodnota 'all' ('subjects' => 'all')
);
POST /api/insertdocument?token=__API_TOKEN__&cause_id=__HASH_ID_KAUZY__

Výstupem je JSON objekt s informací o stavu vložení

{"status":200,"data":{"cause_id":"__HASH_ID_KAUZY__","document_id":__NOVE_ID_DOKUMENTU__,"message":"Your document has been inserted"},"dataSource":"test"}
Název Metoda Typ Povinný Info
cause_id GET string Cause_id kauzy pro kterou vkládáte dokument
id_soudu POST string ID soudu, který vydal daný dokument podle číselníku CEE
spisova_znacka_soudu POST string Soudní spisová značka dokumentu
type POST string Typ dokumentu, podle číselníku CEE
document_vydano POST string Datum vydání dokumentu soudem
popis_dokumentu POST string Popis dokumentu
subjects POST array nebo string Pole obsahující subject_id, pro které je platný tento dokument Viz příklad nebo hodnota "all", pokud je dokument platný pro všechny subjekty v kauze.
Název Typ Info
data object
cause_id string Unikátní identifikátor kauzy v systému - pozor je vždy string i když obsahuje pouze samá čísla!
document_id string Unikátní identifikátor dokumentu v systému - pozor je vždy string i když obsahuje pouze samá čísla!
message string Zpráva s informací o vložení dokumentu do systému

/insertcompletion

Tato metoda slouží k vložení completion k subjektu existující kauzy

# vstupní pole pro POST
array(
  'type' => '1303',         // povinná položka
  'closed' => '2015-09-26', // povinná položka
  'subjects' => array('70') // povinná položka - seznam subjektů, ke kterým se completion váže, nebo hodnota 'all' ('subjects' => 'all')
);
Název Metoda Typ Povinný Info
cause_id GET string Cause_id kauzy pro kterou vkládáte completion
type POST string Typ completionu podle číselník CEE
closed POST string Datum ukončení povinného ve formátu (YYYY-MM-DD)
subjects POST array nebo string Pole obsahující subject_id nebo string s hodnotou "all" ve vztahu k ukončeným povinným
Název Typ Info
data object
data.cause_id string Unikátní identifikátor kauzy v systému - pozor je vždy string i když obsahuje pouze samá čísla!
data.completion_id int Unikátní identifikátor completionu v systému - pozor je vždy string i když obsahuje pouze samá čísla!
data.cause_terminated int 1/0 - 1 pokud byla kauza ukončena.
data.message string Zpráva s informací o vložení completionu do systému

/update

Tato metoda slouží k aktualizaci kauzy. Metoda přijímá stejné paremetry jako metoda /insert (bez dokumentů a subjektů). V payloadu zasílejte parametry, které chcete změnit. Pokud chcete vynulovat nějakou hodnotu pošlete prázdný parametr nebo "NULL".

POST /api/update?token=__API_TOKEN__&cause_id=__HASH_ID_KAUZY__

Výstupem je JSON objekt s informací o stavu updatu a seznamem aktualizovaných polí (ukázka struktury je stejná jako v metodě /api/insert)

{"status":200,"data":{"updated":["one_time_price","adresa"],"message":"Your data has been updated"},"dataSource":"test"}

Příjímá stejné parametry jako metoda /api/insert a parametr cause_id.

Název Metoda Typ Povinný Info
cause_id string GET Cause_id kauzy, kterou chcete upravit.
Název Typ Info
data object
data.updated array Pole obsahující názvy položek, které byly změněné
data.message string Zpráva s informací o změně kauzy

/updatesubject

Tato metoda slouží k aktualizaci subjektu.

POST /api/updatesubject?token=__API_TOKEN__&cause_id=__HASH_ID_KAUZY__&subject_id=__SUBJECT_ID__

Výstupem je JSON objekt s informací o stavu updatu a seznamem aktualizovaných polí

{"status":200,"data":{"updated":["adresa"],"message":"Your data has been updated"},"dataSource":"test"}

Příjímá stejné parametry jako metoda /api/insert v objektu subject.

Název Metoda Typ Povinný Info
cause_id string GET ID kauzy, u které chcete subjekt upravit.
subject_id string GET Subject_id, který chcete upravit.
Název Typ Info
data object
data.updated array Pole obsahující názvy položek, které byly změněné
data.message string Zpráva s informací o změně subjektu

/updateeligible

Tato metoda slouží k aktualizaci oprávněného.

POST /api/updateeligible?token=__API_TOKEN__&cause_id=__HASH_ID_KAUZY__&eligible_id=__ELIGIBLE_ID__

Výstupem je JSON objekt s informací o stavu updatu a seznamem aktualizovaných polí

{"status":200,"data":{"updated":["adresa"],"message":"Your data has been updated"},"dataSource":"test"}

Příjímá stejné parametry jako metoda /api/insert v objektu eligible.

Název Metoda Typ Povinný Info
cause_id string GET ID kauzy, u které chcete subjekt upravit.
eligible_id string GET ID oprávněného, kterého chcete upravit.
active bool POST Parametr navíc oproti /api/insert: Nastavení oprávněného jako aktivního nebo ne (neaktivní = smazaný)
Název Typ Info
data object
data.updated array Pole obsahující názvy položek, které byly změněné
data.message string Zpráva s informací o změně subjektu

/updatedocument

Tato metoda slouží k aktualizaci dokumentu

V payloadu zasílejte všechny parametry, které chcete změnit. Pokud chcete vynulovat nějakou hodnotu pošlete prázdný parametr nebo "NULL" ve formě textového řetězce.

POST /api/updatesubject?token=__API_TOKEN__&cause_id=__HASH_ID_KAUZY__&document_id=__DOUCENT_ID__

Výstupem je JSON objekt s informací o stavu updatu a seznamem aktualizovaných polí

{"status":200,"data":{"updated":["popis_dokumentu"],"message":"Your data has been updated"},"dataSource":"test"}

Příjímá stejné parametry jako metoda /api/insert v objektu document.

Název Metoda Typ Povinný Info
cause_id string GET Cause_id, u které chcete upravit dokument.
document_id string GET Document_id, který chcete upravit.
Název Typ Info
data object
data.updated array Pole obsahující názvy položek, které byly změněné
data.message string Zpráva s informací o změně dokumentu

/courtlist

Tato metoda vypíše seznam všech soudů v systému.
GET /api/courtlist?token=__API_TOKEN__
Výstupem je JSON objekt ve formátu
{"status":200,"data":[{"id": 2,"name": "OS Benešov","combo": "Benešov - OS Benešov"},...],"dataSource":"test"}
Název Typ Info
data object
data.[].id int ID soudu
data.[].name string Krátký název soudu
data.[].combo string Dlouhý název soudu

/documenttypelist

Tato metoda vypíše seznam povolených typů dokumentů.
GET /api/documenttypelist?token=__API_TOKEN__
Výstupem je JSON objekt ve formátu
{"status":200,"data":[{"id":"1401","name":"Nařízení exekuce"},...],"dataSource":"test"}
Název Typ Info
data object
data.[].id int ID dokumentu
data.[].name string Název typu dokumentu

/completiontypelist

Tato metoda vypíše seznam povolených typů ukončení povinného.
GET /api/completiontypelist?token=__API_TOKEN__
Výstupem je JSON objekt ve formátu
{"status":200,"data":[{"id":"1301","name":"Soud rozhodl o vyloučení exekutora"},...],"dataSource":"test"}
Název Typ Info
data object
data.[].id int ID ukončení
data.[].name string Název typu ukončení
>