TeamWherx

A TeamWherx (TW) egy teljes körű szolgáltatásfelügyeleti platform, amely segít hatékonyabban felügyelni a távoli alkalmazottakból álló csapatokat és az általános üzleti műveleteket az irodától távol. Felhőalapú megoldásként a TW lehetővé teszi a távoli adatgyűjtést, és megjeleníti azt a webalkalmazás irányítópultján keresztül, és további betekintést nyújt a vezetőknek, hogy intelligensebb stratégiákat hozzanak létre a hatékonyság, a termelékenység és a költségek csökkentése érdekében a mobil munkaerő koordinálása mellett.

Ez az összekötő a következő termékekben és régiókban érhető el:

Service	Class	Régiók
Copilot Studio	prémium	Az összes Power Automate-régió, kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD)
Logikai alkalmazások	Standard	Az összes Logic Apps-régió , kivéve a következőket: - Azure Government-régiók - Azure China-régiók - Amerikai Védelmi Minisztérium (DoD)
Power Alkalmazások	prémium	Az összes Power Apps-régió , kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD)
Power Automate	prémium	Az összes Power Automate-régió, kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD)

Érintkezés
Név	Actsoft-támogatás
URL	https://www.actsoft.com/self-help-wizards
Email	support@actsoft.com

Összekötő metaadatai
Kiadó	Actsoft
Webhely	https://actsoft.com
Adatvédelmi irányelvek	https://www.actsoft.com/privacy
Kategóriák	Termelékenység

Összekötő leírása:

A TeamWherx lehetővé teszi a digitális űrlapadatok, az alkalmazottak munkaidő-nyilvántartási információinak létrehozását és rögzítését, valamint a munkarendelések kezelését egy diszpécserrendszerrel.

Részletes leírás

A TeamWherx-összekötő lehetővé teszi a felhasználók számára, hogy több platform között csatlakozzanak és kicseréljék az információkat. Az adatokat animálhatja folyamatfolyamatok létrehozásához, más belső alkalmazások vezetéséhez és hatékony elemzésekhez. Automatizálhatja és egyszerűsítheti napi, heti vagy havi folyamatait a up-to-a pillanatnyi végrehajtható adatokhoz való hozzáféréssel.

## Előfeltételek

Az összekötő használatához a következőkre lesz szüksége:

TeamWherx-fiók
TeamWherx API-kulcs
Microsoft Power Apps- vagy Power Automate-csomag

## Hitelesítő adatok lekérése

API Fejlesztői portál

Az összekötő eléréséhez először be kell állítania egy felhasználónevet és jelszót az API Fejlesztői portálhoz, és elő kell fizetnie az Ügyfél API-ra:

Az alkalmazáson belül nyissa meg a Felügyeleti>beállítások>APItelepítőjét.
Válassza a Hitelesítő adatok létrehozása lehetőséget.
Adja meg az utónevét és a vezetéknevét a megfelelő mezőkben.
Írja be az e-mail-címét az E-mail-cím mezőbe.
Válassza a Mentés > e-mail meghívó lehetőséget. Ezután ellenőrizze az e-mail-címében a jelszó létrehozásával kapcsolatos utasításokat.
A meghívó e-mailben kattintson a Jelszókiválasztása elemre, amely megnyit egy párbeszédpanelt, amely lehetővé teszi a jelszó létrehozását.
Válassza a Jelszó mentése lehetőséget.
A fejlesztői portálra való továbblépéshez lépjen az alkalmazáson belülről a Felügyeleti>beállítások>lapra, és nyissa meg a fejlesztői portált.
A fejlesztői portálon válassza a Termékek, majd az ÜgyfélAPI lehetőséget.
Válassza a Feliratkozás lehetőséget.

API-kulcs

Most, hogy ön regisztrált API-felhasználó, létre lett hozva egy kulcsnak nevezett alfanumerikus sorozat. Erre a kulcsra lesz szüksége az API-ban lévő adatok kezeléséhez.

Az API-kulcs megkeresése:

Válassza a Termékek lehetőséget a Fejlesztői portál menüjében. A licencben elérhető API-termékek megjelennek.
Válassza ki az Ügyfél API-verziót a termékhez tartozó X-előfizetés(ek) alatt.
Válassza a Megjelenítés lehetőséget az előfizetés elsődleges kulcsa mellett.
Jelölje ki a mező tartalmát, kattintson a jobb gombbal, és válassza a Másolás parancsot. A rendszer most menti a kulcsot a vágólapra, és készen áll a beillesztésre.

## Ismerkedés az összekötővel

Nyissa meg a Saját folyamatok>új folyamatot, majd válassza az Automatizált felhőfolyamat lehetőséget.
Válassza a Folyamat manuális aktiválása lehetőséget az Automatizált felhőfolyamat létrehozása párbeszédpanelen.
Nevezze el a folyamatot, vagy hagyja, hogy a rendszer automatikusan hozzon létre egyet.
Keresse meg és válassza ki a folyamat eseményindítóját.
Válassza a Létrehozás elemet.
A keresőmezőben keresse meg és válassza ki a TeamWherx-összekötőt.
Keresse meg az összekötővel végrehajtani kívánt műveletet.

A rendszer kérni fogja, hogy jelentkezzen be a választott művelet végrehajtásához szükséges összes alkalmazásba, kihagyva azokat, amelyekbe már bejelentkezett.

Adja meg az új összekötő nevét az Összekötő mezőben.
Ezután adja meg az API-kulcsot.
Válassza a Létrehozás elemet. A folyamat első lépése a folyamatábra első "mezőjeként" jelenik meg.
Az Újlépés lehetőséget választva további műveleteket és lépéseket adhat hozzá az összekötő folyamatához.
Válassza a Mentés lehetőséget.

**Az összekötő használata – Megrendelés állapotának lekérdezési példája
** Az alábbi utasítások bemutatják, hogyan hozhat létre folyamatfolyamatot sorok beszúrásához egy munkalapon, és hogyan szúrhatja be annak az alkalmazottnak az azonosító adatait, aki frissítette a rendelési állapotot.

Lépjen az Összekötők elemre.
Keresse meg és válassza ki a [TeamWherx] összekötőt.
Válassza a Rendelés állapota lekérdezés lehetőséget a műveletek listájából.
Adja meg az új kapcsolat nevét a Kapcsolat neve mezőben.
Ezután adja meg az API-kulcsot.
Válassza a Létrehozás elemet. A folyamat első lépése a folyamatábra első "mezőjeként" jelenik meg.

A kapcsolati folyamat lépéseinek minden műveletpanelén olyan tulajdonságmezők jelennek meg, amelyeket testre szabhat az elvégzett művelet szabályozásához.

A példával folytatva válassza ki, hogy meg szeretné-e jeleníteni az Űrlapok mezőértékeket (excludeFormData paraméter).
Válassza ki a kapcsolat X-API-verzióját.
Válassza a Következő lépés lehetőséget a rendelési állapot módosításakor végrehajtandó művelet beállításához.
A Művelet kiválasztása párbeszédpanelen a keresőmezővel keresse meg az alkalmazást, majd a kívánt műveletet. Ha például egy Google-munkalapra szeretne beszúrni egy sort a rendelési állapot minden módosításakor, akkor a Google-lapok, majd a Sorbeszúrása lehetőséget választja a művelethez.
A következő Sor beszúrásapárbeszédpanelen kattintson a Fájl mezőbe, és válassza ki az eredményeket tartalmazó fájlt.
A Munkalap mezőben válassza ki az adatmunkalap típusát. A dinamikusan megjelenített mezők a munkalap adatoszlopai.
Kattintson az egyes oszlopok mezőjére, és válasszon egy tulajdonságot a Rendelés állapot lekérdezésének tulajdonságai listaelemből. Vagy a keresőmezővel megkereshet egy adott tulajdonságot.
Minden oszlopmezőben több tulajdonságot is megadhat; az Esemény oszlopban válassza a StatusLabel lehetőséget, szúrjon be egy kötőjelet, majd válassza a StatusStartDate lehetőséget. Ez azt jelenti, hogy minden rendelés állapotfrissítéséhez az állapotcímke és az állapot kezdő dátuma az új sorban lévő Esemény oszlopba lesz beírva.
Válassza az Újlépés lehetőséget. Félretett megjegyzésként mindig rámutathat, és a nyíl összekötőre kattintva beszúrhat egy új lépést
A Művelet kiválasztása párbeszédpanelen jelölje ki ismét a TeamWherx-összekötőt, majd hozzon létre egy ügyfelet a művelethez.

A párbeszédpanelen megjelenő mezők ismét egy oszlopot jelölnek a Google Sheets-számolótáblában. Az egyes mezőkre kattintva aktiválhatja a Rendelés állapot lekérdezésének tulajdonságait tartalmazó listát, és kiválaszthatja a kívánt tulajdonságokat.

Ebben a példában válassza az EmployeeNumber lehetőséget a Név mezőhöz, hogy azonosítsa azt az alkalmazottat, aki frissítette a rendelés állapotát.
Válassza a GroupName lehetőséget, és szúrja be a Név mezőbe is.
Válassza a Mentés lehetőséget.

Most létrehozott egy folyamatot, amely frissíti a számolótáblát az alkalmazotti számmal és a hozzájuk tartozó csoporttal minden egyes rendelési állapot frissítésekor.

## Ismert problémák és korlátozások

A hangfájl bináris feltöltései (POST) minden végpont esetében csak MP4-ekre korlátozódnak.
A dátum-idő adatokat igénylő végpontok dátumait RFC3339 irányelvek szerint kell megadni, ahogyan az alábbi példában is látható: 2021-09-22T02:36:56.52Z. Nem szükséges pontos másodperceket megadni az időbélyegben; A 00 elfogadható.

## Gyakori hibák és jogorvoslatok

Példák az esetleges gyakori hibákra, a válaszkódok és a javítások az API Developers Portal(ok) oldalán találhatók:

Ráadás- https://developer.wfmplatform.com/

## GYAKORI KÉRDÉSEK

Kapcsolat létrehozása

Az összekötő a következő hitelesítési típusokat támogatja:


Alapértelmezett	A kapcsolat létrehozásának paraméterei.	Minden régió	Nem osztható meg

Alapértelmezett

Alkalmazható: Minden régió

A kapcsolat létrehozásának paraméterei.

Ez nem megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a rendszer kérni fogja, hogy hozzon létre új kapcsolatot.

Név	Típus	Description	Kötelező
API-kulcs	securestring	Az API API-kulcsa	True

Szabályozási korlátok

Name	Hívások	Megújítási időszak
API-hívások kapcsolatonként	100	60 másodperc

Műveletek

Alverzió lekérése	Az API aktuális alverzióját adja vissza.
Az előfizetés állapotának alaphelyzetbe állítása	Az előfizetés állapotát az = 1 ("Futtatás") állapotra módosítja.
Az esemény webeshook-előfizetés állapotának alaphelyzetbe állítása	Az előfizetés állapotát az = 1 ("Futtatás") állapotra módosítja.
Bináris fájl feltöltése	Ezzel a beállítással űrlapképeket és hangfájlokat tölthet fel. A bináris méret legfeljebb 10 MB lehet. A támogatott fájltípusok a következők: JPEG, PNG és MP4.
Egyetlen rekord lekérése egyéni listából	A CustomListId és az egyedi oszlopérték által talált egyéni listaadatrekordot kéri le. Hibák: 404 – Nincs egyéni listarekord a megadott customListId és egyedi oszlopérték esetében
Egyéni eseménydefiníció lekérése azonosító alapján	Egyetlen egyéni eseménydefiníciót kér le azonosító alapján.
Egyéni eseménydefiníció létrehozása vagy frissítése	Egyéni eseménydefiníciót hoz létre vagy frissít.
Egyéni eseménydefiníció törlése	Töröl egy egyéni eseménydefiníciót.
Egyéni eseménydefiníciók listájának lekérése	Lekéri az egyéni eseménydefiníciók listáját.
Egyéni listaadatok lekérése a CustomListID alapján	Egyetlen egyéni lista összes adatrekordját lekéri a CustomListID használatával. Az eredmények oszlop szerint vannak rendezve, a lapozás pedig támogatott. Hibák: 404 – nincs egyéni lista a megadott customListId azonosítóhoz.
Egyéni listadefiníciók lekérése	Beolvas egy egyéni listadefiníciós listát. A definíciós lista tartalmazza az összes meglévő egyéni lista CustomListID azonosítóját, nevét és verzióját.
Egyéni listamezők listájának lekérése a CustomListID alapján	Egyetlen egyéni lista mezőlistáját kéri le a CustomListID használatával.
Egyéni listarekord létrehozása vagy frissítése	Egyéni lista adatrekordot hoz létre vagy frissít. Az egyedi oszlop értéke kihagyható, de ha van ilyen, akkor meg kell egyeznie a lekérdezési paraméter Egyedi azonosító értékével.
Egyéni listarekord törlése	Törli a meglévő rekordot az egyéni listában a customListId és az azonosító alapján. id – az egyéni listarekord egyedi értéke. Hibák: 404 – customListId vagy id nem található.
Előfizetések listájának lekérése	Lekéri a webhook-előfizetések listáját. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát. Az eredmények automatikusan az SubscriptionId szerint vannak rendezve, növekvő sorrendben. A rendezési paraméterek nem konfigurálhatók.
Esemény elküldése	Esemény beküldése.
Események listájának lekérése	Lekéri egy adott időszakra vonatkozó események listáját. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát. Szűrés eseménytípus szerint adott események lekéréséhez. A járműeseményeket vissza lehet adni egy alkalmazottnak, ha az alkalmazott a járműhöz van társítva.
Event Web Hook-előfizetések listájának lekérése	Lekéri az event web hook-előfizetések listáját. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát. Az eredmények automatikusan az SubscriptionId szerint vannak rendezve, növekvő sorrendben. A rendezési paraméterek nem konfigurálhatók.
Felhasználó aktiválása	Aktivál egy meglévő felhasználót az azonosítója alapján.
Felhasználó egy részének frissítése	Frissíti a felhasználó tulajdonságainak egy részét.
Felhasználó frissítése	Meglévő felhasználó frissítése.
Felhasználó inaktiválása	Inaktivál egy meglévő felhasználót az azonosítója alapján.
Felhasználó lekérése	Lekéri a felhasználót az azonosítója alapján.
Felhasználó létrehozása	Új felhasználót hoz létre.
Felhasználók listájának lekérése	Lekéri a felhasználók listáját. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát. Az eredmények automatikusan a UserId szerint vannak rendezve, növekvő sorrendben. A rendezési paraméterek nem konfigurálhatók.
Feliratkozás eseményekre webes horogra	Új események webeshook-előfizetést ad hozzá. A webhookok lehetővé teszik, hogy automatikus értesítéseket kapjon a megadott URL-címen bekövetkező vállalati eseményekről.
Feliratkozás GPS-adathálóra	Új GPS Tracking-adatokat (GPS-pozíciókat) ad hozzá a webes horoghoz. A webes horgok lehetővé teszik, hogy gps-pozíciókat fogadjon egy megadott URL-címen.
Geofence létrehozása	Új geofencia létrehozása.
Geofence törlése	Egy meglévő geofencia törlése az azonosító alapján.
Geofencesek listájának lekérése	Lekéri a geofencesek listáját. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát, valamint azt is, hogy a földrajzi koordináták metrika-e. Az eredmények automatikusan név szerint és növekvő sorrendben lesznek rendezve. A rendezési paraméterek nem konfigurálhatók.
Geofencia lekérése	A földrajzi adatokat az azonosítója alapján kéri le.
GPS-adatbejegyzések lekérése	Egy megadott dátumtartomány GPS-adatbejegyzéseit kéri le. Emellett visszaad egy folytatási jogkivonatot és egy hivatkozást a következő adatrész lekéréséhez. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát. A törölt felhasználók/járművek pozíciói nem jelennek meg. Ha azonban a felhasználó/jármű az adatok lekérésekor és későbbi eltávolításakor is létezett, akkor a rendszer visszaadja a folytatási jogkivonat által kért felhasználó/jármű adatait. Az eredmények automatikusan UtcTime szerint vannak rendezve, növekvő sorrendben. A rendezési paraméterek nem konfigurálhatók.
Idő nyilvántartási bejegyzés lekérése	Beolvas egy bejegyzést az azonosítója alapján.
Időző bejegyzések listájának lekérése	A dátumtartomány alapján lekéri az időőrző bejegyzések listáját. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát. Az eredmények automatikusan a ClockInTime, majd a TimekeepingStatusId szerint, növekvő sorrendben lesznek rendezve. A rendezési paraméterek nem konfigurálhatók.
Jármű aktiválása	Jármű aktiválása azonosító alapján.
Jármű frissítése	Jármű frissítése azonosító alapján.
Jármű inaktiválása	Jármű inaktiválása azonosító alapján.
Jármű lekérése azonosító alapján	Egyetlen jármű lekérése azonosító alapján.
Jármű létrehozása	Létrehoz egy járművet.
Jármű részleges frissítése	Jármű részleges frissítése azonosító alapján.
Jármű törlése	Jármű törlése azonosító alapján.
Járművek listájának lekérése	Lekéri a járművek listáját.
LEiratkozás a GPS-adatok webes horogról	A GPS data web hook-előfizetést az azonosítója alapján törli.
Leiratkozás eseményekről webes horog	Töröl egy esemény webeshook-előfizetést az azonosítójuk alapján.
Meglévő geofencia frissítése	Frissíti a meglévő geofence azonosítóját.
Megrendelés létrehozása	Új rendelést ad hozzá.
Mellékletfájl feltöltése	Ezzel a beállítással űrlapfájl-mellékleteket tölthet fel. A bináris méret legfeljebb 25 MB lehet. Többrészes/űrlapadat-kérelem várható egyetlen fájllal.
Rendelés frissítése	Meglévő rendelés frissítése.
Rendelés lekérése	Lekéri a meglévő rendelést az azonosítója alapján.
Rendelés állapotának frissítése	Meglévő rendelési állapot módosítása.
Rendelések listájának lekérése	Lekéri a rendelések listáját a szűrők használatával az alább látható kérelemparaméterekből. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát. Az eredmények automatikusan Client.Name szerint és növekvő sorrendben vannak rendezve. A rendezési paraméterek nem konfigurálhatók.
Utazások listájának lekérése	Lekéri egy adott időszakra vonatkozó utazások listáját. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát. Az eredmények automatikusan a StartUtcTIme szerint vannak rendezve növekvő sorrendben. A rendezési paraméterek nem konfigurálhatók.
Webeshook-visszahívás események hírcsatornájával	Ezt a példametódust az események/feliratkozás az eseményadatcsatorna ügyfél által megadott URL-cím használatával történő közzétételére használják.
Webhook visszahívás GPS-adatcsatornával	Ezt a példametódust használja a gpsdata/feliratkozás a visszaküldött adatcsatornára az ügyfél által megadott URL-cím használatával.
Ügyfelek listájának lekérése	Lekéri az ügyfelek listáját. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát. Az eredmények automatikusan név szerint és növekvő sorrendben lesznek rendezve. A rendezési paraméterek nem konfigurálhatók.
Ügyfél frissítése	Meglévő ügyfél frissítése.
Ügyfél lekérése	Lekéri az ügyfélobjektumot az azonosítója alapján.
Ügyfél létrehozása	Új ügyfelet hoz létre.
Ügyfél törlése	Egy meglévő ügyfelet töröl az azonosítója alapján.
Űrlap lekérése	Lekéri az űrlapot az azonosítója alapján.
Űrlap létrehozása	Új űrlapot ad hozzá.
Űrlapok listájának lekérése	Lekéri az űrlapok listáját az alábbi kérelemparaméterek szűrőinek használatával. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát. Az eredmények automatikusan a SubmittedTime szerint vannak rendezve, csökkenő sorrendben. A rendezési paraméterek nem konfigurálhatók.

Alverzió lekérése

Műveletazonosító:: VersionController_Get

Az API aktuális alverzióját adja vissza.

Az előfizetés állapotának alaphelyzetbe állítása

Műveletazonosító:: TrackingController_ResetSubscriptionHealthStatus

Az előfizetés állapotát az = 1 ("Futtatás") állapotra módosítja.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
subscriptionId	subscriptionId	True	integer	Előfizetés azonosítója.

Az esemény webeshook-előfizetés állapotának alaphelyzetbe állítása

Műveletazonosító:: EventController_ResetSubscriptionHealthStatus

Az előfizetés állapotát az = 1 ("Futtatás") állapotra módosítja.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
subscriptionId	subscriptionId	True	integer	Előfizetés azonosítója.

Bináris fájl feltöltése

Műveletazonosító:: BinaryController_UploadBinary

Ezzel a beállítással űrlapképeket és hangfájlokat tölthet fel. A bináris méret legfeljebb 10 MB lehet. A támogatott fájltípusok a következők: JPEG, PNG és MP4.

Válaszok

Törzs: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Egyetlen rekord lekérése egyéni listából

Műveletazonosító:: CustomListController_GetSingleRecord

A CustomListId és az egyedi oszlopérték által talált egyéni listaadatrekordot kéri le.

Hibák:

404 – Nincs egyéni listarekord a megadott customListId és egyedi oszlopérték esetében

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
customListId	customListId	True	integer	Egyéni listaazonosító.
azonosító	id	True	string	Egyedi érték.

Válaszok

Egyéni listaoszlop adattömb tárolója.

Törzs: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Egyéni eseménydefiníció lekérése azonosító alapján

Műveletazonosító:: EventController_Get

Egyetlen egyéni eseménydefiníciót kér le azonosító alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	Eseménydefiníció azonosítója.

Válaszok

Egyéni eseménydefiníciós modell.

Törzs: CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Egyéni eseménydefiníció létrehozása vagy frissítése

Műveletazonosító:: EventController_Put

Egyéni eseménydefiníciót hoz létre vagy frissít.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	Eseménydefiníció azonosítója.
Név	Name		string
ReverseGeocode	ReverseGeocode		boolean
Név	Name		string
Típus	Type		integer
Felirat	Caption		string
Kötelező	Required		boolean

Egyéni eseménydefiníció törlése

Műveletazonosító:: EventController_Delete

Töröl egy egyéni eseménydefiníciót.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	Eseménydefiníció azonosítója.

Egyéni eseménydefiníciók listájának lekérése

Műveletazonosító:: EventController_GetList

Lekéri az egyéni eseménydefiníciók listáját.

Válaszok

response: array of CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Egyéni listaadatok lekérése a CustomListID alapján

Műveletazonosító:: CustomListController_GetCustomList

Egyetlen egyéni lista összes adatrekordját lekéri a CustomListID használatával.

Az eredmények oszlop szerint vannak rendezve, a lapozás pedig támogatott.

Hibák:

404 – nincs egyéni lista a megadott customListId azonosítóhoz.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
customListId	customListId	True	integer	Egyéni listaazonosító.
pageNumber	pageNumber		integer	Kezdő oldalszám.
pageSize	pageSize		integer	Oldalméret.

Válaszok

Egyéni listaoszlop adattömb tárolója.

Törzs: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Egyéni listadefiníciók lekérése

Műveletazonosító:: CustomListController_Get

Beolvas egy egyéni listadefiníciós listát. A definíciós lista tartalmazza az összes meglévő egyéni lista CustomListID azonosítóját, nevét és verzióját.

Válaszok

response: array of CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Egyéni listamezők listájának lekérése a CustomListID alapján

Műveletazonosító:: CustomListController_GetById

Egyetlen egyéni lista mezőlistáját kéri le a CustomListID használatával.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
customListId	customListId	True	integer	Egyéni listaazonosító.

Válaszok

Egyéni listamodell.

Törzs: CustomerAPI.Models.CustomLists.CustomListApiModel

Egyéni listarekord létrehozása vagy frissítése

Műveletazonosító:: CustomListController_PutRecord

Egyéni lista adatrekordot hoz létre vagy frissít. Az egyedi oszlop értéke kihagyható, de ha van ilyen, akkor meg kell egyeznie a lekérdezési paraméter Egyedi azonosító értékével.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
customListId	customListId	True	integer	Egyéni listaazonosító.
azonosító	id	True	string	Egyedi érték.
ColumnIndex	ColumnIndex		integer	Egyéni listaoszlop indexe.
Felirat	Caption		string	Egyéni listaoszlop felirata.
Érték	Value			Egyéni lista oszlopértéke.

Egyéni listarekord törlése

Műveletazonosító:: CustomListController_DeleteRecord

Törli a meglévő rekordot az egyéni listában a customListId és az azonosító alapján.

id – az egyéni listarekord egyedi értéke.

Hibák:

404 – customListId vagy id nem található.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
customListId	customListId	True	integer	Egyéni listaazonosító.
azonosító	id	True	string	Egyedi érték.

Előfizetések listájának lekérése

Műveletazonosító:: TrackingController_GetSubscriptions

Lekéri a webhook-előfizetések listáját. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát. Az eredmények automatikusan az SubscriptionId szerint vannak rendezve, növekvő sorrendben. A rendezési paraméterek nem konfigurálhatók.

Válaszok

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Esemény elküldése

Műveletazonosító:: EventController_Post

Esemény beküldése.

Paraméterek

Name	Kulcs	Típus	Description
EventDefinitionId	EventDefinitionId	string	Eseménydefiníció azonosítója.
Dolgozói Szám	EmployeeNumber	string	Alkalmazotti szám.
VehicleNumber	VehicleNumber	string	Járműszám.
DeviceSerialNumber	DeviceSerialNumber	string	GpsDeviceDto sorozatszám.
Szélesség	Latitude	double
Hosszúság	Longitude	double
Cím sor 1	AddressLine1	string	A LocationApiModel 1. címvonala.
AddressLine2	AddressLine2	string	A LocationApiModel címvonala2.
City	City	string	A LocationApiModel városa.
RégióNév	RegionName	string	A LocationApiModel régióneve.
Irányítószám	PostalCode	string	A LocationApiModel irányítószáma.
Országkód	CountryCode	string	ISO 3166-1 alpha-2 kód.
Alrégiónév	SubRegionName	string	A LocationApiModel alrégió.
Alrégiókód	SubRegionCode	string	A LocationApiModel alrégiókódja.
RegionCode	RegionCode	string	A LocationApiModel régiókódja.
Idő	Time	date-time
Paraméterek	Parameters	object	Eseményparaméterek.

Események listájának lekérése

Műveletazonosító:: EventController_GetEvents

Lekéri egy adott időszakra vonatkozó események listáját. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát.

Szűrés eseménytípus szerint adott események lekéréséhez. A járműeseményeket vissza lehet adni egy alkalmazottnak, ha az alkalmazott a járműhöz van társítva.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
fromDate	fromDate	True	date-time	Dátumtartomány kezdete.
toDate	toDate	True	date-time	Dátumtartomány vége.
employeeNumber	employeeNumber		string	Alkalmazotti szám.
vehicleNumber	vehicleNumber		string	Járműszám.
pageNumber	pageNumber		integer	Kezdő oldalszám.
pageSize	pageSize		integer	Oldalméret.
eventType	eventType		integer	Szűrés eseménytípus szerint. az alkalmazott száma meg van adva: UserEvents(0) – csak felhasználói események. VehicleEvents(1) – csak a jármű eseményei, beleértve az érzékelő eseményeket is. ExternalEvents(2) – csak külső események. a járműszám meg van adva: UserEvents(0) – N/A. VehicleEvents(1) – csak a jármű eseményei, beleértve az érzékelő eseményeket is. ExternalEvents(2) – csak külső események. Sem az alkalmazottak száma, sem a jármű száma nincs megadva: UserEvents(0) – csak felhasználói események. VehicleEvents(1) – csak a jármű eseményei, beleértve az érzékelő eseményeket is. ExternalEvents(2) – csak külső események.

Válaszok

response: array of CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Event Web Hook-előfizetések listájának lekérése

Műveletazonosító:: EventController_GetSubscriptions

Lekéri az event web hook-előfizetések listáját. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát. Az eredmények automatikusan az SubscriptionId szerint vannak rendezve, növekvő sorrendben. A rendezési paraméterek nem konfigurálhatók.

Válaszok

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Felhasználó aktiválása

Műveletazonosító:: UserController_Activate

Aktivál egy meglévő felhasználót az azonosítója alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	A külső vagy belső azonosító a use-external-id paraméter értékétől függ.
use-external-id	use-external-id		boolean	Használjon külső azonosítót vagy sem.

Felhasználó egy részének frissítése

Műveletazonosító:: UserController_PartialUpdate

Frissíti a felhasználó tulajdonságainak egy részét.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	A külső vagy belső azonosító a use-external-id paraméter értékétől függ.
			object
use-external-id	use-external-id		boolean	Használjon külső azonosítót vagy sem.

Válaszok

Törzs: CustomerAPI.Models.ReturnIdApiModel

Felhasználó frissítése

Műveletazonosító:: UserController_Update

Meglévő felhasználó frissítése.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	A külső vagy belső azonosító a use-external-id paraméter értékétől függ.
UserName	UserName		string	Felhasználó felhasználóneve.
Jelszó	Password		password	A felhasználó jelszava.
GroupName	GroupName		string	A felhasználó csoportjának neve.
Keresztnév	FirstName		string	A felhasználó utóneve.
Vezetéknév	LastName		string	A felhasználó vezetékneve.
Dolgozói Szám	EmployeeNumber		string	A felhasználó alkalmazotti száma.
Email	Email		string	A Felhasználó e-mail-címe.
Telefonszám	Phone		string	A felhasználó telefonszáma.
Szerepkörazonosító	RoleId		integer	A felhasználó szerepkörazonosítója – (Rendszergazda: 1, Felhasználó: 3, Power User: 5).
IsActive	IsActive		boolean	A felhasználó aktív állapota.
EPTTEnabled	EPTTEnabled		boolean	A továbbfejlesztett push-to-talk funkció állapota a felhasználó számára: logikai.
EPTTNumber	EPTTNumber		string	A Továbbfejlesztett leküldéses beszélgetés funkció telefonszáma a felhasználó számára: sztring.
EPTTWebMDN	EPTTWebMDN		string	A Felhasználó hitelesítéséhez használt telefonszám a Kodiak EPTT rendszerében – Kodiak által megadott.
EPTTToken	EPTTToken		string	A Felhasználó hitelesítéséhez használt API-jogkivonat a Kodiak EPTT-rendszerre – a Kodiak biztosítja.
GPSEnabled	GPSEnabled		boolean	A felhasználó GPS-funkciójának állapota.
MobileOnly	MobileOnly		boolean	A CAB asztali webalkalmazás-hozzáférésének állapota – (Nincs WebApp-hozzáférés: Igaz, Teljes alkalmazáshozzáférés: Hamis).
LicenseType	LicenseType		integer	A felhasználóhoz rendelt licenc típusa: - 0 a nem definiált, 1 a Normál, 2 a WebOnly és 3 az Alkalmazott esetében.
use-external-id	use-external-id		boolean	Használjon külső azonosítót vagy sem.

Válaszok

Törzs: CustomerAPI.Models.ReturnIdApiModel

Felhasználó inaktiválása

Műveletazonosító:: UserController_Deactivate

Inaktivál egy meglévő felhasználót az azonosítója alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	A külső vagy belső azonosító a use-external-id paraméter értékétől függ.
use-external-id	use-external-id		boolean	Használjon külső azonosítót vagy sem.

Felhasználó lekérése

Műveletazonosító:: UserController_Get

Lekéri a felhasználót az azonosítója alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	A külső vagy belső azonosító a use-external-id paraméter értékétől függ.
use-external-id	use-external-id		boolean	Használjon külső azonosítót vagy sem.

Válaszok

Törzs: CustomerAPI.Models.User.ReadUserApiModel

Felhasználó létrehozása

Műveletazonosító:: UserController_Create

Új felhasználót hoz létre.

Paraméterek

Name	Kulcs	Típus	Description
UserName	UserName	string	Felhasználó felhasználóneve.
Jelszó	Password	password	A felhasználó jelszava.
GroupName	GroupName	string	A felhasználó csoportjának neve.
Keresztnév	FirstName	string	A felhasználó utóneve.
Vezetéknév	LastName	string	A felhasználó vezetékneve.
Dolgozói Szám	EmployeeNumber	string	A felhasználó alkalmazotti száma.
Email	Email	string	A Felhasználó e-mail-címe.
Telefonszám	Phone	string	A felhasználó telefonszáma.
Szerepkörazonosító	RoleId	integer	A felhasználó szerepkörazonosítója – (Rendszergazda: 1, Felhasználó: 3, Power User: 5).
IsActive	IsActive	boolean	A felhasználó aktív állapota.
EPTTEnabled	EPTTEnabled	boolean	A továbbfejlesztett push-to-talk funkció állapota a felhasználó számára: logikai.
EPTTNumber	EPTTNumber	string	A Továbbfejlesztett leküldéses beszélgetés funkció telefonszáma a felhasználó számára: sztring.
EPTTWebMDN	EPTTWebMDN	string	A Felhasználó hitelesítéséhez használt telefonszám a Kodiak EPTT rendszerében – Kodiak által megadott.
EPTTToken	EPTTToken	string	A Felhasználó hitelesítéséhez használt API-jogkivonat a Kodiak EPTT-rendszerre – a Kodiak biztosítja.
GPSEnabled	GPSEnabled	boolean	A felhasználó GPS-funkciójának állapota.
MobileOnly	MobileOnly	boolean	A CAB asztali webalkalmazás-hozzáférésének állapota – (Nincs WebApp-hozzáférés: Igaz, Teljes alkalmazáshozzáférés: Hamis).
LicenseType	LicenseType	integer	A felhasználóhoz rendelt licenc típusa: - 0 a nem definiált, 1 a Normál, 2 a WebOnly és 3 az Alkalmazott esetében.

Válaszok

Törzs: CustomerAPI.Models.ReturnIdApiModel

Felhasználók listájának lekérése

Műveletazonosító:: UserController_GetUsers

Lekéri a felhasználók listáját. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát. Az eredmények automatikusan a UserId szerint vannak rendezve, növekvő sorrendben. A rendezési paraméterek nem konfigurálhatók.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
pageNumber	pageNumber		integer	Kezdő oldalszám. Az alapértelmezett érték 1.
pageSize	pageSize		integer	Oldalméret. Az alapértelmezett érték 500.

Válaszok

response: array of CustomerAPI.Models.User.ReadUserListItemApiModel

Feliratkozás eseményekre webes horogra

Műveletazonosító:: EventController_SubscribeToEventDataFeed

Új események webeshook-előfizetést ad hozzá. A webhookok lehetővé teszik, hogy automatikus értesítéseket kapjon a megadott URL-címen bekövetkező vállalati eseményekről.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
URL vagy webcím	Url		string	A WebHookSubscriptionParamsApiModel címet tartalmazó URL-cím.
SecurityToken	SecurityToken		string	Ehhez a WebHookSubscriptionParamsApiModelhez társított biztonsági jogkivonat.

Válaszok

Törzs: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Feliratkozás GPS-adathálóra

Műveletazonosító:: TrackingController_SubscribeToGpsDataFeed

Új GPS Tracking-adatokat (GPS-pozíciókat) ad hozzá a webes horoghoz. A webes horgok lehetővé teszik, hogy gps-pozíciókat fogadjon egy megadott URL-címen.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
URL vagy webcím	Url		string	A WebHookSubscriptionParamsApiModel címet tartalmazó URL-cím.
SecurityToken	SecurityToken		string	Ehhez a WebHookSubscriptionParamsApiModelhez társított biztonsági jogkivonat.

Válaszok

Törzs: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Geofence létrehozása

Műveletazonosító:: GeofenceController_CreateGeofence

Új geofencia létrehozása.

Paraméterek

Name	Kulcs	Típus	Description
GroupNames	GroupNames	array of string	A GeofenceCreateApiModel csoportpathjai.
Szélesség	Latitude	double
Hosszúság	Longitude	double
Név	Name	string	A GeofenceApiModelBase neve.
Típus	Type	string	A GeofenceApiModel típusa.
Shape	Shape	integer	Alakzat: 0 a körhöz, 1 a sokszög.
Szélesség	Latitude	double
Hosszúság	Longitude	double
Cím sor 1	AddressLine1	string	A LocationApiModel 1. címvonala.
AddressLine2	AddressLine2	string	A LocationApiModel címvonala2.
City	City	string	A LocationApiModel városa.
RégióNév	RegionName	string	A LocationApiModel régióneve.
Irányítószám	PostalCode	string	A LocationApiModel irányítószáma.
Országkód	CountryCode	string	ISO 3166-1 alpha-2 kód.
Alrégiónév	SubRegionName	string	A LocationApiModel alrégió.
Alrégiókód	SubRegionCode	string	A LocationApiModel alrégiókódja.
RegionCode	RegionCode	string	A LocationApiModel régiókódja.
Orsócsont	Radius	double	A GeofenceApiModel sugara.
UseGeofenceAddress	UseGeofenceAddress	boolean	A GeofenceApiModel useGeofenceAddress parancsa.
useMetric	useMetric	boolean	Használjon metrikarendszert vagy sem.
geokód	geocode	boolean	A címnek geokódoltnak kell lennie, vagy nem.

Válaszok

Törzs: CustomerAPI.Models.ReturnIdApiModel

Geofence törlése

Műveletazonosító:: GeofenceController_DeleteGeofence

Egy meglévő geofencia törlése az azonosító alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	integer	Geofence-azonosító.

Geofencesek listájának lekérése

Műveletazonosító:: GeofenceController_GetGeofences

Lekéri a geofencesek listáját. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát, valamint azt is, hogy a földrajzi koordináták metrika-e. Az eredmények automatikusan név szerint és növekvő sorrendben lesznek rendezve. A rendezési paraméterek nem konfigurálhatók.

Paraméterek

Name	Kulcs	Típus	Description
pageNumber	pageNumber	integer	Kezdő oldalszám. Az alapértelmezett érték 1.
pageSize	pageSize	integer	Oldalméret. Az alapértelmezett érték 500.
useMetric	useMetric	boolean	Használjon metrikarendszert vagy sem.

Válaszok

response: array of CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Geofencia lekérése

Műveletazonosító:: GeofenceController_GetGeofence

A földrajzi adatokat az azonosítója alapján kéri le.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	integer	Geofence-azonosító.
useMetric	useMetric		boolean	Használjon metrikarendszert vagy sem.

Válaszok

Törzs: CustomerAPI.Models.Geofence.GeofenceApiModel

GPS-adatbejegyzések lekérése

Műveletazonosító:: TrackingController_GetGpsData

Egy megadott dátumtartomány GPS-adatbejegyzéseit kéri le. Emellett visszaad egy folytatási jogkivonatot és egy hivatkozást a következő adatrész lekéréséhez. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát.

A törölt felhasználók/járművek pozíciói nem jelennek meg. Ha azonban a felhasználó/jármű az adatok lekérésekor és későbbi eltávolításakor is létezett, akkor a rendszer visszaadja a folytatási jogkivonat által kért felhasználó/jármű adatait.

Az eredmények automatikusan UtcTime szerint vannak rendezve, növekvő sorrendben. A rendezési paraméterek nem konfigurálhatók.

Paraméterek

Name	Kulcs	Típus	Description
fromDate	fromDate	date-time	Dátumtartomány kezdete. Javaslat: Kis dátumtartományok helyett használjon nagy dátumtartományokat (>=4 óra).
toDate	toDate	date-time	Dátumtartomány vége. Javaslat: Kis dátumtartományok helyett használjon nagy dátumtartományokat (>=4 óra).
employeeNumber	employeeNumber	string	Alkalmazotti szám.
Vin	vin	string	A jármű VIN-száma.
useMetric	useMetric	boolean	Használjon metrikarendszert vagy sem.
kód	token	string	Az első hívás által visszaadott folytatási jogkivonatot az egymást követő hívásban kell használni.

Válaszok

Törzs: CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Idő nyilvántartási bejegyzés lekérése

Műveletazonosító:: TimekeepingController_GetTimekeepingEntryAsync

Beolvas egy bejegyzést az azonosítója alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	A rekord azonosítója.

Válaszok

Törzs: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Időző bejegyzések listájának lekérése

Műveletazonosító:: TimekeepingController_GetTimekeepingDataList

A dátumtartomány alapján lekéri az időőrző bejegyzések listáját. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát. Az eredmények automatikusan a ClockInTime, majd a TimekeepingStatusId szerint, növekvő sorrendben lesznek rendezve. A rendezési paraméterek nem konfigurálhatók.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
fromDate	fromDate	True	date-time	Kezdési dátum.
toDate	toDate	True	date-time	Befejezési dátum.
employeeNumber	employeeNumber		string	Alkalmazotti szám.
jóváhagyott	approved		boolean	Csak jóváhagyott bejegyzés szűrése.
closedOnly	closedOnly		boolean	Csak zárt bejegyzés szűrése.
excludeFormData	excludeFormData		boolean	Szűrjön az űrlapadatok kizárására.
pageNumber	pageNumber		integer	Kezdő oldalszám (alapértelmezett 1).
pageSize	pageSize		integer	Oldalméret (alapértelmezett 1000).

Válaszok

response: array of CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Jármű aktiválása

Műveletazonosító:: VehicleController_Activate

Jármű aktiválása azonosító alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	A külső vagy belső azonosító a use-external-id paraméter értékétől függ.
use-external-id	use-external-id		boolean	Használjon külső azonosítót vagy sem.

Válaszok

response: integer

Jármű frissítése

Műveletazonosító:: VehicleController_UpdateVehicle

Jármű frissítése azonosító alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	A külső vagy belső azonosító a use-external-id paraméter értékétől függ.
Szám	Number		string
Név	Name		string
Típus	Type		string
Tag	Tag		string
UserEmployeeNumber	UserEmployeeNumber		string
GroupName	GroupName		string
TimeZone	TimeZone		string
Csinál	Make		string
Év	Year		integer
Model	Model		string
Szín	Color		string
VIN	VIN		string
IsActive	IsActive		boolean
Eszköztípus	DeviceType		integer
DeviceSerialNumber	DeviceSerialNumber		string
use-external-id	use-external-id		boolean	Használjon külső azonosítót vagy sem.

Válaszok

response: integer

Jármű inaktiválása

Műveletazonosító:: VehicleController_Deactivate

Jármű inaktiválása azonosító alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	A külső vagy belső azonosító a use-external-id paraméter értékétől függ.
use-external-id	use-external-id		boolean	Használjon külső azonosítót vagy sem.

Válaszok

response: integer

Jármű lekérése azonosító alapján

Műveletazonosító:: VehicleController_GetVehicle

Egyetlen jármű lekérése azonosító alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	A külső vagy belső azonosító a use-external-id paraméter értékétől függ.
use-external-id	use-external-id		boolean	Használjon külső azonosítót vagy sem.

Válaszok

Járműadat-modell.

Törzs: CustomerAPI.Models.Vehicles.VehicleReadApi

Jármű létrehozása

Műveletazonosító:: VehicleController_CreateVehicle

Létrehoz egy járművet.

Paraméterek

Name	Kulcs	Típus
Szám	Number	string
Név	Name	string
Típus	Type	string
Tag	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
TimeZone	TimeZone	string
Csinál	Make	string
Év	Year	integer
Model	Model	string
Szín	Color	string
VIN	VIN	string
IsActive	IsActive	boolean
Eszköztípus	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

Válaszok

Törzs: CustomerAPI.Models.ReturnIdApiModel

Jármű részleges frissítése

Műveletazonosító:: VehicleController_PartialUpdateVehicle

Jármű részleges frissítése azonosító alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	A külső vagy belső azonosító a use-external-id paraméter értékétől függ.
			object
use-external-id	use-external-id		boolean	Használjon külső azonosítót vagy sem.

Válaszok

Törzs: CustomerAPI.Models.ReturnIdApiModel

Jármű törlése

Műveletazonosító:: VehicleController_Delete

Jármű törlése azonosító alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	A külső vagy belső azonosító a use-external-id paraméter értékétől függ.
use-external-id	use-external-id		boolean	Használjon külső azonosítót vagy sem.

Járművek listájának lekérése

Műveletazonosító:: VehicleController_GetVehicles

Lekéri a járművek listáját.

Paraméterek

Name	Kulcs	Típus	Description
pageNumber	pageNumber	integer	Oldalszám.
pageSize	pageSize	integer	Az oldal elemeinek maximális száma. Alapértelmezett = 1000. Maximális érték = 2000.
activeOnly	activeOnly	boolean	ha igaz - csak aktív járműveket ad vissza. Alapértelmezett érték = hamis.

Válaszok

response: array of CustomerAPI.Models.Vehicles.VehicleReadApi

LEiratkozás a GPS-adatok webes horogról

Műveletazonosító:: TrackingController_RemoveGpsDataFeedSubscription

A GPS data web hook-előfizetést az azonosítója alapján törli.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
subscriptionId	subscriptionId	True	string	Törölni kívánt előfizetés-azonosító.

Leiratkozás eseményekről webes horog

Műveletazonosító:: EventController_RemoveEventDataFeedSubscription

Töröl egy esemény webeshook-előfizetést az azonosítójuk alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
subscriptionId	subscriptionId	True	string	Törölni kívánt előfizetés-azonosító.

Meglévő geofencia frissítése

Műveletazonosító:: GeofenceController_UpdateGeofence

Frissíti a meglévő geofence azonosítóját.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	integer	Geofence-azonosító.
GroupNames	GroupNames		array of string	A GeofenceUpdateApiModel csoportpathjai.
Szélesség	Latitude		double
Hosszúság	Longitude		double
Név	Name		string	A GeofenceApiModelBase neve.
Típus	Type		string	A GeofenceApiModel típusa.
Shape	Shape		integer	Alakzat: 0 a körhöz, 1 a sokszög.
Szélesség	Latitude		double
Hosszúság	Longitude		double
Cím sor 1	AddressLine1		string	A LocationApiModel 1. címvonala.
AddressLine2	AddressLine2		string	A LocationApiModel címvonala2.
City	City		string	A LocationApiModel városa.
RégióNév	RegionName		string	A LocationApiModel régióneve.
Irányítószám	PostalCode		string	A LocationApiModel irányítószáma.
Országkód	CountryCode		string	ISO 3166-1 alpha-2 kód.
Alrégiónév	SubRegionName		string	A LocationApiModel alrégió.
Alrégiókód	SubRegionCode		string	A LocationApiModel alrégiókódja.
RegionCode	RegionCode		string	A LocationApiModel régiókódja.
Orsócsont	Radius		double	A GeofenceApiModel sugara.
UseGeofenceAddress	UseGeofenceAddress		boolean	A GeofenceApiModel useGeofenceAddress parancsa.
useMetric	useMetric		boolean	Használjon metrikarendszert vagy sem.
geokód	geocode		boolean	A címnek geokódoltnak kell lennie, vagy nem.

Válaszok

Törzs: CustomerAPI.Models.ReturnIdApiModel

Megrendelés létrehozása

Műveletazonosító:: OrderController_Create

Új rendelést ad hozzá.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
LétrehozásDátumIdő	CreatedDateTime		date-time	Ez a CreateUpdateOrderApiModel létrehozása időpontban történt.
ExternalClientId	ExternalClientId	True	string	Az ügyfél – API-bővítmény tulajdonság külső használati azonosítója.
ServiceType	ServiceType	True	string	Ehhez a CreateUpdateOrderApiModelhez társított szolgáltatástípus.
ExternalOrderId	ExternalOrderId		string	Az ügyfél – API-bővítmény tulajdonság külső használati orderId azonosítója.
Szélesség	Latitude		double
Hosszúság	Longitude		double
Cím sor 1	AddressLine1		string	A LocationApiModel 1. címvonala.
AddressLine2	AddressLine2		string	A LocationApiModel címvonala2.
City	City		string	A LocationApiModel városa.
RégióNév	RegionName		string	A LocationApiModel régióneve.
Irányítószám	PostalCode		string	A LocationApiModel irányítószáma.
Országkód	CountryCode		string	ISO 3166-1 alpha-2 kód.
Alrégiónév	SubRegionName		string	A LocationApiModel alrégió.
Alrégiókód	SubRegionCode		string	A LocationApiModel alrégiókódja.
RegionCode	RegionCode		string	A LocationApiModel régiókódja.
Név	Name		string	A ContactApiModel neve.
Telefonszám	PhoneNumber		string	A ContactApiModel PhoneNumber értéke.
Email	Email		string	A ContactApiModel e-mail címe.
Esedékesség dátuma	DueDate		date-time	Ez a BaseUpdateOrderApiModel időpontban esedékes a befejezéshez (elavult az 1.3-ban).
StartTime	StartTime		date-time	Ennek a BaseUpdateOrderApiModel-nek el kell indulnia (az 1.3-ban bevezetett).
Befejezési idő	EndTime		date-time	Ennek a BaseUpdateOrderApiModel-nek véget kell vetnie (az 1.3-ban bevezetett).
Felirat	Caption	True	string
Érték	Value			Az UpdateFormFieldApiModel értéke. "NFC" mezőérték formátuma: { "Type": number, // 0 - Text "Payload": object, // A type = 0 } szövegnek kell lennie "Camera" mező értékformátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) "Megjegyzés": sztring // Megjegyzés a hivatkozott képhez } "Signature" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) } "Audio" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött hang bináris azonosítója (lásd a bináris API feltöltését) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	A rendszer rögzítette a pont időértékét.
Szélesség	Latitude		double
Hosszúság	Longitude		double
Cím sor 1	AddressLine1		string	A LocationApiModel 1. címvonala.
AddressLine2	AddressLine2		string	A LocationApiModel címvonala2.
City	City		string	A LocationApiModel városa.
RégióNév	RegionName		string	A LocationApiModel régióneve.
Irányítószám	PostalCode		string	A LocationApiModel irányítószáma.
Országkód	CountryCode		string	ISO 3166-1 alpha-2 kód.
Alrégiónév	SubRegionName		string	A LocationApiModel alrégió.
Alrégiókód	SubRegionCode		string	A LocationApiModel alrégiókódja.
RegionCode	RegionCode		string	A LocationApiModel régiókódja.
Felirat	Caption	True	string
Érték	Value			Az UpdateFormFieldApiModel értéke. "NFC" mezőérték formátuma: { "Type": number, // 0 - Text "Payload": object, // A type = 0 } szövegnek kell lennie "Camera" mező értékformátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) "Megjegyzés": sztring // Megjegyzés a hivatkozott képhez } "Signature" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) } "Audio" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött hang bináris azonosítója (lásd a bináris API feltöltését) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	A rendszer rögzítette a pont időértékét.
Dolgozói Szám	EmployeeNumber	True	string	A NewOrderStatusApiModel-t létrehozó felhasználó EmployeeNumber értéke.
StatusLabel	StatusLabel	True	string	Címkézze a NewOrderStatusApiModelhez társított StatusLabel-tartalmat.
StatusStartDateTime	StatusStartDateTime	True	date-time	Ez a NewOrderStatusApiModel állapot elindult.
Felirat	Caption	True	string
Érték	Value			Az UpdateFormFieldApiModel értéke. "NFC" mezőérték formátuma: { "Type": number, // 0 - Text "Payload": object, // A type = 0 } szövegnek kell lennie "Camera" mező értékformátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) "Megjegyzés": sztring // Megjegyzés a hivatkozott képhez } "Signature" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) } "Audio" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött hang bináris azonosítója (lásd a bináris API feltöltését) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	A rendszer rögzítette a pont időértékét.
Szélesség	Latitude		double
Hosszúság	Longitude		double
Cím sor 1	AddressLine1		string	A LocationApiModel 1. címvonala.
AddressLine2	AddressLine2		string	A LocationApiModel címvonala2.
City	City		string	A LocationApiModel városa.
RégióNév	RegionName		string	A LocationApiModel régióneve.
Irányítószám	PostalCode		string	A LocationApiModel irányítószáma.
Országkód	CountryCode		string	ISO 3166-1 alpha-2 kód.
Alrégiónév	SubRegionName		string	A LocationApiModel alrégió.
Alrégiókód	SubRegionCode		string	A LocationApiModel alrégiókódja.
RegionCode	RegionCode		string	A LocationApiModel régiókódja.
Felirat	Caption	True	string
Érték	Value			Az UpdateFormFieldApiModel értéke. "NFC" mezőérték formátuma: { "Type": number, // 0 - Text "Payload": object, // A type = 0 } szövegnek kell lennie "Camera" mező értékformátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) "Megjegyzés": sztring // Megjegyzés a hivatkozott képhez } "Signature" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) } "Audio" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött hang bináris azonosítója (lásd a bináris API feltöltését) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	A rendszer rögzítette a pont időértékét.
FieldIndex	FieldIndex		integer	Mezőindex.
Érték	Value			Mezőérték.
geokód	geocode		boolean	A címnek geokódoltnak kell lennie, vagy nem.

Válaszok

Törzs: CustomerAPI.Models.ReturnIdApiModel

Mellékletfájl feltöltése

Műveletazonosító:: BinaryController_UploadAttachment

Ezzel a beállítással űrlapfájl-mellékleteket tölthet fel. A bináris méret legfeljebb 25 MB lehet. Többrészes/űrlapadat-kérelem várható egyetlen fájllal.

Válaszok

Törzs: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Rendelés frissítése

Műveletazonosító:: OrderController_Update

Meglévő rendelés frissítése.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	A külső vagy belső azonosító a use-external-id paraméter értékétől függ.
ExternalOrderId	ExternalOrderId		string	Az ügyfél – API-bővítmény tulajdonság külső használati orderId azonosítója.
IsClosed	IsClosed		boolean	Az UpdateOrderApiModel bezárásakor megjelenő állapot.
Szélesség	Latitude		double
Hosszúság	Longitude		double
Cím sor 1	AddressLine1		string	A LocationApiModel 1. címvonala.
AddressLine2	AddressLine2		string	A LocationApiModel címvonala2.
City	City		string	A LocationApiModel városa.
RégióNév	RegionName		string	A LocationApiModel régióneve.
Irányítószám	PostalCode		string	A LocationApiModel irányítószáma.
Országkód	CountryCode		string	ISO 3166-1 alpha-2 kód.
Alrégiónév	SubRegionName		string	A LocationApiModel alrégió.
Alrégiókód	SubRegionCode		string	A LocationApiModel alrégiókódja.
RegionCode	RegionCode		string	A LocationApiModel régiókódja.
Név	Name		string	A ContactApiModel neve.
Telefonszám	PhoneNumber		string	A ContactApiModel PhoneNumber értéke.
Email	Email		string	A ContactApiModel e-mail címe.
Esedékesség dátuma	DueDate		date-time	Ez a BaseUpdateOrderApiModel időpontban esedékes a befejezéshez (elavult az 1.3-ban).
StartTime	StartTime		date-time	Ennek a BaseUpdateOrderApiModel-nek el kell indulnia (az 1.3-ban bevezetett).
Befejezési idő	EndTime		date-time	Ennek a BaseUpdateOrderApiModel-nek véget kell vetnie (az 1.3-ban bevezetett).
Felirat	Caption	True	string
Érték	Value			Az UpdateFormFieldApiModel értéke. "NFC" mezőérték formátuma: { "Type": number, // 0 - Text "Payload": object, // A type = 0 } szövegnek kell lennie "Camera" mező értékformátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) "Megjegyzés": sztring // Megjegyzés a hivatkozott képhez } "Signature" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) } "Audio" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött hang bináris azonosítója (lásd a bináris API feltöltését) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	A rendszer rögzítette a pont időértékét.
Szélesség	Latitude		double
Hosszúság	Longitude		double
Cím sor 1	AddressLine1		string	A LocationApiModel 1. címvonala.
AddressLine2	AddressLine2		string	A LocationApiModel címvonala2.
City	City		string	A LocationApiModel városa.
RégióNév	RegionName		string	A LocationApiModel régióneve.
Irányítószám	PostalCode		string	A LocationApiModel irányítószáma.
Országkód	CountryCode		string	ISO 3166-1 alpha-2 kód.
Alrégiónév	SubRegionName		string	A LocationApiModel alrégió.
Alrégiókód	SubRegionCode		string	A LocationApiModel alrégiókódja.
RegionCode	RegionCode		string	A LocationApiModel régiókódja.
Felirat	Caption	True	string
Érték	Value			Az UpdateFormFieldApiModel értéke. "NFC" mezőérték formátuma: { "Type": number, // 0 - Text "Payload": object, // A type = 0 } szövegnek kell lennie "Camera" mező értékformátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) "Megjegyzés": sztring // Megjegyzés a hivatkozott képhez } "Signature" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) } "Audio" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött hang bináris azonosítója (lásd a bináris API feltöltését) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	A rendszer rögzítette a pont időértékét.
Dolgozói Szám	EmployeeNumber	True	string	A NewOrderStatusApiModel-t létrehozó felhasználó EmployeeNumber értéke.
StatusLabel	StatusLabel	True	string	Címkézze a NewOrderStatusApiModelhez társított StatusLabel-tartalmat.
StatusStartDateTime	StatusStartDateTime	True	date-time	Ez a NewOrderStatusApiModel állapot elindult.
Felirat	Caption	True	string
Érték	Value			Az UpdateFormFieldApiModel értéke. "NFC" mezőérték formátuma: { "Type": number, // 0 - Text "Payload": object, // A type = 0 } szövegnek kell lennie "Camera" mező értékformátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) "Megjegyzés": sztring // Megjegyzés a hivatkozott képhez } "Signature" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) } "Audio" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött hang bináris azonosítója (lásd a bináris API feltöltését) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	A rendszer rögzítette a pont időértékét.
Szélesség	Latitude		double
Hosszúság	Longitude		double
Cím sor 1	AddressLine1		string	A LocationApiModel 1. címvonala.
AddressLine2	AddressLine2		string	A LocationApiModel címvonala2.
City	City		string	A LocationApiModel városa.
RégióNév	RegionName		string	A LocationApiModel régióneve.
Irányítószám	PostalCode		string	A LocationApiModel irányítószáma.
Országkód	CountryCode		string	ISO 3166-1 alpha-2 kód.
Alrégiónév	SubRegionName		string	A LocationApiModel alrégió.
Alrégiókód	SubRegionCode		string	A LocationApiModel alrégiókódja.
RegionCode	RegionCode		string	A LocationApiModel régiókódja.
Felirat	Caption	True	string
Érték	Value			Az UpdateFormFieldApiModel értéke. "NFC" mezőérték formátuma: { "Type": number, // 0 - Text "Payload": object, // A type = 0 } szövegnek kell lennie "Camera" mező értékformátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) "Megjegyzés": sztring // Megjegyzés a hivatkozott képhez } "Signature" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) } "Audio" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött hang bináris azonosítója (lásd a bináris API feltöltését) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	A rendszer rögzítette a pont időértékét.
FieldIndex	FieldIndex		integer	Mezőindex.
Érték	Value			Mezőérték.
geokód	geocode		boolean	A címnek geokódoltnak kell lennie, vagy nem.
use-external-id	use-external-id		boolean	Használjon külső azonosítót vagy sem.

Válaszok

Törzs: CustomerAPI.Models.ReturnIdApiModel

Rendelés lekérése

Műveletazonosító:: OrderController_GetOrder

Lekéri a meglévő rendelést az azonosítója alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	A külső vagy belső azonosító a use-external-id paraméter értékétől függ.
include-status-history	include-status-history		string	Ha igaz, a válasz tartalmazza a rendelés összes állapotelőzményét és űrlapadatait.
use-external-id	use-external-id		boolean	Használjon külső azonosítót vagy sem.

Válaszok

Törzs: CustomerAPI.Models.Order.OrderApiModel

Rendelés állapotának frissítése

Műveletazonosító:: OrderController_ChangeStatus

Meglévő rendelési állapot módosítása.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	A külső vagy belső azonosító a use-external-id paraméter értékétől függ.
Dolgozói Szám	EmployeeNumber	True	string	A NewOrderStatusApiModel-t létrehozó felhasználó EmployeeNumber értéke.
StatusLabel	StatusLabel	True	string	Címkézze a NewOrderStatusApiModelhez társított StatusLabel-tartalmat.
StatusStartDateTime	StatusStartDateTime	True	date-time	Ez a NewOrderStatusApiModel állapot elindult.
Felirat	Caption	True	string
Érték	Value			Az UpdateFormFieldApiModel értéke. "NFC" mezőérték formátuma: { "Type": number, // 0 - Text "Payload": object, // A type = 0 } szövegnek kell lennie "Camera" mező értékformátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) "Megjegyzés": sztring // Megjegyzés a hivatkozott képhez } "Signature" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) } "Audio" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött hang bináris azonosítója (lásd a bináris API feltöltését) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	A rendszer rögzítette a pont időértékét.
Szélesség	Latitude		double
Hosszúság	Longitude		double
Cím sor 1	AddressLine1		string	A LocationApiModel 1. címvonala.
AddressLine2	AddressLine2		string	A LocationApiModel címvonala2.
City	City		string	A LocationApiModel városa.
RégióNév	RegionName		string	A LocationApiModel régióneve.
Irányítószám	PostalCode		string	A LocationApiModel irányítószáma.
Országkód	CountryCode		string	ISO 3166-1 alpha-2 kód.
Alrégiónév	SubRegionName		string	A LocationApiModel alrégió.
Alrégiókód	SubRegionCode		string	A LocationApiModel alrégiókódja.
RegionCode	RegionCode		string	A LocationApiModel régiókódja.
Felirat	Caption	True	string
Érték	Value			Az UpdateFormFieldApiModel értéke. "NFC" mezőérték formátuma: { "Type": number, // 0 - Text "Payload": object, // A type = 0 } szövegnek kell lennie "Camera" mező értékformátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) "Megjegyzés": sztring // Megjegyzés a hivatkozott képhez } "Signature" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) } "Audio" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött hang bináris azonosítója (lásd a bináris API feltöltését) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	A rendszer rögzítette a pont időértékét.
use-external-id	use-external-id		boolean	Használjon külső azonosítót vagy sem.

Válaszok

Törzs: CustomerAPI.Models.ReturnIdApiModel

Rendelések listájának lekérése

Műveletazonosító:: OrderController_GetOrders

Lekéri a rendelések listáját a szűrők használatával az alább látható kérelemparaméterekből. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát. Az eredmények automatikusan Client.Name szerint és növekvő sorrendben vannak rendezve. A rendezési paraméterek nem konfigurálhatók.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
dueDateFrom	dueDateFrom	True	date-time	Szűrés határidő szerinti kezdési dátum szerint.
dueDateTo	dueDateTo	True	date-time	Szűrés határidő szerinti befejezési dátum szerint.
employeeNumber	employeeNumber		string	Szűrés alkalmazotti szám alapján.
pageNumber	pageNumber		integer	Kezdő oldalszám (alapértelmezett 1).
pageSize	pageSize		integer	Oldalméret (alapértelmezett 500).

Válaszok

response: array of CustomerAPI.Models.Order.OrderListItemApiModel

Utazások listájának lekérése

Műveletazonosító:: TrackingController_GetTrips

Lekéri egy adott időszakra vonatkozó utazások listáját. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát. Az eredmények automatikusan a StartUtcTIme szerint vannak rendezve növekvő sorrendben. A rendezési paraméterek nem konfigurálhatók.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
fromDate	fromDate	True	date-time	Dátumtartomány kezdete. Javaslat: Kis dátumtartományok helyett használjon nagy dátumtartományokat (>=4 óra).
toDate	toDate	True	date-time	Dátumtartomány vége. Javaslat: Kis dátumtartományok helyett használjon nagy dátumtartományokat (>=4 óra).
employeeNumber	employeeNumber		string	Alkalmazotti szám.
Vin	vin		string	A jármű VIN-száma.
pageNumber	pageNumber		integer	Kezdő oldalszám. Az alapértelmezett érték 1.
pageSize	pageSize		integer	Oldalméret. Az alapértelmezett érték 1000.
useMetric	useMetric		boolean	Használjon metrikarendszert vagy sem.

Válaszok

response: array of CustomerAPI.Models.Tracking.TripApiModel

Webeshook-visszahívás események hírcsatornájával

Műveletazonosító:: EventController_subscribe_callback

Ezt a példametódust az események/feliratkozás az eseményadatcsatorna ügyfél által megadott URL-cím használatával történő közzétételére használják.

Paraméterek

Name	Kulcs	Típus	Description
Azonosító	Id	string	A WebHookSubscriptionParamsApiModel címet tartalmazó URL-cím.
Eseménytípus	EventType	integer
EventCode	EventCode	string
EseményIdő	EventTime	date-time	ISO formátum helyi és eltolással.
DeviceId	DeviceId	string	Az előfizetéshez társított GpsDeviceDto-azonosító.
Eszköztípus	DeviceType	integer	GpsDeviceDto típus: Kézibeszélő (0), CalAmp (1), Geotab (2), Xirgo (3).
UserId	UserId	integer	Felhasználói azonosító.
VehicleId	VehicleId	integer	Járműazonosító.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Az, hogy egy felhasználó kapcsolódik-e a járműhöz.
Lat	Lat	double	Szélesség.
Lon	Lon	double	Hosszúság.
CustomEventDefinitionId	CustomEventDefinitionId	string
EventParams	EventParams	object	Eseményparaméterek.

Válaszok

response: object

Webhook visszahívás GPS-adatcsatornával

Műveletazonosító:: TrackingController_subscribe_callback

Ezt a példametódust használja a gpsdata/feliratkozás a visszaküldött adatcsatornára az ügyfél által megadott URL-cím használatával.

Paraméterek

Name	Kulcs	Típus	Description
Azonosító	Id	string	A WebHookSubscriptionParamsApiModel címet tartalmazó URL-cím.
DeviceId	DeviceId	string	Az előfizetéshez társított GpsDeviceDto-azonosító.
Eszköztípus	DeviceType	integer	GpsDeviceDto típus: Kézibeszélő(0), CalAmp(1), Geotab (2), Xirgo (3).
Időbélyeg	Timestamp	date-time	ISO formátum helyi és eltolással.
Cégazonosító	CompanyId	integer	Cégazonosító.
UserId	UserId	integer	Felhasználói azonosító.
VehicleId	VehicleId	integer	Járműazonosító.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Az, hogy egy felhasználó kapcsolódik-e a járműhöz.
LocationProvider	LocationProvider	string	Helyszolgáltató neve.
Lat	Lat	double	Szélesség.
Lon	Lon	double	Hosszúság.
PontosságFt	AccuracyFt	double	Pozíció pontossága (láb).
AltitudeFt	AltitudeFt	double	Magasság (láb).
Heading	Heading	integer	Iránytű fokban.
SpeedMph	SpeedMph	double	Mozgás sebessége (Mph).
BatteryStatus	BatteryStatus	integer	Akkumulátor állapota: Nincs töltés(0), Töltés(1).
Akkumulátorszint	BatteryLevel	integer	Az akkumulátor töltöttségi szintje százalékban.
ActivityState	ActivityState	integer	Tevékenység állapota: Marad(1), Modving(2).
IsNetworkConnected	IsNetworkConnected	boolean	Az eszköz jelenleg csatlakozik a hálózathoz.
Rssi	Rssi	integer	Kapott jelerősség-jelző.
DOdoMl	DOdoMl	double	GpsDeviceDto odometer (Miles).
VOdoMl	VOdoMl	double	Jármű-kilométer-számláló (Mérföld).

Válaszok

response: object

Ügyfelek listájának lekérése

Műveletazonosító:: ClientController_GetClients

Lekéri az ügyfelek listáját. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát. Az eredmények automatikusan név szerint és növekvő sorrendben lesznek rendezve. A rendezési paraméterek nem konfigurálhatók.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
pageNumber	pageNumber		integer	Kezdő oldalszám.
pageSize	pageSize		integer	Oldalméret.

Válaszok

response: array of CustomerAPI.Models.Client.ReadClientApiModel

Ügyfél frissítése

Műveletazonosító:: ClientController_Update

Meglévő ügyfél frissítése.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	A külső vagy belső azonosító a use-external-id paraméter értékétől függ.
ExternalId	ExternalId		string	Az ügyfél – API-bővítmény tulajdonság külső használati azonosítója.
FieldIndex	FieldIndex		integer	Mezőindex.
Érték	Value			Mezőérték.
Név	Name		string	Az ügyfél neve.
Szélesség	Latitude		double
Hosszúság	Longitude		double
Cím sor 1	AddressLine1		string	A LocationApiModel 1. címvonala.
AddressLine2	AddressLine2		string	A LocationApiModel címvonala2.
City	City		string	A LocationApiModel városa.
RégióNév	RegionName		string	A LocationApiModel régióneve.
Irányítószám	PostalCode		string	A LocationApiModel irányítószáma.
Országkód	CountryCode		string	ISO 3166-1 alpha-2 kód.
Alrégiónév	SubRegionName		string	A LocationApiModel alrégió.
Alrégiókód	SubRegionCode		string	A LocationApiModel alrégiókódja.
RegionCode	RegionCode		string	A LocationApiModel régiókódja.
Név	Name		string	A ContactApiModel neve.
Telefonszám	PhoneNumber		string	A ContactApiModel PhoneNumber értéke.
Email	Email		string	A ContactApiModel e-mail címe.
geokód	geocode		boolean	A címnek geokódoltnak kell lennie, vagy nem.
use-external-id	use-external-id		boolean	Használjon külső azonosítót vagy sem.

Válaszok

Törzs: CustomerAPI.Models.ReturnIdApiModel

Ügyfél lekérése

Műveletazonosító:: ClientController_Get

Lekéri az ügyfélobjektumot az azonosítója alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	Ügyfélazonosító.
use-external-id	use-external-id		boolean	Használjon külső azonosítót vagy sem.

Válaszok

Törzs: CustomerAPI.Models.Client.ReadClientApiModel

Ügyfél létrehozása

Műveletazonosító:: ClientController_Create

Új ügyfelet hoz létre.

Paraméterek

Name	Kulcs	Típus	Description
ExternalId	ExternalId	string	Az ügyfél – API-bővítmény tulajdonság külső használati azonosítója.
FieldIndex	FieldIndex	integer	Mezőindex.
Érték	Value		Mezőérték.
Név	Name	string	Az ügyfél neve.
Szélesség	Latitude	double
Hosszúság	Longitude	double
Cím sor 1	AddressLine1	string	A LocationApiModel 1. címvonala.
AddressLine2	AddressLine2	string	A LocationApiModel címvonala2.
City	City	string	A LocationApiModel városa.
RégióNév	RegionName	string	A LocationApiModel régióneve.
Irányítószám	PostalCode	string	A LocationApiModel irányítószáma.
Országkód	CountryCode	string	ISO 3166-1 alpha-2 kód.
Alrégiónév	SubRegionName	string	A LocationApiModel alrégió.
Alrégiókód	SubRegionCode	string	A LocationApiModel alrégiókódja.
RegionCode	RegionCode	string	A LocationApiModel régiókódja.
Név	Name	string	A ContactApiModel neve.
Telefonszám	PhoneNumber	string	A ContactApiModel PhoneNumber értéke.
Email	Email	string	A ContactApiModel e-mail címe.
geokód	geocode	boolean	A címnek geokódoltnak kell lennie, vagy nem.

Válaszok

Törzs: CustomerAPI.Models.ReturnIdApiModel

Ügyfél törlése

Műveletazonosító:: ClientController_Delete

Egy meglévő ügyfelet töröl az azonosítója alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	string	Ügyfélazonosító.
use-external-id	use-external-id		boolean	Használjon külső azonosítót vagy sem.

Űrlap lekérése

Műveletazonosító:: FormController_GetFormAsync

Lekéri az űrlapot az azonosítója alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
azonosító	id	True	integer	Űrlapazonosító.

Válaszok

Törzs: CustomerAPI.Models.Forms.StandaloneFormApiModel

Űrlap létrehozása

Műveletazonosító:: FormController_PostFormAsync

Új űrlapot ad hozzá.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
ApiModuleId	ApiModuleId		string	Az ehhez a CreateStandaloneFormApiModel-hez társított ApiModule azonosítója.
Felülvizsgált	Reviewed		boolean	A CreateStandaloneFormApiModel felülvizsgálatának állapota.
UserId	UserId		integer	A felhasználó felhasználóazonosítója.
Dolgozói Szám	EmployeeNumber		string	A felhasználó alkalmazotti száma.
SubmittedTime	SubmittedTime	True	date-time	A CreateStandaloneFormApiModel elküldésekor megadott időpont.
Szélesség	Latitude		double
Hosszúság	Longitude		double
Cím sor 1	AddressLine1		string	A LocationApiModel 1. címvonala.
AddressLine2	AddressLine2		string	A LocationApiModel címvonala2.
City	City		string	A LocationApiModel városa.
RégióNév	RegionName		string	A LocationApiModel régióneve.
Irányítószám	PostalCode		string	A LocationApiModel irányítószáma.
Országkód	CountryCode		string	ISO 3166-1 alpha-2 kód.
Alrégiónév	SubRegionName		string	A LocationApiModel alrégió.
Alrégiókód	SubRegionCode		string	A LocationApiModel alrégiókódja.
RegionCode	RegionCode		string	A LocationApiModel régiókódja.
ApiFieldId	ApiFieldId	True	string	API-mezőazonosító.
Érték	Value	True		A FormFieldDataApiModel értéke. "NFC" mezőérték formátuma: { "Type": number, // 0 - Text "Payload": object, // A type = 0 } szövegnek kell lennie "Camera" mező értékformátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) "Megjegyzés": sztring // Megjegyzés a hivatkozott képhez } "Sign" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) } "Audio" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött hang bináris azonosítója (lásd a bináris API feltöltését) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	A bináris adatok rögzítésének időpontja. Formátum – dátum-idő (dátum-időként RFC3339), beleértve az eltolást is.
Szélesség	Latitude		double
Hosszúság	Longitude		double
Cím sor 1	AddressLine1		string	A LocationApiModel 1. címvonala.
AddressLine2	AddressLine2		string	A LocationApiModel címvonala2.
City	City		string	A LocationApiModel városa.
RégióNév	RegionName		string	A LocationApiModel régióneve.
Irányítószám	PostalCode		string	A LocationApiModel irányítószáma.
Országkód	CountryCode		string	ISO 3166-1 alpha-2 kód.
Alrégiónév	SubRegionName		string	A LocationApiModel alrégió.
Alrégiókód	SubRegionCode		string	A LocationApiModel alrégiókódja.
RegionCode	RegionCode		string	A LocationApiModel régiókódja.
ApiFieldId	ApiFieldId	True	string	API-mezőazonosító.
Érték	Value	True		A FormFieldDataApiModel értéke. "NFC" mezőérték formátuma: { "Type": number, // 0 - Text "Payload": object, // A type = 0 } szövegnek kell lennie "Camera" mező értékformátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) "Megjegyzés": sztring // Megjegyzés a hivatkozott képhez } "Sign" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring // Feltöltött kép bináris azonosítója (lásd a bináris API feltöltését) } "Audio" mezőérték formátuma (bináris hivatkozás): { "BinaryId": sztring, // Feltöltött hang bináris azonosítója (lásd a bináris API feltöltését) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	A bináris adatok rögzítésének időpontja. Formátum – dátum-idő (dátum-időként RFC3339), beleértve az eltolást is.

Válaszok

Törzs: CustomerAPI.Models.ReturnIdApiModel

Űrlapok listájának lekérése

Műveletazonosító:: FormController_GetFormsAsync

Lekéri az űrlapok listáját az alábbi kérelemparaméterek szűrőinek használatával. Megadhatja a visszaadott lapok számát és az egyes oldalak elemeinek számát. Az eredmények automatikusan a SubmittedTime szerint vannak rendezve, csökkenő sorrendben. A rendezési paraméterek nem konfigurálhatók.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
submittedStartDate	submittedStartDate	True	date-time	A beküldött űrlap kezdő dátuma.
submittedEndDate	submittedEndDate	True	date-time	A beküldött űrlap záró dátuma.
apiModuleId	apiModuleId		string	Űrlapmodul azonosítója.
employeeNumber	employeeNumber		string	Alkalmazotti szám.
Felülvizsgált	reviewed		boolean	Csak a áttekintett űrlapokat kéri le, vagy sem. Az alapértelmezett érték null mindenkinek.
pageNumber	pageNumber		integer	Kezdő oldalszám. Az alapértelmezett érték 1.
pageSize	pageSize		integer	Oldalméret. Az alapértelmezett érték 1000.

Válaszok

response: array of CustomerAPI.Models.Forms.StandaloneFormApiModel

Triggerek

Időmérési szavazás	Az Timekeeping API lekérdezési végpontja lehetővé teszi, hogy az alkalmazás folyamatosan lekérdezhesse és feldolgozhassa a legutóbb beküldött időmérő bejegyzéseket. Integráció: Ez a végpont úgy lett kialakítva, hogy a Microsoft Flow-t lekérdezési eseményindító-integrációként használják. Másik lehetőségként saját egyéni integrációt is létrehozhat bármilyen nyelv használatával. Használat: Egy tipikus forgatókönyvben a végpontra irányuló első kérés nem adhat meg paramétereket. Két (2) sikeres válasz lehetséges: HTTP-válaszkód 200 – A legutóbb elküldött időnyilvántartási rekordok léteznek; A válasz törzse megjeleníti az idő nyilvántartási bejegyzés adatait. HTTP-válaszkód 202 – Nincsenek legutóbb elküldött rekordok; válasz törzse üres lesz. Mindkét esetben két (2) fontos fejléc található a válaszban: Hely – A következő kérés URL-címe. Retry-After – A következő kéréshez javasolt időintervallum másodpercben. Ha például vannak beolvasandó adatok, a Retry-After fejléc értéke 1 vagy 60 lesz. Ha nincs beolvasandó adat, a Retry-After fejléc értéke 300 lesz. Megjegyzés: Ezek csak ajánlott értékek – az alkalmazás a követelményektől függően eltérő gyakorisággal kérdezhet le. Az első kérés után minden további kérésnek a legutóbbi válasz Hely fejlécében megadott URL-címet kell használnia. Ne adjon hozzá további paramétereket az URL-címhez, mivel már tartalmazza azokat, amelyek szükségesek ahhoz, hogy az időőrző bejegyzések ne hiányoznak a kérelemből. Az eredmények rendezése automatikusan ModifiedUtc, majd TimekeepingStatusId szerint történik, majd növekvő sorrendben. A rendezési paraméterek nem konfigurálhatók. ModifiedUtc definition: internal time tag = timekeeping status change.
Rendelések lekérdezése	Az Orders API lekérdezési végpontja lehetővé teszi, hogy az alkalmazás folyamatosan lekérdezhesse és feldolgozhassa a rendelések legutóbbi módosításait. Integráció: Ez a végpont úgy lett kialakítva, hogy a Microsoft Flow-t lekérdezési eseményindító-integrációként használják. Másik lehetőségként saját egyéni integrációt is létrehozhat bármilyen nyelv használatával. Használat: Egy tipikus forgatókönyvben a végpontra irányuló első kérés nem adhat meg paramétereket. Két (2) sikeres válasz lehetséges: HTTP-válaszkód 200 – Nemrég módosított rendelések léteznek; a válasz törzse megjeleníti a rendelési adatokat. HTTP-válaszkód 202 – Nem léteznek nemrég módosított rendelések; válasz törzse üres lesz. Mindkét esetben két (2) fontos fejléc található a válaszban: Hely – A következő kérés URL-címe. Retry-After – A következő kéréshez javasolt időintervallum másodpercben. Ha például vannak beolvasandó adatok, a Retry-After fejléc értéke 1 vagy 60 lesz. Ha nincs beolvasandó adat, a Retry-After fejléc értéke 300 lesz. Megjegyzés: Ezek csak ajánlott értékek – az alkalmazás a követelményektől függően eltérő gyakorisággal kérdezhet le. Az első kérés után minden további kérésnek a legutóbbi válasz Hely fejlécében megadott URL-címet kell használnia. Ne adjon hozzá további paramétereket az URL-címhez, mivel már tartalmazza a szükséges paramétereket annak biztosításához, hogy a rendelésmódosítások ne hiányoznak a kérelemből. Az eredmények rendezése automatikusan ModifiedUtc, majd OrderId szerint történik növekvő sorrendben. A rendezési paraméterek nem konfigurálhatók. ModifiedUtc definition: internal time tag = time of latest order data change.
Rendelési állapotok lekérdezése	Az Order Statuses API lekérdezési végpontja lehetővé teszi, hogy az alkalmazás folyamatosan lekérdezze és feldolgozhassa a rendelések legutóbbi módosításait. Integráció: Ez a végpont úgy lett kialakítva, hogy a Microsoft Flow-t lekérdezési eseményindító-integrációként használják. Másik lehetőségként saját egyéni integrációt is létrehozhat bármilyen nyelv használatával. Használat: Egy tipikus forgatókönyvben a végpontra irányuló első kérés nem adhat meg paramétereket. Két (2) sikeres válasz lehetséges: HTTP-válaszkód 200 – Nemrég módosított rendelési állapotrekordok léteznek; a válasz törzse megjeleníti a rendelés állapotadatait HTTP-válaszkód 202 – Nincsenek legutóbb elküldött rekordok; válasz törzse üres lesz. Mindkét esetben két (2) fontos fejléc található a válaszban: Hely – A következő kérés URL-címe. Retry-After – A következő kéréshez javasolt időintervallum másodpercben. Ha például vannak beolvasandó adatok, a Retry-After fejléc értéke 1 vagy 60 lesz. Ha nincs beolvasandó adat, a Retry-After fejléc értéke 300 lesz. Megjegyzés: Ezek csak ajánlott értékek – az alkalmazás a követelményektől függően eltérő gyakorisággal kérdezhet le. Az első kérés után minden további kérésnek a legutóbbi válasz Hely fejlécében megadott URL-címet kell használnia. Ne adjon hozzá további paramétereket az URL-címhez, mert már tartalmazza azokat, amelyek szükségesek ahhoz, hogy a rendelési állapotok ne hiányoznak a kérelemből. Az eredményeket az ModifiedUtc, majd a StatusId rendezi növekvő sorrendben. A rendezési paraméterek nem konfigurálhatók. ModifiedUtc definition: internal time tag = time of latest order status data change.
Űrlapadatok lekérdezése	A Forms API lekérdezési végpontja lehetővé teszi, hogy az alkalmazás folyamatosan lekérdezhesse és feldolgozhassa a nemrég beküldött különálló űrlapokat. Integráció: Ez a végpont úgy lett kialakítva, hogy a Microsoft Flow-t lekérdezési eseményindító-integrációként használják. Másik lehetőségként saját egyéni integrációt is létrehozhat bármilyen nyelv használatával. Használat: Egy tipikus forgatókönyvben a végpontra irányuló első kérés nem adhat meg paramétereket. Két (2) sikeres válasz lehetséges: HTTP-válaszkód 200 – A legutóbb elküldött űrlaprekordok léteznek; a válasz törzse űrlapadatokat jelenít meg. HTTP-válaszkód 202 – Nincsenek legutóbb elküldött rekordok; válasz törzse üres lesz. Mindkét esetben két (2) fontos fejléc található a válaszban: Hely – A következő kérés URL-címe. Retry-After – A következő kéréshez javasolt időintervallum másodpercben. Ha például vannak beolvasandó adatok, a Retry-After fejléc értéke 1 vagy 60 lesz. Ha nincs beolvasandó adat, a Retry-After fejléc értéke 300 lesz. Megjegyzés: Ezek csak ajánlott értékek – az alkalmazás a követelményektől függően eltérő gyakorisággal kérdezhet le. Az első kérés után minden további kérésnek a legutóbbi válasz Hely fejlécében megadott URL-címet kell használnia. Ne adjon hozzá további paramétereket az URL-címhez, mivel már tartalmazza azokat a paramétereket, amelyek szükségesek ahhoz, hogy az űrlapok ne hiányoznak a kérelemből. Az eredmények rendezése automatikusan ModifiedUtc, majd FormHeaderId szerint történik növekvő sorrendben. A rendezési paraméterek nem konfigurálhatók. ModifiedUtc definition: internal time tag = time of latest form data change.

Időmérési szavazás

Műveletazonosító:: TimekeepingController_Poll

Az Timekeeping API lekérdezési végpontja lehetővé teszi, hogy az alkalmazás folyamatosan lekérdezhesse és feldolgozhassa a legutóbb beküldött időmérő bejegyzéseket.

Integráció:

Ez a végpont úgy lett kialakítva, hogy a Microsoft Flow-t lekérdezési eseményindító-integrációként használják. Másik lehetőségként saját egyéni integrációt is létrehozhat bármilyen nyelv használatával.

Használat:

Egy tipikus forgatókönyvben a végpontra irányuló első kérés nem adhat meg paramétereket. Két (2) sikeres válasz lehetséges:

HTTP-válaszkód 200 – A legutóbb elküldött időnyilvántartási rekordok léteznek; A válasz törzse megjeleníti az idő nyilvántartási bejegyzés adatait.
HTTP-válaszkód 202 – Nincsenek legutóbb elküldött rekordok; válasz törzse üres lesz.

Mindkét esetben két (2) fontos fejléc található a válaszban:

Hely – A következő kérés URL-címe.
Retry-After – A következő kéréshez javasolt időintervallum másodpercben. Ha például vannak beolvasandó adatok, a Retry-After fejléc értéke 1 vagy 60 lesz. Ha nincs beolvasandó adat, a Retry-After fejléc értéke 300 lesz.

Megjegyzés: Ezek csak ajánlott értékek – az alkalmazás a követelményektől függően eltérő gyakorisággal kérdezhet le. Az első kérés után minden további kérésnek a legutóbbi válasz Hely fejlécében megadott URL-címet kell használnia. Ne adjon hozzá további paramétereket az URL-címhez, mivel már tartalmazza azokat, amelyek szükségesek ahhoz, hogy az időőrző bejegyzések ne hiányoznak a kérelemből.

Az eredmények rendezése automatikusan ModifiedUtc, majd TimekeepingStatusId szerint történik, majd növekvő sorrendben. A rendezési paraméterek nem konfigurálhatók.

ModifiedUtc definition: internal time tag = timekeeping status change.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
excludeFormData	excludeFormData		boolean	Ha igaz, a ClockInFormData és a ClockOutFormData mindig null értékű lesz.

Válaszok

Törzs: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Rendelések lekérdezése

Műveletazonosító:: OrderController_Poll

Az Orders API lekérdezési végpontja lehetővé teszi, hogy az alkalmazás folyamatosan lekérdezhesse és feldolgozhassa a rendelések legutóbbi módosításait.

Integráció:

Használat:

Egy tipikus forgatókönyvben a végpontra irányuló első kérés nem adhat meg paramétereket. Két (2) sikeres válasz lehetséges:

HTTP-válaszkód 200 – Nemrég módosított rendelések léteznek; a válasz törzse megjeleníti a rendelési adatokat.
HTTP-válaszkód 202 – Nem léteznek nemrég módosított rendelések; válasz törzse üres lesz.

Mindkét esetben két (2) fontos fejléc található a válaszban:

Hely – A következő kérés URL-címe.
Retry-After – A következő kéréshez javasolt időintervallum másodpercben. Ha például vannak beolvasandó adatok, a Retry-After fejléc értéke 1 vagy 60 lesz. Ha nincs beolvasandó adat, a Retry-After fejléc értéke 300 lesz.

Megjegyzés: Ezek csak ajánlott értékek – az alkalmazás a követelményektől függően eltérő gyakorisággal kérdezhet le. Az első kérés után minden további kérésnek a legutóbbi válasz Hely fejlécében megadott URL-címet kell használnia. Ne adjon hozzá további paramétereket az URL-címhez, mivel már tartalmazza a szükséges paramétereket annak biztosításához, hogy a rendelésmódosítások ne hiányoznak a kérelemből.

Az eredmények rendezése automatikusan ModifiedUtc, majd OrderId szerint történik növekvő sorrendben. A rendezési paraméterek nem konfigurálhatók.

ModifiedUtc definition: internal time tag = time of latest order data change.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
excludeFormData	excludeFormData		boolean	Ha igaz, az OrderFormFields mindig üres tömb lesz.
excludeCustomFieldData	excludeCustomFieldData		boolean	Ha igaz, a CustomFields nem lesz visszaadva.

Válaszok

Törzs: CustomerAPI.Models.Order.OrderHeaderApiModel

Rendelési állapotok lekérdezése

Műveletazonosító:: OrderController_StatusPoll

Az Order Statuses API lekérdezési végpontja lehetővé teszi, hogy az alkalmazás folyamatosan lekérdezze és feldolgozhassa a rendelések legutóbbi módosításait.

Integráció:

Használat:

Egy tipikus forgatókönyvben a végpontra irányuló első kérés nem adhat meg paramétereket. Két (2) sikeres válasz lehetséges:

HTTP-válaszkód 200 – Nemrég módosított rendelési állapotrekordok léteznek; a válasz törzse megjeleníti a rendelés állapotadatait
HTTP-válaszkód 202 – Nincsenek legutóbb elküldött rekordok; válasz törzse üres lesz.

Mindkét esetben két (2) fontos fejléc található a válaszban:

Hely – A következő kérés URL-címe.
Retry-After – A következő kéréshez javasolt időintervallum másodpercben. Ha például vannak beolvasandó adatok, a Retry-After fejléc értéke 1 vagy 60 lesz. Ha nincs beolvasandó adat, a Retry-After fejléc értéke 300 lesz.

Megjegyzés: Ezek csak ajánlott értékek – az alkalmazás a követelményektől függően eltérő gyakorisággal kérdezhet le. Az első kérés után minden további kérésnek a legutóbbi válasz Hely fejlécében megadott URL-címet kell használnia. Ne adjon hozzá további paramétereket az URL-címhez, mert már tartalmazza azokat, amelyek szükségesek ahhoz, hogy a rendelési állapotok ne hiányoznak a kérelemből.

Az eredményeket az ModifiedUtc, majd a StatusId rendezi növekvő sorrendben. A rendezési paraméterek nem konfigurálhatók.

ModifiedUtc definition: internal time tag = time of latest order status data change.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
excludeFormData	excludeFormData		boolean	Ha igaz, a FieldValues mindig üres tömb lesz.

Válaszok

Törzs: CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Űrlapadatok lekérdezése

Műveletazonosító:: FormController_Poll

A Forms API lekérdezési végpontja lehetővé teszi, hogy az alkalmazás folyamatosan lekérdezhesse és feldolgozhassa a nemrég beküldött különálló űrlapokat.

Integráció:

Használat:

Egy tipikus forgatókönyvben a végpontra irányuló első kérés nem adhat meg paramétereket. Két (2) sikeres válasz lehetséges:

HTTP-válaszkód 200 – A legutóbb elküldött űrlaprekordok léteznek; a válasz törzse űrlapadatokat jelenít meg.
HTTP-válaszkód 202 – Nincsenek legutóbb elküldött rekordok; válasz törzse üres lesz.

Mindkét esetben két (2) fontos fejléc található a válaszban:

Hely – A következő kérés URL-címe.
Retry-After – A következő kéréshez javasolt időintervallum másodpercben. Ha például vannak beolvasandó adatok, a Retry-After fejléc értéke 1 vagy 60 lesz. Ha nincs beolvasandó adat, a Retry-After fejléc értéke 300 lesz.

Megjegyzés: Ezek csak ajánlott értékek – az alkalmazás a követelményektől függően eltérő gyakorisággal kérdezhet le. Az első kérés után minden további kérésnek a legutóbbi válasz Hely fejlécében megadott URL-címet kell használnia. Ne adjon hozzá további paramétereket az URL-címhez, mivel már tartalmazza azokat a paramétereket, amelyek szükségesek ahhoz, hogy az űrlapok ne hiányoznak a kérelemből.

Az eredmények rendezése automatikusan ModifiedUtc, majd FormHeaderId szerint történik növekvő sorrendben. A rendezési paraméterek nem konfigurálhatók.

ModifiedUtc definition: internal time tag = time of latest form data change.

Válaszok

Törzs: CustomerAPI.Models.Forms.StandaloneFormApiModel

Definíciók

CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Name	Elérési út	Típus	Description
Azonosító	Id	string

CustomerAPI.Models.Client.ReadClientApiModel

Name	Elérési út	Típus	Description
Azonosító	Id	integer	Az ügyfél azonosítója.
ExternalId	ExternalId	string	Az ügyfél – API-bővítmény tulajdonság külső használati azonosítója.
CreatedUtc	CreatedUtc	date-time	Az ügyfél létrehozásának eredeti időpontja.
ModifiedUtc	ModifiedUtc	date-time	Az ügyfél frissítésének utolsó pontja.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Név	Name	string	Az ügyfél neve.
Address	Address	CustomerAPI.Models.LocationApiModel
Érintkezés	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

Name	Elérési út	Típus	Description
FieldIndex	FieldIndex	integer	Mezőindex.
Felirat	Caption	string	Mezőfelirat.
Adattípus	DataType	integer	Mező adattípusa.
DateTimeFormat	DateTimeFormat	integer	DateTime formátum.
Érték	Value		Mezőérték.

CustomerAPI.Models.LocationApiModel

Name	Elérési út	Típus	Description
LatLon	LatLon	System.Nullable_1_Actsoft.Core.Geo.LatLon_
Cím sor 1	AddressLine1	string	A LocationApiModel 1. címvonala.
AddressLine2	AddressLine2	string	A LocationApiModel címvonala2.
City	City	string	A LocationApiModel városa.
RégióNév	RegionName	string	A LocationApiModel régióneve.
Irányítószám	PostalCode	string	A LocationApiModel irányítószáma.
Országkód	CountryCode	string	ISO 3166-1 alpha-2 kód.
Alrégiónév	SubRegionName	string	A LocationApiModel alrégió.
Alrégiókód	SubRegionCode	string	A LocationApiModel alrégiókódja.
RegionCode	RegionCode	string	A LocationApiModel régiókódja.

CustomerAPI.Models.Client.ContactApiModel

Name	Elérési út	Típus	Description
Név	Name	string	A ContactApiModel neve.
Telefonszám	PhoneNumber	string	A ContactApiModel PhoneNumber értéke.
Email	Email	string	A ContactApiModel e-mail címe.

System.Nullable_1_Actsoft.Core.Geo.LatLon_

Name	Elérési út	Típus	Description
Szélesség	Latitude	double
Hosszúság	Longitude	double

CustomerAPI.Models.ReturnIdApiModel

Name	Elérési út	Típus	Description
Azonosító	Id	integer	Objektumazonosító.

CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Egyéni listadefiníciós listaelem API-modelljét határozza meg.

Name	Elérési út	Típus	Description
CustomListId	CustomListId	integer	Egyéni listaazonosító.
Név	Name	string	Egyéni listanév.
verzió	Version	string	Egyéni listaverzió.

CustomerAPI.Models.CustomLists.CustomListApiModel

Egyéni listamodell.

Name	Elérési út	Típus	Description
CustomListId	CustomListId	integer	Egyéni listaazonosító.
Név	Name	string	Egyéni listanév.
verzió	Version	string	Egyéni listaverzió.
Definition	Definition	CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel	Egyéni listadefiníciós API-modellt definiál.

CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

Egyéni listadefiníciós API-modellt definiál.

Name	Elérési út	Típus	Description
Columns	Columns	array of CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel	Egyéni listaoszlopok.
UniqueColumnIndexIndex	UniqueColumnIndexIndex	integer	Egyedi oszlopindex.

CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

Egyéni listadefiníció oszlop API-modelljét határozza meg.

Name	Elérési út	Típus	Description
Index	Index	integer	Oszlopindex.
Adattípus	DataType	integer	Column DataType (Szöveg: 0, Numerikus: 1, Dátum: 2, Idő: 3, DateTime: 4, E-mail: 5).
Név	Name	string	Oszlop neve.

CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Egyéni listaoszlop adattömb tárolója.

Name	Elérési út	Típus	Description
ColumnValues	ColumnValues	array of CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel	Adatokkal rendelkező oszlopok tömbje.

CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

Ez a modell egyéni listaoszlop-értéket határoz meg.

Name	Elérési út	Típus	Description
ColumnIndex	ColumnIndex	integer	Egyéni listaoszlop indexe.
Felirat	Caption	string	Egyéni listaoszlop felirata.
Érték	Value		Egyéni lista oszlopértéke.

CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Egyéni eseménydefiníciós modell.

Name	Elérési út	Típus
Azonosító	Id	string
Név	Name	string
ReverseGeocode	ReverseGeocode	boolean
Paraméterek	Parameters	array of CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

Name	Elérési út	Típus
Név	Name	string
Típus	Type	integer
Felirat	Caption	string
Kötelező	Required	boolean

CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Name	Elérési út	Típus	Description
EventId	EventId	integer	Eseményazonosító.
Eseménytípus	EventType	integer
EventCode	EventCode	string	Eseménykód.
EseményIdő	EventTime	date-time	ISO formátum helyi és eltolással.
User	User	CustomerAPI.Models.UserReferenceApiModel
Jármű	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Ha engedélyezve van, az esemény járműve hozzárendelt felhasználót.
Elhelyezkedés	Location	CustomerAPI.Models.LocationApiModel
PrimaryGeofence	PrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
CustomEventDefinitionId	CustomEventDefinitionId	string	Külső eseménydefiníció azonosítója.
EventParams	EventParams	object	Eseményparaméterek.

CustomerAPI.Models.UserReferenceApiModel

Name	Elérési út	Típus	Description
UserId	UserId	integer	A felhasználó felhasználóazonosítója.
Keresztnév	FirstName	string	A felhasználó utóneve.
Vezetéknév	LastName	string	A felhasználó vezetékneve.
Dolgozói Szám	EmployeeNumber	string	A felhasználó alkalmazotti száma.
GroupName	GroupName	string	A felhasználóhoz rendelt csoport neve.

CustomerAPI.Models.ReadVehicleApiModel

Name	Elérési út	Típus	Description
VehicleId	VehicleId	integer	A BaseVehicleApiModel azonosítója.
Név	Name	string	A BaseVehicleApiModel neve.
VIN	VIN	string	A BaseVehicleApiModel járműazonosító száma.
Készüléknév	DeviceName	string	A BaseVehicleApiModel-hez társított GpsDeviceDto neve.
SerialNumber	SerialNumber	string	A BaseVehicleApiModel sorozatszáma.
GroupName	GroupName	string	A BaseVehicleApiModel csoportneve.

CustomerAPI.Models.Geofence.GeofenceInfoApiModel

Name	Elérési út	Típus	Description
GeofenceId	GeofenceId	integer	A Geofence azonosítója.
Név	Name	string	A Geofence neve.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Name	Elérési út	Típus	Description
Előfizetési azonosító	SubscriptionId	string	A WebHookSubscriptionResultApiModel azonosítója.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Name	Elérési út	Típus	Description
Előfizetési azonosító	SubscriptionId	string
URL vagy webcím	Url	string
Státusz	Status	integer	Előfizetés állapota – (Futtatás: 1, Leállítva: 2).

CustomerAPI.Models.Forms.StandaloneFormApiModel

Name	Elérési út	Típus	Description
Azonosító	Id	integer	A standaloneFormApiModel azonosítójához társított azonosító – (Régi megjegyzés: FormHeaderId).
Űrlapazonosító	FormId	integer	A standaloneFormApiModel által hivatkozott űrlap azonosítója.
FormName	FormName	string	A standaloneFormApiModel által hivatkozott űrlap neve.
EntryNumber	EntryNumber	string	Űrlap adatbeviteli száma.
Felülvizsgált	Reviewed	boolean	Az önállóFormApiModel áttekintésének állapota.
User	User	CustomerAPI.Models.UserReferenceApiModel
SubmittedTime	SubmittedTime	date-time	A StandaloneFormApiModel elküldésekor megadott időpont.
StartTime	StartTime	date-time	A StandaloneFormApiModel elindításának időpontja.
SubmittedLocation	SubmittedLocation	CustomerAPI.Models.LocationApiModel
FormData	FormData	array of CustomerAPI.Models.Forms.FormFieldDataApiModel	A StandaloneFormApiModel-hez társított mezők listája.
ApiModuleId	ApiModuleId	string	A standaloneFormApiModel-hez társított ApiModule azonosítója.
SharedUrl	SharedUrl	string	A StandaloneFormApiModel megosztott URL-címe.
ReviewedByUser	ReviewedByUser	CustomerAPI.Models.UserReferenceApiModel
ReviewedByTime	ReviewedByTime	date-time	Az űrlap áttekintésének időpontja

CustomerAPI.Models.Forms.FormFieldDataApiModel

Name	Elérési út	Típus	Description
Megismételhető	Repeatables	array of array
items	Repeatables	array of CustomerAPI.Models.Forms.FormFieldDataBaseApiModel
Azonosító	Id	string	A FormFieldDataApiModel azonosítója.
Érték	Value		A FormFieldDataApiModel értéke.
DisplayValue	DisplayValue		A FormFieldDataApiModel displayValue értéke.
CapturedTime	CapturedTime	date-time	A rendszer rögzítette a FormFieldDataApiModel időértékét.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Felirat	Caption	string	A FormFieldDataApiModel felirattartalma.
ApiFieldId	ApiFieldId	string	A FormFieldDataApiModel ApiField azonosítója.

CustomerAPI.Models.Forms.FormFieldDataBaseApiModel

Name	Elérési út	Típus	Description
Azonosító	Id	string	A FormFieldDataApiModel azonosítója.
Érték	Value		A FormFieldDataApiModel értéke.
DisplayValue	DisplayValue		A FormFieldDataApiModel displayValue értéke.
CapturedTime	CapturedTime	date-time	A rendszer rögzítette a FormFieldDataApiModel időértékét.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Felirat	Caption	string	A FormFieldDataApiModel felirattartalma.
ApiFieldId	ApiFieldId	string	A FormFieldDataApiModel ApiField azonosítója.

CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Name	Elérési út	Típus	Description
GeofenceId	GeofenceId	integer	A GeofenceApiModel GeofenceId azonosítója.
CreatedUtc	CreatedUtc	date-time	A GeofenceApiModel létrehozva.
ModifiedUtc	ModifiedUtc	date-time	A GeofenceApiModel módosított példánya.
GroupNames	GroupNames	array of string	A GeofenceApiModel groupPaths elemei.
Név	Name	string	A GeofenceApiModelBase neve.
Típus	Type	string	A GeofenceApiModel típusa.
Shape	Shape	integer	Alakzat: 0 a körhöz, 1 a sokszög.
Address	Address	CustomerAPI.Models.LocationApiModel
Orsócsont	Radius	double	A GeofenceApiModel sugara.
UseGeofenceAddress	UseGeofenceAddress	boolean	A GeofenceApiModel useGeofenceAddress parancsa.

Actsoft.Core.Geo.LatLon

Name	Elérési út	Típus	Description
Szélesség	Latitude	double
Hosszúság	Longitude	double

CustomerAPI.Models.Geofence.GeofenceApiModel

Name	Elérési út	Típus	Description
GeofenceId	GeofenceId	integer	A GeofenceApiModel GeofenceId azonosítója.
CreatedUtc	CreatedUtc	date-time	A GeofenceApiModel létrehozva.
ModifiedUtc	ModifiedUtc	date-time	A GeofenceApiModel módosított példánya.
GroupNames	GroupNames	array of string	A GeofenceApiModel groupPaths elemei.
Polygon	Polygon	array of Actsoft.Core.Geo.LatLon	Sokszögpontok. Akkor kell kitölteni, ha az alakzat értéke 1.
Név	Name	string	A GeofenceApiModelBase neve.
Típus	Type	string	A GeofenceApiModel típusa.
Shape	Shape	integer	Alakzat: 0 a körhöz, 1 a sokszög.
Address	Address	CustomerAPI.Models.LocationApiModel
Orsócsont	Radius	double	A GeofenceApiModel sugara.
UseGeofenceAddress	UseGeofenceAddress	boolean	A GeofenceApiModel useGeofenceAddress parancsa.

CustomerAPI.Models.Order.OrderListItemApiModel

Name	Elérési út	Típus	Description
Rendelésazonosító	OrderId	integer	Az OrderBaseApiModel azonosítója.
ExternalOrderId	ExternalOrderId	string	Az ügyfél – API-bővítmény tulajdonság külső használati orderId azonosítója.
Esedékesség dátuma	DueDate	date-time	Ez az OrderBaseApiModel időpontban esedékes a befejezéshez (az 1.3-s verzióban elavult).
StartTime	StartTime	date-time	Ennek az OrderBaseApiModel-nek el kell indulnia (az 1.3-ban bevezetett).
Befejezési idő	EndTime	date-time	Ez az OrderBaseApiModel időpontban esedékes a befejezéshez (az 1.3-ban bevezetett).
ServiceType	ServiceType	string	Az OrderBaseApiModelhez társított ServiceType.
CreatedUTCDate	CreatedUTCDate	date-time	Ez az OrderBaseApiModel létrehozása időpontban történt.
Rendelési szám	OrderNumber	string	Az OrderBaseApiModelhez társított rendelésszám.
IsClosed	IsClosed	boolean	Az OrderBaseApiModel bezárása állapotát jelző állapot.
Státusz	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	Az ügyfél – API-bővítmény tulajdonság külső használati azonosítója.
ClientId	ClientId	integer	belső használati azonosító az ügyfél – API-bővítmény tulajdonsághoz.
Ügyfél	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	Az OrderBaseApiModel-hez társított ApiService azonosítója.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Egyéni mezők modul verziója.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusApiModel

Name	Elérési út	Típus	Description
StatusIndex	StatusIndex	integer	Az OrderStatusApiModel indexe.
ÁllapotTípus	StatusType	integer	Rendelés állapota: 0 az új rendeléshez, 1 a kézbesített, 2 a folyamatban lévő, 3 a befejezett, 4 pedig a visszavont.
StatusLabel	StatusLabel	string	Az OrderStatusApiModel címketartalma.
StatusId	StatusId	integer	Az OrderStatusApiModel azonosítója.
StatusStartDateTime	StatusStartDateTime	date-time	Az OrderStatusApiModel kezdési ideje.
User	User	CustomerAPI.Models.UserReferenceApiModel

CustomerAPI.Models.Order.OrderClientReadApiModel

Name	Elérési út	Típus	Description
GroupNames	GroupNames	array of string	Ügyfélcsoport hierarchikus nevei.
Név	Name	string	Az ügyfél neve.
Address	Address	CustomerAPI.Models.LocationApiModel
Érintkezés	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Order.OrderApiModel

Name	Elérési út	Típus	Description
StatusHistory	StatusHistory	array of CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel	Az OrderApiModelhez társított OrderStatusListItems listája.
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
Rendelésazonosító	OrderId	integer	Az OrderBaseApiModel azonosítója.
ExternalOrderId	ExternalOrderId	string	Az ügyfél – API-bővítmény tulajdonság külső használati orderId azonosítója.
Esedékesség dátuma	DueDate	date-time	Ez az OrderBaseApiModel időpontban esedékes a befejezéshez (az 1.3-s verzióban elavult).
StartTime	StartTime	date-time	Ennek az OrderBaseApiModel-nek el kell indulnia (az 1.3-ban bevezetett).
Befejezési idő	EndTime	date-time	Ez az OrderBaseApiModel időpontban esedékes a befejezéshez (az 1.3-ban bevezetett).
ServiceType	ServiceType	string	Az OrderBaseApiModelhez társított ServiceType.
CreatedUTCDate	CreatedUTCDate	date-time	Ez az OrderBaseApiModel létrehozása időpontban történt.
Rendelési szám	OrderNumber	string	Az OrderBaseApiModelhez társított rendelésszám.
IsClosed	IsClosed	boolean	Az OrderBaseApiModel bezárása állapotát jelző állapot.
Státusz	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	Az ügyfél – API-bővítmény tulajdonság külső használati azonosítója.
ClientId	ClientId	integer	belső használati azonosító az ügyfél – API-bővítmény tulajdonsághoz.
Ügyfél	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	Az OrderBaseApiModel-hez társított ApiService azonosítója.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Egyéni mezők modul verziója.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Name	Elérési út	Típus	Description
StatusStartDateTime	StatusStartDateTime	date-time	Ez az OrderStatusHistoryListItemApiModel állapot elindult.
StatusEndDateTime	StatusEndDateTime	date-time	Az OrderStatusHistoryListItemApiModel állapot befejeződött.
StatusId	StatusId	integer	Ehhez az OrderStatusHistoryListItemApiModelhez társított azonosító.
StatusIndex	StatusIndex	integer	Az OrderStatusHistoryListItemApiModel parancshoz társított index.
StatusLabel	StatusLabel	string	Az OrderStatusHistoryListItemApiModelhez társított tartalom címkézése.
ÁllapotTípus	StatusType	integer	Rendelés állapota: 0 az új rendeléshez, 1 a kézbesített, 2 a folyamatban lévő, 3 a befejezett, 4 pedig a visszavont.
ExternalOrderId	ExternalOrderId	string	Az ügyfél – API-bővítmény tulajdonság külső használati orderId azonosítója.
Rendelésazonosító	OrderId	integer	Az OrderStatusHistoryListItemApiModel parancshoz társított OrderId.
User	User	CustomerAPI.Models.UserReferenceApiModel
StartAddress	StartAddress	CustomerAPI.Models.LocationApiModel
EndAddress	EndAddress	CustomerAPI.Models.LocationApiModel
ApiServiceId	ApiServiceId	string	Az OrderStatusHistoryListItemApiModelhez társított ApiService azonosítója.
Mezőértékek	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

CustomerAPI.Models.Order.OrderHeaderApiModel

Name	Elérési út	Típus	Description
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
Rendelésazonosító	OrderId	integer	Az OrderBaseApiModel azonosítója.
ExternalOrderId	ExternalOrderId	string	Az ügyfél – API-bővítmény tulajdonság külső használati orderId azonosítója.
Esedékesség dátuma	DueDate	date-time	Ez az OrderBaseApiModel időpontban esedékes a befejezéshez (az 1.3-s verzióban elavult).
StartTime	StartTime	date-time	Ennek az OrderBaseApiModel-nek el kell indulnia (az 1.3-ban bevezetett).
Befejezési idő	EndTime	date-time	Ez az OrderBaseApiModel időpontban esedékes a befejezéshez (az 1.3-ban bevezetett).
ServiceType	ServiceType	string	Az OrderBaseApiModelhez társított ServiceType.
CreatedUTCDate	CreatedUTCDate	date-time	Ez az OrderBaseApiModel létrehozása időpontban történt.
Rendelési szám	OrderNumber	string	Az OrderBaseApiModelhez társított rendelésszám.
IsClosed	IsClosed	boolean	Az OrderBaseApiModel bezárása állapotát jelző állapot.
Státusz	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	Az ügyfél – API-bővítmény tulajdonság külső használati azonosítója.
ClientId	ClientId	integer	belső használati azonosító az ügyfél – API-bővítmény tulajdonsághoz.
Ügyfél	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	Az OrderBaseApiModel-hez társított ApiService azonosítója.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Egyéni mezők modul verziója.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Name	Elérési út	Típus	Description
Azonosító	Id	integer	Az Időtartás bejegyzés azonosítója (régi megjegyzés: RootSubmittedStatusId).
User	User	CustomerAPI.Models.UserReferenceApiModel
ClockInTime	ClockInTime	date-time	Pont az az időpont, amikor a felhasználó a rendszerbe váltott.
ClockInLocation	ClockInLocation	CustomerAPI.Models.LocationApiModel
ClockOutTime	ClockOutTime	date-time	Pont az az időpont, amikor a felhasználó kijelentkezett a rendszerből.
ClockOutLocation	ClockOutLocation	CustomerAPI.Models.LocationApiModel
TotalHours	TotalHours	double	Az időtartási tételhez tartozó órák teljes száma.
TotalBreakHours	TotalBreakHours	double	A munkaidő-nyilvántartási bejegyzéshez tartozó szünetek (nem munkaórák) teljes száma.
NetHours	NetHours	double	Az időtartási tételért felszámítható órák teljes száma.
Jóváhagyott	Approved	boolean	A felügyelői jóváhagyás állapota ehhez az időtartási bejegyzéshez.
Szünetek	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	Az időmegőrzési bejegyzés beküldéséhez használt Céges modul azonosítója.

CustomerAPI.Models.Timekeeping.TimekeepingBreakModel

Name	Elérési út	Típus	Description
Azonosító	Id	integer	SubmittedStatusId.
StartTime	StartTime	date-time	Kezdés időpontja.
StartLocation	StartLocation	CustomerAPI.Models.LocationApiModel
Befejezési idő	EndTime	date-time	Befejezés időpontja.
EndLocation	EndLocation	CustomerAPI.Models.LocationApiModel
DurationHours	DurationHours	double	Időtartam órákban. Null értékű lehet, ha az EndTime értéke null.
ÁllapotTípus	StatusType	integer	Állapottípus: 1 szünetre, 2 ebédre.
StartLabel	StartLabel	string	Kezdje el a címkét.
EndLabel	EndLabel	string	Záró címke.
Felirat	Caption	string	Felirat.

CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel

Name	Elérési út	Típus
CompanyModuleId	CompanyModuleId	integer
ModuleVersion	ModuleVersion	System.Version
Mezőértékek	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

System.Version

Name	Elérési út	Típus
_Őrnagy	_Major	integer
_Kiskorú	_Minor	integer
_Épít	_Build	integer
_Átvizsgálás	_Revision	integer

CustomerAPI.Models.Tracking.TripApiModel

Name	Elérési út	Típus	Description
User	User	CustomerAPI.Models.UserReferenceApiModel
Jármű	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
StartTime	StartTime	date-time	Ez a TripApiModel állapot elindult.
Befejezési idő	EndTime	date-time	A TripApiModel állapota befejeződött.
StartLocation	StartLocation	CustomerAPI.Models.LocationApiModel
EndLocation	EndLocation	CustomerAPI.Models.LocationApiModel
StartPrimaryGeofence	StartPrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
EndPrimaryGeofence	EndPrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
TotalStopTime	TotalStopTime	double	A TripApiModel-hez társított órákban leállítási idő mennyisége.
TotalIdleTime	TotalIdleTime	double	A TripApiModel-hez társított üresjárati idő mennyisége órákban.
TotalDuration	TotalDuration	double	Ehhez a TripApiModel-hez órákban kapcsolódó teljes idő.
Távolság	Distance	double	A TripApiModelhez társított honosított egységekben megtett távolság.

CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Name	Elérési út	Típus	Description
Feljegyzések	Records	array of CustomerAPI.Models.Tracking.GpsDataRecordApiModel
ContinuationToken	ContinuationToken	string

CustomerAPI.Models.Tracking.GpsDataRecordApiModel

Name	Elérési út	Típus	Description
User	User	CustomerAPI.Models.UserReferenceApiModel
Jármű	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
TimeTag	TimeTag	date-time	Ehhez a GpsDataRecordApiModel-hez társított TimeTag.
Elhelyezkedés	Location	System.Nullable_1_Actsoft.Core.Geo.LatLon_
Geokerítés	Geofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
Sebesség	Speed	double	Ennek a GpsDataRecordApiModel-nek a mozgási sebessége.
Heading	Heading	double	Iránytű iránya az ehhez a GpsDataRecordApiModel-hez társított fokban.
Státusz	Status	integer	Az OrderBaseApiModel-hez társított ApiMovementStatus – (Leállítva: 1, Tétlen: 2, Áthelyezés: 3, NotTracking: 4) : OrderStatusApiModel.
ÁllapotIdő	StatusTime	string	Ez a GpsDataRecordApiModel állapot be van állítva.
Távolság	Distance	double	A TripApiModelhez társított honosított egységekben megtett távolság.
IgnitionOn	IgnitionOn	boolean	A GpsDataRecordApiModel-hez társított járműgyújtás állapota.
LocationProvider	LocationProvider	integer	Ehhez a GpsDataRecordApiModel-hez társított API-helyszolgáltató – (GPS: 1, Hálózat: 2).

CustomerAPI.Models.User.ReadUserApiModel

Name	Elérési út	Típus	Description
UserName	UserName	string	Felhasználó felhasználóneve.
UserId	UserId	integer	A Felhasználó azonosítója.
GroupName	GroupName	string	A felhasználó csoportjának neve.
Keresztnév	FirstName	string	A felhasználó utóneve.
Vezetéknév	LastName	string	A felhasználó vezetékneve.
Dolgozói Szám	EmployeeNumber	string	A felhasználó alkalmazotti száma.
Email	Email	string	A Felhasználó e-mail-címe.
Telefonszám	Phone	string	A felhasználó telefonszáma.
Szerepkörazonosító	RoleId	integer	A felhasználó szerepkörazonosítója – (Rendszergazda: 1, Felhasználó: 3, Power User: 5).
IsActive	IsActive	boolean	A felhasználó aktív állapota.
EPTTEnabled	EPTTEnabled	boolean	A továbbfejlesztett push-to-talk funkció állapota a felhasználó számára: logikai.
EPTTNumber	EPTTNumber	string	A Továbbfejlesztett leküldéses beszélgetés funkció telefonszáma a felhasználó számára: sztring.
EPTTWebMDN	EPTTWebMDN	string	A Felhasználó hitelesítéséhez használt telefonszám a Kodiak EPTT rendszerében – Kodiak által megadott.
EPTTToken	EPTTToken	string	A Felhasználó hitelesítéséhez használt API-jogkivonat a Kodiak EPTT-rendszerre – a Kodiak biztosítja.
GPSEnabled	GPSEnabled	boolean	A felhasználó GPS-funkciójának állapota.
MobileOnly	MobileOnly	boolean	A CAB asztali webalkalmazás-hozzáférésének állapota – (Nincs WebApp-hozzáférés: Igaz, Teljes alkalmazáshozzáférés: Hamis).
LicenseType	LicenseType	integer	A felhasználóhoz rendelt licenc típusa: - 0 a nem definiált, 1 a Normál, 2 a WebOnly és 3 az Alkalmazott esetében.

CustomerAPI.Models.User.ReadUserListItemApiModel

Name	Elérési út	Típus	Description
UserId	UserId	integer	A Felhasználó azonosítója.
Keresztnév	FirstName	string	A felhasználó utóneve.
Vezetéknév	LastName	string	A felhasználó vezetékneve.
Dolgozói Szám	EmployeeNumber	string	A felhasználó alkalmazotti száma.
Email	Email	string	A Felhasználó e-mail-címe.
Telefonszám	Phone	string	A felhasználó telefonszáma.
Szerepkörazonosító	RoleId	integer	A felhasználó szerepkörazonosítója – (Rendszergazda: 1, Felhasználó: 3, Power User: 5).
IsActive	IsActive	boolean	A felhasználó aktív állapota.
EPTTEnabled	EPTTEnabled	boolean	A továbbfejlesztett push-to-talk funkció állapota a felhasználó számára: logikai.
EPTTNumber	EPTTNumber	string	A Továbbfejlesztett leküldéses beszélgetés funkció telefonszáma a felhasználó számára: sztring.
EPTTWebMDN	EPTTWebMDN	string	A Felhasználó hitelesítéséhez használt telefonszám a Kodiak EPTT rendszerében – Kodiak által megadott.
EPTTToken	EPTTToken	string	A Felhasználó hitelesítéséhez használt API-jogkivonat a Kodiak EPTT-rendszerre – a Kodiak biztosítja.
GPSEnabled	GPSEnabled	boolean	A felhasználó GPS-funkciójának állapota.
MobileOnly	MobileOnly	boolean	A CAB asztali webalkalmazás-hozzáférésének állapota – (Nincs WebApp-hozzáférés: Igaz, Teljes alkalmazáshozzáférés: Hamis).
LicenseType	LicenseType	integer	A felhasználóhoz rendelt licenc típusa: - 0 a nem definiált, 1 a Normál, 2 a WebOnly és 3 az Alkalmazott esetében.

CustomerAPI.Models.Vehicles.VehicleReadApi

Járműadat-modell.

Name	Elérési út	Típus
InternalId	InternalId	integer
Szám	Number	string
Név	Name	string
Típus	Type	string
Tag	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
TimeZone	TimeZone	string
Csinál	Make	string
Év	Year	integer
Model	Model	string
Szín	Color	string
VIN	VIN	string
IsActive	IsActive	boolean
Eszköztípus	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

egész szám

Ez az "egész szám" alapszintű adattípus.

objektum

Ez az "objektum" típus.