Docs

Správa přejímek

APIPopis
PATCH docs/{id}/state

Aktualizace stavu přejímky. Přechody do jednotlivých stavů jsou povoleny na základě role uživatele a definovaného workflow zpracování přejímky.
PATCH docs/{id}/region

Nastavení regionu přejímky. Pouze pro uživatele v roli Admin, Přebírající a Zpracovatel.
DELETE docs/{id}/region

Smazání regionu přejímky. Pouze pro uživatele v roli Admin, Přebírající a Zpracovatel.
GET Docs?Number={Number}&State={State}&Type={Type}&SubmissionType={SubmissionType}&DocumentationType={DocumentationType}&DataOrigin={DataOrigin}&BuildingCategoryTopography={BuildingCategoryTopography}&BuildingCategoryUtilities={BuildingCategoryUtilities}&Title={Title}&GeometryPlanNumber={GeometryPlanNumber}&OwnerName={OwnerName}&AuthorId={AuthorId}&OfficerId={OfficerId}&DTMPEditorId={DTMPEditorId}&CadasterId={CadasterId}&BuildingAuthorityId={BuildingAuthorityId}&NewFrom={NewFrom}&NewTo={NewTo}&AcceptedFrom={AcceptedFrom}&AcceptedTo={AcceptedTo}&RejectedFrom={RejectedFrom}&RejectedTo={RejectedTo}&FinishedFrom={FinishedFrom}&FinishedTo={FinishedTo}&IsArchived={IsArchived}&SortAscending={SortAscending}&IncidentParcels={IncidentParcels}

Získání seznamu přejímek dle definovaného filtru.
GET Docs/{id}

Získání detailu přejímky.
POST Docs

Vytvoření nové přejímky. Pouze pro uživatele v roli Admin, Přebírající a Zpracovatel.
PUT Docs/{id}

Editace vlastností přejímky. Pouze pro uživatele v roli Admin, Přebírající a Zpracovatel.
DELETE Docs/{id}

Smazání přejímky. Pouze pro uživatele v roli Admin, Přebírající a Zpracovatel.

Reports

APIPopis
GET reports/csv?IntervalFrom={IntervalFrom}&IntervalTo={IntervalTo}&AggregationType={AggregationType}&TopCount={TopCount}&token={token}

Získání csv přejímek dle definovaného filtru.
GET Reports?IntervalFrom={IntervalFrom}&IntervalTo={IntervalTo}&AggregationType={AggregationType}&TopCount={TopCount}

Získání seznamu reportů dle definovaného filtru.

Users

Správa uživatelů.

APIPopis
GET Users/ConfirmEmail?userId={userId}&token={token}

Ověření e-mailové adresy uživatele. Není vyžadadovaná autentizace.
GET Users/ResendEmailConfirmation?userId={userId}

Poslání e-mailu pro ověření e-mailové adresy daného uživatele. Není vyžadadovaná autentizace.
GET Users/ResetPassword?userName={userName}

Poslání e-mailu s odkazem na reset hesla daného uživatele. Není vyžadadovaná autentizace.
POST Users/ResetPassword

Reset hesla uživatele. Není vyžadadovaná autentizace.
GET Users?roles[0]={roles[0]}&roles[1]={roles[1]}&fullText={fullText}

Získání seznamu uživatelů. Případně omezeno dle filtru. Pouze pro uživatele v roli Admin nebo Přebírající.
GET Users/{id}

Získání detailu uživatele.
POST Users

Vytvoření (registrace) nového uživatele.
PUT Users/{id}

Editace stávajícího uživatele.
DELETE Users/{id}

Smazaní uživatele. Pouze pro uživatele v roli Admin nebo Přebírající.

Attachments

Správa příloh k přejímkám

APIPopis
GET docs/{id}/attachments?token={token}

Získání všech příloh přejímky. Přílohy se vrací v jednom ZIP archivu.
GET Attachments/{id}?token={token}

Získání přílohy k přejímce.
POST Attachments

Vytvoření přílohy k přejímce. Pouze pro uživatele v roli Admin, Přebírající a Zpracovatel. Na vstupu je očekáván požadavek s formátem obsahu "multipart/form-data".
PUT Attachments/{id}

Aktualizace typu přílohy k přejímce. Pouze pro uživatele v roli Admin, Přebírající a Zpracovatel.
DELETE Attachments/{id}

Smazání přílohy k přejímce. Pouze pro uživatele v roli Admin, Přebírající a Zpracovatel.

GeoDocs

APIPopis
GET GeoDocs

Získání seznamu přejímek s regionem dle definovaného prostorového filtru a stavů. Pouze pro admina a přebírajícího.

Cadasters

Správa katastrů

APIPopis
GET Cadasters?fullText={fullText}&code={code}&area={area}

Získání seznamu katastrů. Případně omezeno dle filtru.
GET Cadasters/{id}

Získání detailu katastru.
POST Cadasters

Vytvoření nového katastru. Pouze pro admina a přebírajícího.
PUT Cadasters/{id}

Editace stávajícího katastru. Pouze pro admina a přebírajícího.
DELETE Cadasters/{id}

Smazání katastru. Pouze pro admina a přebírajícího.

BuildingAuthority

Správa stavebních úřadů

APIPopis
GET BuildingAuthority

Získání seznamu stavebních úřadů.
GET BuildingAuthority/{id}

Získání detailu stavebního úřadu.
POST BuildingAuthority

Vytvoření nového stavebního úřadu. Pouze pro admina a přebírajícího.
PUT BuildingAuthority/{id}

Editace stávajícího stavebního úřadu. Pouze pro admina a přebírajícího.
DELETE BuildingAuthority/{id}

Smazání stavebního úřadu. Pouze pro admina a přebírajícího.

SigningCertificates

APIPopis
POST SigningCertificates

Přidání certifikátu pro digitální podpis k uživateli (pro účely podepisování protokolů). Pouze pro uživatele v roli Admin a Přebírající. Na vstupu je očekáván požadavek s formátem obsahu "multipart/form-data".
DELETE SigningCertificates/{id}

Odebrání certifikátu pro digitální podpis pro uživatele. Pouze pro uživatele v roli Admin a Přebírající.

CertifiedGeodesists

Správa úředně oprávněných zeměměřických inženýrů

APIPopis
GET CertifiedGeodesists?fullText={fullText}&number={number}&a={a}&b={b}&c={c}

Získání seznamu úředně oprávněných zeměměřických inženýrů. Případně omezeno dle filtru.
PUT CertifiedGeodesists

Synchronizace seznamu úředně oprávněných zeměměřických inženýrů. Synchornizace probíhá proti oficiálnímu seznamu ÚOZI vystaveném na webu ČÚZK. Pouze pro uživatele v roli Admin a Přebírající.

Protocols

APIPopis
GET Protocols/{id}?token={token}

Získání předávacího protokolu přejímky.
PATCH Protocols/{id}

Přegenerování protokolu přejímky. Pouze pro uživatele v roli Admin a Přebírající.