TeamWherx

TeamWherx(TW) je univerzální platforma pro správu služeb, která vám pomůže efektivněji spravovat vzdálené týmy zaměstnanců a obecné obchodní operace mimo kancelář. Tw jako cloudové řešení umožňuje vzdálené shromažďování dat a zobrazuje je prostřednictvím řídicího panelu webové aplikace a poskytuje správcům další přehledy, které potřebují k vytvoření chytřejších strategií pro zvýšení efektivity, produktivity a snížení nákladů a zároveň koordinují své mobilní pracovníky.

Tento konektor je dostupný v následujících produktech a oblastech:

Service	Class	Regions
Copilot Studio	Premium	Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD)
Logic Apps	Standard	Všechny oblasti Logic Apps s výjimkou následujících: – Oblasti Azure Government – Oblasti Azure China - Ministerstvo obrany USA (DoD)
Power Apps	Premium	Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD)
Power Automate	Premium	Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD)

Kontakt
Název	Podpora Actsoft
URL	https://www.actsoft.com/self-help-wizards
Email	support@actsoft.com

Metadata konektoru
Vydavatel	Actsoft
Internetová stránka	https://actsoft.com
Zásady ochrany osobních údajů	https://www.actsoft.com/privacy
Kategorie	Produktivita

Popis konektoru:

TeamWherx umožňuje vytvářet a zaznamenávat informace o digitálních formuláři, uchovávání času zaměstnanců a správu pracovních objednávek pomocí dispečerského systému.

Podrobný popis

Konektor TeamWherx umožňuje uživatelům připojovat a vyměňovat si informace mezi několika platformami. Data můžete animovat, abyste mohli vytvářet toky procesů, řídit ostatní interní aplikace a informovat výkonné analýzy. Automatizujte a zefektivněte každodenní, týdenní nebo měsíční procesy s přístupem k up-todatům, na které můžete reagovat.

## Požadavky

Abyste mohli tento konektor použít, budete potřebovat následující:

Účet TeamWherx
Klíč rozhraní API TeamWherx
Plán Microsoft Power Apps nebo Power Automate

## Jak získat přihlašovací údaje

Portál pro vývojáře rozhraní API

Pokud chcete získat přístup ke konektoru, musíte nejprve nastavit uživatelské jméno a heslo pro portál pro vývojáře rozhraní API a přihlásit se k odběru rozhraní API zákazníka:

V aplikaci přejděte do nastavenírozhraní APIpro správu>>.
Zvolte Vytvořit přihlašovací údaje.
Do příslušných polí zadejte své jméno a příjmení.
Do pole E-mailová adresa zadejte svoji e-mailovouadresu .
Zvolte Uložit a poslat e-mailovou pozvánku. Pak si v e-mailu přečtěte pokyny k vytvoření hesla.
V e-mailu s pozvánkou klikněte na Zvolitheslo, které otevře dialogové okno, které vám umožní vytvořit heslo.
Zvolte Uložit heslo.
Pokud chcete přejít na portál pro vývojáře, přejděte v aplikaci dočásti Nastavení>pro správu>,přejdětena portál pro vývojáře.
Na portálu pro vývojáře zvolte Produkty a pak vyberte Zákaznickérozhraní API.
Zvolte Přihlásit se k odběru.

Klíč API

Teď, když jste registrovaný uživatel rozhraní API, vygenerovala se pro vás alfanumerická sekvence s názvem klíč. Tento klíč budete potřebovat pro práci s daty v rozhraní API.

Vyhledání klíče rozhraní API:

V nabídce portálu pro vývojáře zvolte Produkty . Zobrazí se produkty rozhraní API dostupné ve vaší licenci.
V části Máte předplatná X k tomuto produktu vyberte verzi rozhraní API zákazníka .
Zvolte Zobrazit vedle primárního klíče pro vaše předplatné.
Vyberte obsah pole, klikněte pravým tlačítkem myši a zvolte Kopírovat. Klíč je teď uložený do schránky a je připravený k vložení.

## Začínáme s konektorem

Přejděte na Moje toky>Nový tok a pak vyberte Automatizovaný tok cloudu.
V dialogovém okně Sestavení automatizovaného toku cloudu zvolte ruční aktivaci toku .
Pojmenujte tok nebo nechte systém automaticky generovat.
Vyhledejte a zvolte trigger pro váš tok.
Zvolte Vytvořit.
Ve vyhledávacím poli vyhledejte a zvolte konektor TeamWherx.
Najděte akci, kterou chcete s konektorem provést.

Systém vás vyzve, abyste se přihlásili ke všem aplikacím potřebným k provedení zvolené akce a přeskočí všechny aplikace, ke kterým jste už přihlášení.

Do pole Konektor zadejte název nového konektoru.
Pak zadejte klíč rozhraní API.
Zvolte Vytvořit. První krok v toku procesu se zobrazí jako první pole v vývojovém diagramu.
Pokud chcete pokračovat v přidávání dalších akcí a kroků do toku procesu konektoru, zvolte Novýkrok .
Vyberte Uložit.

**Použití konektoru – příklad hlasování o stavu objednávky
** Následující pokyny ukazují, jak vytvořit tok procesu pro vložení řádků do listu a vložit identifikační data zaměstnance, který objednávku aktualizoval při aktualizaci stavu objednávky.

Přejděte na Konektory.
Vyhledejte konektor [TeamWherx] a zvolte ho.
V seznamu akcí zvolte hlasování o stavech objednávek .
Do pole Název připojení zadejte název nového připojení.
Pak zadejte klíč rozhraní API.
Zvolte Vytvořit. První krok v toku procesu se zobrazí jako první pole v vývojovém diagramu.

Každé dialogové okno akce v krocích toku připojení bude obsahovat pole vlastností, která můžete přizpůsobit, abyste mohli řídit provedenou akci.

Pokračujte v příkladu a zvolte, jestli se mají zobrazit hodnoty polí Formuláře (parametr excludeFormData).
Zvolte verzi X-API pro připojení.
Pokud chcete nastavit akci, kterou chcete provést při změně stavu objednávky, zvolte Další krok .
V dialogovém okně Zvolit operaci vyhledejte aplikaci pomocí vyhledávacího pole a požadovanou akci. Pokud byste například chtěli vložit řádek do listu Google při každé změně stavu objednávky, zvolili byste ListyGoogle a potom vložitřádek akce.
V následujícím dialogovém okně Vložitřádek klikněte do pole Soubor a zvolte soubor, který bude obsahovat vaše výsledky.
V poli List zvolte datový typ listu. Pole, která se dynamicky zobrazují, jsou datové sloupce v listu.
Klikněte do pole pro každý sloupec a zvolte vlastnost ze seznamu vlastností hlasování o stavu objednávky . Nebo můžete pomocí vyhledávacího pole najít konkrétní vlastnost.
Do každého pole sloupce můžete zadat více než jednu vlastnost; ve sloupci Událost zvolte StatusLabel, vložte pomlčku a pak zvolte StatusStartDate. To znamená, že pro každou aktualizaci stavu objednávky se popisek stavu a počáteční datum stavu zapíše do sloupce Událost v novém řádku.
Vyberte Novýkrok. Jako poznámka k doplňování můžete kdykoli najet myší a kliknout na spojnici se šipkou a vložit nový krok.
V dialogovém okně Zvolit operaci znovu vyberte konektor TeamWherx a pak vytvořte klienta pro akci.

Znovu platí, že každé pole zobrazené v dialogovém okně bude představovat sloupec v tabulce Tabulky Google. Kliknutím na každé pole aktivujte výpis vlastností hlasování o stavu objednávky a vyberte požadované vlastnosti.

V tomto příkladu zvolte EmployeeNumber pro pole Jméno , abyste identifikovali zaměstnance, který aktualizoval stav objednávky.
Zvolte GroupName a vložte ho také do pole Název .
Vyberte Uložit.

Teď jste vytvořili tok procesu, který aktualizuje tabulku číslem zaměstnance a přidruženou skupinou při každé aktualizaci stavu objednávky.

## Známé problémy a omezení

Binární nahrávání zvukových souborů (POST) pro všechny koncové body je omezené jenom na MP4.
Data pro všechny koncové body, které vyžadují informace o datu a čase, musí být zadána podle pokynů RFC3339, jak je uvedeno v následujícím příkladu: 2021-09-22T02:36:56.52Z. V časovém razítku není nutné zadat přesné sekundy; 00 je přijatelné.

## Běžné chyby a nápravné prostředky

Příklady běžných chyb, ke kterým může dojít, najdete kódy odpovědí a opravy na portálech pro vývojáře rozhraní API:

Přídavek- https://developer.wfmplatform.com/

Nejčastější dotazy k ##

Vytvoření připojení

Konektor podporuje následující typy ověřování:


výchozí	Parametry pro vytvoření připojení	Všechny oblasti	Nesdílitelné

Výchozí

Použitelné: Všechny oblasti

Parametry pro vytvoření připojení

Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.

Název	Typ	Description	Povinné
Klíč rozhraní API	securestring	Klíč rozhraní API pro toto rozhraní API	Pravdivé

Limity omezování

Name	Volání	Období obnovení
Volání rozhraní API na připojení	100	60 sekund

Akce

Aktivace uživatele	Aktivuje existujícího uživatele podle jeho ID.
Aktivace vozidla	Aktivujte vozidlo podle ID.
Aktualizace existující geografické zóny	Aktualizuje existující geografickoufenci podle id.
Aktualizace klienta	Aktualizuje existujícího klienta.
Aktualizace objednávky	Aktualizuje existující objednávku.
Aktualizace stavu objednávky	Změní existující stav objednávky.
Aktualizace uživatele	Aktualizuje existujícího uživatele.
Aktualizace vozidla	Aktualizujte vozidlo podle ID.
Aktualizace části uživatele	Aktualizuje část vlastností uživatele.
Deaktivace uživatele	Deaktivuje existujícího uživatele podle jeho ID.
Deaktivace vozidla	Deaktivujte vozidlo podle ID.
Nahrání binárního souboru	Tuto možnost použijte k nahrání obrázků formulářů a zvukových souborů. Binární velikost je omezená na 10 MB. Podporované typy souborů jsou: JPEG, PNG a MP4.
Nahrání souboru přílohy	Tuto možnost použijte k nahrání příloh souborů formuláře. Binární velikost je omezená na 25 MB. Byl očekáváno vícedílný požadavek na data formuláře s jedním souborem.
Odeslat událost	Odešle událost.
Odhlášení odběru událostí webhookem	Odstraní odběr webhooku událostí podle ID.
Odhlášení odběru webhooku s daty GPS	Odstraní odběr webhooku GPS podle ID.
Odstranění geografické zóny	Odstraní existující geografickoufenci podle id.
Odstranění klienta	Odstraní existujícího klienta podle jeho ID.
Odstranění vlastní definice události	Odstraní vlastní definici události.
Odstranění vlastního záznamu seznamu	Odstraní existující záznam ve vlastním seznamu podle jeho customListId a ID. ID – je jedinečná hodnota vlastního záznamu seznamu. Chyby: 404 – customListId nebo ID se nenašlo.
Odstranění vozidla	Odstraňte vozidlo podle ID.
Přihlášení k odběru webhooku DAT GPS	Přidá nový webhook GPS Tracking data (polohy GPS). Webové háky umožňují přijímat polohy GPS, ke kterým dochází na zadané adrese URL.
Přihlášení k odběru webhooku událostí	Přidá nové události odběr webhooku. Webhooky umožňují přijímat automatická oznámení o událostech společnosti, ke kterým dochází na zadané adrese URL.
Resetuje stav odběru webhooku události.	Změní stav předplatného na stav = 1 (Spuštěno).
Resetuje stav předplatného.	Změní stav předplatného na stav = 1 (Spuštěno).
Umožňuje vytvořit objednávku.	Přidá novou objednávku.
Vytvoření formuláře	Přidá nový formulář.
Vytvoření geografické zóny	Vytvoří novou geografickoufenci.
Vytvoření klienta	Vytvoří nového klienta.
Vytvoření nebo aktualizace vlastní definice události	Vytvoří nebo aktualizuje vlastní definici události.
Vytvoření nebo aktualizace vlastního záznamu seznamu	Vytvoří nebo aktualizuje vlastní datový záznam seznamu. Hodnotu jedinečného sloupce je možné vynechat, ale pokud existuje, měla by odpovídat hodnotě Jedinečné ID v parametru dotazu.
Vytvoření uživatele	Vytvoří nového uživatele.
Vytvoření vozidla	Vytvoří vozidlo.
Zpětné volání Webhooku s datovým kanálem GPS	Tuto ukázkovou metodu používá gpsdata nebo přihlášení k odběru k odeslání zpětného datového kanálu pomocí adresy URL poskytnuté zákazníkem.
Zpětné volání webhooku s informačním kanálem událostí	Tato ukázková metoda se používá událostmi nebo přihlášením k odběru k odesílání zpětného datového kanálu událostí pomocí adresy URL poskytnuté zákazníkem.
Získání formuláře	Načte formulář podle jeho ID.
Získání geografické zóny	Načte geografickoufenci podle id.
Získání jednoho záznamu z vlastního seznamu	Načte záznam dat s jedním vlastním seznamem nalezený hodnotou CustomListId a jedinečnou hodnotou sloupce. Chyby: 404 – pro zadanou hodnotu customListId a jedinečnou hodnotu sloupce neexistuje žádný záznam vlastního seznamu.
Získání klienta	Načte objekt klienta podle jeho ID.
Získání objednávky	Získá existující objednávku podle id.
Získání podverze	Vrátí aktuální podverzi rozhraní API.
Získání položek dat GPS	Načte položky dat GPS pro zadaný rozsah kalendářních dat. Vrátí také token pro pokračování a odkaz pro získání další datové části. Můžete zadat počet vrácených stránek a počet prvků na stránku. Pozice pro odstraněné uživatele nebo vozidla se nevrátí. Pokud však uživatel nebo vozidlo existovalo při vyžádání dat a bylo později odebráno, vrátí se data pro uživatele nebo vozidlo požadované tokenem pokračování. Výsledky se automaticky seřadí podle času UtcTime a ve vzestupném pořadí. Parametry řazení nelze konfigurovat.
Získání položky pro uchovávání času	Načte položku podle id.
Získání seznamu cest	Načte seznam cest pro určité časové období. Můžete zadat počet vrácených stránek a počet prvků na stránku. Výsledky se automaticky seřadí podle startUtcTIme a ve vzestupném pořadí. Parametry řazení nelze konfigurovat.
Získání seznamu formulářů	Načte seznam formulářů pomocí některého z filtrů z níže uvedených parametrů požadavku. Můžete zadat počet vrácených stránek a počet prvků na stránku. Výsledky se automaticky seřadí podle hodnoty SubmittedTime a sestupně. Parametry řazení nelze konfigurovat.
Získání seznamu geografických fences	Načte seznam geografických fence. Můžete zadat počet vrácených stránek a počet prvků na stránku a také to, jestli jsou souřadnice geografické zóny metriky. Výsledky se automaticky seřadí podle názvu a ve vzestupném pořadí. Parametry řazení nelze konfigurovat.
Získání seznamu klientů	Načte seznam klientů. Můžete zadat počet vrácených stránek a počet prvků na stránku. Výsledky se automaticky seřadí podle názvu a ve vzestupném pořadí. Parametry řazení nelze konfigurovat.
Získání seznamu objednávek	Načte seznam objednávek pomocí filtrů z níže uvedených parametrů požadavku. Můžete zadat počet vrácených stránek a počet prvků na stránku. Výsledky se automaticky seřadí podle Client.Name a ve vzestupném pořadí. Parametry řazení nelze konfigurovat.
Získání seznamu odběrů webhooků událostí	Načte seznam odběrů webhooků událostí. Můžete zadat počet vrácených stránek a počet prvků na stránku. Výsledky se automaticky seřadí podle SubscriptionId a ve vzestupném pořadí. Parametry řazení nelze konfigurovat.
Získání seznamu položek uchovávání času	Načte seznam položek uchovávání času na základě rozsahu dat. Můžete zadat počet vrácených stránek a počet prvků na stránku. Výsledky se automaticky seřadí podle clockInTime a potom podle hodnoty TimekeepingStatusId a ve vzestupném pořadí. Parametry řazení nelze konfigurovat.
Získání seznamu předplatných	Načte seznam předplatných webhooků. Můžete zadat počet vrácených stránek a počet prvků na stránku. Výsledky se automaticky seřadí podle SubscriptionId a ve vzestupném pořadí. Parametry řazení nelze konfigurovat.
Získání seznamu událostí	Načte seznam událostí pro určité časové období. Můžete zadat počet vrácených stránek a počet prvků na stránku. Filtrováním podle typu události získáte konkrétní události. Události vozidla mohou být vráceny pro zaměstnance, pokud je zaměstnanec přidružen k vozidle.
Získání seznamu uživatelů	Načte seznam uživatelů. Můžete zadat počet vrácených stránek a počet prvků na stránku. Výsledky se automaticky seřadí podle ID uživatele a ve vzestupném pořadí. Parametry řazení nelze konfigurovat.
Získání seznamu vlastních definic událostí	Načte seznam vlastních definic událostí.
Získání seznamu vlastních polí seznamu podle CustomListID	Načte seznam polí pro jeden vlastní seznam pomocí CustomListID.
Získání seznamu vozidel	Načte seznam vozidel.
Získání uživatele	Získá uživatele podle jeho ID.
Získání vlastní definice události podle ID	Načte jednu vlastní definici události podle ID.
Získání vlastních dat seznamu podle CustomListID	Načte všechny datové záznamy v jednom vlastním seznamu pomocí CustomListID. Výsledky se seřadí podle sloupce a stránkování se podporuje. Chyby: 404 – pro zadané id vlastního seznamu neexistuje žádný vlastní seznam.
Získání vlastních definic seznamů	Načte výpis definice vlastního seznamu. Výpis definice obsahuje CustomListID, Name a Version pro všechny existující vlastní seznamy.
Získání vozidla podle ID	Načte jedno vozidlo podle ID.
Částečná aktualizace vozidla	Částečná aktualizace vozidla podle ID.

Aktivace uživatele

ID operace:: UserController_Activate

Aktivuje existujícího uživatele podle jeho ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Externí nebo interní ID závisí na hodnotě parametru use-external-id.
use-external-id	use-external-id		boolean	Použijte externí ID nebo ne.

Aktivace vozidla

ID operace:: VehicleController_Activate

Aktivujte vozidlo podle ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Externí nebo interní ID závisí na hodnotě parametru use-external-id.
use-external-id	use-external-id		boolean	Použijte externí ID nebo ne.

Návraty

response: integer

Aktualizace existující geografické zóny

ID operace:: GeofenceController_UpdateGeofence

Aktualizuje existující geografickoufenci podle id.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	integer	ID geografické zóny.
GroupNames	GroupNames		array of string	GroupPaths of the GeofenceUpdateApiModel.
Zeměpisná šířka	Latitude		double
Zeměpisná délka	Longitude		double
Název	Name		string	Název GeofenceApiModelBase.
Typ	Type		string	Typ GeofenceApiModel.
Shape	Shape		integer	Tvar: 0 pro kruh a 1 pro mnohoúhelník.
Zeměpisná šířka	Latitude		double
Zeměpisná délka	Longitude		double
AdresaŘádek1	AddressLine1		string	AddressLine1 tohoto locationApiModelu.
AddressLine2	AddressLine2		string	AddressLine2 tohoto modelu LocationApiModel.
City	City		string	Město LocationApiModel.
Název oblasti	RegionName		string	Název oblasti modelu LocationApiModel.
PSČ	PostalCode		string	PSČ modelu LocationApiModel.
Kód země	CountryCode		string	Kód ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion of the LocationApiModel.
SubRegionCode	SubRegionCode		string	Podregion Code of the LocationApiModel.
Kód oblasti	RegionCode		string	Kód oblasti modelu LocationApiModel.
Poloměr	Radius		double	Poloměr modelu GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress		boolean	UseGeofenceAddress modelu GeofenceApiModel.
useMetric	useMetric		boolean	Použijte systém metrik nebo ne.
geokód	geocode		boolean	Adresa by měla být geokódovaná nebo ne.

Návraty

Body: CustomerAPI.Models.ReturnIdApiModel

Aktualizace klienta

ID operace:: ClientController_Update

Aktualizuje existujícího klienta.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Externí nebo interní ID závisí na hodnotě parametru use-external-id.
ExternalId	ExternalId		string	ID externího použití pro klienta – vlastnost rozšíření rozhraní API
FieldIndex	FieldIndex		integer	Index pole
Hodnota	Value			Hodnota pole.
Název	Name		string	Název klienta.
Zeměpisná šířka	Latitude		double
Zeměpisná délka	Longitude		double
AdresaŘádek1	AddressLine1		string	AddressLine1 tohoto locationApiModelu.
AddressLine2	AddressLine2		string	AddressLine2 tohoto modelu LocationApiModel.
City	City		string	Město LocationApiModel.
Název oblasti	RegionName		string	Název oblasti modelu LocationApiModel.
PSČ	PostalCode		string	PSČ modelu LocationApiModel.
Kód země	CountryCode		string	Kód ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion of the LocationApiModel.
SubRegionCode	SubRegionCode		string	Podregion Code of the LocationApiModel.
Kód oblasti	RegionCode		string	Kód oblasti modelu LocationApiModel.
Název	Name		string	Název ContactApiModel.
Telefonní číslo	PhoneNumber		string	Telefonní číslo modelu ContactApiModel.
Email	Email		string	E-mail modelu ContactApiModel.
geokód	geocode		boolean	Adresa by měla být geokódovaná nebo ne.
use-external-id	use-external-id		boolean	Použijte externí ID nebo ne.

Návraty

Body: CustomerAPI.Models.ReturnIdApiModel

Aktualizace objednávky

ID operace:: OrderController_Update

Aktualizuje existující objednávku.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Externí nebo interní ID závisí na hodnotě parametru use-external-id.
ExternalOrderId	ExternalOrderId		string	OrderId externího použití pro klienta – vlastnost rozšíření rozhraní API
IsClosed	IsClosed		boolean	Stav zobrazující, jestli se UpdateOrderApiModel zavřel.
Zeměpisná šířka	Latitude		double
Zeměpisná délka	Longitude		double
AdresaŘádek1	AddressLine1		string	AddressLine1 tohoto locationApiModelu.
AddressLine2	AddressLine2		string	AddressLine2 tohoto modelu LocationApiModel.
City	City		string	Město LocationApiModel.
Název oblasti	RegionName		string	Název oblasti modelu LocationApiModel.
PSČ	PostalCode		string	PSČ modelu LocationApiModel.
Kód země	CountryCode		string	Kód ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion of the LocationApiModel.
SubRegionCode	SubRegionCode		string	Podregion Code of the LocationApiModel.
Kód oblasti	RegionCode		string	Kód oblasti modelu LocationApiModel.
Název	Name		string	Název ContactApiModel.
Telefonní číslo	PhoneNumber		string	Telefonní číslo modelu ContactApiModel.
Email	Email		string	E-mail modelu ContactApiModel.
DueDate	DueDate		date-time	K určitému bodu v čase je tento model BaseUpdateOrderApiModel kvůli dokončení (zastaralé v 1.3).
StartTime	StartTime		date-time	Bod v čase by se měl spustit model BaseUpdateOrderApiModel (zavedený ve verzi 1.3).
Konečný čas	EndTime		date-time	Point in time this BaseUpdateOrderApiModel should end (zaveden v1.3).
Titulek	Caption	True	string
Hodnota	Value			Hodnota UpdateFormFieldApiModel. Formát hodnoty pole NFC: { "Type": number, // 0 - Text "Payload": object, // By měl být text pro Typ = 0 } Formát hodnoty pole "Kamera" (binární odkaz): { "BinaryId": string, // Binary ID nahraného obrázku (viz nahrání binárního rozhraní API) "Poznámka": string // Poznámka pro odkazovaný obrázek } Formát hodnoty pole Podpis (binární odkaz): { "BinaryId": string // Binární ID nahraného obrázku (viz nahrání binárního rozhraní API) } Formát hodnoty pole "Audio" (binární odkaz): { "BinaryId": string, // Binary ID nahraného zvuku (viz nahrání binárního rozhraní API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Byla zaznamenána hodnota k určitému bodu v čase.
Zeměpisná šířka	Latitude		double
Zeměpisná délka	Longitude		double
AdresaŘádek1	AddressLine1		string	AddressLine1 tohoto locationApiModelu.
AddressLine2	AddressLine2		string	AddressLine2 tohoto modelu LocationApiModel.
City	City		string	Město LocationApiModel.
Název oblasti	RegionName		string	Název oblasti modelu LocationApiModel.
PSČ	PostalCode		string	PSČ modelu LocationApiModel.
Kód země	CountryCode		string	Kód ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion of the LocationApiModel.
SubRegionCode	SubRegionCode		string	Podregion Code of the LocationApiModel.
Kód oblasti	RegionCode		string	Kód oblasti modelu LocationApiModel.
Titulek	Caption	True	string
Hodnota	Value			Hodnota UpdateFormFieldApiModel. Formát hodnoty pole NFC: { "Type": number, // 0 - Text "Payload": object, // By měl být text pro Typ = 0 } Formát hodnoty pole "Kamera" (binární odkaz): { "BinaryId": string, // Binary ID nahraného obrázku (viz nahrání binárního rozhraní API) "Poznámka": string // Poznámka pro odkazovaný obrázek } Formát hodnoty pole Podpis (binární odkaz): { "BinaryId": string // Binární ID nahraného obrázku (viz nahrání binárního rozhraní API) } Formát hodnoty pole "Audio" (binární odkaz): { "BinaryId": string, // Binary ID nahraného zvuku (viz nahrání binárního rozhraní API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Byla zaznamenána hodnota k určitému bodu v čase.
Číslo zaměstnance	EmployeeNumber	True	string	EmployeeNumber uživatele, který vytvořil tento NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Obsah popisku pro StatusLabel přidružený k tomuto NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	Bod v čase, kdy byl tento stav NewOrderStatusApiModel spuštěn.
Titulek	Caption	True	string
Hodnota	Value			Hodnota UpdateFormFieldApiModel. Formát hodnoty pole NFC: { "Type": number, // 0 - Text "Payload": object, // By měl být text pro Typ = 0 } Formát hodnoty pole "Kamera" (binární odkaz): { "BinaryId": string, // Binary ID nahraného obrázku (viz nahrání binárního rozhraní API) "Poznámka": string // Poznámka pro odkazovaný obrázek } Formát hodnoty pole Podpis (binární odkaz): { "BinaryId": string // Binární ID nahraného obrázku (viz nahrání binárního rozhraní API) } Formát hodnoty pole "Audio" (binární odkaz): { "BinaryId": string, // Binary ID nahraného zvuku (viz nahrání binárního rozhraní API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Byla zaznamenána hodnota k určitému bodu v čase.
Zeměpisná šířka	Latitude		double
Zeměpisná délka	Longitude		double
AdresaŘádek1	AddressLine1		string	AddressLine1 tohoto locationApiModelu.
AddressLine2	AddressLine2		string	AddressLine2 tohoto modelu LocationApiModel.
City	City		string	Město LocationApiModel.
Název oblasti	RegionName		string	Název oblasti modelu LocationApiModel.
PSČ	PostalCode		string	PSČ modelu LocationApiModel.
Kód země	CountryCode		string	Kód ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion of the LocationApiModel.
SubRegionCode	SubRegionCode		string	Podregion Code of the LocationApiModel.
Kód oblasti	RegionCode		string	Kód oblasti modelu LocationApiModel.
Titulek	Caption	True	string
Hodnota	Value			Hodnota UpdateFormFieldApiModel. Formát hodnoty pole NFC: { "Type": number, // 0 - Text "Payload": object, // By měl být text pro Typ = 0 } Formát hodnoty pole "Kamera" (binární odkaz): { "BinaryId": string, // Binary ID nahraného obrázku (viz nahrání binárního rozhraní API) "Poznámka": string // Poznámka pro odkazovaný obrázek } Formát hodnoty pole Podpis (binární odkaz): { "BinaryId": string // Binární ID nahraného obrázku (viz nahrání binárního rozhraní API) } Formát hodnoty pole "Audio" (binární odkaz): { "BinaryId": string, // Binary ID nahraného zvuku (viz nahrání binárního rozhraní API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Byla zaznamenána hodnota k určitému bodu v čase.
FieldIndex	FieldIndex		integer	Index pole
Hodnota	Value			Hodnota pole.
geokód	geocode		boolean	Adresa by měla být geokódovaná nebo ne.
use-external-id	use-external-id		boolean	Použijte externí ID nebo ne.

Návraty

Body: CustomerAPI.Models.ReturnIdApiModel

Aktualizace stavu objednávky

ID operace:: OrderController_ChangeStatus

Změní existující stav objednávky.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Externí nebo interní ID závisí na hodnotě parametru use-external-id.
Číslo zaměstnance	EmployeeNumber	True	string	EmployeeNumber uživatele, který vytvořil tento NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Obsah popisku pro StatusLabel přidružený k tomuto NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	Bod v čase, kdy byl tento stav NewOrderStatusApiModel spuštěn.
Titulek	Caption	True	string
Hodnota	Value			Hodnota UpdateFormFieldApiModel. Formát hodnoty pole NFC: { "Type": number, // 0 - Text "Payload": object, // By měl být text pro Typ = 0 } Formát hodnoty pole "Kamera" (binární odkaz): { "BinaryId": string, // Binary ID nahraného obrázku (viz nahrání binárního rozhraní API) "Poznámka": string // Poznámka pro odkazovaný obrázek } Formát hodnoty pole Podpis (binární odkaz): { "BinaryId": string // Binární ID nahraného obrázku (viz nahrání binárního rozhraní API) } Formát hodnoty pole "Audio" (binární odkaz): { "BinaryId": string, // Binary ID nahraného zvuku (viz nahrání binárního rozhraní API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Byla zaznamenána hodnota k určitému bodu v čase.
Zeměpisná šířka	Latitude		double
Zeměpisná délka	Longitude		double
AdresaŘádek1	AddressLine1		string	AddressLine1 tohoto locationApiModelu.
AddressLine2	AddressLine2		string	AddressLine2 tohoto modelu LocationApiModel.
City	City		string	Město LocationApiModel.
Název oblasti	RegionName		string	Název oblasti modelu LocationApiModel.
PSČ	PostalCode		string	PSČ modelu LocationApiModel.
Kód země	CountryCode		string	Kód ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion of the LocationApiModel.
SubRegionCode	SubRegionCode		string	Podregion Code of the LocationApiModel.
Kód oblasti	RegionCode		string	Kód oblasti modelu LocationApiModel.
Titulek	Caption	True	string
Hodnota	Value			Hodnota UpdateFormFieldApiModel. Formát hodnoty pole NFC: { "Type": number, // 0 - Text "Payload": object, // By měl být text pro Typ = 0 } Formát hodnoty pole "Kamera" (binární odkaz): { "BinaryId": string, // Binary ID nahraného obrázku (viz nahrání binárního rozhraní API) "Poznámka": string // Poznámka pro odkazovaný obrázek } Formát hodnoty pole Podpis (binární odkaz): { "BinaryId": string // Binární ID nahraného obrázku (viz nahrání binárního rozhraní API) } Formát hodnoty pole "Audio" (binární odkaz): { "BinaryId": string, // Binary ID nahraného zvuku (viz nahrání binárního rozhraní API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Byla zaznamenána hodnota k určitému bodu v čase.
use-external-id	use-external-id		boolean	Použijte externí ID nebo ne.

Návraty

Body: CustomerAPI.Models.ReturnIdApiModel

Aktualizace uživatele

ID operace:: UserController_Update

Aktualizuje existujícího uživatele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Externí nebo interní ID závisí na hodnotě parametru use-external-id.
Uživatelské jméno	UserName		string	Uživatelské jméno uživatele.
Heslo	Password		password	Heslo uživatele.
GroupName	GroupName		string	Název skupiny uživatele
Křestní jméno	FirstName		string	Jméno uživatele.
Příjmení	LastName		string	Příjmení uživatele.
Číslo zaměstnance	EmployeeNumber		string	Číslo zaměstnance uživatele.
Email	Email		string	E-mailová adresa uživatele
telefon	Phone		string	Telefonní číslo uživatele
Id role	RoleId		integer	RoleId uživatele – (Admin: 1, User: 3, Power User: 5).
IsActive	IsActive		boolean	Aktivní stav uživatele.
EPTTEnabled	EPTTEnabled		boolean	Stav funkce Enhanced Push-to-Talk pro uživatele: logická hodnota.
EPTTNumber	EPTTNumber		string	Telefonní číslo pro funkci Enhanced Push-to-Talk pro uživatele: řetězec.
EPTTWebMDN	EPTTWebMDN		string	Telefonní číslo použité k ověření uživatele v systému Kodiak EPTT – poskytl Kodiak.
EPTTToken	EPTTToken		string	Token rozhraní API používaný k ověření uživatele v systému Kodiak EPTT – poskytuje Kodiak.
GPSEnabled	GPSEnabled		boolean	Stav funkce GPS pro uživatele
MobileOnly	MobileOnly		boolean	Stav přístupu desktopové webové aplikace pro CAB – (Bez přístupu k webové aplikaci: Pravda, Úplný přístup k aplikaci: Nepravda).
Typ licence	LicenseType		integer	Typ licence přiřazené uživateli: - 0 pro Nedefinováno, 1 pro Regular, 2 pro WebOnly a 3 pro Zaměstnance.
use-external-id	use-external-id		boolean	Použijte externí ID nebo ne.

Návraty

Body: CustomerAPI.Models.ReturnIdApiModel

Aktualizace vozidla

ID operace:: VehicleController_UpdateVehicle

Aktualizujte vozidlo podle ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Externí nebo interní ID závisí na hodnotě parametru use-external-id.
Number	Number		string
Název	Name		string
Typ	Type		string
Štítek	Tag		string
UserEmployeeNumber	UserEmployeeNumber		string
GroupName	GroupName		string
TimeZone	TimeZone		string
Dělat	Make		string
Rok	Year		integer
Model	Model		string
Barva	Color		string
VIN	VIN		string
IsActive	IsActive		boolean
TypZařízení	DeviceType		integer
DeviceSerialNumber	DeviceSerialNumber		string
use-external-id	use-external-id		boolean	Použijte externí ID nebo ne.

Návraty

response: integer

Aktualizace části uživatele

ID operace:: UserController_PartialUpdate

Aktualizuje část vlastností uživatele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Externí nebo interní ID závisí na hodnotě parametru use-external-id.
			object
use-external-id	use-external-id		boolean	Použijte externí ID nebo ne.

Návraty

Body: CustomerAPI.Models.ReturnIdApiModel

Deaktivace uživatele

ID operace:: UserController_Deactivate

Deaktivuje existujícího uživatele podle jeho ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Externí nebo interní ID závisí na hodnotě parametru use-external-id.
use-external-id	use-external-id		boolean	Použijte externí ID nebo ne.

Deaktivace vozidla

ID operace:: VehicleController_Deactivate

Deaktivujte vozidlo podle ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Externí nebo interní ID závisí na hodnotě parametru use-external-id.
use-external-id	use-external-id		boolean	Použijte externí ID nebo ne.

Návraty

response: integer

Nahrání binárního souboru

ID operace:: BinaryController_UploadBinary

Tuto možnost použijte k nahrání obrázků formulářů a zvukových souborů. Binární velikost je omezená na 10 MB. Podporované typy souborů jsou: JPEG, PNG a MP4.

Návraty

Body: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Nahrání souboru přílohy

ID operace:: BinaryController_UploadAttachment

Tuto možnost použijte k nahrání příloh souborů formuláře. Binární velikost je omezená na 25 MB. Byl očekáváno vícedílný požadavek na data formuláře s jedním souborem.

Návraty

Body: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Odeslat událost

ID operace:: EventController_Post

Odešle událost.

Parametry

Name	Klíč	Typ	Description
EventDefinitionId	EventDefinitionId	string	ID definice události.
Číslo zaměstnance	EmployeeNumber	string	Číslo zaměstnance.
Číslo vozidla	VehicleNumber	string	Číslo vozidla.
DeviceSerialNumber	DeviceSerialNumber	string	GpsDeviceDto sériové číslo.
Zeměpisná šířka	Latitude	double
Zeměpisná délka	Longitude	double
AdresaŘádek1	AddressLine1	string	AddressLine1 tohoto locationApiModelu.
AddressLine2	AddressLine2	string	AddressLine2 tohoto modelu LocationApiModel.
City	City	string	Město LocationApiModel.
Název oblasti	RegionName	string	Název oblasti modelu LocationApiModel.
PSČ	PostalCode	string	PSČ modelu LocationApiModel.
Kód země	CountryCode	string	Kód ISO 3166-1 alfa-2.
SubRegionName	SubRegionName	string	SubRegion of the LocationApiModel.
SubRegionCode	SubRegionCode	string	Podregion Code of the LocationApiModel.
Kód oblasti	RegionCode	string	Kód oblasti modelu LocationApiModel.
Time	Time	date-time
Parametry	Parameters	object	Parametry události.

Odhlášení odběru událostí webhookem

ID operace:: EventController_RemoveEventDataFeedSubscription

Odstraní odběr webhooku událostí podle ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
subscriptionId	subscriptionId	True	string	ID předplatného, které chcete odstranit.

Odhlášení odběru webhooku s daty GPS

ID operace:: TrackingController_RemoveGpsDataFeedSubscription

Odstraní odběr webhooku GPS podle ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
subscriptionId	subscriptionId	True	string	ID předplatného, které chcete odstranit.

Odstranění geografické zóny

ID operace:: GeofenceController_DeleteGeofence

Odstraní existující geografickoufenci podle id.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	integer	ID geografické zóny.

Odstranění klienta

ID operace:: ClientController_Delete

Odstraní existujícího klienta podle jeho ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	ID klienta.
use-external-id	use-external-id		boolean	Použijte externí ID nebo ne.

Odstranění vlastní definice události

ID operace:: EventController_Delete

Odstraní vlastní definici události.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	ID definice události.

Odstranění vlastního záznamu seznamu

ID operace:: CustomListController_DeleteRecord

Odstraní existující záznam ve vlastním seznamu podle jeho customListId a ID.

ID – je jedinečná hodnota vlastního záznamu seznamu.

Chyby:

404 – customListId nebo ID se nenašlo.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
customListId	customListId	True	integer	Id vlastního seznamu
identifikační číslo	id	True	string	Jedinečná hodnota

Odstranění vozidla

ID operace:: VehicleController_Delete

Odstraňte vozidlo podle ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Externí nebo interní ID závisí na hodnotě parametru use-external-id.
use-external-id	use-external-id		boolean	Použijte externí ID nebo ne.

Přihlášení k odběru webhooku DAT GPS

ID operace:: TrackingController_SubscribeToGpsDataFeed

Přidá nový webhook GPS Tracking data (polohy GPS). Webové háky umožňují přijímat polohy GPS, ke kterým dochází na zadané adrese URL.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
URL	Url		string	Adresa URL obsahující adresu WebHookSubscriptionParamsApiModel.
SecurityToken	SecurityToken		string	Token zabezpečení přidružený k tomuto objektu WebHookSubscriptionParamsApiModel.

Návraty

Body: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Přihlášení k odběru webhooku událostí

ID operace:: EventController_SubscribeToEventDataFeed

Přidá nové události odběr webhooku. Webhooky umožňují přijímat automatická oznámení o událostech společnosti, ke kterým dochází na zadané adrese URL.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
URL	Url		string	Adresa URL obsahující adresu WebHookSubscriptionParamsApiModel.
SecurityToken	SecurityToken		string	Token zabezpečení přidružený k tomuto objektu WebHookSubscriptionParamsApiModel.

Návraty

Body: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Resetuje stav odběru webhooku události.

ID operace:: EventController_ResetSubscriptionHealthStatus

Změní stav předplatného na stav = 1 (Spuštěno).

Parametry

Name	Klíč	Vyžadováno	Typ	Description
subscriptionId	subscriptionId	True	integer	ID předplatného.

Resetuje stav předplatného.

ID operace:: TrackingController_ResetSubscriptionHealthStatus

Změní stav předplatného na stav = 1 (Spuštěno).

Parametry

Name	Klíč	Vyžadováno	Typ	Description
subscriptionId	subscriptionId	True	integer	ID předplatného.

Umožňuje vytvořit objednávku.

ID operace:: OrderController_Create

Přidá novou objednávku.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Datum a čas vytvoření	CreatedDateTime		date-time	Vytvořili jsme model CreateUpdateOrderApiModel k určitému bodu v čase.
ExternalClientId	ExternalClientId	True	string	ID externího použití pro klienta – vlastnost rozšíření rozhraní API
ServiceType	ServiceType	True	string	Typ služby přidružený k tomuto modelu CreateUpdateOrderApiModel.
ExternalOrderId	ExternalOrderId		string	OrderId externího použití pro klienta – vlastnost rozšíření rozhraní API
Zeměpisná šířka	Latitude		double
Zeměpisná délka	Longitude		double
AdresaŘádek1	AddressLine1		string	AddressLine1 tohoto locationApiModelu.
AddressLine2	AddressLine2		string	AddressLine2 tohoto modelu LocationApiModel.
City	City		string	Město LocationApiModel.
Název oblasti	RegionName		string	Název oblasti modelu LocationApiModel.
PSČ	PostalCode		string	PSČ modelu LocationApiModel.
Kód země	CountryCode		string	Kód ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion of the LocationApiModel.
SubRegionCode	SubRegionCode		string	Podregion Code of the LocationApiModel.
Kód oblasti	RegionCode		string	Kód oblasti modelu LocationApiModel.
Název	Name		string	Název ContactApiModel.
Telefonní číslo	PhoneNumber		string	Telefonní číslo modelu ContactApiModel.
Email	Email		string	E-mail modelu ContactApiModel.
DueDate	DueDate		date-time	K určitému bodu v čase je tento model BaseUpdateOrderApiModel kvůli dokončení (zastaralé v 1.3).
StartTime	StartTime		date-time	Bod v čase by se měl spustit model BaseUpdateOrderApiModel (zavedený ve verzi 1.3).
Konečný čas	EndTime		date-time	Point in time this BaseUpdateOrderApiModel should end (zaveden v1.3).
Titulek	Caption	True	string
Hodnota	Value			Hodnota UpdateFormFieldApiModel. Formát hodnoty pole NFC: { "Type": number, // 0 - Text "Payload": object, // By měl být text pro Typ = 0 } Formát hodnoty pole "Kamera" (binární odkaz): { "BinaryId": string, // Binary ID nahraného obrázku (viz nahrání binárního rozhraní API) "Poznámka": string // Poznámka pro odkazovaný obrázek } Formát hodnoty pole Podpis (binární odkaz): { "BinaryId": string // Binární ID nahraného obrázku (viz nahrání binárního rozhraní API) } Formát hodnoty pole "Audio" (binární odkaz): { "BinaryId": string, // Binary ID nahraného zvuku (viz nahrání binárního rozhraní API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Byla zaznamenána hodnota k určitému bodu v čase.
Zeměpisná šířka	Latitude		double
Zeměpisná délka	Longitude		double
AdresaŘádek1	AddressLine1		string	AddressLine1 tohoto locationApiModelu.
AddressLine2	AddressLine2		string	AddressLine2 tohoto modelu LocationApiModel.
City	City		string	Město LocationApiModel.
Název oblasti	RegionName		string	Název oblasti modelu LocationApiModel.
PSČ	PostalCode		string	PSČ modelu LocationApiModel.
Kód země	CountryCode		string	Kód ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion of the LocationApiModel.
SubRegionCode	SubRegionCode		string	Podregion Code of the LocationApiModel.
Kód oblasti	RegionCode		string	Kód oblasti modelu LocationApiModel.
Titulek	Caption	True	string
Hodnota	Value			Hodnota UpdateFormFieldApiModel. Formát hodnoty pole NFC: { "Type": number, // 0 - Text "Payload": object, // By měl být text pro Typ = 0 } Formát hodnoty pole "Kamera" (binární odkaz): { "BinaryId": string, // Binary ID nahraného obrázku (viz nahrání binárního rozhraní API) "Poznámka": string // Poznámka pro odkazovaný obrázek } Formát hodnoty pole Podpis (binární odkaz): { "BinaryId": string // Binární ID nahraného obrázku (viz nahrání binárního rozhraní API) } Formát hodnoty pole "Audio" (binární odkaz): { "BinaryId": string, // Binary ID nahraného zvuku (viz nahrání binárního rozhraní API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Byla zaznamenána hodnota k určitému bodu v čase.
Číslo zaměstnance	EmployeeNumber	True	string	EmployeeNumber uživatele, který vytvořil tento NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Obsah popisku pro StatusLabel přidružený k tomuto NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	Bod v čase, kdy byl tento stav NewOrderStatusApiModel spuštěn.
Titulek	Caption	True	string
Hodnota	Value			Hodnota UpdateFormFieldApiModel. Formát hodnoty pole NFC: { "Type": number, // 0 - Text "Payload": object, // By měl být text pro Typ = 0 } Formát hodnoty pole "Kamera" (binární odkaz): { "BinaryId": string, // Binary ID nahraného obrázku (viz nahrání binárního rozhraní API) "Poznámka": string // Poznámka pro odkazovaný obrázek } Formát hodnoty pole Podpis (binární odkaz): { "BinaryId": string // Binární ID nahraného obrázku (viz nahrání binárního rozhraní API) } Formát hodnoty pole "Audio" (binární odkaz): { "BinaryId": string, // Binary ID nahraného zvuku (viz nahrání binárního rozhraní API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Byla zaznamenána hodnota k určitému bodu v čase.
Zeměpisná šířka	Latitude		double
Zeměpisná délka	Longitude		double
AdresaŘádek1	AddressLine1		string	AddressLine1 tohoto locationApiModelu.
AddressLine2	AddressLine2		string	AddressLine2 tohoto modelu LocationApiModel.
City	City		string	Město LocationApiModel.
Název oblasti	RegionName		string	Název oblasti modelu LocationApiModel.
PSČ	PostalCode		string	PSČ modelu LocationApiModel.
Kód země	CountryCode		string	Kód ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion of the LocationApiModel.
SubRegionCode	SubRegionCode		string	Podregion Code of the LocationApiModel.
Kód oblasti	RegionCode		string	Kód oblasti modelu LocationApiModel.
Titulek	Caption	True	string
Hodnota	Value			Hodnota UpdateFormFieldApiModel. Formát hodnoty pole NFC: { "Type": number, // 0 - Text "Payload": object, // By měl být text pro Typ = 0 } Formát hodnoty pole "Kamera" (binární odkaz): { "BinaryId": string, // Binary ID nahraného obrázku (viz nahrání binárního rozhraní API) "Poznámka": string // Poznámka pro odkazovaný obrázek } Formát hodnoty pole Podpis (binární odkaz): { "BinaryId": string // Binární ID nahraného obrázku (viz nahrání binárního rozhraní API) } Formát hodnoty pole "Audio" (binární odkaz): { "BinaryId": string, // Binary ID nahraného zvuku (viz nahrání binárního rozhraní API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Byla zaznamenána hodnota k určitému bodu v čase.
FieldIndex	FieldIndex		integer	Index pole
Hodnota	Value			Hodnota pole.
geokód	geocode		boolean	Adresa by měla být geokódovaná nebo ne.

Návraty

Body: CustomerAPI.Models.ReturnIdApiModel

Vytvoření formuláře

ID operace:: FormController_PostFormAsync

Přidá nový formulář.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ApiModuleId	ApiModuleId		string	ID objektu ApiModule přidruženého k tomuto modelu CreateStandaloneFormApiModel.
Zhodnotil	Reviewed		boolean	Stav recenze tohoto Modelu CreateStandaloneFormApiModel.
UserId	UserId		integer	UserId uživatele.
Číslo zaměstnance	EmployeeNumber		string	Číslo zaměstnance uživatele.
Odeslaná doba	SubmittedTime	True	date-time	Bod v čase, kdy byl odeslán CreateStandaloneFormApiModel.
Zeměpisná šířka	Latitude		double
Zeměpisná délka	Longitude		double
AdresaŘádek1	AddressLine1		string	AddressLine1 tohoto locationApiModelu.
AddressLine2	AddressLine2		string	AddressLine2 tohoto modelu LocationApiModel.
City	City		string	Město LocationApiModel.
Název oblasti	RegionName		string	Název oblasti modelu LocationApiModel.
PSČ	PostalCode		string	PSČ modelu LocationApiModel.
Kód země	CountryCode		string	Kód ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion of the LocationApiModel.
SubRegionCode	SubRegionCode		string	Podregion Code of the LocationApiModel.
Kód oblasti	RegionCode		string	Kód oblasti modelu LocationApiModel.
ApiFieldId	ApiFieldId	True	string	ID pole rozhraní API
Hodnota	Value	True		Hodnota FormFieldDataApiModel. Formát hodnoty pole NFC: { "Type": number, // 0 - Text "Payload": object, // By měl být text pro Typ = 0 } Formát hodnoty pole "Kamera" (binární odkaz): { "BinaryId": string, // Binary ID nahraného obrázku (viz nahrání binárního rozhraní API) "Poznámka": string // Poznámka pro odkazovaný obrázek } Formát hodnoty pole Sign (binární odkaz): { "BinaryId": string // Binary ID nahraného obrázku (viz nahrání binárního rozhraní API) } Formát hodnoty pole "Audio" (binární odkaz): { "BinaryId": string, // Binary ID nahraného zvuku (viz nahrání binárního rozhraní API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Čas zachycení binárních dat Formát – datum a čas (jako datum a čas v RFC3339) včetně posunu.
Zeměpisná šířka	Latitude		double
Zeměpisná délka	Longitude		double
AdresaŘádek1	AddressLine1		string	AddressLine1 tohoto locationApiModelu.
AddressLine2	AddressLine2		string	AddressLine2 tohoto modelu LocationApiModel.
City	City		string	Město LocationApiModel.
Název oblasti	RegionName		string	Název oblasti modelu LocationApiModel.
PSČ	PostalCode		string	PSČ modelu LocationApiModel.
Kód země	CountryCode		string	Kód ISO 3166-1 alfa-2.
SubRegionName	SubRegionName		string	SubRegion of the LocationApiModel.
SubRegionCode	SubRegionCode		string	Podregion Code of the LocationApiModel.
Kód oblasti	RegionCode		string	Kód oblasti modelu LocationApiModel.
ApiFieldId	ApiFieldId	True	string	ID pole rozhraní API
Hodnota	Value	True		Hodnota FormFieldDataApiModel. Formát hodnoty pole NFC: { "Type": number, // 0 - Text "Payload": object, // By měl být text pro Typ = 0 } Formát hodnoty pole "Kamera" (binární odkaz): { "BinaryId": string, // Binary ID nahraného obrázku (viz nahrání binárního rozhraní API) "Poznámka": string // Poznámka pro odkazovaný obrázek } Formát hodnoty pole Sign (binární odkaz): { "BinaryId": string // Binary ID nahraného obrázku (viz nahrání binárního rozhraní API) } Formát hodnoty pole "Audio" (binární odkaz): { "BinaryId": string, // Binary ID nahraného zvuku (viz nahrání binárního rozhraní API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Čas zachycení binárních dat Formát – datum a čas (jako datum a čas v RFC3339) včetně posunu.

Návraty

Body: CustomerAPI.Models.ReturnIdApiModel

Vytvoření geografické zóny

ID operace:: GeofenceController_CreateGeofence

Vytvoří novou geografickoufenci.

Parametry

Name	Klíč	Typ	Description
GroupNames	GroupNames	array of string	GroupPaths of the GeofenceCreateApiModel.
Zeměpisná šířka	Latitude	double
Zeměpisná délka	Longitude	double
Název	Name	string	Název GeofenceApiModelBase.
Typ	Type	string	Typ GeofenceApiModel.
Shape	Shape	integer	Tvar: 0 pro kruh a 1 pro mnohoúhelník.
Zeměpisná šířka	Latitude	double
Zeměpisná délka	Longitude	double
AdresaŘádek1	AddressLine1	string	AddressLine1 tohoto locationApiModelu.
AddressLine2	AddressLine2	string	AddressLine2 tohoto modelu LocationApiModel.
City	City	string	Město LocationApiModel.
Název oblasti	RegionName	string	Název oblasti modelu LocationApiModel.
PSČ	PostalCode	string	PSČ modelu LocationApiModel.
Kód země	CountryCode	string	Kód ISO 3166-1 alfa-2.
SubRegionName	SubRegionName	string	SubRegion of the LocationApiModel.
SubRegionCode	SubRegionCode	string	Podregion Code of the LocationApiModel.
Kód oblasti	RegionCode	string	Kód oblasti modelu LocationApiModel.
Poloměr	Radius	double	Poloměr modelu GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress modelu GeofenceApiModel.
useMetric	useMetric	boolean	Použijte systém metrik nebo ne.
geokód	geocode	boolean	Adresa by měla být geokódovaná nebo ne.

Návraty

Body: CustomerAPI.Models.ReturnIdApiModel

Vytvoření klienta

ID operace:: ClientController_Create

Vytvoří nového klienta.

Parametry

Name	Klíč	Typ	Description
ExternalId	ExternalId	string	ID externího použití pro klienta – vlastnost rozšíření rozhraní API
FieldIndex	FieldIndex	integer	Index pole
Hodnota	Value		Hodnota pole.
Název	Name	string	Název klienta.
Zeměpisná šířka	Latitude	double
Zeměpisná délka	Longitude	double
AdresaŘádek1	AddressLine1	string	AddressLine1 tohoto locationApiModelu.
AddressLine2	AddressLine2	string	AddressLine2 tohoto modelu LocationApiModel.
City	City	string	Město LocationApiModel.
Název oblasti	RegionName	string	Název oblasti modelu LocationApiModel.
PSČ	PostalCode	string	PSČ modelu LocationApiModel.
Kód země	CountryCode	string	Kód ISO 3166-1 alfa-2.
SubRegionName	SubRegionName	string	SubRegion of the LocationApiModel.
SubRegionCode	SubRegionCode	string	Podregion Code of the LocationApiModel.
Kód oblasti	RegionCode	string	Kód oblasti modelu LocationApiModel.
Název	Name	string	Název ContactApiModel.
Telefonní číslo	PhoneNumber	string	Telefonní číslo modelu ContactApiModel.
Email	Email	string	E-mail modelu ContactApiModel.
geokód	geocode	boolean	Adresa by měla být geokódovaná nebo ne.

Návraty

Body: CustomerAPI.Models.ReturnIdApiModel

Vytvoření nebo aktualizace vlastní definice události

ID operace:: EventController_Put

Vytvoří nebo aktualizuje vlastní definici události.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	ID definice události.
Název	Name		string
ReverseGeocode	ReverseGeocode		boolean
Název	Name		string
Typ	Type		integer
Titulek	Caption		string
Povinné	Required		boolean

Vytvoření nebo aktualizace vlastního záznamu seznamu

ID operace:: CustomListController_PutRecord

Vytvoří nebo aktualizuje vlastní datový záznam seznamu. Hodnotu jedinečného sloupce je možné vynechat, ale pokud existuje, měla by odpovídat hodnotě Jedinečné ID v parametru dotazu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
customListId	customListId	True	integer	Id vlastního seznamu
identifikační číslo	id	True	string	Jedinečná hodnota
ColumnIndex	ColumnIndex		integer	Index sloupce vlastního seznamu
Titulek	Caption		string	Vlastní titulek sloupce seznamu
Hodnota	Value			Vlastní hodnota sloupce seznamu

Vytvoření uživatele

ID operace:: UserController_Create

Vytvoří nového uživatele.

Parametry

Name	Klíč	Typ	Description
Uživatelské jméno	UserName	string	Uživatelské jméno uživatele.
Heslo	Password	password	Heslo uživatele.
GroupName	GroupName	string	Název skupiny uživatele
Křestní jméno	FirstName	string	Jméno uživatele.
Příjmení	LastName	string	Příjmení uživatele.
Číslo zaměstnance	EmployeeNumber	string	Číslo zaměstnance uživatele.
Email	Email	string	E-mailová adresa uživatele
telefon	Phone	string	Telefonní číslo uživatele
Id role	RoleId	integer	RoleId uživatele – (Admin: 1, User: 3, Power User: 5).
IsActive	IsActive	boolean	Aktivní stav uživatele.
EPTTEnabled	EPTTEnabled	boolean	Stav funkce Enhanced Push-to-Talk pro uživatele: logická hodnota.
EPTTNumber	EPTTNumber	string	Telefonní číslo pro funkci Enhanced Push-to-Talk pro uživatele: řetězec.
EPTTWebMDN	EPTTWebMDN	string	Telefonní číslo použité k ověření uživatele v systému Kodiak EPTT – poskytl Kodiak.
EPTTToken	EPTTToken	string	Token rozhraní API používaný k ověření uživatele v systému Kodiak EPTT – poskytuje Kodiak.
GPSEnabled	GPSEnabled	boolean	Stav funkce GPS pro uživatele
MobileOnly	MobileOnly	boolean	Stav přístupu desktopové webové aplikace pro CAB – (Bez přístupu k webové aplikaci: Pravda, Úplný přístup k aplikaci: Nepravda).
Typ licence	LicenseType	integer	Typ licence přiřazené uživateli: - 0 pro Nedefinováno, 1 pro Regular, 2 pro WebOnly a 3 pro Zaměstnance.

Návraty

Body: CustomerAPI.Models.ReturnIdApiModel

Vytvoření vozidla

ID operace:: VehicleController_CreateVehicle

Vytvoří vozidlo.

Parametry

Name	Klíč	Typ
Number	Number	string
Název	Name	string
Typ	Type	string
Štítek	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
TimeZone	TimeZone	string
Dělat	Make	string
Rok	Year	integer
Model	Model	string
Barva	Color	string
VIN	VIN	string
IsActive	IsActive	boolean
TypZařízení	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

Návraty

Body: CustomerAPI.Models.ReturnIdApiModel

Zpětné volání Webhooku s datovým kanálem GPS

ID operace:: TrackingController_subscribe_callback

Tuto ukázkovou metodu používá gpsdata nebo přihlášení k odběru k odeslání zpětného datového kanálu pomocí adresy URL poskytnuté zákazníkem.

Parametry

Name	Klíč	Typ	Description
identifikační číslo	Id	string	Adresa URL obsahující adresu WebHookSubscriptionParamsApiModel.
DeviceId	DeviceId	string	GPSDeviceDto ID přidružené k předplatnému.
TypZařízení	DeviceType	integer	GpsDeviceDto typ: Handset(0), CalAmp(1), Geotab (2), Xirgo (3).
Časová značka	Timestamp	date-time	Formát ISO s místním formátem a posunem.
Id společnosti	CompanyId	integer	ID společnosti.
UserId	UserId	integer	ID uživatele.
ID vozidla	VehicleId	integer	ID vozidla.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Zda je uživatel propojený s vozidlem.
LocationProvider	LocationProvider	string	Název zprostředkovatele umístění.
Lat	Lat	double	Zeměpisná šířka.
Lon	Lon	double	Zeměpisná délka.
PřesnostFt	AccuracyFt	double	Přesnost pozice (stopy).
AltitudeFt	AltitudeFt	double	Nadmořské výšky (stopy).
Heading	Heading	integer	Směr kompasu ve stupních.
SpeedMph	SpeedMph	double	Rychlost pohybu (Mph).
BatteryStatus	BatteryStatus	integer	Stav baterie: Nenabíjené(0), Nabíjení(1).
BatteryLevel	BatteryLevel	integer	Úroveň baterie v procentech.
ActivityState	ActivityState	integer	Stav aktivity: Zůstat(1), Modving(2).
IsNetworkConnected	IsNetworkConnected	boolean	Je zařízení v tuto chvíli připojené k síti.
Rssi	Rssi	integer	Přijatý indikátor síly signálu.
DOdoMl	DOdoMl	double	GpsDeviceDto Odometer (míle).
VOdoMl	VOdoMl	double	Odometer vozidla (míle).

Návraty

response: object

Zpětné volání webhooku s informačním kanálem událostí

ID operace:: EventController_subscribe_callback

Tato ukázková metoda se používá událostmi nebo přihlášením k odběru k odesílání zpětného datového kanálu událostí pomocí adresy URL poskytnuté zákazníkem.

Parametry

Name	Klíč	Typ	Description
identifikační číslo	Id	string	Adresa URL obsahující adresu WebHookSubscriptionParamsApiModel.
EventType	EventType	integer
EventCode	EventCode	string
EventTime	EventTime	date-time	Formát ISO s místním formátem a posunem.
DeviceId	DeviceId	string	GPSDeviceDto ID přidružené k předplatnému.
TypZařízení	DeviceType	integer	GpsDeviceDto type: Handset (0), CalAmp (1), Geotab (2), Xirgo (3).
UserId	UserId	integer	ID uživatele.
ID vozidla	VehicleId	integer	ID vozidla.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Zda je uživatel propojený s vozidlem.
Lat	Lat	double	Zeměpisná šířka.
Lon	Lon	double	Zeměpisná délka.
CustomEventDefinitionId	CustomEventDefinitionId	string
EventParams	EventParams	object	Parametry události.

Návraty

response: object

Získání formuláře

ID operace:: FormController_GetFormAsync

Načte formulář podle jeho ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	integer	ID formuláře.

Návraty

Body: CustomerAPI.Models.Forms.StandaloneFormApiModel

Získání geografické zóny

ID operace:: GeofenceController_GetGeofence

Načte geografickoufenci podle id.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	integer	ID geografické zóny.
useMetric	useMetric		boolean	Použijte systém metrik nebo ne.

Návraty

Body: CustomerAPI.Models.Geofence.GeofenceApiModel

Získání jednoho záznamu z vlastního seznamu

ID operace:: CustomListController_GetSingleRecord

Načte záznam dat s jedním vlastním seznamem nalezený hodnotou CustomListId a jedinečnou hodnotou sloupce.

Chyby:

404 – pro zadanou hodnotu customListId a jedinečnou hodnotu sloupce neexistuje žádný záznam vlastního seznamu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
customListId	customListId	True	integer	Id vlastního seznamu
identifikační číslo	id	True	string	Jedinečná hodnota

Návraty

Kontejner pro pole dat ve sloupci vlastního seznamu

Body: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Získání klienta

ID operace:: ClientController_Get

Načte objekt klienta podle jeho ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	ID klienta.
use-external-id	use-external-id		boolean	Použijte externí ID nebo ne.

Návraty

Body: CustomerAPI.Models.Client.ReadClientApiModel

Získání objednávky

ID operace:: OrderController_GetOrder

Získá existující objednávku podle id.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Externí nebo interní ID závisí na hodnotě parametru use-external-id.
include-status-history	include-status-history		string	Pokud ano, odpověď bude obsahovat veškerou historii stavu a data formuláře pro tuto objednávku.
use-external-id	use-external-id		boolean	Použijte externí ID nebo ne.

Návraty

Body: CustomerAPI.Models.Order.OrderApiModel

Získání podverze

ID operace:: VersionController_Get

Vrátí aktuální podverzi rozhraní API.

Získání položek dat GPS

ID operace:: TrackingController_GetGpsData

Načte položky dat GPS pro zadaný rozsah kalendářních dat. Vrátí také token pro pokračování a odkaz pro získání další datové části. Můžete zadat počet vrácených stránek a počet prvků na stránku.

Pozice pro odstraněné uživatele nebo vozidla se nevrátí. Pokud však uživatel nebo vozidlo existovalo při vyžádání dat a bylo později odebráno, vrátí se data pro uživatele nebo vozidlo požadované tokenem pokračování.

Výsledky se automaticky seřadí podle času UtcTime a ve vzestupném pořadí. Parametry řazení nelze konfigurovat.

Parametry

Name	Klíč	Typ	Description
fromDate	fromDate	date-time	Začátek rozsahu dat. Doporučení: Místo malých rozsahů kalendářních dat používejte velké rozsahy kalendářních dat (>=4 hodiny).
toDate	toDate	date-time	Konec rozsahu dat. Doporučení: Místo malých rozsahů kalendářních dat používejte velké rozsahy kalendářních dat (>=4 hodiny).
employeeNumber	employeeNumber	string	Číslo zaměstnance.
Vin	vin	string	Číslo VIN vozidla.
useMetric	useMetric	boolean	Použijte systém metrik nebo ne.
token	token	string	Token pokračování vrácený počátečním voláním a použije se v následném volání.

Návraty

Body: CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Získání položky pro uchovávání času

ID operace:: TimekeepingController_GetTimekeepingEntryAsync

Načte položku podle id.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	ID záznamu.

Návraty

Body: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Získání seznamu cest

ID operace:: TrackingController_GetTrips

Načte seznam cest pro určité časové období. Můžete zadat počet vrácených stránek a počet prvků na stránku. Výsledky se automaticky seřadí podle startUtcTIme a ve vzestupném pořadí. Parametry řazení nelze konfigurovat.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
fromDate	fromDate	True	date-time	Začátek rozsahu dat. Doporučení: Místo malých rozsahů kalendářních dat používejte velké rozsahy kalendářních dat (>=4 hodiny).
toDate	toDate	True	date-time	Konec rozsahu dat. Doporučení: Místo malých rozsahů kalendářních dat používejte velké rozsahy kalendářních dat (>=4 hodiny).
employeeNumber	employeeNumber		string	Číslo zaměstnance.
Vin	vin		string	Číslo VIN vozidla.
pageNumber	pageNumber		integer	Číslo úvodní stránky Výchozí hodnota je 1.
pageSize	pageSize		integer	Velikost stránky. Výchozí hodnota je 1 000.
useMetric	useMetric		boolean	Použijte systém metrik nebo ne.

Návraty

response: array of CustomerAPI.Models.Tracking.TripApiModel

Získání seznamu formulářů

ID operace:: FormController_GetFormsAsync

Načte seznam formulářů pomocí některého z filtrů z níže uvedených parametrů požadavku. Můžete zadat počet vrácených stránek a počet prvků na stránku. Výsledky se automaticky seřadí podle hodnoty SubmittedTime a sestupně. Parametry řazení nelze konfigurovat.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
submittedStartDate	submittedStartDate	True	date-time	Počáteční datum odeslaného formuláře
submittedEndDate	submittedEndDate	True	date-time	Koncové datum odeslaného formuláře.
apiModuleId	apiModuleId		string	ID modulu formuláře.
employeeNumber	employeeNumber		string	Číslo zaměstnance.
zhodnotil	reviewed		boolean	Načte pouze zkontrolované formuláře nebo ne. Výchozí hodnota je null pro všechny.
pageNumber	pageNumber		integer	Počáteční číslo stránky Výchozí hodnota je 1.
pageSize	pageSize		integer	Velikost stránky. Výchozí hodnota je 1 000.

Návraty

response: array of CustomerAPI.Models.Forms.StandaloneFormApiModel

Získání seznamu geografických fences

ID operace:: GeofenceController_GetGeofences

Načte seznam geografických fence. Můžete zadat počet vrácených stránek a počet prvků na stránku a také to, jestli jsou souřadnice geografické zóny metriky. Výsledky se automaticky seřadí podle názvu a ve vzestupném pořadí. Parametry řazení nelze konfigurovat.

Parametry

Name	Klíč	Typ	Description
pageNumber	pageNumber	integer	Číslo úvodní stránky Výchozí hodnota je 1.
pageSize	pageSize	integer	Velikost stránky. Výchozí hodnota je 500.
useMetric	useMetric	boolean	Použijte systém metrik nebo ne.

Návraty

response: array of CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Získání seznamu klientů

ID operace:: ClientController_GetClients

Načte seznam klientů. Můžete zadat počet vrácených stránek a počet prvků na stránku. Výsledky se automaticky seřadí podle názvu a ve vzestupném pořadí. Parametry řazení nelze konfigurovat.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
pageNumber	pageNumber		integer	Číslo úvodní stránky
pageSize	pageSize		integer	Velikost stránky.

Návraty

response: array of CustomerAPI.Models.Client.ReadClientApiModel

Získání seznamu objednávek

ID operace:: OrderController_GetOrders

Načte seznam objednávek pomocí filtrů z níže uvedených parametrů požadavku. Můžete zadat počet vrácených stránek a počet prvků na stránku. Výsledky se automaticky seřadí podle Client.Name a ve vzestupném pořadí. Parametry řazení nelze konfigurovat.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
dueDateFrom	dueDateFrom	True	date-time	Filtrovat podle data zahájení termínu splnění.
dueDateTo	dueDateTo	True	date-time	Filtrovat podle koncového data splnění
employeeNumber	employeeNumber		string	Filtrujte podle čísla zaměstnance.
pageNumber	pageNumber		integer	Počáteční číslo stránky (výchozí 1)
pageSize	pageSize		integer	Velikost stránky (výchozí 500)

Návraty

response: array of CustomerAPI.Models.Order.OrderListItemApiModel

Získání seznamu odběrů webhooků událostí

ID operace:: EventController_GetSubscriptions

Načte seznam odběrů webhooků událostí. Můžete zadat počet vrácených stránek a počet prvků na stránku. Výsledky se automaticky seřadí podle SubscriptionId a ve vzestupném pořadí. Parametry řazení nelze konfigurovat.

Návraty

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Získání seznamu položek uchovávání času

ID operace:: TimekeepingController_GetTimekeepingDataList

Načte seznam položek uchovávání času na základě rozsahu dat. Můžete zadat počet vrácených stránek a počet prvků na stránku. Výsledky se automaticky seřadí podle clockInTime a potom podle hodnoty TimekeepingStatusId a ve vzestupném pořadí. Parametry řazení nelze konfigurovat.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
fromDate	fromDate	True	date-time	Počáteční datum.
toDate	toDate	True	date-time	Koncové datum.
employeeNumber	employeeNumber		string	Číslo zaměstnance.
schválený	approved		boolean	Vyfiltrujte jenom schválenou položku.
closedOnly	closedOnly		boolean	Filtruje pouze uzavřenou položku.
excludeFormData	excludeFormData		boolean	Filtrování pro vyloučení dat formuláře
pageNumber	pageNumber		integer	Počáteční číslo stránky (výchozí 1)
pageSize	pageSize		integer	Velikost stránky (výchozí 1000)

Návraty

response: array of CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Získání seznamu předplatných

ID operace:: TrackingController_GetSubscriptions

Načte seznam předplatných webhooků. Můžete zadat počet vrácených stránek a počet prvků na stránku. Výsledky se automaticky seřadí podle SubscriptionId a ve vzestupném pořadí. Parametry řazení nelze konfigurovat.

Návraty

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Získání seznamu událostí

ID operace:: EventController_GetEvents

Načte seznam událostí pro určité časové období. Můžete zadat počet vrácených stránek a počet prvků na stránku.

Filtrováním podle typu události získáte konkrétní události. Události vozidla mohou být vráceny pro zaměstnance, pokud je zaměstnanec přidružen k vozidle.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
fromDate	fromDate	True	date-time	Začátek rozsahu dat.
toDate	toDate	True	date-time	Konec rozsahu dat.
employeeNumber	employeeNumber		string	Číslo zaměstnance.
vehicleNumber	vehicleNumber		string	Číslo vozidla.
pageNumber	pageNumber		integer	Číslo úvodní stránky
pageSize	pageSize		integer	Velikost stránky.
eventType	eventType		integer	Filtrovat podle typu události Je zadáno číslo zaměstnance: UserEvents(0) – pouze uživatelské události. VehicleEvents(1) - pouze události vozidel, včetně událostí snímače. ExternalEvents(2) – pouze externí události. je zadáno číslo vozidla: UserEvents(0) – není k dispozici. VehicleEvents(1) - pouze události vozidel, včetně událostí snímače. ExternalEvents(2) – pouze externí události. Není zadáno číslo zaměstnance ani číslo vozidla: UserEvents(0) – pouze uživatelské události. VehicleEvents(1) - pouze události vozidel, včetně událostí snímače. ExternalEvents(2) – pouze externí události.

Návraty

response: array of CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Získání seznamu uživatelů

ID operace:: UserController_GetUsers

Načte seznam uživatelů. Můžete zadat počet vrácených stránek a počet prvků na stránku. Výsledky se automaticky seřadí podle ID uživatele a ve vzestupném pořadí. Parametry řazení nelze konfigurovat.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
pageNumber	pageNumber		integer	Číslo úvodní stránky Výchozí hodnota je 1.
pageSize	pageSize		integer	Velikost stránky. Výchozí hodnota je 500.

Návraty

response: array of CustomerAPI.Models.User.ReadUserListItemApiModel

Získání seznamu vlastních definic událostí

ID operace:: EventController_GetList

Načte seznam vlastních definic událostí.

Návraty

response: array of CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Získání seznamu vlastních polí seznamu podle CustomListID

ID operace:: CustomListController_GetById

Načte seznam polí pro jeden vlastní seznam pomocí CustomListID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
customListId	customListId	True	integer	Id vlastního seznamu

Návraty

Vlastní model seznamu

Body: CustomerAPI.Models.CustomLists.CustomListApiModel

Získání seznamu vozidel

ID operace:: VehicleController_GetVehicles

Načte seznam vozidel.

Parametry

Name	Klíč	Typ	Description
pageNumber	pageNumber	integer	Číslo stránky.
pageSize	pageSize	integer	Maximální počet položek na stránce Výchozí hodnota = 1000. Maximální hodnota = 2000.
activeOnly	activeOnly	boolean	pokud je true - vrátí pouze aktivní vozidla. Výchozí hodnota = false

Návraty

response: array of CustomerAPI.Models.Vehicles.VehicleReadApi

Získání uživatele

ID operace:: UserController_Get

Získá uživatele podle jeho ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Externí nebo interní ID závisí na hodnotě parametru use-external-id.
use-external-id	use-external-id		boolean	Použijte externí ID nebo ne.

Návraty

Body: CustomerAPI.Models.User.ReadUserApiModel

Získání vlastní definice události podle ID

ID operace:: EventController_Get

Načte jednu vlastní definici události podle ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	ID definice události.

Návraty

Vlastní model definice události

Body: CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Získání vlastních dat seznamu podle CustomListID

ID operace:: CustomListController_GetCustomList

Načte všechny datové záznamy v jednom vlastním seznamu pomocí CustomListID.

Výsledky se seřadí podle sloupce a stránkování se podporuje.

Chyby:

404 – pro zadané id vlastního seznamu neexistuje žádný vlastní seznam.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
customListId	customListId	True	integer	Id vlastního seznamu
pageNumber	pageNumber		integer	Číslo úvodní stránky
pageSize	pageSize		integer	Velikost stránky.

Návraty

Kontejner pro pole dat ve sloupci vlastního seznamu

Body: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Získání vlastních definic seznamů

ID operace:: CustomListController_Get

Načte výpis definice vlastního seznamu. Výpis definice obsahuje CustomListID, Name a Version pro všechny existující vlastní seznamy.

Návraty

response: array of CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Získání vozidla podle ID

ID operace:: VehicleController_GetVehicle

Načte jedno vozidlo podle ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Externí nebo interní ID závisí na hodnotě parametru use-external-id.
use-external-id	use-external-id		boolean	Použijte externí ID nebo ne.

Návraty

Datový model vozidla.

Body: CustomerAPI.Models.Vehicles.VehicleReadApi

Částečná aktualizace vozidla

ID operace:: VehicleController_PartialUpdateVehicle

Částečná aktualizace vozidla podle ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
identifikační číslo	id	True	string	Externí nebo interní ID závisí na hodnotě parametru use-external-id.
			object
use-external-id	use-external-id		boolean	Použijte externí ID nebo ne.

Návraty

Body: CustomerAPI.Models.ReturnIdApiModel

Aktivační události

Dotazování dat formuláře	Koncový bod dotazování rozhraní API forms umožňuje vaší aplikaci průběžně cyklické dotazování a zpracování nedávno odeslaných samostatných formulářů. Integrace: Tento koncový bod je navržený tak, aby fungoval s Microsoft Flow jako integrací triggeru dotazování. Případně můžete vyvíjet vlastní integraci pomocí libovolného jazyka. Použití: V typickém scénáři by první požadavek na tento koncový bod neměl poskytovat žádné parametry. Existují dvě (2) možné odpovědi: Kód odpovědi HTTP 200 – existují nedávno odeslané záznamy formuláře; Text odpovědi zobrazí data formuláře. Kód odpovědi HTTP 202 – Neexistují žádné nedávno odeslané záznamy; text odpovědi bude prázdný. V obou případech jsou v odpovědi dvě (2) důležité hlavičky: Umístění – adresa URL dalšího požadavku. Retry-After – doporučený časový interval v sekundách pro další požadavek. Pokud se mají načíst například data, bude mít hlavička Retry-After hodnotu 1 nebo 60. Pokud nejsou k dispozici žádná data k načtení, bude hodnota hlavičky Retry-After 300. Poznámka: Jedná se pouze o doporučené hodnoty – v závislosti na vašich požadavcích se vaše aplikace může rozhodnout dotazovat na jinou frekvenci. Po prvním požadavku by všechny následné požadavky měly používat adresu URL uvedenou v hlavičce Umístění poslední odpovědi. Nepřidávejte do adresy URL další parametry, protože už obsahuje nezbytné parametry potřebné k zajištění chybějících formulářů v požadavku. Výsledky se automaticky seřadí podle ModifiedUtc a potom podle FormHeaderId ve vzestupném pořadí. Parametry řazení nelze konfigurovat. Definice ModifiedUtc: interní časová značka = čas poslední změny dat formuláře.
Dotazování na stavy objednávek	Koncový bod dotazování rozhraní API stavu objednávek umožňuje vaší aplikaci průběžně dotazovat a zpracovávat nedávné změny objednávek. Integrace: Tento koncový bod je navržený tak, aby fungoval s Microsoft Flow jako integrací triggeru dotazování. Případně můžete vyvíjet vlastní integraci pomocí libovolného jazyka. Použití: V typickém scénáři by první požadavek na tento koncový bod neměl poskytovat žádné parametry. Existují dvě (2) možné odpovědi: Kód odpovědi HTTP 200 – Existují nedávno změněné záznamy o stavu objednávky; Text odpovědi zobrazí data o stavu objednávky. Kód odpovědi HTTP 202 – Neexistují žádné nedávno odeslané záznamy; text odpovědi bude prázdný. V obou případech jsou v odpovědi dvě (2) důležité hlavičky: Umístění – adresa URL dalšího požadavku. Retry-After – doporučený časový interval v sekundách pro další požadavek. Pokud se mají načíst například data, bude mít hlavička Retry-After hodnotu 1 nebo 60. Pokud nejsou k dispozici žádná data k načtení, bude hodnota hlavičky Retry-After 300. Poznámka: Jedná se pouze o doporučené hodnoty – v závislosti na vašich požadavcích se vaše aplikace může rozhodnout dotazovat na jinou frekvenci. Po prvním požadavku by všechny následné požadavky měly používat adresu URL uvedenou v hlavičce Umístění poslední odpovědi. Nepřidávejte do adresy URL další parametry, protože už obsahuje ty, které jsou nezbytné k zajištění, že v požadavku nechybí stavy objednávek. Výsledky se seřadí podle ModifiedUtc a potom podle StatusId ve vzestupném pořadí. Parametry řazení nelze konfigurovat. Definice ModifiedUtc: interní časová značka = čas změny dat o stavu nejnovější objednávky.
Dotazování s časovým intervalem	Koncový bod dotazování rozhraní API pro uchovávání času umožňuje vaší aplikaci průběžně cyklické dotazování a zpracování nedávno odeslaných záznamů o čase. Integrace: Tento koncový bod je navržený tak, aby fungoval s Microsoft Flow jako integrací triggeru dotazování. Případně můžete vyvíjet vlastní integraci pomocí libovolného jazyka. Použití: V typickém scénáři by první požadavek na tento koncový bod neměl poskytovat žádné parametry. Existují dvě (2) možné odpovědi: Kód odpovědi HTTP 200 – nedávno odeslaný čas uchovávání záznamů existuje; Text odpovědi zobrazí data o uchovávání času pro zadávání dat. Kód odpovědi HTTP 202 – Neexistují žádné nedávno odeslané záznamy; text odpovědi bude prázdný. V obou případech jsou v odpovědi dvě (2) důležité hlavičky: Umístění – adresa URL dalšího požadavku. Retry-After – doporučený časový interval v sekundách pro další požadavek. Pokud se mají načíst například data, bude mít hlavička Retry-After hodnotu 1 nebo 60. Pokud nejsou k dispozici žádná data k načtení, bude hodnota hlavičky Retry-After 300. Poznámka: Jedná se pouze o doporučené hodnoty – v závislosti na vašich požadavcích se vaše aplikace může rozhodnout dotazovat na jinou frekvenci. Po prvním požadavku by všechny následné požadavky měly používat adresu URL uvedenou v hlavičce Umístění poslední odpovědi. Nepřidávejte do adresy URL další parametry, protože už obsahuje ty, které jsou nezbytné k zajištění toho, aby v požadavku nezůstávali položky uchovávání času. Výsledky se automaticky seřadí podle ModifiedUtc a potom podle TimekeepingStatusId a potom ve vzestupném pořadí. Parametry řazení nelze konfigurovat. Definice ModifiedUtc: interní časová značka = čas poslední změny stavu.
Hlasování o objednávkách	Koncový bod dotazování rozhraní API Pro objednávky umožňuje vaší aplikaci průběžně dotazovat a zpracovávat nedávné změny objednávek. Integrace: Tento koncový bod je navržený tak, aby fungoval s Microsoft Flow jako integrací triggeru dotazování. Případně můžete vyvíjet vlastní integraci pomocí libovolného jazyka. Použití: V typickém scénáři by první požadavek na tento koncový bod neměl poskytovat žádné parametry. Existují dvě (2) možné odpovědi: Kód odpovědi HTTP 200 - Nedávno změněné objednávky existují; Text odpovědi zobrazí data objednávky. Kód odpovědi HTTP 202 – Neexistují žádné nedávno změněné objednávky; text odpovědi bude prázdný. V obou případech jsou v odpovědi dvě (2) důležité hlavičky: Umístění – adresa URL dalšího požadavku. Retry-After – doporučený časový interval v sekundách pro další požadavek. Pokud se mají načíst například data, bude mít hlavička Retry-After hodnotu 1 nebo 60. Pokud nejsou k dispozici žádná data k načtení, bude hodnota hlavičky Retry-After 300. Poznámka: Jedná se pouze o doporučené hodnoty – v závislosti na vašich požadavcích se vaše aplikace může rozhodnout dotazovat na jinou frekvenci. Po prvním požadavku by všechny následné požadavky měly používat adresu URL uvedenou v hlavičce Umístění poslední odpovědi. Nepřidávejte do adresy URL další parametry, protože už obsahuje nezbytné parametry potřebné k zajištění, že změny objednávek v požadavku chybí. Výsledky se automaticky seřadí podle ModifiedUtc a potom podle OrderId ve vzestupném pořadí. Parametry řazení nelze konfigurovat. Definice ModifiedUtc: interní časová značka = čas poslední změny dat objednávky.

Dotazování dat formuláře

ID operace:: FormController_Poll

Koncový bod dotazování rozhraní API forms umožňuje vaší aplikaci průběžně cyklické dotazování a zpracování nedávno odeslaných samostatných formulářů.

Integrace:

Tento koncový bod je navržený tak, aby fungoval s Microsoft Flow jako integrací triggeru dotazování. Případně můžete vyvíjet vlastní integraci pomocí libovolného jazyka.

Použití:

V typickém scénáři by první požadavek na tento koncový bod neměl poskytovat žádné parametry. Existují dvě (2) možné odpovědi:

Kód odpovědi HTTP 200 – existují nedávno odeslané záznamy formuláře; Text odpovědi zobrazí data formuláře.
Kód odpovědi HTTP 202 – Neexistují žádné nedávno odeslané záznamy; text odpovědi bude prázdný.

V obou případech jsou v odpovědi dvě (2) důležité hlavičky:

Umístění – adresa URL dalšího požadavku.
Retry-After – doporučený časový interval v sekundách pro další požadavek. Pokud se mají načíst například data, bude mít hlavička Retry-After hodnotu 1 nebo 60. Pokud nejsou k dispozici žádná data k načtení, bude hodnota hlavičky Retry-After 300.

Poznámka: Jedná se pouze o doporučené hodnoty – v závislosti na vašich požadavcích se vaše aplikace může rozhodnout dotazovat na jinou frekvenci. Po prvním požadavku by všechny následné požadavky měly používat adresu URL uvedenou v hlavičce Umístění poslední odpovědi. Nepřidávejte do adresy URL další parametry, protože už obsahuje nezbytné parametry potřebné k zajištění chybějících formulářů v požadavku.

Výsledky se automaticky seřadí podle ModifiedUtc a potom podle FormHeaderId ve vzestupném pořadí. Parametry řazení nelze konfigurovat.

Definice ModifiedUtc: interní časová značka = čas poslední změny dat formuláře.

Návraty

Body: CustomerAPI.Models.Forms.StandaloneFormApiModel

Dotazování na stavy objednávek

ID operace:: OrderController_StatusPoll

Koncový bod dotazování rozhraní API stavu objednávek umožňuje vaší aplikaci průběžně dotazovat a zpracovávat nedávné změny objednávek.

Integrace:

Tento koncový bod je navržený tak, aby fungoval s Microsoft Flow jako integrací triggeru dotazování. Případně můžete vyvíjet vlastní integraci pomocí libovolného jazyka.

Použití:

V typickém scénáři by první požadavek na tento koncový bod neměl poskytovat žádné parametry. Existují dvě (2) možné odpovědi:

Kód odpovědi HTTP 200 – Existují nedávno změněné záznamy o stavu objednávky; Text odpovědi zobrazí data o stavu objednávky.
Kód odpovědi HTTP 202 – Neexistují žádné nedávno odeslané záznamy; text odpovědi bude prázdný.

V obou případech jsou v odpovědi dvě (2) důležité hlavičky:

Umístění – adresa URL dalšího požadavku.
Retry-After – doporučený časový interval v sekundách pro další požadavek. Pokud se mají načíst například data, bude mít hlavička Retry-After hodnotu 1 nebo 60. Pokud nejsou k dispozici žádná data k načtení, bude hodnota hlavičky Retry-After 300.

Poznámka: Jedná se pouze o doporučené hodnoty – v závislosti na vašich požadavcích se vaše aplikace může rozhodnout dotazovat na jinou frekvenci. Po prvním požadavku by všechny následné požadavky měly používat adresu URL uvedenou v hlavičce Umístění poslední odpovědi. Nepřidávejte do adresy URL další parametry, protože už obsahuje ty, které jsou nezbytné k zajištění, že v požadavku nechybí stavy objednávek.

Výsledky se seřadí podle ModifiedUtc a potom podle StatusId ve vzestupném pořadí. Parametry řazení nelze konfigurovat.

Definice ModifiedUtc: interní časová značka = čas změny dat o stavu nejnovější objednávky.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
excludeFormData	excludeFormData		boolean	Pokud je hodnota true, poleValues bude vždy prázdné pole.

Návraty

Body: CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Dotazování s časovým intervalem

ID operace:: TimekeepingController_Poll

Koncový bod dotazování rozhraní API pro uchovávání času umožňuje vaší aplikaci průběžně cyklické dotazování a zpracování nedávno odeslaných záznamů o čase.

Integrace:

Tento koncový bod je navržený tak, aby fungoval s Microsoft Flow jako integrací triggeru dotazování. Případně můžete vyvíjet vlastní integraci pomocí libovolného jazyka.

Použití:

V typickém scénáři by první požadavek na tento koncový bod neměl poskytovat žádné parametry. Existují dvě (2) možné odpovědi:

Kód odpovědi HTTP 200 – nedávno odeslaný čas uchovávání záznamů existuje; Text odpovědi zobrazí data o uchovávání času pro zadávání dat.
Kód odpovědi HTTP 202 – Neexistují žádné nedávno odeslané záznamy; text odpovědi bude prázdný.

V obou případech jsou v odpovědi dvě (2) důležité hlavičky:

Umístění – adresa URL dalšího požadavku.
Retry-After – doporučený časový interval v sekundách pro další požadavek. Pokud se mají načíst například data, bude mít hlavička Retry-After hodnotu 1 nebo 60. Pokud nejsou k dispozici žádná data k načtení, bude hodnota hlavičky Retry-After 300.

Poznámka: Jedná se pouze o doporučené hodnoty – v závislosti na vašich požadavcích se vaše aplikace může rozhodnout dotazovat na jinou frekvenci. Po prvním požadavku by všechny následné požadavky měly používat adresu URL uvedenou v hlavičce Umístění poslední odpovědi. Nepřidávejte do adresy URL další parametry, protože už obsahuje ty, které jsou nezbytné k zajištění toho, aby v požadavku nezůstávali položky uchovávání času.

Výsledky se automaticky seřadí podle ModifiedUtc a potom podle TimekeepingStatusId a potom ve vzestupném pořadí. Parametry řazení nelze konfigurovat.

Definice ModifiedUtc: interní časová značka = čas poslední změny stavu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
excludeFormData	excludeFormData		boolean	Pokud je true, ClockInFormData a ClockOutFormData budou vždy null.

Návraty

Body: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Hlasování o objednávkách

ID operace:: OrderController_Poll

Koncový bod dotazování rozhraní API Pro objednávky umožňuje vaší aplikaci průběžně dotazovat a zpracovávat nedávné změny objednávek.

Integrace:

Tento koncový bod je navržený tak, aby fungoval s Microsoft Flow jako integrací triggeru dotazování. Případně můžete vyvíjet vlastní integraci pomocí libovolného jazyka.

Použití:

V typickém scénáři by první požadavek na tento koncový bod neměl poskytovat žádné parametry. Existují dvě (2) možné odpovědi:

Kód odpovědi HTTP 200 - Nedávno změněné objednávky existují; Text odpovědi zobrazí data objednávky.
Kód odpovědi HTTP 202 – Neexistují žádné nedávno změněné objednávky; text odpovědi bude prázdný.

V obou případech jsou v odpovědi dvě (2) důležité hlavičky:

Umístění – adresa URL dalšího požadavku.
Retry-After – doporučený časový interval v sekundách pro další požadavek. Pokud se mají načíst například data, bude mít hlavička Retry-After hodnotu 1 nebo 60. Pokud nejsou k dispozici žádná data k načtení, bude hodnota hlavičky Retry-After 300.

Výsledky se automaticky seřadí podle ModifiedUtc a potom podle OrderId ve vzestupném pořadí. Parametry řazení nelze konfigurovat.

Definice ModifiedUtc: interní časová značka = čas poslední změny dat objednávky.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
excludeFormData	excludeFormData		boolean	Pokud je pravda, Pole OrderFormFields bude vždy prázdné pole.
excludeCustomFieldData	excludeCustomFieldData		boolean	Pokud je hodnota true, customfields se nevrátí.

Návraty

Body: CustomerAPI.Models.Order.OrderHeaderApiModel

Definice

CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Name	Cesta	Typ	Description
identifikační číslo	Id	string

CustomerAPI.Models.Client.ReadClientApiModel

Name	Cesta	Typ	Description
identifikační číslo	Id	integer	ID klienta.
ExternalId	ExternalId	string	ID externího použití pro klienta – vlastnost rozšíření rozhraní API
VytvořenoUtc	CreatedUtc	date-time	Původní bod v čase, kdy byl klient vytvořen.
ModifiedUtc	ModifiedUtc	date-time	Poslední bod v čase, kdy byl klient aktualizován.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Název	Name	string	Název klienta.
Address	Address	CustomerAPI.Models.LocationApiModel
Kontakt	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

Name	Cesta	Typ	Description
FieldIndex	FieldIndex	integer	Index pole
Titulek	Caption	string	Titulek pole
datový typ	DataType	integer	Datový typ pole
DateTimeFormat	DateTimeFormat	integer	Formát DateTime
Hodnota	Value		Hodnota pole.

CustomerAPI.Models.LocationApiModel

Name	Cesta	Typ	Description
LatLon	LatLon	System.Nullable_1_Actsoft.Core.Geo.LatLon_
AdresaŘádek1	AddressLine1	string	AddressLine1 tohoto locationApiModelu.
AddressLine2	AddressLine2	string	AddressLine2 tohoto modelu LocationApiModel.
City	City	string	Město LocationApiModel.
Název oblasti	RegionName	string	Název oblasti modelu LocationApiModel.
PSČ	PostalCode	string	PSČ modelu LocationApiModel.
Kód země	CountryCode	string	Kód ISO 3166-1 alfa-2.
SubRegionName	SubRegionName	string	SubRegion of the LocationApiModel.
SubRegionCode	SubRegionCode	string	Podregion Code of the LocationApiModel.
Kód oblasti	RegionCode	string	Kód oblasti modelu LocationApiModel.

CustomerAPI.Models.Client.ContactApiModel

Name	Cesta	Typ	Description
Název	Name	string	Název ContactApiModel.
Telefonní číslo	PhoneNumber	string	Telefonní číslo modelu ContactApiModel.
Email	Email	string	E-mail modelu ContactApiModel.

System.Nullable_1_Actsoft.Core.Geo.LatLon_

Name	Cesta	Typ	Description
Zeměpisná šířka	Latitude	double
Zeměpisná délka	Longitude	double

CustomerAPI.Models.ReturnIdApiModel

Name	Cesta	Typ	Description
identifikační číslo	Id	integer	ID objektu.

CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Definuje vlastní model rozhraní API seznamu definic seznamu seznamů.

Name	Cesta	Typ	Description
CustomListId	CustomListId	integer	Id vlastního seznamu
Název	Name	string	Název vlastního seznamu
Version	Version	string	Vlastní verze seznamu

CustomerAPI.Models.CustomLists.CustomListApiModel

Vlastní model seznamu

Name	Cesta	Typ	Description
CustomListId	CustomListId	integer	Id vlastního seznamu
Název	Name	string	Název vlastního seznamu
Version	Version	string	Vlastní verze seznamu
Definition	Definition	CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel	Definuje model rozhraní API pro definici vlastního seznamu.

CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

Definuje model rozhraní API pro definici vlastního seznamu.

Name	Cesta	Typ	Description
Columns	Columns	array of CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel	Vlastní sloupce seznamu
UniqueColumnIndexIndex	UniqueColumnIndexIndex	integer	Jedinečný index sloupce

CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

Definuje vlastní model rozhraní API pro definici seznamu.

Name	Cesta	Typ	Description
Index	Index	integer	Index sloupce
datový typ	DataType	integer	Datový typ sloupce (Text: 0, Číslo: 1, Datum: 2, Čas: 3, Datum: 4, E-mail: 5).
Název	Name	string	Název sloupce

CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Kontejner pro pole dat ve sloupci vlastního seznamu

Name	Cesta	Typ	Description
ColumnValues	ColumnValues	array of CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel	Pole sloupců s daty

CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

Tento model definuje vlastní hodnotu sloupce seznamu.

Name	Cesta	Typ	Description
ColumnIndex	ColumnIndex	integer	Index sloupce vlastního seznamu
Titulek	Caption	string	Vlastní titulek sloupce seznamu
Hodnota	Value		Vlastní hodnota sloupce seznamu

CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Vlastní model definice události

Name	Cesta	Typ
identifikační číslo	Id	string
Název	Name	string
ReverseGeocode	ReverseGeocode	boolean
Parametry	Parameters	array of CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

Name	Cesta	Typ
Název	Name	string
Typ	Type	integer
Titulek	Caption	string
Povinné	Required	boolean

CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Name	Cesta	Typ	Description
Id události	EventId	integer	ID události.
EventType	EventType	integer
EventCode	EventCode	string	Kód události.
EventTime	EventTime	date-time	Formát ISO s místním formátem a posunem.
Uživatel	User	CustomerAPI.Models.UserReferenceApiModel
Vozidlo	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Pokud je tato možnost povolená, přiřadí se uživateli vozidlo události.
Umístění	Location	CustomerAPI.Models.LocationApiModel
PrimaryGeofence	PrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
CustomEventDefinitionId	CustomEventDefinitionId	string	ID definice externí události.
EventParams	EventParams	object	Parametry události.

CustomerAPI.Models.UserReferenceApiModel

Name	Cesta	Typ	Description
UserId	UserId	integer	UserId uživatele.
Křestní jméno	FirstName	string	Jméno uživatele.
Příjmení	LastName	string	Příjmení uživatele.
Číslo zaměstnance	EmployeeNumber	string	Číslo zaměstnance uživatele.
GroupName	GroupName	string	Název skupiny přiřazené uživateli

CustomerAPI.Models.ReadVehicleApiModel

Name	Cesta	Typ	Description
ID vozidla	VehicleId	integer	Id of the BaseVehicleApiModel.
Název	Name	string	Název BaseVehicleApiModel.
VIN	VIN	string	Identifikační číslo vozidla BaseVehicleApiModel.
Název zařízení	DeviceName	string	Název GpsDeviceDto přidružené k BaseVehicleApiModel.
Sériové číslo	SerialNumber	string	SerialNumber of the BaseVehicleApiModel.
GroupName	GroupName	string	GroupName modelu BaseVehicleApiModel.

CustomerAPI.Models.Geofence.GeofenceInfoApiModel

Name	Cesta	Typ	Description
GeofenceId	GeofenceId	integer	Id of the Geofence.
Název	Name	string	Název geofence.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Name	Cesta	Typ	Description
ID předplatného	SubscriptionId	string	Id of the WebHookSubscriptionResultApiModel.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Name	Cesta	Typ	Description
ID předplatného	SubscriptionId	string
URL	Url	string
Stav	Status	integer	Stav předplatného – (Spuštěno: 1, Zastaveno: 2).

CustomerAPI.Models.Forms.StandaloneFormApiModel

Name	Cesta	Typ	Description
identifikační číslo	Id	integer	ID přidružené k tomuto StandaloneFormApiModel - (starší komentář: FormHeaderId).
Id formuláře	FormId	integer	ID formuláře odkazovaného tímto modelem StandaloneFormApiModel.
FormName	FormName	string	Název formuláře odkazovaného tímto modelem StandaloneFormApiModel.
EntryNumber	EntryNumber	string	Číslo pro zadání dat formuláře.
Zhodnotil	Reviewed	boolean	Stav recenze tohoto modelu StandaloneFormApiModel.
Uživatel	User	CustomerAPI.Models.UserReferenceApiModel
Odeslaná doba	SubmittedTime	date-time	Point in time when the StandaloneFormApiModel was submitted.
StartTime	StartTime	date-time	Bod v čase, kdy byl spuštěn model StandaloneFormApiModel.
Odeslaná poloha	SubmittedLocation	CustomerAPI.Models.LocationApiModel
FormData	FormData	array of CustomerAPI.Models.Forms.FormFieldDataApiModel	Seznam polí přidružených k tomuto modelu StandaloneFormApiModel
ApiModuleId	ApiModuleId	string	ID objektu ApiModule přidruženého k tomuto modelu StandaloneFormApiModel.
SharedUrl	SharedUrl	string	Sdílená adresa URL tohoto modelu StandaloneFormApiModel.
ReviewedByUser	ReviewedByUser	CustomerAPI.Models.UserReferenceApiModel
ReviewedByTime	ReviewedByTime	date-time	Čas kontroly formuláře

CustomerAPI.Models.Forms.FormFieldDataApiModel

Name	Cesta	Typ	Description
Opakovatelné	Repeatables	array of array
items	Repeatables	array of CustomerAPI.Models.Forms.FormFieldDataBaseApiModel
identifikační číslo	Id	string	Id of the FormFieldDataApiModel.
Hodnota	Value		Hodnota FormFieldDataApiModel.
DisplayValue	DisplayValue		DisplayValue modelu FormFieldDataApiModel.
CapturedTime	CapturedTime	date-time	Hodnota bodu v čase byla zachycena modelEm FormFieldDataApiModel.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Titulek	Caption	string	Titulek obsahu FormFieldDataApiModel.
ApiFieldId	ApiFieldId	string	Id of the ApiField of the FormFieldDataApiModel.

CustomerAPI.Models.Forms.FormFieldDataBaseApiModel

Name	Cesta	Typ	Description
identifikační číslo	Id	string	Id of the FormFieldDataApiModel.
Hodnota	Value		Hodnota FormFieldDataApiModel.
DisplayValue	DisplayValue		DisplayValue modelu FormFieldDataApiModel.
CapturedTime	CapturedTime	date-time	Hodnota bodu v čase byla zachycena modelEm FormFieldDataApiModel.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Titulek	Caption	string	Titulek obsahu FormFieldDataApiModel.
ApiFieldId	ApiFieldId	string	Id of the ApiField of the FormFieldDataApiModel.

CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Name	Cesta	Typ	Description
GeofenceId	GeofenceId	integer	GeofenceId modelu GeofenceApiModel.
VytvořenoUtc	CreatedUtc	date-time	CreatedUtc of the GeofenceApiModel.
ModifiedUtc	ModifiedUtc	date-time	ModifiedUtc of the GeofenceApiModel.
GroupNames	GroupNames	array of string	GroupPaths of the GeofenceApiModel.
Název	Name	string	Název GeofenceApiModelBase.
Typ	Type	string	Typ GeofenceApiModel.
Shape	Shape	integer	Tvar: 0 pro kruh a 1 pro mnohoúhelník.
Address	Address	CustomerAPI.Models.LocationApiModel
Poloměr	Radius	double	Poloměr modelu GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress modelu GeofenceApiModel.

Actsoft.Core.Geo.LatLon

Name	Cesta	Typ	Description
Zeměpisná šířka	Latitude	double
Zeměpisná délka	Longitude	double

CustomerAPI.Models.Geofence.GeofenceApiModel

Name	Cesta	Typ	Description
GeofenceId	GeofenceId	integer	GeofenceId modelu GeofenceApiModel.
VytvořenoUtc	CreatedUtc	date-time	CreatedUtc of the GeofenceApiModel.
ModifiedUtc	ModifiedUtc	date-time	ModifiedUtc of the GeofenceApiModel.
GroupNames	GroupNames	array of string	GroupPaths of the GeofenceApiModel.
Polygon	Polygon	array of Actsoft.Core.Geo.LatLon	Mnohoúhelníkové body. Pokud se obrazec rovná 1, měl by být vyplněný.
Název	Name	string	Název GeofenceApiModelBase.
Typ	Type	string	Typ GeofenceApiModel.
Shape	Shape	integer	Tvar: 0 pro kruh a 1 pro mnohoúhelník.
Address	Address	CustomerAPI.Models.LocationApiModel
Poloměr	Radius	double	Poloměr modelu GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress modelu GeofenceApiModel.

CustomerAPI.Models.Order.OrderListItemApiModel

Name	Cesta	Typ	Description
ID objednávky	OrderId	integer	Id of the OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	OrderId externího použití pro klienta – vlastnost rozšíření rozhraní API
DueDate	DueDate	date-time	Bod v čase, kdy je tento Model OrderBaseApiModel dokončen (zastaralý v 1.3).
StartTime	StartTime	date-time	Bod v čase by se měl spustit model OrderBaseApiModel (zavedený ve verzi 1.3).
Konečný čas	EndTime	date-time	Point in time this OrderBaseApiModel is due for completion (zaveden v1.3).
ServiceType	ServiceType	string	ServiceType přidružené k tomuto OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	Bod v čase vytvoření tohoto modelu OrderBaseApiModel.
Číslo objednávky	OrderNumber	string	Číslo objednávky přidružené k tomuto modelu OrderBaseApiModel.
IsClosed	IsClosed	boolean	Stav zobrazující, jestli je model OrderBaseApiModel zavřený.
Stav	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	ID externího použití pro klienta – vlastnost rozšíření rozhraní API
ClientId	ClientId	integer	id interního použití pro klienta – vlastnost rozšíření rozhraní API
Klient	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
APIServiceId	ApiServiceId	string	ID služby ApiService přidružené k tomuto modelu OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Verze modulu vlastních polí
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusApiModel

Name	Cesta	Typ	Description
StatusIndex	StatusIndex	integer	Index of the OrderStatusApiModel.
TypStatusu	StatusType	integer	Stav objednávky: 0 pro novou objednávku, 1 pro odeslání, 2 pro probíhající, 3 pro dokončení a 4 pro zrušení.
StatusLabel	StatusLabel	string	Popisek obsahu OrderStatusApiModel.
StatusId	StatusId	integer	Id of the OrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	date-time	Point in time of Start of the OrderStatusApiModel.
Uživatel	User	CustomerAPI.Models.UserReferenceApiModel

CustomerAPI.Models.Order.OrderClientReadApiModel

Name	Cesta	Typ	Description
GroupNames	GroupNames	array of string	Hierarchické názvy skupin klientů
Název	Name	string	Název klienta.
Address	Address	CustomerAPI.Models.LocationApiModel
Kontakt	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Order.OrderApiModel

Name	Cesta	Typ	Description
StatusHistory	StatusHistory	array of CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel	Seznam OrderStatusListItems Přidružené k tomuto OrderApiModel.
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
ID objednávky	OrderId	integer	Id of the OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	OrderId externího použití pro klienta – vlastnost rozšíření rozhraní API
DueDate	DueDate	date-time	Bod v čase, kdy je tento Model OrderBaseApiModel dokončen (zastaralý v 1.3).
StartTime	StartTime	date-time	Bod v čase by se měl spustit model OrderBaseApiModel (zavedený ve verzi 1.3).
Konečný čas	EndTime	date-time	Point in time this OrderBaseApiModel is due for completion (zaveden v1.3).
ServiceType	ServiceType	string	ServiceType přidružené k tomuto OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	Bod v čase vytvoření tohoto modelu OrderBaseApiModel.
Číslo objednávky	OrderNumber	string	Číslo objednávky přidružené k tomuto modelu OrderBaseApiModel.
IsClosed	IsClosed	boolean	Stav zobrazující, jestli je model OrderBaseApiModel zavřený.
Stav	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	ID externího použití pro klienta – vlastnost rozšíření rozhraní API
ClientId	ClientId	integer	id interního použití pro klienta – vlastnost rozšíření rozhraní API
Klient	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
APIServiceId	ApiServiceId	string	ID služby ApiService přidružené k tomuto modelu OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Verze modulu vlastních polí
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Name	Cesta	Typ	Description
StatusStartDateTime	StatusStartDateTime	date-time	Bod v čase, kdy se spustil stav OrderStatusHistoryListItemApiModel.
StatusEndDateTime	StatusEndDateTime	date-time	Bod v čase, kdy byl stav OrderStatusHistoryListItemApiModel ukončen.
StatusId	StatusId	integer	ID přidružené k tomuto OrderStatusHistoryListItemApiModel.
StatusIndex	StatusIndex	integer	Index přidružený k tomuto OrderStatusHistoryListItemApiModel.
StatusLabel	StatusLabel	string	Popisek obsahu přidruženého k tomuto OrderStatusHistoryListItemApiModel.
TypStatusu	StatusType	integer	Stav objednávky: 0 pro novou objednávku, 1 pro odeslání, 2 pro probíhající, 3 pro dokončení a 4 pro zrušení.
ExternalOrderId	ExternalOrderId	string	OrderId externího použití pro klienta – vlastnost rozšíření rozhraní API
ID objednávky	OrderId	integer	OrderId přidružené k tomuto OrderStatusHistoryListItemApiModel.
Uživatel	User	CustomerAPI.Models.UserReferenceApiModel
StartAddress	StartAddress	CustomerAPI.Models.LocationApiModel
EndAddress	EndAddress	CustomerAPI.Models.LocationApiModel
APIServiceId	ApiServiceId	string	ID služby API přidružené k tomuto OrderStatusHistoryListItemApiModel.
FieldValues	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

CustomerAPI.Models.Order.OrderHeaderApiModel

Name	Cesta	Typ	Description
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
ID objednávky	OrderId	integer	Id of the OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	OrderId externího použití pro klienta – vlastnost rozšíření rozhraní API
DueDate	DueDate	date-time	Bod v čase, kdy je tento Model OrderBaseApiModel dokončen (zastaralý v 1.3).
StartTime	StartTime	date-time	Bod v čase by se měl spustit model OrderBaseApiModel (zavedený ve verzi 1.3).
Konečný čas	EndTime	date-time	Point in time this OrderBaseApiModel is due for completion (zaveden v1.3).
ServiceType	ServiceType	string	ServiceType přidružené k tomuto OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	Bod v čase vytvoření tohoto modelu OrderBaseApiModel.
Číslo objednávky	OrderNumber	string	Číslo objednávky přidružené k tomuto modelu OrderBaseApiModel.
IsClosed	IsClosed	boolean	Stav zobrazující, jestli je model OrderBaseApiModel zavřený.
Stav	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	ID externího použití pro klienta – vlastnost rozšíření rozhraní API
ClientId	ClientId	integer	id interního použití pro klienta – vlastnost rozšíření rozhraní API
Klient	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
APIServiceId	ApiServiceId	string	ID služby ApiService přidružené k tomuto modelu OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Verze modulu vlastních polí
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Timekeeping.Timekeeping.TimekeepingApiModel

Name	Cesta	Typ	Description
identifikační číslo	Id	integer	ID položky Timekeeping (starší komentář: RootSubmittedStatusId).
Uživatel	User	CustomerAPI.Models.UserReferenceApiModel
ClockInTime	ClockInTime	date-time	Point in time when the User clocked into the system.
ClockInLocation	ClockInLocation	CustomerAPI.Models.LocationApiModel
ClockOutTime	ClockOutTime	date-time	Point in time when the User clocked out of the system.
ClockOutLocation	ClockOutLocation	CustomerAPI.Models.LocationApiModel
TotalHours	TotalHours	double	Celkový počethodinýchch
TotalBreakHours	TotalBreakHours	double	Celkový počet hodin přerušení (nepracovní) pro tuto položku Timekeeping.
NetHours	NetHours	double	Celkový počet hodin účtovaných pro tuto položku Timekeeping.
Schválené	Approved	boolean	Stav schválení správcem pro tuto položku Timekeeping.
Pauzy	Breaks	array of CustomerAPI.Models.Timekeeping.TimekeepingBreakModel
ClockInFormData	ClockInFormData	CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ClockOutFormData	ClockOutFormData	CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ModuleVersion	ModuleVersion	System.Version
CompanyModuleId	CompanyModuleId	integer	ID modulu společnosti použitého k odeslání této položky Timekeeping.

CustomerAPI.Models.Timekeeping.TimekeepingBreakModel

Name	Cesta	Typ	Description
identifikační číslo	Id	integer	SubmittedStatusId.
StartTime	StartTime	date-time	Čas zahájení.
Počáteční poloha	StartLocation	CustomerAPI.Models.LocationApiModel
Konečný čas	EndTime	date-time	Čas ukončení.
EndLocation	EndLocation	CustomerAPI.Models.LocationApiModel
DurationHours	DurationHours	double	Doba trvání v hodinách. Pokud má koncový čas hodnotu null, může mít hodnotu null.
TypStatusu	StatusType	integer	Typ stavu: 1 pro přestávku a 2 na oběd.
StartLabel	StartLabel	string	Počáteční popisek
EndLabel	EndLabel	string	Koncový popisek.
Titulek	Caption	string	Titulek.

CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel

Name	Cesta	Typ
CompanyModuleId	CompanyModuleId	integer
ModuleVersion	ModuleVersion	System.Version
FieldValues	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

System.Version

Name	Cesta	Typ
_Major	_Major	integer
_Moll	_Minor	integer
_Vybudovat	_Build	integer
_Revize	_Revision	integer

CustomerAPI.Models.Tracking.TripApiModel

Name	Cesta	Typ	Description
Uživatel	User	CustomerAPI.Models.UserReferenceApiModel
Vozidlo	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
StartTime	StartTime	date-time	Bod v čase, kdy byl tento stav TripApiModel zahájen.
Konečný čas	EndTime	date-time	Bod v čase, kdy byl tento stav TripApiModel ukončen.
Počáteční poloha	StartLocation	CustomerAPI.Models.LocationApiModel
EndLocation	EndLocation	CustomerAPI.Models.LocationApiModel
StartPrimaryGeofence	StartPrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
EndPrimaryGeofence	EndPrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
TotalStopTime	TotalStopTime	double	Doba zastavení v hodinách přidružená k tomuto modelu TripApiModel.
TotalIdleTime	TotalIdleTime	double	Doba nečinnosti v hodinách přidružená k tomuto modelu TripApiModel.
TotalDuration	TotalDuration	double	Úplná doba v hodinách přidružená k tomuto modelu TripApiModel.
Vzdálenost	Distance	double	Vzdálenost cestuje v lokalizovaných jednotkách přidružených k tomuto modelu TripApiModel.

CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Name	Cesta	Typ	Description
Záznamy	Records	array of CustomerAPI.Models.Tracking.GpsDataRecordApiModel
Token pokračování	ContinuationToken	string

CustomerAPI.Models.Tracking.GpsDataRecordApiModel

Name	Cesta	Typ	Description
Uživatel	User	CustomerAPI.Models.UserReferenceApiModel
Vozidlo	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
TimeTag	TimeTag	date-time	TimeTag přidružený k tomuto GpsDataRecordApiModel.
Umístění	Location	System.Nullable_1_Actsoft.Core.Geo.LatLon_
Geofence	Geofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
Rychlost	Speed	double	Rychlost pohybu přidružené k tomuto GpsDataRecordApiModel.
Heading	Heading	double	Směr kompasu ve stupních přidružených k tomuto objektu GpsDataRecordApiModel.
Stav	Status	integer	ApiMovementStatus přidružené k OrderBaseApiModel - (Zastaveno: 1, Nečinnost: 2, Přesunutí: 3, NotTracking: 4) : OrderStatusApiModel.
Čas stavu	StatusTime	string	Bod v čase, kdy byl nastaven stav GpsDataRecordApiModel.
Vzdálenost	Distance	double	Vzdálenost cestovaná v lokalizovaných jednotkách přidružených k tomuto modelu TripApiModel.
ZapalováníOn	IgnitionOn	boolean	Stav zapalování vozidla spojeného s tímto modelem GpsDataRecordApiModel.
LocationProvider	LocationProvider	integer	Zprostředkovatel umístění rozhraní API přidružený k tomuto GpsDataRecordApiModel - (GPS: 1, Síť: 2).

CustomerAPI.Models.User.ReadUserApiModel

Name	Cesta	Typ	Description
Uživatelské jméno	UserName	string	Uživatelské jméno uživatele.
UserId	UserId	integer	Hodnota ID uživatele.
GroupName	GroupName	string	Název skupiny uživatele
Křestní jméno	FirstName	string	Jméno uživatele.
Příjmení	LastName	string	Příjmení uživatele.
Číslo zaměstnance	EmployeeNumber	string	Číslo zaměstnance uživatele.
Email	Email	string	E-mailová adresa uživatele
telefon	Phone	string	Telefonní číslo uživatele
Id role	RoleId	integer	RoleId uživatele – (Admin: 1, User: 3, Power User: 5).
IsActive	IsActive	boolean	Aktivní stav uživatele.
EPTTEnabled	EPTTEnabled	boolean	Stav funkce Enhanced Push-to-Talk pro uživatele: logická hodnota.
EPTTNumber	EPTTNumber	string	Telefonní číslo pro funkci Enhanced Push-to-Talk pro uživatele: řetězec.
EPTTWebMDN	EPTTWebMDN	string	Telefonní číslo použité k ověření uživatele v systému Kodiak EPTT – poskytl Kodiak.
EPTTToken	EPTTToken	string	Token rozhraní API používaný k ověření uživatele v systému Kodiak EPTT – poskytuje Kodiak.
GPSEnabled	GPSEnabled	boolean	Stav funkce GPS pro uživatele
MobileOnly	MobileOnly	boolean	Stav přístupu desktopové webové aplikace pro CAB – (Bez přístupu k webové aplikaci: Pravda, Úplný přístup k aplikaci: Nepravda).
Typ licence	LicenseType	integer	Typ licence přiřazené uživateli: - 0 pro Nedefinováno, 1 pro Regular, 2 pro WebOnly a 3 pro Zaměstnance.

CustomerAPI.Models.User.ReadUserListItemApiModel

Name	Cesta	Typ	Description
UserId	UserId	integer	Hodnota ID uživatele.
Křestní jméno	FirstName	string	Jméno uživatele.
Příjmení	LastName	string	Příjmení uživatele.
Číslo zaměstnance	EmployeeNumber	string	Číslo zaměstnance uživatele.
Email	Email	string	E-mailová adresa uživatele
telefon	Phone	string	Telefonní číslo uživatele
Id role	RoleId	integer	RoleId uživatele – (Admin: 1, User: 3, Power User: 5).
IsActive	IsActive	boolean	Aktivní stav uživatele.
EPTTEnabled	EPTTEnabled	boolean	Stav funkce Enhanced Push-to-Talk pro uživatele: logická hodnota.
EPTTNumber	EPTTNumber	string	Telefonní číslo pro funkci Enhanced Push-to-Talk pro uživatele: řetězec.
EPTTWebMDN	EPTTWebMDN	string	Telefonní číslo použité k ověření uživatele v systému Kodiak EPTT – poskytl Kodiak.
EPTTToken	EPTTToken	string	Token rozhraní API používaný k ověření uživatele v systému Kodiak EPTT – poskytuje Kodiak.
GPSEnabled	GPSEnabled	boolean	Stav funkce GPS pro uživatele
MobileOnly	MobileOnly	boolean	Stav přístupu desktopové webové aplikace pro CAB – (Bez přístupu k webové aplikaci: Pravda, Úplný přístup k aplikaci: Nepravda).
Typ licence	LicenseType	integer	Typ licence přiřazené uživateli: - 0 pro Nedefinováno, 1 pro Regular, 2 pro WebOnly a 3 pro Zaměstnance.

CustomerAPI.Models.Vehicles.VehicleReadApi

Datový model vozidla.

Name	Cesta	Typ
InternalId	InternalId	integer
Number	Number	string
Název	Name	string
Typ	Type	string
Štítek	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
TimeZone	TimeZone	string
Dělat	Make	string
Rok	Year	integer
Model	Model	string
Barva	Color	string
VIN	VIN	string
IsActive	IsActive	boolean
TypZařízení	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

integer

Toto je základní datový typ integer.

objekt

Toto je typ 'objekt'.

Sdílet prostřednictvím

TeamWherx

Vytvoření připojení

Výchozí

Limity omezování

Akce

Aktivace uživatele

Parametry

Aktivace vozidla

Parametry

Návraty

Aktualizace existující geografické zóny

Parametry

Návraty

Aktualizace klienta

Parametry

Návraty

Aktualizace objednávky

Parametry

Návraty

Aktualizace stavu objednávky

Parametry

Návraty

Aktualizace uživatele

Parametry

Návraty

Aktualizace vozidla

Parametry

Návraty

Aktualizace části uživatele

Parametry

Návraty

Deaktivace uživatele

Parametry

Deaktivace vozidla

Parametry

Návraty

Nahrání binárního souboru

Návraty

Nahrání souboru přílohy

Návraty

Odeslat událost

Parametry

Odhlášení odběru událostí webhookem

Parametry

Odhlášení odběru webhooku s daty GPS

Parametry

Odstranění geografické zóny

Parametry

Odstranění klienta

Parametry

Odstranění vlastní definice události

Parametry

Odstranění vlastního záznamu seznamu

Parametry

Odstranění vozidla

Parametry

Přihlášení k odběru webhooku DAT GPS

Parametry

Návraty

Přihlášení k odběru webhooku událostí

Parametry

Návraty

Resetuje stav odběru webhooku události.

Parametry

Resetuje stav předplatného.

Parametry

Umožňuje vytvořit objednávku.

Parametry

Návraty

Vytvoření formuláře

Parametry

Návraty

Vytvoření geografické zóny

Parametry

Návraty

Vytvoření klienta

Parametry

Návraty

Vytvoření nebo aktualizace vlastní definice události