TeamWherx

TeamWherx (TW) är en allt-i-ett-tjänsthanteringsplattform som hjälper dig att mer effektivt hantera dina distansteam med anställda och allmänna affärsverksamheter utanför kontoret. Som en molnbaserad lösning möjliggör TW fjärrdatainsamling och visar den via sin instrumentpanel för webbappar, vilket ger cheferna den ytterligare insikt de behöver för att skapa smartare strategier för ökad effektivitet, produktivitet och minskade kostnader samtidigt som de samordnar sina mobila arbetsstyrka.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Tjänster	Class	Regioner
Copilot Studio	Premie	Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD)
Logiska appar	Norm	Alla Logic Apps-regioner utom följande: – Azure Government-regioner – Regioner i Azure Kina - US Department of Defense (DoD)
Power Apps	Premie	Alla Power Apps-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD)
Power Automate	Premie	Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD)

Kontakt
Namn	Actsoft-support
URL	https://www.actsoft.com/self-help-wizards
E-postmeddelande	support@actsoft.com

Metadata för anslutningsprogram
Utgivare	Actsoft
Webbplats	https://actsoft.com
Sekretesspolicy	https://www.actsoft.com/privacy
Kategorier	Produktivitet

Beskrivning av anslutningsapp:

Med TeamWherx kan du skapa och samla in information om digitala formulär, tidshållningsinformation för anställda och hantera arbetsorder med ett leveranssystem.

Detaljerad beskrivning

Med TeamWherx-anslutningsappen kan användarna ansluta och utbyta information mellan flera plattformar. Du kan animera dina data för att skapa processflöden, driva dina andra interna program och informera om kraftfulla analyser. Automatisera och effektivisera dina dagliga, veckovisa eller månatliga processer med åtkomst till up-to-the-moment-åtgärdsbara data.

## Förutsättningar

Om du vill använda den här anslutningsappen behöver du följande:

TeamWherx-konto
TeamWherx API-nyckel
Microsoft Power Apps- eller Power Automate-plan

## Hämta autentiseringsuppgifter

API Developer-portalen

För att få åtkomst till anslutningsappen måste du först konfigurera ett användarnamn och lösenord för API Developer-portalen och prenumerera på kund-API:et:

Inifrån programmet går du tillAPI-installationsprogrammetför administrativa>inställningar>.
Välj Skapa autentiseringsuppgifter.
Ange ditt förnamn och efternamn i lämpliga fält.
Ange din e-postadress i fältet E-postadress.
Välj Spara & e-postinbjudan. Kontrollera sedan e-postmeddelandet om du vill ha instruktioner om hur du skapar ett lösenord.
När du är inne i e-postmeddelandet med inbjudan klickar du på Väljlösenord, vilket öppnar en dialogruta där du kan skapa ett lösenord.
Välj Spara lösenord.
Om du vill gå vidare till utvecklarportalen går du till Administrationsinställningar>>Gåtill utvecklarportalen.
I utvecklarportalen väljer du Produkter och sedan Kund-API.
Välj Prenumerera.

API-nyckel

Nu när du är en registrerad API-användare har en alfanumerisk sekvens, som kallas nyckel, genererats åt dig. Du behöver den här nyckeln för att arbeta med dina data i API:et.

Så här hittar du DIN API-nyckel:

Välj Produkter på menyn i utvecklarportalen. DE API-produkter som är tillgängliga i din licens visas.
Välj kund-API-versionen under "Du har X-prenumerationer för den här produkten".
Välj Visa bredvid primärnyckeln för din prenumeration.
Välj innehållet i fältet, högerklicka och välj Kopiera. Nyckeln sparas nu i Urklipp och är redo att klistras in.

## Kom igång med anslutningsappen

Gå till Mina flöden>Nytt flöde och välj sedan Automatiserat molnflöde.
Välj Utlösa ett flöde manuellt från dialogrutan Skapa ett automatiserat molnflöde.
Namnge ditt flöde eller låt systemet generera ett automatiskt.
Sök efter och välj en utlösare för ditt flöde.
Välj Skapa.
I sökfältet söker du efter och väljer TeamWherx-anslutningsappen.
Hitta den åtgärd som du vill utföra med anslutningsappen.

Systemet uppmanar dig att logga in på alla appar som krävs för att utföra den valda åtgärden och hoppas över alla som du redan är inloggad på.

Ange ett namn för den nya anslutningsappen i fältet Anslutningsapp.
Ange sedan din API-nyckel.
Välj Skapa. Det första steget i processflödet visas som den första rutan i ett flödesschema.
Välj Nyttsteg om du vill fortsätta att lägga till fler åtgärder och steg i anslutningsprocessflödet.
Välj Spara.

**Använda anslutningsappen – Exempel på orderstatussökning
** Anvisningarna nedan visar hur du skapar ett processflöde för att infoga rader i ett kalkylblad och infoga identifierande data för den medarbetare som uppdaterade ordern när en orderstatus uppdateras.

Gå till Anslutningsappar.
Sök efter och välj anslutningsprogrammet [TeamWherx].
Välj Avsökning av orderstatusar från åtgärdslistan.
Ange ett namn för den nya anslutningen i fältet Anslutningsnamn .
Ange sedan din API-nyckel.
Välj Skapa. Det första steget i processflödet visas som den första rutan i ett flödesschema.

Varje åtgärdsdialogruta i stegen i ditt anslutningsflöde har egenskapsfält som du kan anpassa för att styra den åtgärd som utförs.

Om du fortsätter med exemplet väljer du om du vill att formulärfältvärden ska visas (excludeFormData-parameter).
Välj X-API-versionen för anslutningen.
Välj Nästa steg för att ange den åtgärd som du vill utföra när en orderstatus ändras.
I dialogrutan Välj en åtgärd använder du sökfältet för att hitta programmet och sedan önskad åtgärd. Om du till exempel vill infoga en rad i ett Google-kalkylblad varje gång en orderstatus ändras väljer du GoogleSheets och sedan Infogarad för åtgärden.
I dialogrutan Infogarad som följer klickar du i fältet Arkiv och väljer den fil som ska innehålla dina resultat.
I fältet Kalkylblad väljer du databladstypen . Fälten som visas dynamiskt är datakolumnerna i kalkylbladet.
Klicka i fältet för varje kolumn och välj en egenskap i listan orderstatusavsökningsegenskaper . Du kan också använda sökfältet för att hitta en specifik egenskap.
Du kan ange mer än en egenskap i varje kolumnfält. I kolumnen Händelse väljer du StatusLabel, infogar ett bindestreck och väljer sedan StatusStartDate. Det innebär att statusetiketten och startdatumet för status skrivs till kolumnen Händelse i den nya raden för varje orderstatusuppdatering.
Välj Nyttsteg. Som en sidoanteckning kan du alltid hovra och klicka på pilanslutningen för att infoga ett nytt steg
I dialogrutan Välj en åtgärd väljer du TeamWherx-anslutningsappen igen och sedan Skapa en klient för åtgärden.

Återigen representerar varje fält som visas i dialogrutan en kolumn i Google Sheets-kalkylbladet. Klicka i varje fält för att aktivera listan orderstatusavsökningsegenskaper och välj de egenskaper som du vill använda.

I det här exemplet väljer du EmployeeNumber för fältet Namn för att identifiera den medarbetare som uppdaterade orderstatusen.
Välj GroupName och infoga det även i fältet Namn .
Välj Spara.

Nu har du skapat ett processflöde som uppdaterar kalkylbladet med personalnumret och deras associerade grupp varje gång en orderstatus uppdateras.

## Kända problem och begränsningar

Binära uppladdningar av ljudfiler (POST) för alla slutpunkter är endast begränsade till MP4.
Datum för alla slutpunkter som kräver information om datum och tid måste anges enligt RFC3339 riktlinjer, som i följande exempel: 2021-09-22T02:36:56.52Z. Det är inte nödvändigt att ange de exakta sekunderna i tidsstämpeln. 00 är acceptabelt.

## Vanliga fel och åtgärder

Exempel på vanliga fel som kan inträffa, svarskoder och korrigeringar finns på API Developers Portal(er):

Extranummer- https://developer.wfmplatform.com/

Vanliga frågor och svar om ##

Skapa en anslutning

Anslutningsappen stöder följande autentiseringstyper:


Standardinställning	Parametrar för att skapa anslutning.	Alla regioner	Går inte att dela

Standard

Tillämpligt: Alla regioner

Parametrar för att skapa anslutning.

Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.

Namn	Typ	Description	Krävs
API-nyckel	securestring	API-nyckeln för det här API:et	Sann

Begränsningsgränser

Name	Anrop	Förnyelseperiod
API-anrop per anslutning	100	60 sekunder

Åtgärder

** Skapa en order	Lägger till en ny order.
Aktivera en användare	Aktiverar en befintlig användare med dess ID.
Aktivera ett fordon	Aktivera ett fordon med ID.
Avbryta prenumerationen på WEBB-webbkroken för GPS-data	Tar bort en prenumeration på EN GPS-datawebbkrok med sitt ID.
Avsluta prenumerationen på händelsewebbkroken	Tar bort en web hook-prenumeration för händelser med dess ID.
Få en geofence	Hämtar en geofence med sitt ID.
Hämta anpassade listdata via CustomListID	Hämtar alla dataposter i en enda anpassad lista med hjälp av CustomListID. Resultaten sorteras efter kolumn och växling stöds. Fel: 404 – det finns ingen anpassad lista för angivet customListId.
Hämta anpassade listdefinitioner	Hämtar en definitionslista för anpassad lista. Definitionslistan innehåller CustomListID, Namn och Version för alla befintliga anpassade listor.
Hämta delversion	Returnerar den aktuella delversionen av API:et.
Hämta en anpassad händelsedefinition efter ID	Hämtar en enskild anpassad händelsedefinition efter ID.
Hämta en användare	Hämtar en användare efter sitt ID.
Hämta en beställning	Hämtar en befintlig order med sitt ID.
Hämta en fordonslista	Hämtar en fordonslista.
Hämta en klient	Hämtar ett klientobjekt med sitt ID.
Hämta en lista över anpassade händelsedefinitioner	Hämtar en lista över anpassade händelsedefinitioner.
Hämta en lista över användare	Hämtar en lista över användare. Du kan ange antalet sidor som returneras och antalet element per sida. Resultaten sorteras automatiskt efter UserId och i stigande ordning. Sorteringsparametrar kan inte konfigureras.
Hämta en lista över beställningar	Hämtar en lista över beställningar med hjälp av filtren från de begärandeparametrar som visas nedan. Du kan ange antalet sidor som returneras och antalet element per sida. Resultaten sorteras automatiskt efter Client.Name och i stigande ordning. Sorteringsparametrar kan inte konfigureras.
Hämta en lista över event web hook-prenumerationer	Hämtar en lista över event web hook-prenumerationer. Du kan ange antalet sidor som returneras och antalet element per sida. Resultaten sorteras automatiskt efter SubscriptionId och i stigande ordning. Sorteringsparametrar kan inte konfigureras.
Hämta en lista över formulär	Hämtar en lista över formulär med hjälp av något av filtren från de begärandeparametrar som visas nedan. Du kan ange antalet sidor som returneras och antalet element per sida. Resultaten sorteras automatiskt efter SubmittedTime och i fallande ordning. Sorteringsparametrar kan inte konfigureras.
Hämta en lista över geofences	Hämtar en lista över geofences. Du kan ange antalet sidor som returneras och antalet element per sida, samt om geofencekoordinaterna är mått. Resultaten sorteras automatiskt efter Namn och i stigande ordning. Sorteringsparametrar kan inte konfigureras.
Hämta en lista över händelser	Hämtar en lista över händelser under en viss tidsperiod. Du kan ange antalet sidor som returneras och antalet element per sida. Filtrera efter händelsetyp för att hämta specifika händelser. Fordonshändelser kan returneras för en anställd om den anställde är associerad med fordonet.
Hämta en lista över klienter	Hämtar en lista över klienter. Du kan ange antalet sidor som returneras och antalet element per sida. Resultaten sorteras automatiskt efter Namn och i stigande ordning. Sorteringsparametrar kan inte konfigureras.
Hämta en lista över prenumerationer	Hämtar en lista över web hook-prenumerationer. Du kan ange antalet sidor som returneras och antalet element per sida. Resultaten sorteras automatiskt efter SubscriptionId och i stigande ordning. Sorteringsparametrar kan inte konfigureras.
Hämta en lista över resor	Hämtar en lista över resor under en viss tidsperiod. Du kan ange antalet sidor som returneras och antalet element per sida. Resultaten sorteras automatiskt efter StartUtcTIme och i stigande ordning. Sorteringsparametrar kan inte konfigureras.
Hämta en lista över tidshållningsposter	Hämtar en lista över tidshållningsposter baserat på datumintervall. Du kan ange antalet sidor som returneras och antalet element per sida. Resultaten sorteras automatiskt efter ClockInTime och sedan efter TimekeepingStatusId och i stigande ordning. Sorteringsparametrar kan inte konfigureras.
Hämta en post från en anpassad lista	Hämtar datapost för en enda anpassad lista som hittas av CustomListId och unikt kolumnvärde. Fel: 404 – det finns ingen anpassad listpost för angivet customListId- och unikt kolumnvärde
Hämta en tidshållningspost	Hämtar en post med dess ID.
Hämta ett fordon med ID	Hämtar ett enskilt fordon med ID.
Hämta ett formulär	Hämtar ett formulär med sitt ID.
Hämta GPS-dataposter	Hämtar GPS-dataposter för ett angivet datumintervall. Returnerar också en fortsättningstoken och en länk för att hämta nästa datadel. Du kan ange antalet sidor som returneras och antalet element per sida. Positioner för borttagna användare/fordon returneras inte. Men om användaren/fordonet fanns när data begärdes och senare togs bort, returneras data för användaren/fordonet som begärs av en fortsättningstoken. Resultaten sorteras automatiskt efter UtcTime och i stigande ordning. Sorteringsparametrar kan inte konfigureras.
Hämta lista med anpassade listfält efter CustomListID	Hämtar en lista med fält för en enda anpassad lista med hjälp av CustomListID.
Inaktivera en användare	Inaktiverar en befintlig användare med dess ID.
Inaktivera ett fordon	Inaktivera ett fordon med ID.
Ladda upp bifogad fil	Använd det här alternativet om du vill ladda upp bifogade filer i formulärfilen. Binär storlek är begränsad till 25 MB. Förväntad begäran om flera delar/formulärdata med en enda fil.
Ladda upp binär fil	Använd det här alternativet om du vill ladda upp formulärbilder och ljudfiler. Binär storlek är begränsad till 10 MB. Filtyper som stöds är: JPEG, PNG och MP4.
Partiell uppdatering av ett fordon	Partiell uppdatering av ett fordon med ID.
Prenumerera PÅ GPS-datawebbkrok	Lägger till en ny webbkrok för GPS-spårningsdata (GPS-positioner). Med webbkrokar kan du ta emot GPS-positioner som förekommer på en angiven URL.
Prenumerera på händelsewebbkrok	Lägger till en web hook-prenumeration för nya händelser. Med webbkrokar kan du ta emot automatiska meddelanden om företagshändelser som inträffar på en angiven URL.
Skapa eller uppdatera en anpassad händelsedefinition	Skapar eller uppdaterar en anpassad händelsedefinition.
Skapa eller uppdatera post för anpassad lista	Skapar eller uppdaterar en anpassad listdatapost. Värdet för den unika kolumnen kan utelämnas, men om det finns bör det matcha värdet unikt ID i frågeparametern.
Skapa en användare	Skapar en ny användare.
Skapa en geofence	Skapar en ny geofence.
Skapa en klient	Skapar en ny klient.
Skapa ett fordon	Skapar ett fordon.
Skapa ett formulär	Lägger till ett nytt formulär.
Skicka händelse	Skickar händelsen.
Ta bort en anpassad händelsedefinition	Tar bort en anpassad händelsedefinition.
Ta bort en geofence	Tar bort en befintlig geofence med dess ID.
Ta bort en klient	Tar bort en befintlig klient med dess ID.
Ta bort ett fordon	Ta bort ett fordon med ID.
Ta bort post för anpassad lista	Tar bort befintlig post i den anpassade listan med dess customListId och ID. id – är ett unikt värde för anpassad listpost. Fel: 404 – customListId eller ID hittades inte.
Uppdatera en användare	Uppdaterar en befintlig användare.
Uppdatera en befintlig geofence	Uppdaterar en befintlig geofence med sitt ID.
Uppdatera en del av en användare	Uppdaterar en del av användarens egenskaper.
Uppdatera en klient	Uppdaterar en befintlig klient.
Uppdatera en order	Uppdaterar en befintlig order.
Uppdatera ett fordon	Uppdatera ett fordon med ID.
Uppdatera orderstatus	Ändrar en befintlig orderstatus.
Web hook callback med händelsefeed	Den här exempelmetoden används av händelser/prenumererar på post back event data feed med hjälp av en url från kunden.
Webhook-återanrop med GPS-dataflöde	Den här exempelmetoden används av gpsdata/prenumerera på att skicka tillbaka datafeed med hjälp av kundens url.
Återställer händelsewebbhookprenumerationstatus	Ändrar prenumerationsstatus till status = 1 ("Körs").
Återställer prenumerationsstatus	Ändrar prenumerationsstatus till status = 1 ("Körs").

** Skapa en order

Åtgärds-ID:: OrderController_Create

Lägger till en ny order.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
CreatedDateTime	CreatedDateTime		date-time	Tidpunkt då createUpdateOrderApiModel skapades.
ExternalClientId	ExternalClientId	True	string	Externt användnings-ID för egenskapen Client – API Extension.
ServiceType	ServiceType	True	string	Tjänsttyp som är associerad med den här CreateUpdateOrderApiModel.
ExternalOrderId	ExternalOrderId		string	Externt användnings-OrderId för egenskapen Client – API Extension.
Latitud	Latitude		double
Longitud	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 för den här LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 för den här LocationApiModel.
City	City		string	Ort för LocationApiModel.
RegionNamn	RegionName		string	Regionnamn för LocationApiModel.
Postnummer	PostalCode		string	Postnummer för LocationApiModel.
Landskod	CountryCode		string	ISO 3166-1 alfa-2-kod.
UnderregionNamn	SubRegionName		string	Underregion för LocationApiModel.
Underregionkod	SubRegionCode		string	Underregionkod för LocationApiModel.
RegionCode	RegionCode		string	Regionkod för LocationApiModel.
Namn	Name		string	Namnet på ContactApiModel.
Telefonnummer	PhoneNumber		string	PhoneNumber för ContactApiModel.
E-postmeddelande	Email		string	E-post för ContactApiModel.
Förfallodatum	DueDate		date-time	Tidpunkt då denna BaseUpdateOrderApiModel ska slutföras (föråldrad i v1.3).
StartTime	StartTime		date-time	Tidpunkt då denna BaseUpdateOrderApiModel ska starta (introduceras i v1.3).
EndTime	EndTime		date-time	Tidpunkt då denna BaseUpdateOrderApiModel ska sluta (introduceras i v1.3).
Bildtext	Caption	True	string
Värde	Value			Värdet för UpdateFormFieldApiModel. "NFC"-fältvärdeformat: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Fältvärdesformat för "Kamera" (binär referens): { "BinaryId": sträng, // Binärt ID för en uppladdad bild (se ladda upp binärt API) "Obs": sträng // Obs! för den refererade bilden } Fältvärdeformat för signatur (binär referens): { "BinaryId": sträng // Binärt ID för en uppladdad bild (se ladda upp binärt API) } Fältvärdeformat för "Ljud" (binär referens): { "BinaryId": sträng, // Binärt ID för uppladdat ljud (se ladda upp binärt API) "DurationSeconds": tal // Ljudvaraktighet i sekunder }
CapturedTime	CapturedTime		date-time	Värdet för tidpunkten registrerades.
Latitud	Latitude		double
Longitud	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 för den här LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 för den här LocationApiModel.
City	City		string	Ort för LocationApiModel.
RegionNamn	RegionName		string	Regionnamn för LocationApiModel.
Postnummer	PostalCode		string	Postnummer för LocationApiModel.
Landskod	CountryCode		string	ISO 3166-1 alfa-2-kod.
UnderregionNamn	SubRegionName		string	Underregion för LocationApiModel.
Underregionkod	SubRegionCode		string	Underregionkod för LocationApiModel.
RegionCode	RegionCode		string	Regionkod för LocationApiModel.
Bildtext	Caption	True	string
Värde	Value			Värdet för UpdateFormFieldApiModel. "NFC"-fältvärdeformat: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Fältvärdesformat för "Kamera" (binär referens): { "BinaryId": sträng, // Binärt ID för en uppladdad bild (se ladda upp binärt API) "Obs": sträng // Obs! för den refererade bilden } Fältvärdeformat för signatur (binär referens): { "BinaryId": sträng // Binärt ID för en uppladdad bild (se ladda upp binärt API) } Fältvärdeformat för "Ljud" (binär referens): { "BinaryId": sträng, // Binärt ID för uppladdat ljud (se ladda upp binärt API) "DurationSeconds": tal // Ljudvaraktighet i sekunder }
CapturedTime	CapturedTime		date-time	Värdet för tidpunkten registrerades.
Anställningsnummer	EmployeeNumber	True	string	EmployeeNumber för användaren som skapade den här NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Etikettinnehåll för StatusLabel som är associerad med den här NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	Tidpunkt då den här NewOrderStatusApiModel-statusen startades.
Bildtext	Caption	True	string
Värde	Value			Värdet för UpdateFormFieldApiModel. "NFC"-fältvärdeformat: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Fältvärdesformat för "Kamera" (binär referens): { "BinaryId": sträng, // Binärt ID för en uppladdad bild (se ladda upp binärt API) "Obs": sträng // Obs! för den refererade bilden } Fältvärdeformat för signatur (binär referens): { "BinaryId": sträng // Binärt ID för en uppladdad bild (se ladda upp binärt API) } Fältvärdeformat för "Ljud" (binär referens): { "BinaryId": sträng, // Binärt ID för uppladdat ljud (se ladda upp binärt API) "DurationSeconds": tal // Ljudvaraktighet i sekunder }
CapturedTime	CapturedTime		date-time	Värdet för tidpunkten registrerades.
Latitud	Latitude		double
Longitud	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 för den här LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 för den här LocationApiModel.
City	City		string	Ort för LocationApiModel.
RegionNamn	RegionName		string	Regionnamn för LocationApiModel.
Postnummer	PostalCode		string	Postnummer för LocationApiModel.
Landskod	CountryCode		string	ISO 3166-1 alfa-2-kod.
UnderregionNamn	SubRegionName		string	Underregion för LocationApiModel.
Underregionkod	SubRegionCode		string	Underregionkod för LocationApiModel.
RegionCode	RegionCode		string	Regionkod för LocationApiModel.
Bildtext	Caption	True	string
Värde	Value			Värdet för UpdateFormFieldApiModel. "NFC"-fältvärdeformat: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Fältvärdesformat för "Kamera" (binär referens): { "BinaryId": sträng, // Binärt ID för en uppladdad bild (se ladda upp binärt API) "Obs": sträng // Obs! för den refererade bilden } Fältvärdeformat för signatur (binär referens): { "BinaryId": sträng // Binärt ID för en uppladdad bild (se ladda upp binärt API) } Fältvärdeformat för "Ljud" (binär referens): { "BinaryId": sträng, // Binärt ID för uppladdat ljud (se ladda upp binärt API) "DurationSeconds": tal // Ljudvaraktighet i sekunder }
CapturedTime	CapturedTime		date-time	Värdet för tidpunkten registrerades.
FieldIndex	FieldIndex		integer	Fältindex.
Värde	Value			Fältvärde.
geocode	geocode		boolean	Ska adressen vara geokodad eller inte.

Returer

Body: CustomerAPI.Models.ReturnIdApiModel

Aktivera en användare

Åtgärds-ID:: UserController_Activate

Aktiverar en befintlig användare med dess ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Externt eller internt ID beror på värdet i parametern use-external-id.
use-external-id	use-external-id		boolean	Använd externt ID eller inte.

Aktivera ett fordon

Åtgärds-ID:: VehicleController_Activate

Aktivera ett fordon med ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Externt eller internt ID beror på värdet i parametern use-external-id.
use-external-id	use-external-id		boolean	Använd externt ID eller inte.

Returer

response: integer

Avbryta prenumerationen på WEBB-webbkroken för GPS-data

Åtgärds-ID:: TrackingController_RemoveGpsDataFeedSubscription

Tar bort en prenumeration på EN GPS-datawebbkrok med sitt ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
subscriptionId	subscriptionId	True	string	Prenumerations-ID som ska tas bort.

Avsluta prenumerationen på händelsewebbkroken

Åtgärds-ID:: EventController_RemoveEventDataFeedSubscription

Tar bort en web hook-prenumeration för händelser med dess ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
subscriptionId	subscriptionId	True	string	Prenumerations-ID som ska tas bort.

Få en geofence

Åtgärds-ID:: GeofenceController_GetGeofence

Hämtar en geofence med sitt ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	integer	Geofence-ID.
useMetric	useMetric		boolean	Använd måttsystem eller inte.

Returer

Body: CustomerAPI.Models.Geofence.GeofenceApiModel

Hämta anpassade listdata via CustomListID

Åtgärds-ID:: CustomListController_GetCustomList

Hämtar alla dataposter i en enda anpassad lista med hjälp av CustomListID.

Resultaten sorteras efter kolumn och växling stöds.

Fel:

404 – det finns ingen anpassad lista för angivet customListId.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
customListId	customListId	True	integer	Anpassat list-ID.
pageNumber	pageNumber		integer	Starta sidnummer.
pageSize	pageSize		integer	Sidans storlek.

Returer

Container för datamatris för anpassade listor.

Body: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Hämta anpassade listdefinitioner

Åtgärds-ID:: CustomListController_Get

Hämtar en definitionslista för anpassad lista. Definitionslistan innehåller CustomListID, Namn och Version för alla befintliga anpassade listor.

Returer

response: array of CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Hämta delversion

Åtgärds-ID:: VersionController_Get

Returnerar den aktuella delversionen av API:et.

Hämta en anpassad händelsedefinition efter ID

Åtgärds-ID:: EventController_Get

Hämtar en enskild anpassad händelsedefinition efter ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Händelsedefinitions-ID.

Returer

Anpassad händelsedefinitionsmodell.

Body: CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Hämta en användare

Åtgärds-ID:: UserController_Get

Hämtar en användare efter sitt ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Externt eller internt ID beror på värdet i parametern use-external-id.
use-external-id	use-external-id		boolean	Använd externt ID eller inte.

Returer

Body: CustomerAPI.Models.User.ReadUserApiModel

Hämta en beställning

Åtgärds-ID:: OrderController_GetOrder

Hämtar en befintlig order med sitt ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Externt eller internt ID beror på värdet i parametern use-external-id.
include-status-history	include-status-history		string	Om sant innehåller svaret all statushistorik och formulärdata för den här ordningen.
use-external-id	use-external-id		boolean	Använd externt ID eller inte.

Returer

Body: CustomerAPI.Models.Order.OrderApiModel

Hämta en fordonslista

Åtgärds-ID:: VehicleController_GetVehicles

Hämtar en fordonslista.

Parametrar

Name	Nyckel	Typ	Description
pageNumber	pageNumber	integer	Sidnummer.
pageSize	pageSize	integer	Maximalt antal objekt på en sida. Standard = 1 000. Maxvärde = 2 000.
activeOnly	activeOnly	boolean	om sant - returnerar endast aktiva fordon. Standardvärde = false.

Returer

response: array of CustomerAPI.Models.Vehicles.VehicleReadApi

Hämta en klient

Åtgärds-ID:: ClientController_Get

Hämtar ett klientobjekt med sitt ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Klient-ID.
use-external-id	use-external-id		boolean	Använd externt ID eller inte.

Returer

Body: CustomerAPI.Models.Client.ReadClientApiModel

Hämta en lista över anpassade händelsedefinitioner

Åtgärds-ID:: EventController_GetList

Hämtar en lista över anpassade händelsedefinitioner.

Returer

response: array of CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Hämta en lista över användare

Åtgärds-ID:: UserController_GetUsers

Hämtar en lista över användare. Du kan ange antalet sidor som returneras och antalet element per sida. Resultaten sorteras automatiskt efter UserId och i stigande ordning. Sorteringsparametrar kan inte konfigureras.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
pageNumber	pageNumber		integer	Starta sidnummer. Standardvärdet är 1.
pageSize	pageSize		integer	Sidans storlek. Standardvärdet är 500.

Returer

response: array of CustomerAPI.Models.User.ReadUserListItemApiModel

Hämta en lista över beställningar

Åtgärds-ID:: OrderController_GetOrders

Hämtar en lista över beställningar med hjälp av filtren från de begärandeparametrar som visas nedan. Du kan ange antalet sidor som returneras och antalet element per sida. Resultaten sorteras automatiskt efter Client.Name och i stigande ordning. Sorteringsparametrar kan inte konfigureras.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
dueDateFrom	dueDateFrom	True	date-time	Filtrera efter förfallodatum startdatum.
dueDateTo	dueDateTo	True	date-time	Filtrera efter slutdatum för förfallodatum.
anställningsnummer	employeeNumber		string	Filtrera efter anställds nummer.
pageNumber	pageNumber		integer	Startsida (standard 1).
pageSize	pageSize		integer	Sidstorlek (standard 500).

Returer

response: array of CustomerAPI.Models.Order.OrderListItemApiModel

Hämta en lista över event web hook-prenumerationer

Åtgärds-ID:: EventController_GetSubscriptions

Hämtar en lista över event web hook-prenumerationer. Du kan ange antalet sidor som returneras och antalet element per sida. Resultaten sorteras automatiskt efter SubscriptionId och i stigande ordning. Sorteringsparametrar kan inte konfigureras.

Returer

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Hämta en lista över formulär

Åtgärds-ID:: FormController_GetFormsAsync

Hämtar en lista över formulär med hjälp av något av filtren från de begärandeparametrar som visas nedan. Du kan ange antalet sidor som returneras och antalet element per sida. Resultaten sorteras automatiskt efter SubmittedTime och i fallande ordning. Sorteringsparametrar kan inte konfigureras.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
submittedStartDate	submittedStartDate	True	date-time	Startdatum för det skickade formuläret.
submittedEndDate	submittedEndDate	True	date-time	Slutdatum för det inskickade formuläret.
apiModuleId	apiModuleId		string	Formulärmodul-ID.
anställningsnummer	employeeNumber		string	Personalnummer.
Recenserade	reviewed		boolean	Hämtar endast granskade formulär eller inte. Standardvärdet är null för alla.
pageNumber	pageNumber		integer	Startar sidnummer. Standardvärdet är 1.
pageSize	pageSize		integer	Sidans storlek. Standardvärdet är 1000.

Returer

response: array of CustomerAPI.Models.Forms.StandaloneFormApiModel

Hämta en lista över geofences

Åtgärds-ID:: GeofenceController_GetGeofences

Hämtar en lista över geofences. Du kan ange antalet sidor som returneras och antalet element per sida, samt om geofencekoordinaterna är mått. Resultaten sorteras automatiskt efter Namn och i stigande ordning. Sorteringsparametrar kan inte konfigureras.

Parametrar

Name	Nyckel	Typ	Description
pageNumber	pageNumber	integer	Starta sidnummer. Standardvärdet är 1.
pageSize	pageSize	integer	Sidans storlek. Standardvärdet är 500.
useMetric	useMetric	boolean	Använd måttsystem eller inte.

Returer

response: array of CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Hämta en lista över händelser

Åtgärds-ID:: EventController_GetEvents

Hämtar en lista över händelser under en viss tidsperiod. Du kan ange antalet sidor som returneras och antalet element per sida.

Filtrera efter händelsetyp för att hämta specifika händelser. Fordonshändelser kan returneras för en anställd om den anställde är associerad med fordonet.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
fromDate	fromDate	True	date-time	Startdatumintervall.
toDate	toDate	True	date-time	Datumintervallsslut.
anställningsnummer	employeeNumber		string	Personalnummer.
vehicleNumber	vehicleNumber		string	Fordonsnummer.
pageNumber	pageNumber		integer	Starta sidnummer.
pageSize	pageSize		integer	Sidans storlek.
eventType	eventType		integer	Filtrera efter händelsetyp. antal anställda har angetts: UserEvents(0) – endast användarhändelser. VehicleEvents(1) – endast fordonshändelser, inklusive sensorhändelser. ExternalEvents(2) – endast externa händelser. fordonsnummer anges: UserEvents(0) – N/A. VehicleEvents(1) – endast fordonshändelser, inklusive sensorhändelser. ExternalEvents(2) – endast externa händelser. Varken personalnummer eller fordonsnummer anges: UserEvents(0) – endast användarhändelser. VehicleEvents(1) – endast fordonshändelser, inklusive sensorhändelser. ExternalEvents(2) – endast externa händelser.

Returer

response: array of CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Hämta en lista över klienter

Åtgärds-ID:: ClientController_GetClients

Hämtar en lista över klienter. Du kan ange antalet sidor som returneras och antalet element per sida. Resultaten sorteras automatiskt efter Namn och i stigande ordning. Sorteringsparametrar kan inte konfigureras.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
pageNumber	pageNumber		integer	Starta sidnummer.
pageSize	pageSize		integer	Sidans storlek.

Returer

response: array of CustomerAPI.Models.Client.ReadClientApiModel

Hämta en lista över prenumerationer

Åtgärds-ID:: TrackingController_GetSubscriptions

Hämtar en lista över web hook-prenumerationer. Du kan ange antalet sidor som returneras och antalet element per sida. Resultaten sorteras automatiskt efter SubscriptionId och i stigande ordning. Sorteringsparametrar kan inte konfigureras.

Returer

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Hämta en lista över resor

Åtgärds-ID:: TrackingController_GetTrips

Hämtar en lista över resor under en viss tidsperiod. Du kan ange antalet sidor som returneras och antalet element per sida. Resultaten sorteras automatiskt efter StartUtcTIme och i stigande ordning. Sorteringsparametrar kan inte konfigureras.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
fromDate	fromDate	True	date-time	Startdatumintervall. Rekommendation: Använd stora datumintervall (>=4 timmar) i stället för små datumintervall.
toDate	toDate	True	date-time	Datumintervallsslut. Rekommendation: Använd stora datumintervall (>=4 timmar) i stället för små datumintervall.
anställningsnummer	employeeNumber		string	Personalnummer.
vin	vin		string	Fordonets VIN-nummer.
pageNumber	pageNumber		integer	Starta sidnummer. Standardvärdet är 1.
pageSize	pageSize		integer	Sidans storlek. Standardvärdet är 1000.
useMetric	useMetric		boolean	Använd måttsystem eller inte.

Returer

response: array of CustomerAPI.Models.Tracking.TripApiModel

Hämta en lista över tidshållningsposter

Åtgärds-ID:: TimekeepingController_GetTimekeepingDataList

Hämtar en lista över tidshållningsposter baserat på datumintervall. Du kan ange antalet sidor som returneras och antalet element per sida. Resultaten sorteras automatiskt efter ClockInTime och sedan efter TimekeepingStatusId och i stigande ordning. Sorteringsparametrar kan inte konfigureras.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
fromDate	fromDate	True	date-time	Startdatum.
toDate	toDate	True	date-time	Slutdatum.
anställningsnummer	employeeNumber		string	Personalnummer.
godkänd	approved		boolean	Filtrera endast efter godkänd post.
closedOnly	closedOnly		boolean	Filtrera endast efter stängd post.
excludeFormData	excludeFormData		boolean	Filtrera för att exkludering av formulärdata.
pageNumber	pageNumber		integer	Startsida (standard 1).
pageSize	pageSize		integer	Sidstorlek (standard 1 000).

Returer

response: array of CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Hämta en post från en anpassad lista

Åtgärds-ID:: CustomListController_GetSingleRecord

Hämtar datapost för en enda anpassad lista som hittas av CustomListId och unikt kolumnvärde.

Fel:

404 – det finns ingen anpassad listpost för angivet customListId- och unikt kolumnvärde

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
customListId	customListId	True	integer	Anpassat list-ID.
Id-nummer	id	True	string	Unikt värde.

Returer

Container för datamatris för anpassade listor.

Body: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Hämta en tidshållningspost

Åtgärds-ID:: TimekeepingController_GetTimekeepingEntryAsync

Hämtar en post med dess ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Id för posten.

Returer

Body: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Hämta ett fordon med ID

Åtgärds-ID:: VehicleController_GetVehicle

Hämtar ett enskilt fordon med ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Externt eller internt ID beror på värdet i parametern use-external-id.
use-external-id	use-external-id		boolean	Använd externt ID eller inte.

Returer

Fordonsdatamodell.

Body: CustomerAPI.Models.Vehicles.VehicleReadApi

Hämta ett formulär

Åtgärds-ID:: FormController_GetFormAsync

Hämtar ett formulär med sitt ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	integer	Formulär-ID.

Returer

Body: CustomerAPI.Models.Forms.StandaloneFormApiModel

Hämta GPS-dataposter

Åtgärds-ID:: TrackingController_GetGpsData

Hämtar GPS-dataposter för ett angivet datumintervall. Returnerar också en fortsättningstoken och en länk för att hämta nästa datadel. Du kan ange antalet sidor som returneras och antalet element per sida.

Positioner för borttagna användare/fordon returneras inte. Men om användaren/fordonet fanns när data begärdes och senare togs bort, returneras data för användaren/fordonet som begärs av en fortsättningstoken.

Resultaten sorteras automatiskt efter UtcTime och i stigande ordning. Sorteringsparametrar kan inte konfigureras.

Parametrar

Name	Nyckel	Typ	Description
fromDate	fromDate	date-time	Startdatumintervall. Rekommendation: Använd stora datumintervall (>=4 timmar) i stället för små datumintervall.
toDate	toDate	date-time	Datumintervallsslut. Rekommendation: Använd stora datumintervall (>=4 timmar) i stället för små datumintervall.
anställningsnummer	employeeNumber	string	Personalnummer.
vin	vin	string	Fordonets VIN-nummer.
useMetric	useMetric	boolean	Använd måttsystem eller inte.
token	token	string	Fortsättningstoken som returneras av det första anropet och ska användas i det efterföljande anropet.

Returer

Body: CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Hämta lista med anpassade listfält efter CustomListID

Åtgärds-ID:: CustomListController_GetById

Hämtar en lista med fält för en enda anpassad lista med hjälp av CustomListID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
customListId	customListId	True	integer	Anpassat list-ID.

Returer

Anpassad listmodell.

Body: CustomerAPI.Models.CustomLists.CustomListApiModel

Inaktivera en användare

Åtgärds-ID:: UserController_Deactivate

Inaktiverar en befintlig användare med dess ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Externt eller internt ID beror på värdet i parametern use-external-id.
use-external-id	use-external-id		boolean	Använd externt ID eller inte.

Inaktivera ett fordon

Åtgärds-ID:: VehicleController_Deactivate

Inaktivera ett fordon med ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Externt eller internt ID beror på värdet i parametern use-external-id.
use-external-id	use-external-id		boolean	Använd externt ID eller inte.

Returer

response: integer

Ladda upp bifogad fil

Åtgärds-ID:: BinaryController_UploadAttachment

Använd det här alternativet om du vill ladda upp bifogade filer i formulärfilen. Binär storlek är begränsad till 25 MB. Förväntad begäran om flera delar/formulärdata med en enda fil.

Returer

Body: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Ladda upp binär fil

Åtgärds-ID:: BinaryController_UploadBinary

Använd det här alternativet om du vill ladda upp formulärbilder och ljudfiler. Binär storlek är begränsad till 10 MB. Filtyper som stöds är: JPEG, PNG och MP4.

Returer

Body: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Partiell uppdatering av ett fordon

Åtgärds-ID:: VehicleController_PartialUpdateVehicle

Partiell uppdatering av ett fordon med ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Externt eller internt ID beror på värdet i parametern use-external-id.
			object
use-external-id	use-external-id		boolean	Använd externt ID eller inte.

Returer

Body: CustomerAPI.Models.ReturnIdApiModel

Prenumerera PÅ GPS-datawebbkrok

Åtgärds-ID:: TrackingController_SubscribeToGpsDataFeed

Lägger till en ny webbkrok för GPS-spårningsdata (GPS-positioner). Med webbkrokar kan du ta emot GPS-positioner som förekommer på en angiven URL.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
URL	Url		string	Url som innehåller adressen till WebHookSubscriptionParamsApiModel.
SecurityToken	SecurityToken		string	Säkerhetstoken som är associerad med denna WebHookSubscriptionParamsApiModel.

Returer

Body: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Prenumerera på händelsewebbkrok

Åtgärds-ID:: EventController_SubscribeToEventDataFeed

Lägger till en web hook-prenumeration för nya händelser. Med webbkrokar kan du ta emot automatiska meddelanden om företagshändelser som inträffar på en angiven URL.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
URL	Url		string	Url som innehåller adressen till WebHookSubscriptionParamsApiModel.
SecurityToken	SecurityToken		string	Säkerhetstoken som är associerad med denna WebHookSubscriptionParamsApiModel.

Returer

Body: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Skapa eller uppdatera en anpassad händelsedefinition

Åtgärds-ID:: EventController_Put

Skapar eller uppdaterar en anpassad händelsedefinition.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Händelsedefinitions-ID.
Namn	Name		string
ReverseGeocode	ReverseGeocode		boolean
Namn	Name		string
Typ	Type		integer
Bildtext	Caption		string
Krävs	Required		boolean

Skapa eller uppdatera post för anpassad lista

Åtgärds-ID:: CustomListController_PutRecord

Skapar eller uppdaterar en anpassad listdatapost. Värdet för den unika kolumnen kan utelämnas, men om det finns bör det matcha värdet unikt ID i frågeparametern.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
customListId	customListId	True	integer	Anpassat list-ID.
Id-nummer	id	True	string	Unikt värde.
ColumnIndex	ColumnIndex		integer	Kolumnindex för anpassad lista.
Bildtext	Caption		string	Kolumnrubrik för anpassad lista.
Värde	Value			Kolumnvärde för anpassad lista.

Skapa en användare

Åtgärds-ID:: UserController_Create

Skapar en ny användare.

Parametrar

Name	Nyckel	Typ	Description
Användarnamn	UserName	string	Användarens användarnamn.
Lösenord	Password	password	Användarens lösenord.
GroupName	GroupName	string	Namnet på användarens grupp.
Förnamn	FirstName	string	Användarens förnamn.
Efternamn	LastName	string	Användarens efternamn.
Anställningsnummer	EmployeeNumber	string	Användarens personalnummer.
E-postmeddelande	Email	string	E-postadress till användaren.
Telefon	Phone	string	Användarens telefonnummer.
RoleId	RoleId	integer	RoleId för användaren – (Administratör: 1, Användare: 3, Power User: 5).
Är aktiv	IsActive	boolean	Aktiv status för användaren.
EPTTEnabled	EPTTEnabled	boolean	Status för utökad push-to-talk-funktion för användare: booleskt värde.
EPTTNumber	EPTTNumber	string	Telefonnummer för utökad push-to-talk-funktion för användare: sträng.
EPTTWebMDN	EPTTWebMDN	string	Telefonnummer som används för att autentisera användaren till Kodiak EPTT-systemet – tillhandahålls av Kodiak.
EPTTToken	EPTTToken	string	API-token som används för att autentisera användaren till Kodiak EPTT-systemet – tillhandahålls av Kodiak.
GPSEnabled	GPSEnabled	boolean	Status för GPS-funktionen för användaren.
MobileOnly	MobileOnly	boolean	Status för skrivbordswebbprogramåtkomst för CAB – (Ingen webbappåtkomst: Sant, Fullständig appåtkomst: Falskt).
LicenseType	LicenseType	integer	Typ av licens som tilldelats användaren: – 0 för Odefinierad, 1 för Regular, 2 för WebOnly och 3 för Employee.

Returer

Body: CustomerAPI.Models.ReturnIdApiModel

Skapa en geofence

Åtgärds-ID:: GeofenceController_CreateGeofence

Skapar en ny geofence.

Parametrar

Name	Nyckel	Typ	Description
GroupNames	GroupNames	array of string	GroupPaths för GeofenceCreateApiModel.
Latitud	Latitude	double
Longitud	Longitude	double
Namn	Name	string	Namnet på GeofenceApiModelBase.
Typ	Type	string	Typ av GeofenceApiModel.
Shape	Shape	integer	Form: 0 för cirkel och 1 för polygon.
Latitud	Latitude	double
Longitud	Longitude	double
AddressLine1	AddressLine1	string	AddressLine1 för den här LocationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 för den här LocationApiModel.
City	City	string	Ort för LocationApiModel.
RegionNamn	RegionName	string	Regionnamn för LocationApiModel.
Postnummer	PostalCode	string	Postnummer för LocationApiModel.
Landskod	CountryCode	string	ISO 3166-1 alfa-2-kod.
UnderregionNamn	SubRegionName	string	Underregion för LocationApiModel.
Underregionkod	SubRegionCode	string	Underregionkod för LocationApiModel.
RegionCode	RegionCode	string	Regionkod för LocationApiModel.
Radie	Radius	double	Radius för GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress för GeofenceApiModel.
useMetric	useMetric	boolean	Använd måttsystem eller inte.
geocode	geocode	boolean	Ska adressen vara geokodad eller inte.

Returer

Body: CustomerAPI.Models.ReturnIdApiModel

Skapa en klient

Åtgärds-ID:: ClientController_Create

Skapar en ny klient.

Parametrar

Name	Nyckel	Typ	Description
ExternalId	ExternalId	string	Externt användnings-ID för egenskapen Client – API Extension.
FieldIndex	FieldIndex	integer	Fältindex.
Värde	Value		Fältvärde.
Namn	Name	string	Namnet på klienten.
Latitud	Latitude	double
Longitud	Longitude	double
AddressLine1	AddressLine1	string	AddressLine1 för den här LocationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 för den här LocationApiModel.
City	City	string	Ort för LocationApiModel.
RegionNamn	RegionName	string	Regionnamn för LocationApiModel.
Postnummer	PostalCode	string	Postnummer för LocationApiModel.
Landskod	CountryCode	string	ISO 3166-1 alfa-2-kod.
UnderregionNamn	SubRegionName	string	Underregion för LocationApiModel.
Underregionkod	SubRegionCode	string	Underregionkod för LocationApiModel.
RegionCode	RegionCode	string	Regionkod för LocationApiModel.
Namn	Name	string	Namnet på ContactApiModel.
Telefonnummer	PhoneNumber	string	PhoneNumber för ContactApiModel.
E-postmeddelande	Email	string	E-post för ContactApiModel.
geocode	geocode	boolean	Ska adressen vara geokodad eller inte.

Returer

Body: CustomerAPI.Models.ReturnIdApiModel

Skapa ett fordon

Åtgärds-ID:: VehicleController_CreateVehicle

Skapar ett fordon.

Parametrar

Name	Nyckel	Typ
Nummer	Number	string
Namn	Name	string
Typ	Type	string
Tag	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
TimeZone	TimeZone	string
Göra	Make	string
År	Year	integer
Model	Model	string
Färg	Color	string
VIN	VIN	string
Är aktiv	IsActive	boolean
Enhetstyp	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

Returer

Body: CustomerAPI.Models.ReturnIdApiModel

Skapa ett formulär

Åtgärds-ID:: FormController_PostFormAsync

Lägger till ett nytt formulär.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ApiModuleId	ApiModuleId		string	ID för ApiModule som är associerat med den här CreateStandaloneFormApiModel.
Recenserade	Reviewed		boolean	Status för granskning av denna CreateStandaloneFormApiModel.
UserId	UserId		integer	UserId för användaren.
Anställningsnummer	EmployeeNumber		string	Användarens personalnummer.
SubmittedTime	SubmittedTime	True	date-time	Tidpunkt då CreateStandaloneFormApiModel skickades.
Latitud	Latitude		double
Longitud	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 för den här LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 för den här LocationApiModel.
City	City		string	Ort för LocationApiModel.
RegionNamn	RegionName		string	Regionnamn för LocationApiModel.
Postnummer	PostalCode		string	Postnummer för LocationApiModel.
Landskod	CountryCode		string	ISO 3166-1 alfa-2-kod.
UnderregionNamn	SubRegionName		string	Underregion för LocationApiModel.
Underregionkod	SubRegionCode		string	Underregionkod för LocationApiModel.
RegionCode	RegionCode		string	Regionkod för LocationApiModel.
ApiFieldId	ApiFieldId	True	string	API-fält-ID.
Värde	Value	True		Värdet för FormFieldDataApiModel. "NFC"-fältvärdeformat: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Fältvärdesformat för "Kamera" (binär referens): { "BinaryId": sträng, // Binärt ID för en uppladdad bild (se ladda upp binärt API) "Obs": sträng // Obs! för den refererade bilden } Fältvärdesformat för "Signera" (binär referens): { "BinaryId": sträng // Binärt ID för en uppladdad bild (se ladda upp binärt API) } Fältvärdeformat för "Ljud" (binär referens): { "BinaryId": sträng, // Binärt ID för uppladdat ljud (se ladda upp binärt API) "DurationSeconds": tal // Ljudvaraktighet i sekunder }
CapturedTime	CapturedTime		date-time	Tid då binära data hämtades. Format – datum-tid (som datum-tid i RFC3339) inklusive förskjutning.
Latitud	Latitude		double
Longitud	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 för den här LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 för den här LocationApiModel.
City	City		string	Ort för LocationApiModel.
RegionNamn	RegionName		string	Regionnamn för LocationApiModel.
Postnummer	PostalCode		string	Postnummer för LocationApiModel.
Landskod	CountryCode		string	ISO 3166-1 alfa-2-kod.
UnderregionNamn	SubRegionName		string	Underregion för LocationApiModel.
Underregionkod	SubRegionCode		string	Underregionkod för LocationApiModel.
RegionCode	RegionCode		string	Regionkod för LocationApiModel.
ApiFieldId	ApiFieldId	True	string	API-fält-ID.
Värde	Value	True		Värdet för FormFieldDataApiModel. "NFC"-fältvärdeformat: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Fältvärdesformat för "Kamera" (binär referens): { "BinaryId": sträng, // Binärt ID för en uppladdad bild (se ladda upp binärt API) "Obs": sträng // Obs! för den refererade bilden } Fältvärdesformat för "Signera" (binär referens): { "BinaryId": sträng // Binärt ID för en uppladdad bild (se ladda upp binärt API) } Fältvärdeformat för "Ljud" (binär referens): { "BinaryId": sträng, // Binärt ID för uppladdat ljud (se ladda upp binärt API) "DurationSeconds": tal // Ljudvaraktighet i sekunder }
CapturedTime	CapturedTime		date-time	Tid då binära data hämtades. Format – datum-tid (som datum-tid i RFC3339) inklusive förskjutning.

Returer

Body: CustomerAPI.Models.ReturnIdApiModel

Skicka händelse

Åtgärds-ID:: EventController_Post

Skickar händelsen.

Parametrar

Name	Nyckel	Typ	Description
EventDefinitionId	EventDefinitionId	string	Händelsedefinitions-ID.
Anställningsnummer	EmployeeNumber	string	Personalnummer.
VehicleNumber	VehicleNumber	string	Fordonsnummer.
DeviceSerialNumber	DeviceSerialNumber	string	GpsDeviceDto serienummer.
Latitud	Latitude	double
Longitud	Longitude	double
AddressLine1	AddressLine1	string	AddressLine1 för den här LocationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 för den här LocationApiModel.
City	City	string	Ort för LocationApiModel.
RegionNamn	RegionName	string	Regionnamn för LocationApiModel.
Postnummer	PostalCode	string	Postnummer för LocationApiModel.
Landskod	CountryCode	string	ISO 3166-1 alfa-2-kod.
UnderregionNamn	SubRegionName	string	Underregion för LocationApiModel.
Underregionkod	SubRegionCode	string	Underregionkod för LocationApiModel.
RegionCode	RegionCode	string	Regionkod för LocationApiModel.
Time	Time	date-time
Parameterar	Parameters	object	Händelseparametrar.

Ta bort en anpassad händelsedefinition

Åtgärds-ID:: EventController_Delete

Tar bort en anpassad händelsedefinition.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Händelsedefinitions-ID.

Ta bort en geofence

Åtgärds-ID:: GeofenceController_DeleteGeofence

Tar bort en befintlig geofence med dess ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	integer	Geofence-ID.

Ta bort en klient

Åtgärds-ID:: ClientController_Delete

Tar bort en befintlig klient med dess ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Klient-ID.
use-external-id	use-external-id		boolean	Använd externt ID eller inte.

Ta bort ett fordon

Åtgärds-ID:: VehicleController_Delete

Ta bort ett fordon med ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Externt eller internt ID beror på värdet i parametern use-external-id.
use-external-id	use-external-id		boolean	Använd externt ID eller inte.

Ta bort post för anpassad lista

Åtgärds-ID:: CustomListController_DeleteRecord

Tar bort befintlig post i den anpassade listan med dess customListId och ID.

id – är ett unikt värde för anpassad listpost.

Fel:

404 – customListId eller ID hittades inte.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
customListId	customListId	True	integer	Anpassat list-ID.
Id-nummer	id	True	string	Unikt värde.

Uppdatera en användare

Åtgärds-ID:: UserController_Update

Uppdaterar en befintlig användare.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Externt eller internt ID beror på värdet i parametern use-external-id.
Användarnamn	UserName		string	Användarens användarnamn.
Lösenord	Password		password	Användarens lösenord.
GroupName	GroupName		string	Namnet på användarens grupp.
Förnamn	FirstName		string	Användarens förnamn.
Efternamn	LastName		string	Användarens efternamn.
Anställningsnummer	EmployeeNumber		string	Användarens personalnummer.
E-postmeddelande	Email		string	E-postadress till användaren.
Telefon	Phone		string	Användarens telefonnummer.
RoleId	RoleId		integer	RoleId för användaren – (Administratör: 1, Användare: 3, Power User: 5).
Är aktiv	IsActive		boolean	Aktiv status för användaren.
EPTTEnabled	EPTTEnabled		boolean	Status för utökad push-to-talk-funktion för användare: booleskt värde.
EPTTNumber	EPTTNumber		string	Telefonnummer för utökad push-to-talk-funktion för användare: sträng.
EPTTWebMDN	EPTTWebMDN		string	Telefonnummer som används för att autentisera användaren till Kodiak EPTT-systemet – tillhandahålls av Kodiak.
EPTTToken	EPTTToken		string	API-token som används för att autentisera användaren till Kodiak EPTT-systemet – tillhandahålls av Kodiak.
GPSEnabled	GPSEnabled		boolean	Status för GPS-funktionen för användaren.
MobileOnly	MobileOnly		boolean	Status för skrivbordswebbprogramåtkomst för CAB – (Ingen webbappåtkomst: Sant, Fullständig appåtkomst: Falskt).
LicenseType	LicenseType		integer	Typ av licens som tilldelats användaren: – 0 för Odefinierad, 1 för Regular, 2 för WebOnly och 3 för Employee.
use-external-id	use-external-id		boolean	Använd externt ID eller inte.

Returer

Body: CustomerAPI.Models.ReturnIdApiModel

Uppdatera en befintlig geofence

Åtgärds-ID:: GeofenceController_UpdateGeofence

Uppdaterar en befintlig geofence med sitt ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	integer	Geofence-ID.
GroupNames	GroupNames		array of string	GroupPaths för GeofenceUpdateApiModel.
Latitud	Latitude		double
Longitud	Longitude		double
Namn	Name		string	Namnet på GeofenceApiModelBase.
Typ	Type		string	Typ av GeofenceApiModel.
Shape	Shape		integer	Form: 0 för cirkel och 1 för polygon.
Latitud	Latitude		double
Longitud	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 för den här LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 för den här LocationApiModel.
City	City		string	Ort för LocationApiModel.
RegionNamn	RegionName		string	Regionnamn för LocationApiModel.
Postnummer	PostalCode		string	Postnummer för LocationApiModel.
Landskod	CountryCode		string	ISO 3166-1 alfa-2-kod.
UnderregionNamn	SubRegionName		string	Underregion för LocationApiModel.
Underregionkod	SubRegionCode		string	Underregionkod för LocationApiModel.
RegionCode	RegionCode		string	Regionkod för LocationApiModel.
Radie	Radius		double	Radius för GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress		boolean	UseGeofenceAddress för GeofenceApiModel.
useMetric	useMetric		boolean	Använd måttsystem eller inte.
geocode	geocode		boolean	Ska adressen vara geokodad eller inte.

Returer

Body: CustomerAPI.Models.ReturnIdApiModel

Uppdatera en del av en användare

Åtgärds-ID:: UserController_PartialUpdate

Uppdaterar en del av användarens egenskaper.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Externt eller internt ID beror på värdet i parametern use-external-id.
			object
use-external-id	use-external-id		boolean	Använd externt ID eller inte.

Returer

Body: CustomerAPI.Models.ReturnIdApiModel

Uppdatera en klient

Åtgärds-ID:: ClientController_Update

Uppdaterar en befintlig klient.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Externt eller internt ID beror på värdet i parametern use-external-id.
ExternalId	ExternalId		string	Externt användnings-ID för egenskapen Client – API Extension.
FieldIndex	FieldIndex		integer	Fältindex.
Värde	Value			Fältvärde.
Namn	Name		string	Namnet på klienten.
Latitud	Latitude		double
Longitud	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 för den här LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 för den här LocationApiModel.
City	City		string	Ort för LocationApiModel.
RegionNamn	RegionName		string	Regionnamn för LocationApiModel.
Postnummer	PostalCode		string	Postnummer för LocationApiModel.
Landskod	CountryCode		string	ISO 3166-1 alfa-2-kod.
UnderregionNamn	SubRegionName		string	Underregion för LocationApiModel.
Underregionkod	SubRegionCode		string	Underregionkod för LocationApiModel.
RegionCode	RegionCode		string	Regionkod för LocationApiModel.
Namn	Name		string	Namnet på ContactApiModel.
Telefonnummer	PhoneNumber		string	PhoneNumber för ContactApiModel.
E-postmeddelande	Email		string	E-post för ContactApiModel.
geocode	geocode		boolean	Ska adressen vara geokodad eller inte.
use-external-id	use-external-id		boolean	Använd externt ID eller inte.

Returer

Body: CustomerAPI.Models.ReturnIdApiModel

Uppdatera en order

Åtgärds-ID:: OrderController_Update

Uppdaterar en befintlig order.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Externt eller internt ID beror på värdet i parametern use-external-id.
ExternalOrderId	ExternalOrderId		string	Externt användnings-OrderId för egenskapen Client – API Extension.
Omsluten	IsClosed		boolean	Status som visar om UpdateOrderApiModel stängdes.
Latitud	Latitude		double
Longitud	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 för den här LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 för den här LocationApiModel.
City	City		string	Ort för LocationApiModel.
RegionNamn	RegionName		string	Regionnamn för LocationApiModel.
Postnummer	PostalCode		string	Postnummer för LocationApiModel.
Landskod	CountryCode		string	ISO 3166-1 alfa-2-kod.
UnderregionNamn	SubRegionName		string	Underregion för LocationApiModel.
Underregionkod	SubRegionCode		string	Underregionkod för LocationApiModel.
RegionCode	RegionCode		string	Regionkod för LocationApiModel.
Namn	Name		string	Namnet på ContactApiModel.
Telefonnummer	PhoneNumber		string	PhoneNumber för ContactApiModel.
E-postmeddelande	Email		string	E-post för ContactApiModel.
Förfallodatum	DueDate		date-time	Tidpunkt då denna BaseUpdateOrderApiModel ska slutföras (föråldrad i v1.3).
StartTime	StartTime		date-time	Tidpunkt då denna BaseUpdateOrderApiModel ska starta (introduceras i v1.3).
EndTime	EndTime		date-time	Tidpunkt då denna BaseUpdateOrderApiModel ska sluta (introduceras i v1.3).
Bildtext	Caption	True	string
Värde	Value			Värdet för UpdateFormFieldApiModel. "NFC"-fältvärdeformat: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Fältvärdesformat för "Kamera" (binär referens): { "BinaryId": sträng, // Binärt ID för en uppladdad bild (se ladda upp binärt API) "Obs": sträng // Obs! för den refererade bilden } Fältvärdeformat för signatur (binär referens): { "BinaryId": sträng // Binärt ID för en uppladdad bild (se ladda upp binärt API) } Fältvärdeformat för "Ljud" (binär referens): { "BinaryId": sträng, // Binärt ID för uppladdat ljud (se ladda upp binärt API) "DurationSeconds": tal // Ljudvaraktighet i sekunder }
CapturedTime	CapturedTime		date-time	Värdet för tidpunkten registrerades.
Latitud	Latitude		double
Longitud	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 för den här LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 för den här LocationApiModel.
City	City		string	Ort för LocationApiModel.
RegionNamn	RegionName		string	Regionnamn för LocationApiModel.
Postnummer	PostalCode		string	Postnummer för LocationApiModel.
Landskod	CountryCode		string	ISO 3166-1 alfa-2-kod.
UnderregionNamn	SubRegionName		string	Underregion för LocationApiModel.
Underregionkod	SubRegionCode		string	Underregionkod för LocationApiModel.
RegionCode	RegionCode		string	Regionkod för LocationApiModel.
Bildtext	Caption	True	string
Värde	Value			Värdet för UpdateFormFieldApiModel. "NFC"-fältvärdeformat: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Fältvärdesformat för "Kamera" (binär referens): { "BinaryId": sträng, // Binärt ID för en uppladdad bild (se ladda upp binärt API) "Obs": sträng // Obs! för den refererade bilden } Fältvärdeformat för signatur (binär referens): { "BinaryId": sträng // Binärt ID för en uppladdad bild (se ladda upp binärt API) } Fältvärdeformat för "Ljud" (binär referens): { "BinaryId": sträng, // Binärt ID för uppladdat ljud (se ladda upp binärt API) "DurationSeconds": tal // Ljudvaraktighet i sekunder }
CapturedTime	CapturedTime		date-time	Värdet för tidpunkten registrerades.
Anställningsnummer	EmployeeNumber	True	string	EmployeeNumber för användaren som skapade den här NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Etikettinnehåll för StatusLabel som är associerad med den här NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	Tidpunkt då den här NewOrderStatusApiModel-statusen startades.
Bildtext	Caption	True	string
Värde	Value			Värdet för UpdateFormFieldApiModel. "NFC"-fältvärdeformat: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Fältvärdesformat för "Kamera" (binär referens): { "BinaryId": sträng, // Binärt ID för en uppladdad bild (se ladda upp binärt API) "Obs": sträng // Obs! för den refererade bilden } Fältvärdeformat för signatur (binär referens): { "BinaryId": sträng // Binärt ID för en uppladdad bild (se ladda upp binärt API) } Fältvärdeformat för "Ljud" (binär referens): { "BinaryId": sträng, // Binärt ID för uppladdat ljud (se ladda upp binärt API) "DurationSeconds": tal // Ljudvaraktighet i sekunder }
CapturedTime	CapturedTime		date-time	Värdet för tidpunkten registrerades.
Latitud	Latitude		double
Longitud	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 för den här LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 för den här LocationApiModel.
City	City		string	Ort för LocationApiModel.
RegionNamn	RegionName		string	Regionnamn för LocationApiModel.
Postnummer	PostalCode		string	Postnummer för LocationApiModel.
Landskod	CountryCode		string	ISO 3166-1 alfa-2-kod.
UnderregionNamn	SubRegionName		string	Underregion för LocationApiModel.
Underregionkod	SubRegionCode		string	Underregionkod för LocationApiModel.
RegionCode	RegionCode		string	Regionkod för LocationApiModel.
Bildtext	Caption	True	string
Värde	Value			Värdet för UpdateFormFieldApiModel. "NFC"-fältvärdeformat: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Fältvärdesformat för "Kamera" (binär referens): { "BinaryId": sträng, // Binärt ID för en uppladdad bild (se ladda upp binärt API) "Obs": sträng // Obs! för den refererade bilden } Fältvärdeformat för signatur (binär referens): { "BinaryId": sträng // Binärt ID för en uppladdad bild (se ladda upp binärt API) } Fältvärdeformat för "Ljud" (binär referens): { "BinaryId": sträng, // Binärt ID för uppladdat ljud (se ladda upp binärt API) "DurationSeconds": tal // Ljudvaraktighet i sekunder }
CapturedTime	CapturedTime		date-time	Värdet för tidpunkten registrerades.
FieldIndex	FieldIndex		integer	Fältindex.
Värde	Value			Fältvärde.
geocode	geocode		boolean	Ska adressen vara geokodad eller inte.
use-external-id	use-external-id		boolean	Använd externt ID eller inte.

Returer

Body: CustomerAPI.Models.ReturnIdApiModel

Uppdatera ett fordon

Åtgärds-ID:: VehicleController_UpdateVehicle

Uppdatera ett fordon med ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Externt eller internt ID beror på värdet i parametern use-external-id.
Nummer	Number		string
Namn	Name		string
Typ	Type		string
Tag	Tag		string
UserEmployeeNumber	UserEmployeeNumber		string
GroupName	GroupName		string
TimeZone	TimeZone		string
Göra	Make		string
År	Year		integer
Model	Model		string
Färg	Color		string
VIN	VIN		string
Är aktiv	IsActive		boolean
Enhetstyp	DeviceType		integer
DeviceSerialNumber	DeviceSerialNumber		string
use-external-id	use-external-id		boolean	Använd externt ID eller inte.

Returer

response: integer

Uppdatera orderstatus

Åtgärds-ID:: OrderController_ChangeStatus

Ändrar en befintlig orderstatus.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Id-nummer	id	True	string	Externt eller internt ID beror på värdet i parametern use-external-id.
Anställningsnummer	EmployeeNumber	True	string	EmployeeNumber för användaren som skapade den här NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Etikettinnehåll för StatusLabel som är associerad med den här NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	Tidpunkt då den här NewOrderStatusApiModel-statusen startades.
Bildtext	Caption	True	string
Värde	Value			Värdet för UpdateFormFieldApiModel. "NFC"-fältvärdeformat: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Fältvärdesformat för "Kamera" (binär referens): { "BinaryId": sträng, // Binärt ID för en uppladdad bild (se ladda upp binärt API) "Obs": sträng // Obs! för den refererade bilden } Fältvärdeformat för signatur (binär referens): { "BinaryId": sträng // Binärt ID för en uppladdad bild (se ladda upp binärt API) } Fältvärdeformat för "Ljud" (binär referens): { "BinaryId": sträng, // Binärt ID för uppladdat ljud (se ladda upp binärt API) "DurationSeconds": tal // Ljudvaraktighet i sekunder }
CapturedTime	CapturedTime		date-time	Värdet för tidpunkten registrerades.
Latitud	Latitude		double
Longitud	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 för den här LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 för den här LocationApiModel.
City	City		string	Ort för LocationApiModel.
RegionNamn	RegionName		string	Regionnamn för LocationApiModel.
Postnummer	PostalCode		string	Postnummer för LocationApiModel.
Landskod	CountryCode		string	ISO 3166-1 alfa-2-kod.
UnderregionNamn	SubRegionName		string	Underregion för LocationApiModel.
Underregionkod	SubRegionCode		string	Underregionkod för LocationApiModel.
RegionCode	RegionCode		string	Regionkod för LocationApiModel.
Bildtext	Caption	True	string
Värde	Value			Värdet för UpdateFormFieldApiModel. "NFC"-fältvärdeformat: { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Fältvärdesformat för "Kamera" (binär referens): { "BinaryId": sträng, // Binärt ID för en uppladdad bild (se ladda upp binärt API) "Obs": sträng // Obs! för den refererade bilden } Fältvärdeformat för signatur (binär referens): { "BinaryId": sträng // Binärt ID för en uppladdad bild (se ladda upp binärt API) } Fältvärdeformat för "Ljud" (binär referens): { "BinaryId": sträng, // Binärt ID för uppladdat ljud (se ladda upp binärt API) "DurationSeconds": tal // Ljudvaraktighet i sekunder }
CapturedTime	CapturedTime		date-time	Värdet för tidpunkten registrerades.
use-external-id	use-external-id		boolean	Använd externt ID eller inte.

Returer

Body: CustomerAPI.Models.ReturnIdApiModel

Web hook callback med händelsefeed

Åtgärds-ID:: EventController_subscribe_callback

Den här exempelmetoden används av händelser/prenumererar på post back event data feed med hjälp av en url från kunden.

Parametrar

Name	Nyckel	Typ	Description
Id	Id	string	Url som innehåller adressen till WebHookSubscriptionParamsApiModel.
Evenemangstyp	EventType	integer
EventCode	EventCode	string
Evenemangstid	EventTime	date-time	ISO-format med lokal och förskjutning.
DeviceId	DeviceId	string	GpsDeviceDto-ID som är associerat med prenumerationen.
Enhetstyp	DeviceType	integer	GpsDeviceDto typ: Handenhet (0), CalAmp (1), Geotab (2), Xirgo (3).
UserId	UserId	integer	Användar-ID.
VehicleId	VehicleId	integer	Fordons-ID.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Om en användare är kopplad till fordonet.
Lat	Lat	double	Breddgrad.
Lon	Lon	double	Longitud.
CustomEventDefinitionId	CustomEventDefinitionId	string
EventParams	EventParams	object	Händelseparametrar.

Returer

response: object

Webhook-återanrop med GPS-dataflöde

Åtgärds-ID:: TrackingController_subscribe_callback

Den här exempelmetoden används av gpsdata/prenumerera på att skicka tillbaka datafeed med hjälp av kundens url.

Parametrar

Name	Nyckel	Typ	Description
Id	Id	string	Url som innehåller adressen till WebHookSubscriptionParamsApiModel.
DeviceId	DeviceId	string	GpsDeviceDto-ID som är associerat med prenumerationen.
Enhetstyp	DeviceType	integer	GpsDeviceDto typ: Handset(0), CalAmp(1), Geotab (2), Xirgo (3).
Tidsstämpel	Timestamp	date-time	ISO-format med lokal och förskjutning.
CompanyId	CompanyId	integer	Företags-ID.
UserId	UserId	integer	Användar-ID.
VehicleId	VehicleId	integer	Fordons-ID.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Om en användare är kopplad till fordonet.
LocationProvider	LocationProvider	string	Platsproviderns namn.
Lat	Lat	double	Breddgrad.
Lon	Lon	double	Longitud.
AccuracyFt	AccuracyFt	double	Positionsnoggrannhet (fötter).
AltitudeFt	AltitudeFt	double	Höjd (fötter).
Heading	Heading	integer	Kompassriktning i grader.
SpeedMph	SpeedMph	double	Rörelsehastighet (Mph).
BatteryStatus	BatteryStatus	integer	Batteristatus: Laddar inte(0), Laddning(1).
BatteryLevel	BatteryLevel	integer	Batterinivå i procent.
ActivityState	ActivityState	integer	Aktivitetstillstånd: Staying(1), Modving(2).
IsNetworkConnected	IsNetworkConnected	boolean	Är enheten ansluten till nätverket just nu.
Rssi	Rssi	integer	Indikator för mottagen signalstyrka.
DOdoMl	DOdoMl	double	GpsDeviceDto Odometer (Miles).
VOdoMl	VOdoMl	double	Fordonsmätare (miles).

Returer

response: object

Återställer händelsewebbhookprenumerationstatus

Åtgärds-ID:: EventController_ResetSubscriptionHealthStatus

Ändrar prenumerationsstatus till status = 1 ("Körs").

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
subscriptionId	subscriptionId	True	integer	Prenumerations-ID.

Återställer prenumerationsstatus

Åtgärds-ID:: TrackingController_ResetSubscriptionHealthStatus

Ändrar prenumerationsstatus till status = 1 ("Körs").

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
subscriptionId	subscriptionId	True	integer	Prenumerations-ID.

Utlösare

Avsökning av beställningar	Med api-avsökningsslutpunkten Orders kan ditt program kontinuerligt avsöka och bearbeta de senaste ändringarna i beställningar. Integration: Den här slutpunkten är utformad för att fungera direkt med Microsoft Flow som en avsökningsutlösarintegrering. Du kan också utveckla din egen anpassade integrering med valfritt språk. Användning: I ett typiskt scenario bör den första begäran till den här slutpunkten inte innehålla några parametrar. Det finns två (2) möjliga lyckade svar: HTTP-svarskod 200 – Nyligen ändrade beställningar finns; svarstexten visar orderdata. HTTP-svarskod 202 – Det finns inga nyligen ändrade beställningar. svarstexten är tom. I båda fallen finns det två (2) viktiga rubriker i svaret: Plats – URL:en för nästa begäran. Retry-After – Det rekommenderade tidsintervallet i sekunder för nästa begäran. Om det till exempel finns data att hämta har Retry-After-huvudet värdet 1 eller 60. Om det inte finns några data att hämta blir värdet för Retry-After-huvudet 300. Obs! Det här är bara rekommenderade värden – ditt program kan välja att avsöka med en annan frekvens beroende på dina behov. Efter den första begäran ska alla efterföljande begäranden använda url:en som anges i platsrubriken för det senaste svaret. Lägg inte till fler parametrar i URL:en eftersom den redan innehåller de parametrar som krävs för att säkerställa att orderändringarna inte saknas i begäran. Resultaten sorteras automatiskt efter ModifiedUtc och sedan efter OrderId i stigande ordning. Sorteringsparametrar kan inte konfigureras. ModifiedUtc-definition: intern tidstagg = tid för senaste ändring av orderdata.
Avsökning av orderstatusar	Med API-avsökningsslutpunkten Order Statuses kan ditt program kontinuerligt avsöka och bearbeta de senaste ändringarna i beställningar. Integration: Den här slutpunkten är utformad för att fungera direkt med Microsoft Flow som en avsökningsutlösarintegrering. Du kan också utveckla din egen anpassade integrering med valfritt språk. Användning: I ett typiskt scenario bör den första begäran till den här slutpunkten inte innehålla några parametrar. Det finns två (2) möjliga lyckade svar: HTTP-svarskod 200 – Det finns nyligen ändrade orderstatusposter. svarstexten visar orderstatusdata HTTP-svarskod 202 – Det finns inga nyligen skickade poster. svarstexten är tom. I båda fallen finns det två (2) viktiga rubriker i svaret: Plats – URL:en för nästa begäran. Retry-After – Det rekommenderade tidsintervallet i sekunder för nästa begäran. Om det till exempel finns data att hämta har Retry-After-huvudet värdet 1 eller 60. Om det inte finns några data att hämta blir värdet för Retry-After-huvudet 300. Obs! Det här är bara rekommenderade värden – ditt program kan välja att avsöka med en annan frekvens beroende på dina behov. Efter den första begäran ska alla efterföljande begäranden använda url:en som anges i platsrubriken för det senaste svaret. Lägg inte till fler parametrar i URL:en eftersom den redan innehåller de som behövs för att säkerställa att orderstatusar inte saknas i begäran. Resultaten sorteras efter ModifiedUtc och sedan efter StatusId, i stigande ordning. Sorteringsparametrar kan inte konfigureras. ModifiedUtc-definition: intern tidstagg = tid för senaste ändring av orderstatusdata.
Formulärdatasökning	Med slutpunkten för Forms API-avsökning kan ditt program kontinuerligt avsöka och bearbeta nyligen skickade fristående formulär. Integration: Den här slutpunkten är utformad för att fungera direkt med Microsoft Flow som en avsökningsutlösarintegrering. Du kan också utveckla din egen anpassade integrering med valfritt språk. Användning: I ett typiskt scenario bör den första begäran till den här slutpunkten inte innehålla några parametrar. Det finns två (2) möjliga lyckade svar: HTTP-svarskod 200 – formulärposter som nyligen skickats finns. svarstexten visar formulärdata. HTTP-svarskod 202 – Det finns inga nyligen skickade poster. svarstexten är tom. I båda fallen finns det två (2) viktiga rubriker i svaret: Plats – URL:en för nästa begäran. Retry-After – Det rekommenderade tidsintervallet i sekunder för nästa begäran. Om det till exempel finns data att hämta har Retry-After-huvudet värdet 1 eller 60. Om det inte finns några data att hämta blir värdet för Retry-After-huvudet 300. Obs! Det här är bara rekommenderade värden – ditt program kan välja att avsöka med en annan frekvens beroende på dina behov. Efter den första begäran ska alla efterföljande begäranden använda url:en som anges i platsrubriken för det senaste svaret. Lägg inte till fler parametrar i URL:en eftersom den redan innehåller de parametrar som krävs för att säkerställa att formulären inte saknas i begäran. Resultaten sorteras automatiskt efter ModifiedUtc och sedan efter FormHeaderId i stigande ordning. Sorteringsparametrar kan inte konfigureras. ModifiedUtc-definition: intern tidstagg = tid för senaste ändring av formulärdata.
Tidtagningsundersökning	Med slutpunkten för timekeeping API-avsökning kan ditt program kontinuerligt avsöka och bearbeta nyligen skickade tidtagningsposter. Integration: Den här slutpunkten är utformad för att fungera direkt med Microsoft Flow som en avsökningsutlösarintegrering. Du kan också utveckla din egen anpassade integrering med valfritt språk. Användning: I ett typiskt scenario bör den första begäran till den här slutpunkten inte innehålla några parametrar. Det finns två (2) möjliga lyckade svar: HTTP-svarskod 200 – Det finns nyligen skickade tidhållningsposter. svarstexten visar tidsåtgångsinmatningsdata. HTTP-svarskod 202 – Det finns inga nyligen skickade poster. svarstexten är tom. I båda fallen finns det två (2) viktiga rubriker i svaret: Plats – URL:en för nästa begäran. Retry-After – Det rekommenderade tidsintervallet i sekunder för nästa begäran. Om det till exempel finns data att hämta har Retry-After-huvudet värdet 1 eller 60. Om det inte finns några data att hämta blir värdet för Retry-After-huvudet 300. Obs! Det här är bara rekommenderade värden – ditt program kan välja att avsöka med en annan frekvens beroende på dina behov. Efter den första begäran ska alla efterföljande begäranden använda url:en som anges i platsrubriken för det senaste svaret. Lägg inte till fler parametrar i URL:en eftersom den redan innehåller de som behövs för att säkerställa att tidshållningsposter inte saknas i begäran. Resultaten sorteras automatiskt efter ModifiedUtc och sedan efter TimekeepingStatusId och sedan i stigande ordning. Sorteringsparametrar kan inte konfigureras. ModifiedUtc-definition: intern tidstagg = tid för senaste tidshållningsstatusändring.

Avsökning av beställningar

Åtgärds-ID:: OrderController_Poll

Med api-avsökningsslutpunkten Orders kan ditt program kontinuerligt avsöka och bearbeta de senaste ändringarna i beställningar.

Integration:

Den här slutpunkten är utformad för att fungera direkt med Microsoft Flow som en avsökningsutlösarintegrering. Du kan också utveckla din egen anpassade integrering med valfritt språk.

Användning:

I ett typiskt scenario bör den första begäran till den här slutpunkten inte innehålla några parametrar. Det finns två (2) möjliga lyckade svar:

HTTP-svarskod 200 – Nyligen ändrade beställningar finns; svarstexten visar orderdata.
HTTP-svarskod 202 – Det finns inga nyligen ändrade beställningar. svarstexten är tom.

I båda fallen finns det två (2) viktiga rubriker i svaret:

Plats – URL:en för nästa begäran.
Retry-After – Det rekommenderade tidsintervallet i sekunder för nästa begäran. Om det till exempel finns data att hämta har Retry-After-huvudet värdet 1 eller 60. Om det inte finns några data att hämta blir värdet för Retry-After-huvudet 300.

Obs! Det här är bara rekommenderade värden – ditt program kan välja att avsöka med en annan frekvens beroende på dina behov. Efter den första begäran ska alla efterföljande begäranden använda url:en som anges i platsrubriken för det senaste svaret. Lägg inte till fler parametrar i URL:en eftersom den redan innehåller de parametrar som krävs för att säkerställa att orderändringarna inte saknas i begäran.

Resultaten sorteras automatiskt efter ModifiedUtc och sedan efter OrderId i stigande ordning. Sorteringsparametrar kan inte konfigureras.

ModifiedUtc-definition: intern tidstagg = tid för senaste ändring av orderdata.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
excludeFormData	excludeFormData		boolean	Om det är sant är OrderFormFields alltid en tom matris.
excludeCustomFieldData	excludeCustomFieldData		boolean	Om det är sant returneras inte CustomFields.

Returer

Body: CustomerAPI.Models.Order.OrderHeaderApiModel

Avsökning av orderstatusar

Åtgärds-ID:: OrderController_StatusPoll

Med API-avsökningsslutpunkten Order Statuses kan ditt program kontinuerligt avsöka och bearbeta de senaste ändringarna i beställningar.

Integration:

Den här slutpunkten är utformad för att fungera direkt med Microsoft Flow som en avsökningsutlösarintegrering. Du kan också utveckla din egen anpassade integrering med valfritt språk.

Användning:

I ett typiskt scenario bör den första begäran till den här slutpunkten inte innehålla några parametrar. Det finns två (2) möjliga lyckade svar:

HTTP-svarskod 200 – Det finns nyligen ändrade orderstatusposter. svarstexten visar orderstatusdata
HTTP-svarskod 202 – Det finns inga nyligen skickade poster. svarstexten är tom.

I båda fallen finns det två (2) viktiga rubriker i svaret:

Plats – URL:en för nästa begäran.
Retry-After – Det rekommenderade tidsintervallet i sekunder för nästa begäran. Om det till exempel finns data att hämta har Retry-After-huvudet värdet 1 eller 60. Om det inte finns några data att hämta blir värdet för Retry-After-huvudet 300.

Obs! Det här är bara rekommenderade värden – ditt program kan välja att avsöka med en annan frekvens beroende på dina behov. Efter den första begäran ska alla efterföljande begäranden använda url:en som anges i platsrubriken för det senaste svaret. Lägg inte till fler parametrar i URL:en eftersom den redan innehåller de som behövs för att säkerställa att orderstatusar inte saknas i begäran.

Resultaten sorteras efter ModifiedUtc och sedan efter StatusId, i stigande ordning. Sorteringsparametrar kan inte konfigureras.

ModifiedUtc-definition: intern tidstagg = tid för senaste ändring av orderstatusdata.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
excludeFormData	excludeFormData		boolean	Om det är sant är FieldValues alltid en tom matris.

Returer

Body: CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Formulärdatasökning

Åtgärds-ID:: FormController_Poll

Med slutpunkten för Forms API-avsökning kan ditt program kontinuerligt avsöka och bearbeta nyligen skickade fristående formulär.

Integration:

Den här slutpunkten är utformad för att fungera direkt med Microsoft Flow som en avsökningsutlösarintegrering. Du kan också utveckla din egen anpassade integrering med valfritt språk.

Användning:

I ett typiskt scenario bör den första begäran till den här slutpunkten inte innehålla några parametrar. Det finns två (2) möjliga lyckade svar:

HTTP-svarskod 200 – formulärposter som nyligen skickats finns. svarstexten visar formulärdata.
HTTP-svarskod 202 – Det finns inga nyligen skickade poster. svarstexten är tom.

I båda fallen finns det två (2) viktiga rubriker i svaret:

Plats – URL:en för nästa begäran.
Retry-After – Det rekommenderade tidsintervallet i sekunder för nästa begäran. Om det till exempel finns data att hämta har Retry-After-huvudet värdet 1 eller 60. Om det inte finns några data att hämta blir värdet för Retry-After-huvudet 300.

Resultaten sorteras automatiskt efter ModifiedUtc och sedan efter FormHeaderId i stigande ordning. Sorteringsparametrar kan inte konfigureras.

ModifiedUtc-definition: intern tidstagg = tid för senaste ändring av formulärdata.

Returer

Body: CustomerAPI.Models.Forms.StandaloneFormApiModel

Tidtagningsundersökning

Åtgärds-ID:: TimekeepingController_Poll

Med slutpunkten för timekeeping API-avsökning kan ditt program kontinuerligt avsöka och bearbeta nyligen skickade tidtagningsposter.

Integration:

Den här slutpunkten är utformad för att fungera direkt med Microsoft Flow som en avsökningsutlösarintegrering. Du kan också utveckla din egen anpassade integrering med valfritt språk.

Användning:

I ett typiskt scenario bör den första begäran till den här slutpunkten inte innehålla några parametrar. Det finns två (2) möjliga lyckade svar:

HTTP-svarskod 200 – Det finns nyligen skickade tidhållningsposter. svarstexten visar tidsåtgångsinmatningsdata.
HTTP-svarskod 202 – Det finns inga nyligen skickade poster. svarstexten är tom.

I båda fallen finns det två (2) viktiga rubriker i svaret:

Plats – URL:en för nästa begäran.
Retry-After – Det rekommenderade tidsintervallet i sekunder för nästa begäran. Om det till exempel finns data att hämta har Retry-After-huvudet värdet 1 eller 60. Om det inte finns några data att hämta blir värdet för Retry-After-huvudet 300.

Obs! Det här är bara rekommenderade värden – ditt program kan välja att avsöka med en annan frekvens beroende på dina behov. Efter den första begäran ska alla efterföljande begäranden använda url:en som anges i platsrubriken för det senaste svaret. Lägg inte till fler parametrar i URL:en eftersom den redan innehåller de som behövs för att säkerställa att tidshållningsposter inte saknas i begäran.

Resultaten sorteras automatiskt efter ModifiedUtc och sedan efter TimekeepingStatusId och sedan i stigande ordning. Sorteringsparametrar kan inte konfigureras.

ModifiedUtc-definition: intern tidstagg = tid för senaste tidshållningsstatusändring.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
excludeFormData	excludeFormData		boolean	Om det är sant är ClockInFormData och ClockOutFormData alltid null.

Returer

Body: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Definitioner

CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Name	Sökväg	Typ	Description
Id	Id	string

CustomerAPI.Models.Client.ReadClientApiModel

Name	Sökväg	Typ	Description
Id	Id	integer	ID för klienten.
ExternalId	ExternalId	string	Externt användnings-ID för egenskapen Client – API Extension.
CreatedUtc	CreatedUtc	date-time	Den ursprungliga tidpunkt då klienten skapades.
ModifiedUtc	ModifiedUtc	date-time	Den sista tidpunkten då klienten uppdaterades.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Namn	Name	string	Namnet på klienten.
Address	Address	CustomerAPI.Models.LocationApiModel
Kontakt	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

Name	Sökväg	Typ	Description
FieldIndex	FieldIndex	integer	Fältindex.
Bildtext	Caption	string	Fältrubrik.
Datatyp	DataType	integer	Fältdatatyp.
DateTimeFormat	DateTimeFormat	integer	DateTime-format.
Värde	Value		Fältvärde.

CustomerAPI.Models.LocationApiModel

Name	Sökväg	Typ	Description
LatLon	LatLon	System.Nullable_1_Actsoft.Core.Geo.LatLon_
AddressLine1	AddressLine1	string	AddressLine1 för den här LocationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 för den här LocationApiModel.
City	City	string	Ort för LocationApiModel.
RegionNamn	RegionName	string	Regionnamn för LocationApiModel.
Postnummer	PostalCode	string	Postnummer för LocationApiModel.
Landskod	CountryCode	string	ISO 3166-1 alfa-2-kod.
UnderregionNamn	SubRegionName	string	Underregion för LocationApiModel.
Underregionkod	SubRegionCode	string	Underregionkod för LocationApiModel.
RegionCode	RegionCode	string	Regionkod för LocationApiModel.

CustomerAPI.Models.Client.ContactApiModel

Name	Sökväg	Typ	Description
Namn	Name	string	Namnet på ContactApiModel.
Telefonnummer	PhoneNumber	string	PhoneNumber för ContactApiModel.
E-postmeddelande	Email	string	E-post för ContactApiModel.

System.Nullable_1_Actsoft.Core.Geo.LatLon_

Name	Sökväg	Typ	Description
Latitud	Latitude	double
Longitud	Longitude	double

CustomerAPI.Models.ReturnIdApiModel

Name	Sökväg	Typ	Description
Id	Id	integer	Objekt-ID.

CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Definierar API-modellen för objekt-API:et för anpassad listasdefinitionslista.

Name	Sökväg	Typ	Description
CustomListId	CustomListId	integer	Anpassat list-ID.
Namn	Name	string	Namn på anpassad lista.
Utgåva	Version	string	Anpassad listversion.

CustomerAPI.Models.CustomLists.CustomListApiModel

Anpassad listmodell.

Name	Sökväg	Typ	Description
CustomListId	CustomListId	integer	Anpassat list-ID.
Namn	Name	string	Namn på anpassad lista.
Utgåva	Version	string	Anpassad listversion.
Definition	Definition	CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel	Definierar API-modellen för definition av anpassad lista.

CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

Definierar API-modellen för definition av anpassad lista.

Name	Sökväg	Typ	Description
Columns	Columns	array of CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel	Anpassade listkolumner.
UniqueColumnIndexIndex	UniqueColumnIndexIndex	integer	Unikt kolumnindex.

CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

Definierar API-modellen för anpassad listdefinitionskolumn.

Name	Sökväg	Typ	Description
Index	Index	integer	Kolumnindex.
Datatyp	DataType	integer	Column DataType (Text: 0, Numerisk: 1, Datum: 2, Tid: 3, DateTime: 4, E-post: 5).
Namn	Name	string	Kolumnnamn.

CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Container för datamatris för anpassade listor.

Name	Sökväg	Typ	Description
ColumnValues	ColumnValues	array of CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel	Matris med kolumner med data.

CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

Den här modellen definierar kolumnvärde för anpassad lista.

Name	Sökväg	Typ	Description
ColumnIndex	ColumnIndex	integer	Kolumnindex för anpassad lista.
Bildtext	Caption	string	Kolumnrubrik för anpassad lista.
Värde	Value		Kolumnvärde för anpassad lista.

CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Anpassad händelsedefinitionsmodell.

Name	Sökväg	Typ
Id	Id	string
Namn	Name	string
ReverseGeocode	ReverseGeocode	boolean
Parameterar	Parameters	array of CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

Name	Sökväg	Typ
Namn	Name	string
Typ	Type	integer
Bildtext	Caption	string
Krävs	Required	boolean

CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Name	Sökväg	Typ	Description
EventId	EventId	integer	Händelse-ID.
Evenemangstyp	EventType	integer
EventCode	EventCode	string	Händelsekod.
Evenemangstid	EventTime	date-time	ISO-format med lokal och förskjutning.
User	User	CustomerAPI.Models.UserReferenceApiModel
Fordon	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Om det är aktiverat har händelsens fordon tilldelat användaren.
Plats	Location	CustomerAPI.Models.LocationApiModel
PrimaryGeofence	PrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
CustomEventDefinitionId	CustomEventDefinitionId	string	Definitions-ID för extern händelse.
EventParams	EventParams	object	Händelseparametrar.

CustomerAPI.Models.UserReferenceApiModel

Name	Sökväg	Typ	Description
UserId	UserId	integer	UserId för användaren.
Förnamn	FirstName	string	Användarens förnamn.
Efternamn	LastName	string	Användarens efternamn.
Anställningsnummer	EmployeeNumber	string	Användarens personalnummer.
GroupName	GroupName	string	Namnet på den grupp som tilldelats användaren.

CustomerAPI.Models.ReadVehicleApiModel

Name	Sökväg	Typ	Description
VehicleId	VehicleId	integer	ID för BaseVehicleApiModel.
Namn	Name	string	Namnet på BaseVehicleApiModel.
VIN	VIN	string	Fordonsidentifieringsnummer för BaseVehicleApiModel.
Enhetsnamn	DeviceName	string	Namnet på GpsDeviceDto som är associerat med BaseVehicleApiModel.
SerialNumber	SerialNumber	string	SerialNumber för BaseVehicleApiModel.
GroupName	GroupName	string	GroupName för BaseVehicleApiModel.

CustomerAPI.Models.Geofence.GeofenceInfoApiModel

Name	Sökväg	Typ	Description
GeofenceId	GeofenceId	integer	ID för Geofence.
Namn	Name	string	Geofences namn.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Name	Sökväg	Typ	Description
Prenumerations-ID	SubscriptionId	string	ID för WebHookSubscriptionResultApiModel.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Name	Sökväg	Typ	Description
Prenumerations-ID	SubscriptionId	string
URL	Url	string
Läge	Status	integer	Prenumerationsstatus – (Körs: 1, Stoppad: 2).

CustomerAPI.Models.Forms.StandaloneFormApiModel

Name	Sökväg	Typ	Description
Id	Id	integer	ID som är associerat med detta friståendeFormApiModel – (äldre kommentar: FormHeaderId).
FormId	FormId	integer	ID för formuläret som refereras av den här friståendeFormApiModel.
FormName	FormName	string	Namnet på formuläret som refereras till av den här friståendeFormApiModel.
EntryNumber	EntryNumber	string	Formulärdatainmatningsnummer.
Recenserade	Reviewed	boolean	Status för granskning av denna friståendeFormApiModel.
User	User	CustomerAPI.Models.UserReferenceApiModel
SubmittedTime	SubmittedTime	date-time	Tidpunkt då StandaloneFormApiModel skickades.
StartTime	StartTime	date-time	Tidpunkt då StandaloneFormApiModel startades.
SubmittedLocation	SubmittedLocation	CustomerAPI.Models.LocationApiModel
FormData	FormData	array of CustomerAPI.Models.Forms.FormFieldDataApiModel	Lista över fält som är associerade med den här friståendeFormApiModel.
ApiModuleId	ApiModuleId	string	ID för ApiModule som är associerat med den här friståendeFormApiModel.
SharedUrl	SharedUrl	string	Delad URL för denna friståendeFormApiModel.
ReviewedByUser	ReviewedByUser	CustomerAPI.Models.UserReferenceApiModel
ReviewedByTime	ReviewedByTime	date-time	Tid för formulärgranskningen

CustomerAPI.Models.Forms.FormFieldDataApiModel

Name	Sökväg	Typ	Description
Repeterbara	Repeatables	array of array
items	Repeatables	array of CustomerAPI.Models.Forms.FormFieldDataBaseApiModel
Id	Id	string	ID för FormFieldDataApiModel.
Värde	Value		Värdet för FormFieldDataApiModel.
DisplayValue	DisplayValue		DisplayValue för FormFieldDataApiModel.
CapturedTime	CapturedTime	date-time	Värdet för tidpunkten hämtades från FormFieldDataApiModel.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Bildtext	Caption	string	Textinnehåll i FormFieldDataApiModel.
ApiFieldId	ApiFieldId	string	ID för ApiField för FormFieldDataApiModel.

CustomerAPI.Models.Forms.FormFieldDataBaseApiModel

Name	Sökväg	Typ	Description
Id	Id	string	ID för FormFieldDataApiModel.
Värde	Value		Värdet för FormFieldDataApiModel.
DisplayValue	DisplayValue		DisplayValue för FormFieldDataApiModel.
CapturedTime	CapturedTime	date-time	Värdet för tidpunkten hämtades från FormFieldDataApiModel.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Bildtext	Caption	string	Textinnehåll i FormFieldDataApiModel.
ApiFieldId	ApiFieldId	string	ID för ApiField för FormFieldDataApiModel.

CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Name	Sökväg	Typ	Description
GeofenceId	GeofenceId	integer	GeofenceId för GeofenceApiModel.
CreatedUtc	CreatedUtc	date-time	CreatedUtc för GeofenceApiModel.
ModifiedUtc	ModifiedUtc	date-time	ModifiedUtc för GeofenceApiModel.
GroupNames	GroupNames	array of string	GroupPaths för GeofenceApiModel.
Namn	Name	string	Namnet på GeofenceApiModelBase.
Typ	Type	string	Typ av GeofenceApiModel.
Shape	Shape	integer	Form: 0 för cirkel och 1 för polygon.
Address	Address	CustomerAPI.Models.LocationApiModel
Radie	Radius	double	Radius för GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress för GeofenceApiModel.

Actsoft.Core.Geo.LatLon

Name	Sökväg	Typ	Description
Latitud	Latitude	double
Longitud	Longitude	double

CustomerAPI.Models.Geofence.GeofenceApiModel

Name	Sökväg	Typ	Description
GeofenceId	GeofenceId	integer	GeofenceId för GeofenceApiModel.
CreatedUtc	CreatedUtc	date-time	CreatedUtc för GeofenceApiModel.
ModifiedUtc	ModifiedUtc	date-time	ModifiedUtc för GeofenceApiModel.
GroupNames	GroupNames	array of string	GroupPaths för GeofenceApiModel.
Polygon	Polygon	array of Actsoft.Core.Geo.LatLon	Polygonpunkter. Ska fyllas när formen är lika med 1.
Namn	Name	string	Namnet på GeofenceApiModelBase.
Typ	Type	string	Typ av GeofenceApiModel.
Shape	Shape	integer	Form: 0 för cirkel och 1 för polygon.
Address	Address	CustomerAPI.Models.LocationApiModel
Radie	Radius	double	Radius för GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress för GeofenceApiModel.

CustomerAPI.Models.Order.OrderListItemApiModel

Name	Sökväg	Typ	Description
Beställnings-ID	OrderId	integer	ID för OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	Externt användnings-OrderId för egenskapen Client – API Extension.
Förfallodatum	DueDate	date-time	Tidpunkt då orderBaseApiModel ska slutföras (föråldrad i v1.3).
StartTime	StartTime	date-time	Tidpunkt då orderBaseApiModel ska starta (introduceras i v1.3).
EndTime	EndTime	date-time	Tidpunkt då orderBaseApiModel ska slutföras (introducerades i v1.3).
ServiceType	ServiceType	string	ServiceType som är associerad med denna OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	Tidpunkt då orderBaseApiModel skapades.
Ordernummer	OrderNumber	string	Ordernummer som är associerat med denna OrderBaseApiModel.
Omsluten	IsClosed	boolean	Status som visar om OrderBaseApiModel är stängd.
Läge	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	Externt användnings-ID för egenskapen Client – API Extension.
ClientId	ClientId	integer	internt användnings-ID för egenskapen Client – API Extension.
Klient	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	ID för ApiService som är associerad med denna OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Modulversion för anpassade fält.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusApiModel

Name	Sökväg	Typ	Description
StatusIndex	StatusIndex	integer	Index för OrderStatusApiModel.
Statustyp	StatusType	integer	Orderstatus: 0 för ny order, 1 för avsänd, 2 för pågående, 3 för slutförd och 4 för avbruten.
StatusLabel	StatusLabel	string	Etikettinnehåll i OrderStatusApiModel.
StatusId	StatusId	integer	ID för OrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	date-time	Tidpunkt då OrderStatusApiModel startades.
User	User	CustomerAPI.Models.UserReferenceApiModel

CustomerAPI.Models.Order.OrderClientReadApiModel

Name	Sökväg	Typ	Description
GroupNames	GroupNames	array of string	Hierarkiska namn för klientgrupper.
Namn	Name	string	Namnet på klienten.
Address	Address	CustomerAPI.Models.LocationApiModel
Kontakt	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Order.OrderApiModel

Name	Sökväg	Typ	Description
StatusHistory	StatusHistory	array of CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel	Lista över OrderStatusListItems som är associerade med denna OrderApiModel.
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
Beställnings-ID	OrderId	integer	ID för OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	Externt användnings-OrderId för egenskapen Client – API Extension.
Förfallodatum	DueDate	date-time	Tidpunkt då orderBaseApiModel ska slutföras (föråldrad i v1.3).
StartTime	StartTime	date-time	Tidpunkt då orderBaseApiModel ska starta (introduceras i v1.3).
EndTime	EndTime	date-time	Tidpunkt då orderBaseApiModel ska slutföras (introducerades i v1.3).
ServiceType	ServiceType	string	ServiceType som är associerad med denna OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	Tidpunkt då orderBaseApiModel skapades.
Ordernummer	OrderNumber	string	Ordernummer som är associerat med denna OrderBaseApiModel.
Omsluten	IsClosed	boolean	Status som visar om OrderBaseApiModel är stängd.
Läge	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	Externt användnings-ID för egenskapen Client – API Extension.
ClientId	ClientId	integer	internt användnings-ID för egenskapen Client – API Extension.
Klient	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	ID för ApiService som är associerad med denna OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Modulversion för anpassade fält.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Name	Sökväg	Typ	Description
StatusStartDateTime	StatusStartDateTime	date-time	Tidpunkt då den här OrderStatusHistoryListItemApiModel-statusen startades.
StatusEndDateTime	StatusEndDateTime	date-time	Tidpunkt då den här OrderStatusHistoryListItemApiModel-statusen avslutades.
StatusId	StatusId	integer	ID som är associerat med denna OrderStatusHistoryListItemApiModel.
StatusIndex	StatusIndex	integer	Index som är associerat med denna OrderStatusHistoryListItemApiModel.
StatusLabel	StatusLabel	string	Etikettinnehåll som är associerat med denna OrderStatusHistoryListItemApiModel.
Statustyp	StatusType	integer	Orderstatus: 0 för ny order, 1 för avsänd, 2 för pågående, 3 för slutförd och 4 för avbruten.
ExternalOrderId	ExternalOrderId	string	Externt användnings-OrderId för egenskapen Client – API Extension.
Beställnings-ID	OrderId	integer	OrderId som är associerat med denna OrderStatusHistoryListItemApiModel.
User	User	CustomerAPI.Models.UserReferenceApiModel
StartAddress	StartAddress	CustomerAPI.Models.LocationApiModel
EndAddress	EndAddress	CustomerAPI.Models.LocationApiModel
ApiServiceId	ApiServiceId	string	ID för ApiService som är associerad med denna OrderStatusHistoryListItemApiModel.
FieldValues	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

CustomerAPI.Models.Order.OrderHeaderApiModel

Name	Sökväg	Typ	Description
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
Beställnings-ID	OrderId	integer	ID för OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	Externt användnings-OrderId för egenskapen Client – API Extension.
Förfallodatum	DueDate	date-time	Tidpunkt då orderBaseApiModel ska slutföras (föråldrad i v1.3).
StartTime	StartTime	date-time	Tidpunkt då orderBaseApiModel ska starta (introduceras i v1.3).
EndTime	EndTime	date-time	Tidpunkt då orderBaseApiModel ska slutföras (introducerades i v1.3).
ServiceType	ServiceType	string	ServiceType som är associerad med denna OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	Tidpunkt då orderBaseApiModel skapades.
Ordernummer	OrderNumber	string	Ordernummer som är associerat med denna OrderBaseApiModel.
Omsluten	IsClosed	boolean	Status som visar om OrderBaseApiModel är stängd.
Läge	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	Externt användnings-ID för egenskapen Client – API Extension.
ClientId	ClientId	integer	internt användnings-ID för egenskapen Client – API Extension.
Klient	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	ID för ApiService som är associerad med denna OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Modulversion för anpassade fält.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Name	Sökväg	Typ	Description
Id	Id	integer	ID för posten Timekeeping (äldre kommentar: RootSubmittedStatusId).
User	User	CustomerAPI.Models.UserReferenceApiModel
ClockInTime	ClockInTime	date-time	Tidpunkt då användaren klockade in i systemet.
ClockInLocation	ClockInLocation	CustomerAPI.Models.LocationApiModel
ClockOutTime	ClockOutTime	date-time	Tidpunkt då användaren klockade ut ur systemet.
ClockOutLocation	ClockOutLocation	CustomerAPI.Models.LocationApiModel
TotalHours	TotalHours	double	Totalt antal timmar för den här tidtagningsposten.
TotalBreakHours	TotalBreakHours	double	Totalt antal rasttimmar (ej arbetstimmar) för den här tidtagningsposten.
NetHours	NetHours	double	Totalt antal timmar som kan debiteras för den här tidtagningsposten.
Godkänd	Approved	boolean	Status för övervakarens godkännande för den här tidtagningsposten.
Avbrott	Breaks	array of CustomerAPI.Models.Timekeeping.TimekeepingBreakModel
ClockInFormData	ClockInFormData	CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ClockOutFormData	ClockOutFormData	CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ModuleVersion	ModuleVersion	System.Version
CompanyModuleId	CompanyModuleId	integer	ID för företagsmodulen som används för att skicka den här tidtagningsposten.

CustomerAPI.Models.Timekeeping.TimekeepingBreakModel

Name	Sökväg	Typ	Description
Id	Id	integer	SubmittedStatusId.
StartTime	StartTime	date-time	Starttid.
StartLocation	StartLocation	CustomerAPI.Models.LocationApiModel
EndTime	EndTime	date-time	Sluttid.
EndLocation	EndLocation	CustomerAPI.Models.LocationApiModel
DurationHours	DurationHours	double	Varaktighet i timmar. Den kan vara null om EndTime är null.
Statustyp	StatusType	integer	Statustyp: 1 för paus och 2 för lunch.
StartLabel	StartLabel	string	Startetikett.
EndLabel	EndLabel	string	Slutetikett.
Bildtext	Caption	string	Bildtext.

CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel

Name	Sökväg	Typ
CompanyModuleId	CompanyModuleId	integer
ModuleVersion	ModuleVersion	System.Version
FieldValues	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

System.Version

Name	Sökväg	Typ
_Major	_Major	integer
_Underårig	_Minor	integer
_Bygga	_Build	integer
_Revision	_Revision	integer

CustomerAPI.Models.Tracking.TripApiModel

Name	Sökväg	Typ	Description
User	User	CustomerAPI.Models.UserReferenceApiModel
Fordon	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
StartTime	StartTime	date-time	Tidpunkt då TripApiModel-statusen startades.
EndTime	EndTime	date-time	Tidpunkt då TripApiModel-statusen avslutades.
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	Mängden stopptid i timmar som associeras med denna TripApiModel.
TotalIdleTime	TotalIdleTime	double	Mängden inaktiv tid i timmar som associeras med denna TripApiModel.
TotalDuration	TotalDuration	double	Fullständig tid i timmar associeras med denna TripApiModel.
Avstånd	Distance	double	Avstånd som färdas i lokaliserade enheter som är associerade med denna TripApiModel.

CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Name	Sökväg	Typ	Description
Register	Records	array of CustomerAPI.Models.Tracking.GpsDataRecordApiModel
FortsättningToken	ContinuationToken	string

CustomerAPI.Models.Tracking.GpsDataRecordApiModel

Name	Sökväg	Typ	Description
User	User	CustomerAPI.Models.UserReferenceApiModel
Fordon	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
TimeTag	TimeTag	date-time	TimeTag associerad med denna GpsDataRecordApiModel.
Plats	Location	System.Nullable_1_Actsoft.Core.Geo.LatLon_
Geofence	Geofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
Hastighet	Speed	double	Rörelsehastighet som är associerad med denna GpsDataRecordApiModel.
Heading	Heading	double	Kompassriktning i grader som är associerade med denna GpsDataRecordApiModel.
Läge	Status	integer	ApiMovementStatus associerat med OrderBaseApiModel – (Stoppad: 1, Inaktiv: 2, Flytt: 3, NotTracking: 4) : OrderStatusApiModel.
Statustid	StatusTime	string	Tidpunkt då den här GpsDataRecordApiModel-statusen angavs.
Avstånd	Distance	double	Avstånd som färdas i lokaliserade enheter som är associerade med denna TripApiModel.
IgnitionOn	IgnitionOn	boolean	Status för fordonständning som är associerad med denna GpsDataRecordApiModel.
LocationProvider	LocationProvider	integer	Api Location Provider associerad med denna GpsDataRecordApiModel - (GPS: 1, Nätverk: 2).

CustomerAPI.Models.User.ReadUserApiModel

Name	Sökväg	Typ	Description
Användarnamn	UserName	string	Användarens användarnamn.
UserId	UserId	integer	ID-värdet för användaren.
GroupName	GroupName	string	Namnet på användarens grupp.
Förnamn	FirstName	string	Användarens förnamn.
Efternamn	LastName	string	Användarens efternamn.
Anställningsnummer	EmployeeNumber	string	Användarens personalnummer.
E-postmeddelande	Email	string	E-postadress till användaren.
Telefon	Phone	string	Användarens telefonnummer.
RoleId	RoleId	integer	RoleId för användaren – (Administratör: 1, Användare: 3, Power User: 5).
Är aktiv	IsActive	boolean	Aktiv status för användaren.
EPTTEnabled	EPTTEnabled	boolean	Status för utökad push-to-talk-funktion för användare: booleskt värde.
EPTTNumber	EPTTNumber	string	Telefonnummer för utökad push-to-talk-funktion för användare: sträng.
EPTTWebMDN	EPTTWebMDN	string	Telefonnummer som används för att autentisera användaren till Kodiak EPTT-systemet – tillhandahålls av Kodiak.
EPTTToken	EPTTToken	string	API-token som används för att autentisera användaren till Kodiak EPTT-systemet – tillhandahålls av Kodiak.
GPSEnabled	GPSEnabled	boolean	Status för GPS-funktionen för användaren.
MobileOnly	MobileOnly	boolean	Status för skrivbordswebbprogramåtkomst för CAB – (Ingen webbappåtkomst: Sant, Fullständig appåtkomst: Falskt).
LicenseType	LicenseType	integer	Typ av licens som tilldelats användaren: – 0 för Odefinierad, 1 för Regular, 2 för WebOnly och 3 för Employee.

CustomerAPI.Models.User.ReadUserListItemApiModel

Name	Sökväg	Typ	Description
UserId	UserId	integer	ID-värdet för användaren.
Förnamn	FirstName	string	Användarens förnamn.
Efternamn	LastName	string	Användarens efternamn.
Anställningsnummer	EmployeeNumber	string	Användarens personalnummer.
E-postmeddelande	Email	string	E-postadress till användaren.
Telefon	Phone	string	Användarens telefonnummer.
RoleId	RoleId	integer	RoleId för användaren – (Administratör: 1, Användare: 3, Power User: 5).
Är aktiv	IsActive	boolean	Aktiv status för användaren.
EPTTEnabled	EPTTEnabled	boolean	Status för utökad push-to-talk-funktion för användare: booleskt värde.
EPTTNumber	EPTTNumber	string	Telefonnummer för utökad push-to-talk-funktion för användare: sträng.
EPTTWebMDN	EPTTWebMDN	string	Telefonnummer som används för att autentisera användaren till Kodiak EPTT-systemet – tillhandahålls av Kodiak.
EPTTToken	EPTTToken	string	API-token som används för att autentisera användaren till Kodiak EPTT-systemet – tillhandahålls av Kodiak.
GPSEnabled	GPSEnabled	boolean	Status för GPS-funktionen för användaren.
MobileOnly	MobileOnly	boolean	Status för skrivbordswebbprogramåtkomst för CAB – (Ingen webbappåtkomst: Sant, Fullständig appåtkomst: Falskt).
LicenseType	LicenseType	integer	Typ av licens som tilldelats användaren: – 0 för Odefinierad, 1 för Regular, 2 för WebOnly och 3 för Employee.

CustomerAPI.Models.Vehicles.VehicleReadApi

Fordonsdatamodell.

Name	Sökväg	Typ
InternalId	InternalId	integer
Nummer	Number	string
Namn	Name	string
Typ	Type	string
Tag	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
TimeZone	TimeZone	string
Göra	Make	string
År	Year	integer
Model	Model	string
Färg	Color	string
VIN	VIN	string
Är aktiv	IsActive	boolean
Enhetstyp	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

integer

Det här är den grundläggande datatypen heltal.

objekt

Detta är typen 'objekt'.

Dela via

TeamWherx

Skapa en anslutning

Standard

Begränsningsgränser

Åtgärder

** Skapa en order

Parametrar

Returer

Aktivera en användare

Parametrar

Aktivera ett fordon

Parametrar

Returer

Avbryta prenumerationen på WEBB-webbkroken för GPS-data

Parametrar

Avsluta prenumerationen på händelsewebbkroken

Parametrar

Få en geofence

Parametrar

Returer

Hämta anpassade listdata via CustomListID

Parametrar

Returer

Hämta anpassade listdefinitioner

Returer

Hämta delversion

Hämta en anpassad händelsedefinition efter ID

Parametrar

Returer

Hämta en användare

Parametrar

Returer

Hämta en beställning

Parametrar

Returer

Hämta en fordonslista

Parametrar

Returer

Hämta en klient

Parametrar

Returer

Hämta en lista över anpassade händelsedefinitioner

Returer

Hämta en lista över användare

Parametrar

Returer

Hämta en lista över beställningar

Parametrar

Returer

Hämta en lista över event web hook-prenumerationer

Returer

Hämta en lista över formulär

Parametrar

Returer

Hämta en lista över geofences

Parametrar

Returer

Hämta en lista över händelser

Parametrar

Returer

Hämta en lista över klienter

Parametrar

Returer

Hämta en lista över prenumerationer

Returer

Hämta en lista över resor

Parametrar

Returer

Hämta en lista över tidshållningsposter

Parametrar

Returer

Hämta en post från en anpassad lista

Parametrar

Returer

Hämta en tidshållningspost

Parametrar

Returer

Hämta ett fordon med ID

Parametrar