Reports
| API | Popis |
|---|---|
| GET reports/csv/orders?IntervalFrom={IntervalFrom}&IntervalTo={IntervalTo}&AggregationType={AggregationType}&TopCount={TopCount}&token={token} |
Získání csv objednavek dle definovaného filtru. |
| GET reports/csv/distsets?IntervalFrom={IntervalFrom}&IntervalTo={IntervalTo}&AggregationType={AggregationType}&TopCount={TopCount}&token={token} |
Získání csv objednavek 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ů
| API | Popis |
|---|---|
| GET Users/ConfirmEmail?userId={userId}&token={token} |
Ověření e-mailové adresy uživatele. |
| GET Users/ResendEmailConfirmation?userId={userId} |
Poslání e-mailu pro ověření e-mailové adresy daného uživatele. |
| GET Users/ResetPassword?userName={userName} |
Poslání e-mailu s odkazem na reset hesla daného uživatele. |
| POST Users/ResetPassword |
Reset hesla uživatele. |
| GET Users?roles[0]={roles[0]}&roles[1]={roles[1]}&fullText={fullText}&page={page}&pageSize={pageSize} |
Získání seznamu uživatelů. Pouze pro výdejce nebo admina. |
| GET Users/{id} |
Získání detailu uživatele. Pouze pro výdejce nebo admina. |
| POST Users |
Vytvoření (registrace) nového uživatele. |
| PUT Users/{id} |
Editace stávajícího uživatele. Pouze pro autentizované uživatele. |
| DELETE Users/{id} |
Smazání uživatele. Pouze pro admina. |
SystemSources
| API | Popis |
|---|---|
| GET systemsources/Feature2JsonService |
Test dostupnosti služby pro konverzi souboru ve formátu ESRI ShapeFile do ESRI JSON. |
| GET systemsources/Wkt2ShpService |
Test dostupnosti služby pro konverzi WKT do SHP |
| POST systemsources/MapServices |
Test dostupnosti mapových služeb |
| GET systemsources/DriveInfo |
Získání informace o dostupnosti uložišť |
| GET systemsources/Broker |
Získání informace o broker |
DistSets
Správa výdejních sad
| API | Popis |
|---|---|
| GET DistSets |
Získání seznamu výdejních sad. |
| GET DistSets/{id} |
Získání detailu výdejní sady. |
| POST DistSets |
Vytvoření výdejní sady. Pouze pro výdejce nebo admina. |
| PUT DistSets/{id} |
Editace výdejní sady. Pouze pro výdejce nebo admina. |
| DELETE DistSets/{id} |
Smazání výdejní sady. Pouze pro výdejce nebo admina. |
Orders
Správa objednávek
| API | Popis |
|---|---|
| GET Orders?page={page}&pageSize={pageSize} |
Získání seznamu objednávek. Pouze pro autentizované uživatele. |
| GET Orders/{id} |
Získání detailu objednávky. Pouze pro autentizované uživatele. |
| POST Orders |
Vytvoření nové objednávky. Pouze pro autentizované uživatele. |
| PUT Orders/{id} |
Editace objednávky. Pouze pro autentizované uživatele. |
UserAttachments
Správa příloh k uživatelům
| API | Popis |
|---|---|
| GET UserAttachments/{id}?token={token} |
Získání přílohy k uživateli |
| POST UserAttachments |
Vytvoření přílohy k uživateli. Pouze pro autentizované uživatele. Na vstupu je očekáván požadavek s formátem obsahu "multipart/form-data". |
| PUT UserAttachments/{id} |
Editace nastavení viditelnosti přílohy k uživateli - určuje, zda má být příloha viditelná pouze pro výdejce a admina nebo i odběratele. Pouze pro výdejce nebo admina. |
| DELETE UserAttachments/{id} |
Smazání přílohy k uživateli. Pouze pro autentizované uživatele. |
InvoiceProtocols
Získání daňových dokladů k objednávkám
| API | Popis |
|---|---|
| GET InvoiceProtocols/{id}?securityStamp={securityStamp} |
Získání daňového dokladu. |
DistDataSourceDistSetsValidations
Ověření použití datových sad ve výdejních sadách
| API | Popis |
|---|---|
| GET DistDataSourceDistSetsValidations/{id} |
Ověří použití datových sadnebo nástrojů z datového zdroje s daným id ve výdejních sadách. Pouze pro výdejce a admina. |
DistSetGroups
Správa skupin výdejních sad
| API | Popis |
|---|---|
| GET DistSetGroups |
Získání seznamu skupin výdejních sad. |
| GET DistSetGroups/{id} |
Získání detailu skupiny výdejních sad. |
| POST DistSetGroups |
Vytvoření skupiny výdejních sad. Pouze pro výdejce nebo admina. |
| PUT DistSetGroups/{id} |
Editace skupiny výdejních sad. Pouze pro výdejce nebo admina. |
| DELETE DistSetGroups/{id} |
Smazání skupiny výdejních sad. Pouze pro výdejce nebo admina. |
Feature2Json
Konverze ESRI shapefile do formátu JSON
| API | Popis |
|---|---|
| POST Feature2Json |
Převede uploadovaný soubor ve formátu SHP na JSON. Pouze pro soubory obsahující polygony. Na vstupu je očekáván požadavek s formátem obsahu "multipart/form-data". |
FileDistSetPaths
Ověřování správnosti cest k souborovým výdejním sadám
| API | Popis |
|---|---|
| GET FileDistSetPaths?path={path} |
Ověří platnost cesty pro aouborovou výdejní sadu |
PriceListItems
Získání ceníku
| API | Popis |
|---|---|
| GET PriceListItems?date={date} |
Získání kompletního ceníku k danému datu. |
| GET PriceListItems/{id} |
Získání detailu ceníkové položky. Pouze pro autentizované uživatele. |
| POST PriceListItems |
Vytvoření nové ceníkové položky. Pouze pro admina. |
| PUT PriceListItems/{id} |
Editace ceníkové položky. Pouze pro admina. |
| DELETE PriceListItems/{id} |
Smaže ceníkovou položku s daným id. Pouze pro admina. |
ExportRequestsStats
Statistiky exportních požadavků
| API | Popis |
|---|---|
| GET ExportRequestsStats |
Získání statistiky aktuálního stavu exportních požadavků. Pouze pro výdejce nebo admina. |
OnlinePayments
Vytváření a zpracování požadavků na online úhradu objednávek
| API | Popis |
|---|---|
| GET OnlinePayments?Operation={Operation}&OrderNumber={OrderNumber}&MerOrderNum={MerOrderNum}&Md={Md}&PrCode={PrCode}&SrCode={SrCode}&ResultText={ResultText}&UserParam1={UserParam1}&AddInfo={AddInfo}&Digest={Digest}&Digest1={Digest1} |
Zpracování požadavků (odpovědí) od platební brány GP WebPay. Není určeno pro přímé volání z klienta. |
| POST OnlinePayments |
Vytvoří požadavek pro zaplacení objednávky pomocí GP WebPay a přesměruje klienta na platební bránu. Pouze pro autentizované uživatele. |
ExportFormats
Správa exportních formátů
| API | Popis |
|---|---|
| GET ExportFormats |
Získání seznamu exportních formátů. |
| GET ExportFormats/{id} |
Získání detailu exportního formátu. |
| POST ExportFormats |
Vytvoření exportního formátu. Pouze pro výdejce nebo admina. |
| PUT ExportFormats/{id} |
Editace exportního formátu. Pouze pro výdejce nebo admina. |
| DELETE ExportFormats/{id} |
Smazání exportního formátu. Pouze pro výdejce nebo admina. |
Protocols
Získání předávacích protokolů k objednávkám
| API | Popis |
|---|---|
| GET Protocols/{id}?securityStamp={securityStamp} |
Získání předávacího protokolu objednávky |
OrderAttachments
Správa příloh k objednávkám
| API | Popis |
|---|---|
| GET OrderAttachments/{id}?token={token} |
Získání přílohy k objednávce |
| POST OrderAttachments |
Vytvoření přílohy k objednávce. Pouze pro autentizované uživatele. Na vstupu je očekáván požadavek s formátem obsahu "multipart/form-data". |
| PUT OrderAttachments/{id} |
Editace nastavení viditelnosti přílohy k objednávce - určuje, zda má být příloha viditelná pouze pro výdejce a admina nebo i odběratele. Pouze pro výdejce nebo admina. |
| DELETE OrderAttachments/{id} |
Smazání přílohy k objednávce. Pouze pro autentizované uživatele. |
OrderRegionShapes
| API | Popis |
|---|---|
| GET OrderRegionShapes/{id}?token={token} |
Stažení |
ProcessParameters
| API | Popis |
|---|---|
| GET ProcessParameters |
Vrací seznam všech konfiguračních parametrů. Pouze pro admina. |
| PUT ProcessParameters |
Aktualizace hodnot konfiguračních parametrů. Pouze pro admina. |
ProcessLogs
Získání logovacích zpráv
| API | Popis |
|---|---|
| GET ProcessLogs |
Získání logovacích zpráv, které vyhovují danému filtru. Pouze pro výdejce nebo admina. |
DistDataSets
Informace o datových sadách
| API | Popis |
|---|---|
| GET DistDataSets |
Získání seznamu datových sad. Pouze pro výdejce nebo admina. |
OrderRegions
Získání předdefinovaných výdejních oblastí
| API | Popis |
|---|---|
| GET OrderRegions |
Získání seznamu předdefinovaných výdejních oblastí. |
| GET OrderRegions/{id} |
Získání detailu výdejní oblasti. |
OrderRegionTypes
Získání předefinovaných typů výdejních oblastí
| API | Popis |
|---|---|
| GET OrderRegionTypes |
Získání seznamu předdefinovaných typů výdejních oblastí. |
ExportRequests
Správa exportních požadavků
| API | Popis |
|---|---|
| GET ExportRequests |
Získání seznamu exportních požadavků. Pouze pro výdejce nebo admina. |
| GET ExportRequests/{id} |
Získání detailu exportního požadavku. Pouze pro výdejce nebo admina. |
| PUT ExportRequests/{id} |
Editace exportního požadavku. Pouze pro výdejce nebo admina. |
DistDataSources
Správa datových zdrojů
| API | Popis |
|---|---|
| GET DistDataSources |
Získání seznamu datových zdrojů. Pouze pro výdejce nebo admina. |
| GET DistDataSources/{id} |
Získání detailu datového zdroje. Pouze pro výdejce nebo admina. |
| POST DistDataSources |
Vytvoření nového datového zdroje. Pouze pro výdejce nebo admina. |
| PUT DistDataSources/{id} |
Editace nebo synchronizace datového zdroje. Pouze pro výdejce nebo admina. |
| DELETE DistDataSources/{id} |
Smazání datového zdroje. Pouze pro výdejce nebo admina. |