API
jedním z těchto dvou parametrů:
cadastral_office
- toto akceptuje platný název obce ČR (dle katastrálního území)ruian_cadastral_office
- toto akceptuje kód KÚ (katastrální území)
pokud budou zaslány oba parametry, použije se ruian_cadastral_office
, cadastral_office
se nepoužije.
kódy KÚ viz https://regiony.kurzy.cz/katastr/ku/729213/
Pokud u dražby není požadována úhrada dražební jistoty musíte nechat všechna pole pro úhradu dražební jistoty
prázdná (null
). Pole, která zůstanou prázdná jsou: Číslo účtu, Dražební jistota, Variabilní symbol,
Specifický symbol. :
"caution_deposit":null,"caution_account_number":null,"caution_variable_symbol":null,"account_specific_symbol":null
formát spisové značky dražby musí splňovat tento regex:
/^(\d{3}(DD|EX)\d{1,6}\/\d{2})(-[0-9a-zA-Z]{1,6})?$/
První tři čísla jsou číslem kanceláře soudního exekutora.
Pokud se jedná o dražbu nedobrovolnou, musí mít vyplněno voluntary:false
a obsahovat EX
v čísle.
Pokud se jedná o dražbu dobrovolnou, musí mít voluntary:true
a obsahovat DD
v čísle.
Všude se předpokládá časové pásmo UTC
"start_at":"2021-02-07T12:00:00.000Z"
Pro parsování datumu a času se používá DateTime constructor,
referenční formát v dokumentaci a příkladech je DateTimeInteface::RFC3339_EXTENDED
.
všechny cenové údaje jsou celočíselné (int
). pokud vyplníte číslo desetinné (float
),
tak systém tu desetinnou část zahodí a použije se pouze ta celočíselná část.
https://www.portaldrazeb.cz/admin/auctions/upload-image
https://www.portaldrazeb.cz/admin/auctions/upload-document
k dražbě lze samozřejmě přiložit libovolný počet jak obrázků, tak dokumentů. pro zveřejnění dražby je vyžadována 1x dražební vyhláška, ale lze jich přiložit více, i dalších typů dokumentů.
Dokumenty
přiložení dokumentu se posílá na samostatný endpoint.
POST /admin/auction-documents/<auction_id>.json
{"document":{"document_type":"<document_type>","file":{"uploadedFileName":"<uploaded_file_id>","originalFileName":"1.pdf"}}}
například
POST https://www.portaldrazeb.cz/admin/auction-documents/999ex6789-20-5xq.json
{"document":{"document_type":"auction_decree","file":{"uploadedFileName":"/097d51ab814093029a01602198613592.pdf","originalFileName":"1.pdf"}}}
v odpovědi je obsažen hash
dokumentu. ten je jinak stále obsažen i v datech dražby.
smazání dokumentu také probíhá na samostatný endpoint
DELETE /admin/auction-documents/<auction_id>/<document_id>.json
například
DELETE https://www.portaldrazeb.cz/admin/auction-documents/999ex6789-20-5xq/b68.json
dokument po přiložení nelze editovat. pro změnu typu dokumentu je potřeba dokument smazat a vložit znovu s jiným typem.
Obrázky
je ovšem nutné je vždy uvést, pokud dražbu dále editujete. když přiložíte obrázek, systém vrátí jeho hash, což značí, že byl přiložen. pokud ale poté provedete editaci dražby a tento hash neuvedete, systém přílohu odstraní.
tedy příklad toho, kdy v jednom kroku přiložíte jeden obrázek a v druhém kroku druhý, tak v tom druhém kroku to pole musí vypadat takto:
"images":[{"file":{"uploadedFileName":"/3c1dbd4e215e51e8a63217396853ced5.jpeg","name":"2.jpg"},"priority":1},{"hash":"wYV","priority":0}]
kde images[0]
je nově přikládaný obrázek, images[1]
uchování již přiloženého.
viz Jak změnit stav dražby
PATCH /auctions/{auction}.json
tělo requestu musí obsahovat požadovaný stav, např pro stav "zveřejněná"
{"transition":"to_upcoming"}
jsou povolené jen určité přechody
"to_upcoming" // draft -> upcoming
"to_deleted" // draft -> deleted
"to_deferred" // upcoming -> deferred
"to_cancelled" // upcoming -> cancelled
"to_paid" // upcoming -> paid
Termín konání nelze u zveřejněné dražby (upcoming
) měnit. Dražba se musí ukončit změnou stavu na odročená (deferred
) či zrušená (cancelled
).
Každý stav dražby má povolené určité typy příloh (viz API-popis, typy dokumentů). Dražbu na nový termín si můžete zadat jako novou nebo můžete
vytvořit kopii
PATCH /auctions/{auction}/copy.json
Číslo spisové značky doplníte o číslo listu (číslo za pomlčkou), nastavíte nový termín dražby, dražbu lze do zveřejnění libovolně editovat.
týká se pouze kamenných dražeb. vyplníte jedno z tohoto:
ruian
- toto akceptuje platný RUIAN ADM kód- alternativní zadání souřadnic (GPS + okres)
location_district
location_longitude
location_latitude
Pokud budou zaslány oba údaje, použije se pouze údaj ruian
, alternativní zadání se nepoužije.
kódy ADM viz https://vdp.cuzk.cz/vdp/ruian/overeniadresy/vyhledej
vyplníte jedno z tohoto:
ruian
- toto akceptuje platný RUIAN ADM kód- alternativní zadání souřadnic (GPS + okres)
location_district
location_longitude
location_latitude
Pokud budou zaslány oba údaje, použije se pouze údaj ruian
, alternativní zadání se nepoužije.
kódy ADM viz https://vdp.cuzk.cz/vdp/ruian/overeniadresy/vyhledej
číslo účtu musí být:
- validní české číslo účtu
XXX-YYYYY/ZZZZ
- validní IBAN
nevalidní (vymyšlená) čísla nejsou akceptována. proto i pro testovací dražby použijte reálné číslo účtu nebo IBAN.