logo Centrální Evidence Exekucí Exekutorská komora České republiky
Přihlášení pro registrované uživatele

Changelog

  • 29. 01. 2018 Nová metoda /validatesubject a objekt výstupu data.errors pro některé metody viz chyby, vyjímky, vyrování.
  • 21. 01. 2017 Nová metoda /ruiantoaddress pro převod kódu ADM z RÚIAN na infomrace o adrese
  • 23. 10. 2016 Nová metoda /geocodeaddress pro dohledání adresy z RÚIAN
  • 27. 03. 2016 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 Nově pokud /insert vloží kauzu a stejná kauza u kanceláře již existuje, bude stará kauza automaticky deaktivována.
  • 03. 03. 2016 Neaktivní kauzy s datem založení starším než 30 dní jsou nyní automaticky přesouvány do archivu.
  • 12. 02. 2016 Ve všech metodách byla vypnuta validace rodného čísla a IČ.
  • 05. 02. 2016 Ve všech metodách kromě /search byla vypnuta validace rodného čísla.
  • 03. 02. 2016 Parametr /insert nový parametr "cizinec" vkládání rodných čísel cizinců (také pro /updatesubject, /addsubjecttocause).
  • 03. 02. 2016 Parametr /search nový parametr "cizinec" pro vyhledávání cizinců.
  • 22. 01. 2016 Parametr /insert one_time_price nyní může být "0" pro vyjádření nulové jistiny.
  • 28. 11. 2015 Přidána metoda /completiontypelist pro seznam povolených typů ukončení.
  • 10. 11. 2015 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 Z důvodu přetížení serveru jsme zavedli limit na jeden evidenční dotaz za jednu sekundu.
  • 20. 10. 2015 Přidání nového typu dotazu - evidenční dotaz
  • 14. 10. 2015 HTTP POST nyní akceptuje nejen form-data ale i application/json, vizte ukázku
  • 04. 10. 2015 U metody /search je nová položka search_reason
  • 04. 10. 2015 U metody /insert a /update je nová položka software_version
  • 27. 09. 2015 Zneplatnění metod /removesubjectfromcause a /removedocumentfromcause
  • 26. 09. 2015 Přidána nová metoda /insertcompletion
  • 26. 09. 2015 Upraveny datumy u kauzy, documents je povinná položka pro /insert a /addsubjecttocause, documents se váže na subject
  • 21. 09. 2015 Přidány nové metody /courtlist, /documenttypelist
  • 13. 08. 2015 Přidány nové metody /me, /colleagues
  • 30. 07. 2015 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 Vydána verze 3.0.0

Informace pro nové uživatele API

Nové CEE API verze 3.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

FAQ (často kladené dotazy)

Bere systém v potaz tvary jména Jan Novák a Novák Jan?

Na pořadí jméno a příjmení nezáleží.

Bere systém v potaz rozdíl mezi 123 EX 456 a 123EX456?

Systém ukládá ex čísla do databáze bez mezer, pokud do vyhledávání zadáte ex číslo s mezerami, systém je automaticky vyhodí. Mezi spisovou značkou s mezerami a bez mezer tedy není žádný rozdíl.

Jakým způsobem jsou zpracovávána jména s diakritikou?

Systém rozlišuje diakritiku, proto je nutné uvést jméno hledaného subjektu správně s diakritkou. Jan Novak, i Ján Novák jsou chápána jako dvě rozdílná jména.

Rozlišování velkých i malých písmen v dotazech.

Dotaz JAN NOVÁK, jan novák a Jan Novák jsou každý zpracován stejně. Velikost písmen se ignoruje.

Ve výsledcích vyhledávání chybí rodné číslo!

Z důvodu ochrany osobních údajů a dalších bezpečnostních důvodů není rodné číslo nikdy v návratových hodnotách systému.

Co se stane, když do JSON API pošlu dotaz na konkrétní kauzu na základě včerejšího monitoringu, ale kauza byla mezitím zrušena?

Jelikož kauza zůstává i po jejím ukončení ještě dalších 15 dní v systému s daným příznakem, resp. informací, je výsledek zobrazen a klasicky zpoplatněn. Jesliže dojde k on-line dotazu v době, kdy již došlo ke zneviditelnění informace pro uživatele, je dotaz taktéž zpoplatněn, neboť výsledkem je informace, že daná kauza již v systému není, což je relevantní informace stojící na roveň zobrazení detailů kauzy.

Předpokládáme, že v CEE budeme mít jeden účet, kam se zapíše každý dotaz (ať už online nebo offline) a ten se už znovu neúčtuje, pokud je opakovaně zadáván v monitoringu, tj. v denním souboru CSV. Nebo online dotaz (typ IČ/RČ) je jednou zpoplatněn a pak znovu, pokud se objeví v CSV souboru?

Každý dotaz na systém je vždy účtován. V případě, že se dotážete na stejný subjekt vícekrát během dne, je každý dotaz zpoplatněn jako nový dotaz. CSV, API i webové dotazy jsou každý tedy zpoplatněn zvlášť.

V dávkových dotazech cvs soubor - co je jednotkou zpoplatnění za kterou se platí 60Kč? Je to jeden řádek zadávaciho CVS souboru, který vytvoři jeden záznam v db dotazu? Kde to najdeme?

Jednotkou zpoplatnění je jeden řádak zadávacího souboru. Odpovědí na jeden zpoplatněný dotazovací řádek může být X řádků, kdy X = počet relevantních kauz.

K vyúčtování: existuje nějaká průběžná forma kontroly nákladů, tj. přehled učiněných a účtovaných dotazů tak, jak to je i v případě WEB dotazu z menu CEECR?

Vyúčtování a přehled všech dotazů je v nastavení vašeho účtu. API navíc vrací informace o ceně a zůstatku kreditu ve zvláštním objektu viz příklady.

Jak byste uvažovali RČ před rokem 1950 kdy RČ mělo jen 9 cifer a nesplňovalo podmínku mod 11?

Rodná čísla do roku 1954 nelze kontrolovat. Pokud takové rodné číslo bude zahrnuto v dotazovací větě, systém jej nekontroluje.

Jak je to z tohoto pohledu se jmény a příjmeními, některé osoby mají např dvě příjmení? Jaká jsou pravidla pro určení shody dotazovaného parametru s údajem v databázi? Je to někde popsané, co je shoda a co již shoda není?

Vyhledávací systém zpracuje název subjektu jako jeden řetězec. Chcete-li tedy napřílad najít Jana Aloise Nováka, je třeba zadat Jan Alois Novák, nikoliv pouze Jan Novák.

Jak se v tomto případě vyhodnocují mezery? Třeba mezera omylem uvedená na prvním míste řetězce s příjmením?

Systém automaticky ořízne prázdné znaky na začátku i konci řetězce.

Datumy se závazně uvádějí ve formě DD.MM.RRRR nebo jsou povolene i jiné formy? Musí mít den a měsic dvě cifry nebo stačí jedna?

Je nutné dodržet formát den.měsíc.rok, data uváděná čísly, den i měsíc na dva znaky, rok na čtyři.

Jak rychle se aktualizuje seznam v případě vypořádání exekuce, tedy jinými slovy, jak neaktuální může být záznam o exekuci, která byla již vypořádána?

Exekutor, resp. daný exekutorský úřad je povinnen zanést rozhodné údaje do databáze CEE ČR do pěti pracovních dní od doby, kdy mu byla daná informace doručena.

Rychlý návod

Pro užití API je ze všeho nejdříve nutné mít uživatelské jméno API_KEY a uživatelské heslo API_SECRET, obojí obdržíte od správce centrální evidence exekucí.

  1. Autorizujte se pomocí svého uživatelského jména a hesla: https://www.ceecr.cz/api/auth?api_key=__API_KEY__&api_secret=__API_SECRET__
  2. Obdržíte návratové hodnoty ve formátu JSON a především token_value, obsahující autorizační řetězec.
  3. Hodnotu token_value předávejte vždy všem metodán pomocí parametru token.
    Například https://www.ceecr.cz/api/search?token=__API_TOKEN__&name=Jan+Novák&birth=2000-01-01
  4. Systém vám vždy vrátí výsledek ve formátu JSON. Jednotlivé výstupy jsou popsány níže.

Ukázka: Získání tokenu v Pythonu

# Níže uvedený příklad využívá knihovny urllib2 a json
>>> import urllib2
>>> import json
>>> # nacteme token do promenne json_encode
>>> json_data = urllib2.urlopen("https://www.ceecr.cz/api/auth?api_key=__API_KEY__&api_secret=__API_SECRET__").read()
>>> # vypsani promenne json_data
>>> print json_data
>>> # prevedeni na python object 
>>> json_object = json.loads(json_data)
{u'status': 200, u'data': {u'valid_till': u'2015-03-17 01:18:47', u'token_value': u'UcGc#ZVT4Gzu9', u'valid_for': u'111.112.111.113'}}
>>> # vypsani tokenu
>>> print json_object['data']['token_value']
UcGc1ZVT4Gzu9
>>> # Klient se úspěšně autorizoval a získal token UcGc1ZVT4Gzu9, pro další práci v API není nutné se opětovně přihlašovat.
					

Ukázka: Získání tokenu v PHP

$apiJson = file_get_contents('https://www.ceecr.cz/api/auth?api_key=__API_KEY__&api_secret=__API_SECRET__');
$apiArray = json_decode($apiJson, true);
if ($apiArray['status'] == 200) {
	//$apiArray['data']['token_value'];
}
					

Ukázka: Získání tokenu v Javascriptu

# vanilla Javascript
xmlhttp.open("GET","https://www.ceecr.cz/api/auth?api_key=__API_KEY__&api_secret=__API_SECRET__",false);
xmlhttp.send();
json_data = JSON.parse(xmlhttp.responseText);
console.log(json_data.data.token_value);

# varianta s jQuery
$.getJSON(
	'https://www.ceecr.cz/api/auth?api_key=__API_KEY__&api_secret=__API_SECRET__',
	function(json){
		console.log(json.data.token_value)
	}
);
					

Ukázka: CURL s POST payloadem ve formátu JSON

Metody, které akceptují data formou POST payloadu, akceptují zaslání dat buď ve tvaru form-data nebo ve tvaru JSON.

root@localhost:~|⇒  curl -X POST --url https://www.ceecr.cz/api/test/insert/?token=PxRK9JQPZcq8f -d '{"ex_cislo":"123 EX 456","subject":[{"subject_type":"P","legal_name":"Jan Novák"}],"documents":[{"id_soudu":25,"type":1401,"subjects":[0],"document_vydano":"2015-09-01"}],"one_time_price":10000}'

{"status":200,"data":{"cause_id":"4zbW","subject_id":[6871],"document_id":[815],"ex_number":"123EX456","message":"Kauza byla vložena do systému!"},"dataSource":"test"}
					

Testovací prostředí

Pro účely testování a vývoje vašich aplikací je možné (a vhodné) pracovat s testovacími daty. Vyhledávaní v testovacích datech není nijak zpoplatněno. Po zřízení přístupu do API jsou veškeré účty napojené pouze na testovací rozhraní, nikoliv na reálná data. V okamžiku, kdy je vaše aplikace připravena pro produkční nasazení, administrátor přepne váš účet z testovacího do reálného prostředí.

Pokud i po přepnutí účtu budete potřebovat připojení na testovací data, využijte URL adresu https://www.ceecr.cz/api/test/ místo https://www.ceecr.cz/api/

Níže uvedené kauzy můžete použít pro testovací lustraci v testovací databázi #2, v případě, že testovací data jsou vymazána - jsou vždy automaticky obnovena v několika následujících minutách.

EX Číslo Cause Id Povinní
132EX123456/15 6D
    • legal_name: Honzíček Boubelatý
    • subject_type: F
    • birthdate: 1990-01-01
    • rc: 9001010018
    • adresa: Pěkná ulice 28, 110 00 Praha 1
    • legal_name: Antonie Boubelatá
    • subject_type: F
    • birthdate: 1990-01-01
    • rc: 9051010023
    • adresa: Pěkná ulice 28, 110 00 Praha 1
132EX123450/15 7n
    • legal_name: Boubel s.r.o.
    • subject_type: P
    • ico: 25596641
    • adresa: Pěkná ulice 28, 110 00 Praha 1

Společné parametry

Všechny výstupy z API vrací objekt status a dataSource. Tyto dva objekty nejsou již dále zahrnuté v dokumentaci jednotlivých metod, protože u všech metod vrací pouze zde uvedené parametry. Více informací na kartě "Parametry výstupu".

Název Typ Info
status int Vrací int buď 200 (všechnov pořádku) nebo 500 (nastala chyba). Pozor, při kontrole HTTP hlaviček může být vracen HTTP status 200 ale api status 500. Kontrolujte proto vždy obojí.
dataSource string Vrátí informaci, zda se jedná o testovací (test) nebo produkční (regular) API rozhraní.

Chyby, výjimky a varování

Metody, které pracují se subjekty kauzy (/insert, /update ..) mohou i při úspěšném vložení kauzy do systému vrátit kromě objektu data.message taktéž objekt data.errors. Tento objekt obsahuje informace o nevalidních subjektech, tedy data, která neprošla logickou validací a obsahují například neplatné datum narození, nebo neexistující adresu. Subjekt, který neprošel validací, je vložen do systému a připojen ke kauze, pro statistické účely je však označen jako nevalidní.

V případě, že je kauza vložena bez problémů není objekt data.errors vrácen, v opačném případě je výstup podobný tomuto:


{
    "status":200,
    "data": {
        "cause_id":"4zbW",
        "subject_id":[6871,6872],
        "document_id":[815],
        "ex_number":"123EX456",
        "message": "Kauza byla vložena do systému!"
        "errors": {
            "subjects": {
                "6871": {
                    "bday": "Věk nemůže být větší než 110, vámi zadaný věk je 500",
                    "adresa": "Adresa neodpovídá žádnému adresnímu místu v RUIAN",
                    "rc": "Právnická osoba nemůže mít rodné číslo"
                },
                "6872": {
                    "adresa": "Adresa neodpovídá žádnému adresnímu místu v RUIAN"
                }
            }
        }
    },
    "dataSource":"test"
                        }
                    

Systém vyhodnocuje validaci subjektů podle následujících klíčů. V některých případech může systém označit i validní subjekt, jako nevalidní, například pokud je trvalé bydliště subjektu v ulici, která není zanesena do RUIANu. V tomto případě, je možné tuto osobu označit jako validní zavoláním metody /validatesubject.

/api/auth

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.

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_secred 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
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.

/api/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.

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ý

/api/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

/api/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_login string Jméno
user_login 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
credit string Aktuální výše předplaceného kreditu
price_for_search string Cena za vyhledávání
price_for_detail string Cena za zobrazení detailu

/api/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": {"ex_number": "111EX1111/2015","user_id": "19316","user_name": "jana smolikova"},
"8G": {"ex_number": "888 EX 808080/80","user_id": "19313","user_name": "Michal Kapitán"}, ... },"dataSource":"test"}
							
Název Metoda Typ Povinný Info
token GET string Váš token, který jste získali metodou /api/auth
Název Typ Info
cause_id string Unikátní identifikátor kauzy v systému v systému: EX číslo

/api/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

{"status":200,"data":{"y4": {"ex_number": "111EX1111/2015","user_id": "19316","user_name": "jana smolikova"},
"8G": {"ex_number": "888 EX 808080/80","user_id": "19313","user_name": "Michal Kapitán"}, ... },"dataSource":"test"}
							
Název Metoda Typ Povinný Info
token GET string Váš token, který jste získali metodou /api/auth
Název Typ Info
cause_id object
ex_number string EX číslo - 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

/api/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

/api/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":[{
   "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"
     }],
   "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":"888 EX 88/88",
   "one_time_price":"78682.00",
   "regular_price":null,
   "monetary_description":"s přísl.",
   "nonmonetary_description":null,
   "documents":[{
     "document_id":"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","free":null},
   "debug":{"found":1,"elapsed":0.31462216377258
   }
 }
}

# prázdný výsledek
{"status":200,
 "data":[],
 "dataSource":"test",
 "info":{
   "zbyva_dotazu":{"placenych":93,"free":0},
   "cena":{"zaplaceno":"bezplatný testovací dotaz","kredit":"5580.00","free":"0"},
   "debug":{"found":0,"elapsed":0.085257768630981}
   }
}
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("FREE","RECORD") [pouze pro exekutory] Pro zobrazení detailu za použití FREE nebo RECORD kreditu.
Název Typ Info
subjects object
subjects.subject_id string 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.ic string IČO
subjects.adresa string Adresa trvalého bydliště fyzické osoby nebo sídlo právnické osoby
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_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 string Identifikátor exekutora v systému centrální evidence exekucí
id_kancelare string 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
documents object
documents.document_id string Unikátní identifikátor dokumentu v systému
documents.subjects array Pole se subject_id (identifikátor subjektu v systému), pro které je platný výše uvedený dokument
documents.document_type_id string Číselné označení typu dokumentu
documents.document_type_description string Slovní označení typu dokumentu
documents.id_soudu string Čí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
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 object
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
info.debug.elapsed decimal Počet sekund které systém spotřeboval pro váš dotaz
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.

/api/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' => 'string', // povinná položka
  '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',
  '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_id' => '' // ID existujícího subjektu - zatím neimplementováno
      '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(9|10)',
      'ico' => 'string',
      'adresa' => 'string',
      'gender' => 'char(F|M)' // nepovinná položka pro FO, F = žena, M = muž, jinak bude určeno z RČ
    )
  ),
  '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',
      'subjects' => array('0',...) // povinná položka - seznam subjektů, ke kterým se dokument váže (číslovano od 0 podle pořadí v poli subjects)
    )
  )
);
							
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 POST string Spisová značka kauzy vydaná exektuorským úřadem
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
monetary_description POST string Popis peněžité povinnosti
nonmonetary_description POST string Popis nepeněžité povinnosti
merged_cause_code POST string Cause_id sloučené kauzy
merged_date POST string Datum a čas sloučení kauzy (YYYY-MM-DD H: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 nebo identifikátor cizince, povinné u fyzických osob
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
subject.[].gender POST string Pohlaví u fyzickách osob, jinak bude určeno z rodného čísla, F = žena, M = muž
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
data.cause_id string Unikátní identifikátor kauzy v systému - pozor je vždy string i když obsahuje pouze samá čísla!
data.document_id string Unikátní identifikátor dokumentu v systému - pozor je vždy string i když obsahuje pouze samá čísla!
data.message string Zpráva s informací o vložení kauzy do systému
data.errors object|null Chybová zpráva při vložení kauzy, viz chyby, výjimky a varování

/api/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',  
  'gender' => 'char(F|M)', // nepovinná položka pro FO, F = žena, M = muž, jinak bude určeno z RČ
  '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 HH:ii:ss)
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
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ž
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 - pozor je vždy string i když obsahuje pouze samá čísla!
message string Zpráva s informací o vložení povinného do systému
data.errors object|null Chybová zpráva při vložení kauzy, viz chyby, výjimky a varování

/api/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

/api/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 object Unikátní identifikátor kauzy v systému - pozor je vždy string i když obsahuje pouze samá čísla!
data.completion_id object Unikátní identifikátor completionu v systému - pozor je vždy string i když obsahuje pouze samá čísla!
data.message string Zpráva s informací o vložení completionu do systému

V nadcházející verzi API bude tato metoda označená jako deprecated, nicméně zůstane přístupná pro zpětnou kompatibilitu.

/api/update

Tato metoda slouží k aktualizaci kauzy. Metoda přijímá stejné paremetry jako metoda /insert. V payloadu zasílejte pouze ty parametry, které chcete změnit. Parametry které jsou prázdné "" (tedy strings 0 délkou) jsou ignorovány a tyto položky nebudou upraveny. Pokud chcete vyresetovat pole, tedy jej nastavit jako prázdné pošlete hodnotu (string) NULL nebo (type) 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
data.errors object|null Chybová zpráva při vložení kauzy, viz chyby, výjimky a varování

/api/updatesubject

Tato metoda slouží k aktualizaci subjektu.

POST /api/updatesubject?token=__API_TOKEN__&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
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
data.errors object|null Chybová zpráva při vložení kauzy, viz chyby, výjimky a varování

/api/updatedocument

Tato metoda slouží k aktualizaci dokumentu

V payloadu zasílejte pouze ty parametry, které chcete změnit. Parametry které jsou prázdné "" (tedy strings 0 délkou) jsou ignorovány a tyto položky nebudou upraveny. Pokud chcete vyresetovat pole, tedy jej nastavit jako prázdné pošlete hodnotu (string) NULL nebo (type) NULL

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

/api/delete

Tato metoda slouží ke zneaktivnění kauzy.

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

POZOR - tato metoda slouží ke smazání kauzy například z důvodu duplicity, či vložení špatných údajů, které nelze upravit metodou update.

Neslouží k ukončení kauzy, pro ukončení kauzy použijte metodu update.

{"status":200,"data":{"message":"Cause \"VnKyzz\" was deleted"},"dataSource":"test"}
Název Metoda Typ Povinný Info
cause_id string GET Cause_id, kauzy kterou chcete smazat.
Název Typ Info
data object
data.message string Zpráva s informací o smazání kauzy

/api/mergecause

Tato metoda není momentálně zdokumentovaná.

/api/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":"1401","name":"Nařízení exekuce"},{"id":"1402","name":"Odklad exekuce soudem"},...],"dataSource":"test"}

/api/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":"1301","name":"Soud rozhodl o vyloučení exekutora"},...],"dataSource":"test"}

/api/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"}

/api/geocodeaddress

Tato metoda slouží pro dohledání adresy v RÚIAN. Systém se pokusí na základě zadané adresy, zaslané v parametru address, dohledat adresu a následně ji dekódovat. Touto metodou lze například ověřit existenci adresního místa v České republice. Pokud adresa není nalezena, toto adresní místo neexistuje v RÚIAN.
GET /api/geocodeaddress?token=mAUcrDmj5pn7s&adresa=Pod% altánem% 33930 Praha
Výstupem ke JSON objekt ve formátu
{"status":200,"data":{"message":"Adresa Pod altánem 3393 Praha byla geokódována z databáze RUIAN", ...

POZOR - Do parametru adresa je třeba zadat co nejvíce informací o adresa (ulici, město, psč, číslo popisné). Čím méně je známých parametrů, tím je větší pravděpodobnost, že sytém nedokáže správně dohledat správnou adresu.

Název Metoda Typ Povinný Info
adresa string GET Kód adresního místa z RÚIAN
Název Typ Info
data object
data.message string Zpráva o stavu vyřízení požadavku
data.kod_adm string Kód adresního místa
data.nazev_obce string Název obce
data.nazev_casti_obce string Název části obce
data.nazev_ulice string Název ulice
data.cislo_popisne string Číslo popisné (domovní)
data.cislo_orientacni string Číslo orientační
data.znak_cisla_orientacniho string Doplňkový znak čísla orientačního
data.psc string PSČ

/api/ruiantoaddress

Tato metoda slouží k převedení kódu adresního místa (kód ADM) získaného v RÚIAN na jednotlivé detailní informace o adresním místu.
GET /api/ruiantoaddress?token=__API_TOKEN__&kod_adm=73361801
Výstupem je JSON objekt ve formátu
{"status":200,"data":{"kod_adm":"73361801","nazev_obce":"Praha","nazev_ulice":"Pod altánem","co":"30z","cp":"3393","psc":"10000"},"dataSource":"test"}
Název Metoda Typ Povinný Info
kod_adm string GET Kód adresního místa z RÚIAN
Název Typ Info
data object
data.kod_adm string Kód adresního místa
data.nazev_obce string Název obce
data.nazev_ulice string Název ulice
data.co string Číslo orientační ulice
data.cp string Číslo popisné ulice
data.psc string PSČ

/api/validatesubject

Tato metoda označní subjekt, který byl při vložení nebo změně označen za nevalidní, jako validní.

Název Metoda Typ Povinný Info
subject_id string GET ID subjektu, který chcete zvalidovat
Název Typ Info
data object
data.message string Zpráva o stavu vyřízení požadavku