TeamWherx

TeamWherx(TW) ist eine all-in-one-Dienstverwaltungsplattform, die Ihnen hilft, Ihre Remoteteams von Mitarbeitern und allgemeinen Geschäftsvorgängen außerhalb des Büros effektiver zu verwalten. Als cloudbasierte Lösung ermöglicht TW die Remotedatensammlung und zeigt sie über das Web App-Dashboard an und bietet Managern die zusätzlichen Einblicke, die sie benötigen, um intelligentere Strategien für erhöhte Effizienz, Produktivität und reduzierte Kosten zu erstellen und gleichzeitig ihre mobilen Mitarbeiter zu koordinieren.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung	Class	Regions
Copilot Studio	Premium	Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)
Logik-Apps	Norm	Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD)
Power Apps	Premium	Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)
Power Automate	Premium	Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)

Kontakt
Name	Actsoft-Support
URL	https://www.actsoft.com/self-help-wizards
Email	support@actsoft.com

Connectormetadaten
Herausgeber	Actsoft
Webseite	https://actsoft.com
Datenschutzrichtlinie	https://www.actsoft.com/privacy
Kategorien	Produktivität

Connectorbeschreibung:

TeamWherx ermöglicht es Ihnen, digitale Formularinformationen, Arbeitszeiterfassungsinformationen für Mitarbeiter und Arbeitsaufträge mit einem Versandsystem zu erstellen und zu erfassen.

Detaillierte Beschreibung

Mit dem TeamWherx-Connector können Benutzer Verbindungen herstellen und Informationen zwischen mehreren Plattformen austauschen. Sie können Ihre Daten animieren, um Prozessflüsse zu erstellen, Ihre anderen internen Anwendungen voranzutreiben und leistungsstarke Analysen zu informieren. Automatisieren und optimieren Sie Ihre täglichen, wöchentlichen oder monatlichen Prozesse mit Zugriff auf up-to- die momentan umsetzbaren Daten.

## Voraussetzungen

Um diesen Connector zu verwenden, benötigen Sie Folgendes:

TeamWherx-Konto
TeamWherx-API-Schlüssel
Microsoft Power Apps oder Power Automate-Plan

## Abrufen von Anmeldeinformationen

API-Entwicklerportal

Um auf den Connector zuzugreifen, müssen Sie zunächst einen Benutzernamen und ein Kennwort für das API-Entwicklerportal einrichten und die Kunden-API abonnieren:

Wechseln Sie in der Anwendung zu "Api-Setup für administrative>Einstellungen>".
Wählen Sie "Anmeldeinformationen erstellen" aus.
Geben Sie Ihren Vornamen und Nachnamen in die entsprechenden Felder ein.
Geben Sie Ihre E-Mail-Adresse in das Feld "E-Mail-Adresse" ein.
Wählen Sie "Speichern" und "E-Mail-Einladung" aus. Überprüfen Sie dann Ihre E-Mail auf Anweisungen zum Erstellen eines Kennworts.
Klicken Sie in der Einladungs-E-Mail auf "Kennwortauswählen", in dem ein Dialogfeld geöffnet wird, in dem Sie ein Kennwort erstellen können.
Wählen Sie "Kennwort speichern" aus.
Um mit dem Entwicklerportal fortzufahren, wechseln Sie in der Anwendung zu "Administrative>Einstellungen>"zum Entwicklerportal.
Wählen Sie im Entwicklerportal "Produkte" und dann "Kunden-API" aus.
Wählen Sie "Abonnieren" aus.

API-Schlüssel

Da Sie nun ein registrierter API-Benutzer sind, wurde eine alphanumerische Sequenz, die als Schlüssel bezeichnet wird, für Sie generiert. Sie benötigen diesen Schlüssel, um mit Ihren Daten in der API zu arbeiten.

So suchen Sie Ihren API-Schlüssel:

Wählen Sie " Produkte " im Menü "Entwicklerportal" aus. Die in Ihrer Lizenz verfügbaren API-Produkte werden angezeigt.
Wählen Sie die Kunden-API-Version unter "Sie haben X-Abonnements für dieses Produkt".
Wählen Sie " Anzeigen " neben dem Primärschlüssel für Ihr Abonnement aus.
Wählen Sie den Inhalt des Felds aus, klicken Sie mit der rechten Maustaste, und wählen Sie "Kopieren" aus. Der Schlüssel wird nun in der Zwischenablage gespeichert und kann eingefügt werden.

## Erste Schritte mit Ihrem Connector

Wechseln Sie zu "Meine Flüsse>" "Neuer Fluss", und wählen Sie dann "Automatisierter Cloudfluss" aus.
Wählen Sie manuell einen Fluss aus dem Dialogfeld "Erstellen eines automatisierten Cloudflusses" aus.
Benennen Sie Ihren Fluss, oder lassen Sie das System automatisch generieren.
Suchen Sie nach einem Trigger für Ihren Flow, und wählen Sie diesen aus.
Klicken Sie auf Erstellen.
Suchen Sie im Suchfeld nach dem TeamWherx-Connector, und wählen Sie diesen aus.
Suchen Sie die Aktion, die Sie mit dem Connector ausführen möchten.

Das System fordert Sie auf, sich bei allen Apps anzumelden, die zum Ausführen Ihrer ausgewählten Aktion erforderlich sind, und überspringt alle bereits angemeldeten Apps.

Geben Sie im Feld "Connector" einen Namen für den neuen Verbinder ein.
Geben Sie dann Ihren API-Schlüssel ein.
Klicken Sie auf Erstellen. Der erste Schritt in Ihrem Prozessfluss wird als erstes "Feld" in einem Flussdiagramm angezeigt.
Wählen Sie "NeuerSchritt " aus, um weitere Aktionen und Schritte zum Prozessablauf des Connectors hinzuzufügen.
Wählen Sie Speichern aus.

**Using the connector - Order status poll example
** In den folgenden Anweisungen wird gezeigt, wie Sie einen Prozessfluss zum Einfügen von Zeilen in ein Arbeitsblatt erstellen und identifizierende Daten des Mitarbeiters einfügen, der die Bestellung aktualisiert hat, wenn ein Auftragsstatus aktualisiert wird.

Wechseln Sie zu Connectors.
Suchen Und wählen Sie den [TeamWherx]-Connector aus.
Wählen Sie "Bestellstatus" aus der Aktionsauflistung aus.
Geben Sie im Feld "Verbindungsname " einen Namen für ihre neue Verbindung ein.
Geben Sie dann Ihren API-Schlüssel ein.
Klicken Sie auf Erstellen. Der erste Schritt in Ihrem Prozessfluss wird als erstes "Feld" in einem Flussdiagramm angezeigt.

Jedes Aktionsdialogfeld in den Schritten des Verbindungsflusses enthält Eigenschaftenfelder, die Sie anpassen können, um die ausgeführte Aktion zu steuern.

Wählen Sie weiter mit dem Beispiel aus, ob Forms-Feldwerte angezeigt werden sollen (excludeFormData-Parameter).
Wählen Sie die X-API-Version für die Verbindung aus.
Wählen Sie "Nächster Schritt " aus, um die Aktion festzulegen, die beim Ändern eines Auftragsstatus auftreten soll.
Verwenden Sie im Dialogfeld " Vorgang auswählen " das Suchfeld, um die Anwendung und dann die gewünschte Aktion zu suchen. Wenn Sie beispielsweise jedes Mal, wenn ein Bestellstatus geändert wird, eine Zeile in ein Google-Arbeitsblatt einfügen möchten, wählen Sie GoogleSheets und dann zeile für die Aktion einfügen.
Klicken Sie im folgenden Dialogfeld "Zeileeinfügen" auf das Feld "Datei", und wählen Sie die Datei aus, die Ihre Ergebnisse enthält.
Wählen Sie im Feld "Arbeitsblatt " den Datentyp des Arbeitsblatts aus. Die felder, die dynamisch angezeigt werden, sind die Datenspalten im Arbeitsblatt.
Klicken Sie in das Feld für jede Spalte, und wählen Sie eine Eigenschaft aus der Auflistung der Bestellstatus-Umfrageeigenschaften aus. Sie können auch das Suchfeld verwenden, um eine bestimmte Eigenschaft zu finden.
Sie können mehr als eine Eigenschaft in jedes Spaltenfeld eingeben. wählen Sie in der Spalte "Ereignis" "StatusLabel" aus, fügen Sie einen Gedankenstrich ein, und wählen Sie dann "StatusStartDate" aus. Dies bedeutet, dass für jede Auftragsstatusaktualisierung die Statusbeschriftung und das Statusanfangsdatum in die Spalte "Ereignis" in der neuen Zeile geschrieben werden.
Wählen Sie "NeuerSchritt" aus. Als Nebenhinweis können Sie immer darauf zeigen und auf den Pfeilverbinder klicken, um einen neuen Schritt einzufügen.
Wählen Sie im Dialogfeld "Vorgang auswählen" den TeamWherx-Connector erneut aus, und erstellen Sie dann einen Client für die Aktion.

Auch hier stellt jedes feld, das im Dialogfeld angezeigt wird, eine Spalte in der Google Sheets-Tabelle dar. Klicken Sie in jedes Feld, um die Auflistung der Bestellstatus-Umfrageeigenschaften zu aktivieren, und wählen Sie die gewünschten Eigenschaften aus.

Wählen Sie in diesem Beispiel "EmployeeNumber " für das Feld "Name " aus, um den Mitarbeiter zu identifizieren, der den Auftragsstatus aktualisiert hat.
Wählen Sie "GroupName" aus, und fügen Sie ihn auch in das Feld "Name " ein.
Wählen Sie Speichern aus.

Jetzt haben Sie einen Prozessablauf erstellt, der Ihre Kalkulationstabelle mit der Mitarbeiternummer und der zugehörigen Gruppe aktualisiert, sobald ein Auftragsstatus aktualisiert wird.

## Bekannte Probleme und Einschränkungen

Binäre Uploads von Audiodateien (POST) für alle Endpunkte sind nur auf MP4 beschränkt.
Datumsangaben für alle Endpunkte, die Datum-Uhrzeit-Informationen erfordern, müssen gemäß RFC3339 Richtlinien angegeben werden, wie im folgenden Beispiel: 2021-09-22T02:36:56.52Z. Es ist nicht erforderlich, die genauen Sekunden im Zeitstempel anzugeben; 00 ist akzeptabel.

## Häufige Fehler und Abhilfemaßnahmen

Beispiele für häufige Fehler, die auftreten können, Antwortcodes und Korrekturen finden Sie im API Developers Portal(en):

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

## FAQs

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:


Vorgabe	Parameter zum Erstellen einer Verbindung.	Alle Regionen	Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name	Typ	Description	Erforderlich
API-Schlüssel	securestring	Der API-Schlüssel für diese API	Richtig

Drosselungsgrenzwerte

Name	Aufrufe	Verlängerungszeitraum
API-Aufrufe pro Verbindung	100	60 Sekunden

Aktionen

Abmelden von Ereignisse-Web-Hooks	Löscht ein Ereignisweb hook-Abonnement anhand seiner ID.
Abonnieren des GPS-Datenwebhakens	Fügt neue GPS-Tracking-Daten (GPS-Positions) Web-Hook hinzu. Mit Web-Hooks können Sie GPS-Positionen empfangen, die auf einer angegebenen URL auftreten.
Abonnieren von Ereignisse-Web-Hooks	Fügt ein Web hook-Abonnement für neue Ereignisse hinzu. Mit Web-Hooks können Sie automatische Benachrichtigungen zu Unternehmensereignissen empfangen, die auf einer angegebenen URL auftreten.
Abrufen benutzerdefinierter Listendefinitionen	Ruft eine Auflistung der benutzerdefinierten Listendefinitionen ab. Die Definitionsauflistung enthält die CustomListID, den Namen und die Version für alle vorhandenen benutzerdefinierten Listen.
Abrufen einer benutzerdefinierten Ereignisdefinition nach ID	Ruft eine einzelne benutzerdefinierte Ereignisdefinition nach ID ab.
Abrufen einer benutzerdefinierten Listenfelderauflistung nach CustomListID	Ruft eine Liste von Feldern für eine einzelne benutzerdefinierte Liste mithilfe der CustomListID ab.
Abrufen einer Fahrzeugliste	Ruft eine Fahrzeugliste ab.
Abrufen einer Liste von Abonnements	Ruft eine Liste der Web hook-Abonnements ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben. Die Ergebnisse werden automatisch nach SubscriptionId und in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.
Abrufen einer Liste von benutzerdefinierten Ereignisdefinitionen	Ruft eine Liste der benutzerdefinierten Ereignisdefinitionen ab.
Abrufen einer Liste von Benutzern	Ruft eine Liste der Benutzer ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben. Die Ergebnisse werden automatisch nach UserId und in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.
Abrufen einer Liste von Bestellungen	Ruft eine Liste der Bestellungen mithilfe der Filter aus den unten gezeigten Anforderungsparametern ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben. Die Ergebnisse werden automatisch nach Client.Name und in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.
Abrufen einer Liste von Clients	Ruft eine Liste von Clients ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben. Die Ergebnisse werden automatisch nach Name und in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.
Abrufen einer Liste von Ereignissen	Ruft eine Liste von Ereignissen für einen bestimmten Zeitraum ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben. Filtern Sie nach Ereignistyp, um bestimmte Ereignisse abzurufen. Fahrzeugereignisse können für einen Mitarbeiter zurückgegeben werden, wenn der Mitarbeiter mit dem Fahrzeug verbunden ist.
Abrufen einer Liste von Ereigniswebhakenabonnements	Ruft eine Liste der Ereigniswebhakenabonnements ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben. Die Ergebnisse werden automatisch nach SubscriptionId und in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.
Abrufen einer Liste von Formularen	Ruft eine Liste von Formularen mithilfe eines der Filter aus den unten gezeigten Anforderungsparametern ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben. Die Ergebnisse werden automatisch nach SubmittedTime und in absteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.
Abrufen einer Liste von Geofences	Ruft eine Liste von Geofences ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben sowie angeben, ob die Geofence-Koordinaten metrisch sind. Die Ergebnisse werden automatisch nach Name und in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.
Abrufen einer Liste von Reisen	Ruft eine Liste von Reisen für einen bestimmten Zeitraum ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben. Die Ergebnisse werden automatisch nach StartUtcTIme und in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.
Abrufen einer Liste von Zeiterfassungseinträgen	Ruft eine Liste von Zeiterfassungseinträgen basierend auf dem Datumsbereich ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben. Die Ergebnisse werden automatisch nach ClockInTime und dann nach TimekeepingStatusId und in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.
Abrufen eines Benutzers	Ruft einen Benutzer anhand seiner ID ab.
Abrufen eines Clients	Ruft ein Clientobjekt anhand seiner ID ab.
Abrufen eines Fahrzeugs nach ID	Ruft ein einzelnes Fahrzeug nach ID ab.
Abrufen eines Formulars	Ruft ein Formular anhand seiner ID ab.
Abrufen eines Geofence-Standorts	Ruft einen Geofence anhand seiner ID ab.
Abrufen eines Zeiterfassungseintrags	Ruft einen Eintrag anhand seiner ID ab.
Abrufen einzelner Datensätze aus einer benutzerdefinierten Liste	Ruft einen einzelnen benutzerdefinierten Listendatensatz ab, der von CustomListId und einem eindeutigen Spaltenwert gefunden wurde. Irrtümer: 404 – Es gibt keinen benutzerdefinierten Listendatensatz für die bereitgestellte customListId und einen eindeutigen Spaltenwert.
Abrufen von GPS-Dateneinträgen	Ruft GPS-Dateneinträge für einen angegebenen Datumsbereich ab. Gibt außerdem ein Fortsetzungstoken und einen Link zum Abrufen des nächsten Datenteils zurück. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben. Positionen für gelöschte Nutzer/Fahrzeuge werden nicht zurückgegeben. Wenn der Benutzer/das Fahrzeug jedoch vorhanden ist, wenn Daten angefordert und später entfernt wurden, werden daten für den Benutzer/das Fahrzeug, das von einem Fortsetzungstoken angefordert wird, zurückgegeben. Die Ergebnisse werden automatisch nach UtcTime und in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.
Aktivieren eines Benutzers	Aktiviert einen vorhandenen Benutzer anhand seiner ID.
Aktivieren eines Fahrzeugs	Aktivieren Sie ein Fahrzeug anhand der ID.
Aktualisieren einer Bestellung	Aktualisiert eine vorhandene Bestellung.
Aktualisieren eines Benutzers	Aktualisiert einen vorhandenen Benutzer.
Aktualisieren eines Clients	Aktualisiert einen vorhandenen Client.
Aktualisieren eines Fahrzeugs	Aktualisieren Sie ein Fahrzeug anhand der ID.
Aktualisieren eines Teils eines Benutzers	Aktualisiert einen Teil der Eigenschaften des Benutzers.
Aktualisieren eines vorhandenen Geofence-Bereichs	Aktualisiert einen vorhandenen Geofence durch seine ID.
Anlagendatei hochladen	Verwenden Sie diese Option, um Formulardateianlagen hochzuladen. Die Binäre Größe ist auf 25 MB begrenzt. Es wurde eine mehrteilige/Formulardatenanforderung mit einer einzelnen Datei erwartet.
Auftragsstatus aktualisieren	Ändert einen vorhandenen Bestellstatus.
Benutzerdefinierte Listendaten nach CustomListID abrufen	Ruft alle Datensätze in einer einzelnen benutzerdefinierten Liste mithilfe der CustomListID ab. Die Ergebnisse werden nach Spalte sortiert, und das Paging wird unterstützt. Irrtümer: 404 – es gibt keine benutzerdefinierte Liste für die bereitgestellte customListId.
Benutzerdefinierten Listendatensatz löschen	Löscht vorhandenen Datensatz in einer benutzerdefinierten Liste anhand seiner customListId und ID. id - ist eindeutiger Wert des benutzerdefinierten Listendatensatzes. Irrtümer: 404 – customListId oder ID nicht gefunden.
Bestellung abrufen	Ruft eine vorhandene Reihenfolge anhand der ID ab.
Binärdatei hochladen	Verwenden Sie diese Option, um Formularbilder und Audiodateien hochzuladen. Die Binäre Größe ist auf 10 MB begrenzt. Unterstützte Dateitypen sind: JPEG, PNG und MP4.
Deaktivieren eines Benutzers	Deaktiviert einen vorhandenen Benutzer anhand seiner ID.
Deaktivieren eines Fahrzeugs	Deaktivieren Sie ein Fahrzeug nach ID.
Einen Client erstellen	Erstellt einen neuen Client.
Erstellen eines Benutzers	Erstellt einen neuen Benutzer.
Erstellen eines Fahrzeugs	Erstellt ein Fahrzeug.
Erstellen eines Formulars	Fügt ein neues Formular hinzu.
Erstellen eines Geofence-Raums	Erstellt einen neuen Geofence-Raum.
Erstellen oder Aktualisieren einer benutzerdefinierten Ereignisdefinition	Erstellt oder aktualisiert eine benutzerdefinierte Ereignisdefinition.
Erstellen oder Aktualisieren eines benutzerdefinierten Listendatensatzes	Erstellt oder aktualisiert benutzerdefinierte Listendatensatz. Der Wert der eindeutigen Spalte kann weggelassen werden, aber wenn vorhanden, sollte er mit dem Eindeutigen ID-Wert im Abfrageparameter übereinstimmen.
Erstellt einen Auftrag.	Fügt eine neue Bestellung hinzu.
Gps-Datenwebhaken kündigen	Löscht ein GPS-Datenwebhaken-Abonnement anhand seiner ID.
Löschen einer benutzerdefinierten Ereignisdefinition	Löscht eine benutzerdefinierte Ereignisdefinition.
Löschen eines Clients	Löscht einen vorhandenen Client anhand seiner ID.
Löschen eines Fahrzeugs	Löschen Sie ein Fahrzeug nach ID.
Löschen eines Geofence-Raums	Löscht einen vorhandenen Geofence durch seine ID.
Nebenversion abrufen	Gibt die aktuelle Nebenversion der API zurück.
Setzt den Abonnementstatus zurück.	Ändert den Abonnementstatus in den Status = 1 ("Läuft").
Submit-Ereignis	Submits-Ereignis.
Teilaktualisierung eines Fahrzeugs	Teilaktualisierung eines Fahrzeugs nach ID.
Web-Hook-Rückruf mit Ereignisfeed	Diese Beispielmethode wird von Ereignissen/Abonnieren von Postback-Ereignisdatenfeed mithilfe der vom Kunden bereitgestellten URL verwendet.
Webhook-Rückruf mit GPS-Datenfeed	Diese Beispielmethode wird von gpsdata/subscribe verwendet, um den Datenfeed mithilfe der vom Kunden bereitgestellten URL zu posten.
Zurücksetzen des Ereignisweb hook-Abonnementstatus	Ändert den Abonnementstatus in den Status = 1 ("Läuft").

Abmelden von Ereignisse-Web-Hooks

Vorgangs-ID:: EventController_RemoveEventDataFeedSubscription

Löscht ein Ereignisweb hook-Abonnement anhand seiner ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
subscriptionId	subscriptionId	True	string	Zu löschende Abonnement-ID.

Abonnieren des GPS-Datenwebhakens

Vorgangs-ID:: TrackingController_SubscribeToGpsDataFeed

Fügt neue GPS-Tracking-Daten (GPS-Positions) Web-Hook hinzu. Mit Web-Hooks können Sie GPS-Positionen empfangen, die auf einer angegebenen URL auftreten.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
URL	Url		string	Url mit der Adresse des WebHookSubscriptionParamsApiModel.
SecurityToken	SecurityToken		string	Sicherheitstoken, das diesem WebHookSubscriptionParamsApiModel zugeordnet ist.

Gibt zurück

Body: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Abonnieren von Ereignisse-Web-Hooks

Vorgangs-ID:: EventController_SubscribeToEventDataFeed

Fügt ein Web hook-Abonnement für neue Ereignisse hinzu. Mit Web-Hooks können Sie automatische Benachrichtigungen zu Unternehmensereignissen empfangen, die auf einer angegebenen URL auftreten.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
URL	Url		string	Url mit der Adresse des WebHookSubscriptionParamsApiModel.
SecurityToken	SecurityToken		string	Sicherheitstoken, das diesem WebHookSubscriptionParamsApiModel zugeordnet ist.

Gibt zurück

Body: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Abrufen benutzerdefinierter Listendefinitionen

Vorgangs-ID:: CustomListController_Get

Ruft eine Auflistung der benutzerdefinierten Listendefinitionen ab. Die Definitionsauflistung enthält die CustomListID, den Namen und die Version für alle vorhandenen benutzerdefinierten Listen.

Gibt zurück

response: array of CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Abrufen einer benutzerdefinierten Ereignisdefinition nach ID

Vorgangs-ID:: EventController_Get

Ruft eine einzelne benutzerdefinierte Ereignisdefinition nach ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Ereignisdefinitions-ID.

Gibt zurück

Benutzerdefiniertes Ereignisdefinitionsmodell.

Body: CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Abrufen einer benutzerdefinierten Listenfelderauflistung nach CustomListID

Vorgangs-ID:: CustomListController_GetById

Ruft eine Liste von Feldern für eine einzelne benutzerdefinierte Liste mithilfe der CustomListID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
customListId	customListId	True	integer	Benutzerdefinierte Listen-ID.

Gibt zurück

Benutzerdefiniertes Listenmodell.

Body: CustomerAPI.Models.CustomLists.CustomListApiModel

Abrufen einer Fahrzeugliste

Vorgangs-ID:: VehicleController_GetVehicles

Ruft eine Fahrzeugliste ab.

Parameter

Name	Schlüssel	Typ	Beschreibung
pageNumber	pageNumber	integer	Seitennummer.
pageSize	pageSize	integer	Maximale Anzahl von Elementen auf einer Seite. Standard = 1000. Max. Wert = 2000.
activeOnly	activeOnly	boolean	wenn wahr - gibt nur aktive Fahrzeuge zurück. Standardwert = false.

Gibt zurück

response: array of CustomerAPI.Models.Vehicles.VehicleReadApi

Abrufen einer Liste von Abonnements

Vorgangs-ID:: TrackingController_GetSubscriptions

Ruft eine Liste der Web hook-Abonnements ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben. Die Ergebnisse werden automatisch nach SubscriptionId und in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.

Gibt zurück

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Abrufen einer Liste von benutzerdefinierten Ereignisdefinitionen

Vorgangs-ID:: EventController_GetList

Ruft eine Liste der benutzerdefinierten Ereignisdefinitionen ab.

Gibt zurück

response: array of CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Abrufen einer Liste von Benutzern

Vorgangs-ID:: UserController_GetUsers

Ruft eine Liste der Benutzer ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben. Die Ergebnisse werden automatisch nach UserId und in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
pageNumber	pageNumber		integer	Seitenzahl beginnen. Der Standardwert ist 1.
pageSize	pageSize		integer	Seitengröße. Der Standardwert ist 500.

Gibt zurück

response: array of CustomerAPI.Models.User.ReadUserListItemApiModel

Abrufen einer Liste von Bestellungen

Vorgangs-ID:: OrderController_GetOrders

Ruft eine Liste der Bestellungen mithilfe der Filter aus den unten gezeigten Anforderungsparametern ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben. Die Ergebnisse werden automatisch nach Client.Name und in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
dueDateFrom	dueDateFrom	True	date-time	Filtert nach Fälligkeitsdatumsanfangsdatum.
dueDateTo	dueDateTo	True	date-time	Filtert nach Fälligkeitsdatum enddatum.
Mitarbeiternummer	employeeNumber		string	Nach Mitarbeiternummer filtern.
pageNumber	pageNumber		integer	Seitenzahl der Startseite (Standard 1).
pageSize	pageSize		integer	Seitengröße (Standard 500).

Gibt zurück

response: array of CustomerAPI.Models.Order.OrderListItemApiModel

Abrufen einer Liste von Clients

Vorgangs-ID:: ClientController_GetClients

Ruft eine Liste von Clients ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben. Die Ergebnisse werden automatisch nach Name und in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
pageNumber	pageNumber		integer	Seitenzahl beginnen.
pageSize	pageSize		integer	Seitengröße.

Gibt zurück

response: array of CustomerAPI.Models.Client.ReadClientApiModel

Abrufen einer Liste von Ereignissen

Vorgangs-ID:: EventController_GetEvents

Ruft eine Liste von Ereignissen für einen bestimmten Zeitraum ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben.

Filtern Sie nach Ereignistyp, um bestimmte Ereignisse abzurufen. Fahrzeugereignisse können für einen Mitarbeiter zurückgegeben werden, wenn der Mitarbeiter mit dem Fahrzeug verbunden ist.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
fromDate	fromDate	True	date-time	Anfang des Datumsbereichs.
toDate	toDate	True	date-time	Datumsbereichsende.
Mitarbeiternummer	employeeNumber		string	Mitarbeiternummer.
vehicleNumber	vehicleNumber		string	Fahrzeugnummer.
pageNumber	pageNumber		integer	Seitenzahl beginnen.
pageSize	pageSize		integer	Seitengröße.
eventType	eventType		integer	Filtern nach Ereignistyp. Die Mitarbeiternummer wird angegeben: UserEvents(0) – nur Benutzerereignisse. VehicleEvents(1) – nur Fahrzeugereignisse, einschließlich Sensorereignissen. ExternalEvents(2) – nur externe Ereignisse. Die Fahrzeugnummer ist angegeben: UserEvents(0) - N/A. VehicleEvents(1) – nur Fahrzeugereignisse, einschließlich Sensorereignissen. ExternalEvents(2) – nur externe Ereignisse. Weder Die Mitarbeiternummer noch die Fahrzeugnummer sind angegeben: UserEvents(0) – nur Benutzerereignisse. VehicleEvents(1) – nur Fahrzeugereignisse, einschließlich Sensorereignissen. ExternalEvents(2) – nur externe Ereignisse.

Gibt zurück

response: array of CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Abrufen einer Liste von Ereigniswebhakenabonnements

Vorgangs-ID:: EventController_GetSubscriptions

Ruft eine Liste der Ereigniswebhakenabonnements ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben. Die Ergebnisse werden automatisch nach SubscriptionId und in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.

Gibt zurück

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Abrufen einer Liste von Formularen

Vorgangs-ID:: FormController_GetFormsAsync

Ruft eine Liste von Formularen mithilfe eines der Filter aus den unten gezeigten Anforderungsparametern ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben. Die Ergebnisse werden automatisch nach SubmittedTime und in absteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
submittedStartDate	submittedStartDate	True	date-time	Startdatum des übermittelten Formulars.
submittedEndDate	submittedEndDate	True	date-time	Enddatum des übermittelten Formulars.
apiModuleId	apiModuleId		string	Formularmodul-ID.
Mitarbeiternummer	employeeNumber		string	Mitarbeiternummer.
reviewed	reviewed		boolean	Ruft nur überprüfte Formulare ab oder nicht. Der Standardwert ist null für alle.
pageNumber	pageNumber		integer	Seitenzahl wird gestartet. Der Standardwert ist 1.
pageSize	pageSize		integer	Seitengröße. Der Standardwert lautet 1000.

Gibt zurück

response: array of CustomerAPI.Models.Forms.StandaloneFormApiModel

Abrufen einer Liste von Geofences

Vorgangs-ID:: GeofenceController_GetGeofences

Ruft eine Liste von Geofences ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben sowie angeben, ob die Geofence-Koordinaten metrisch sind. Die Ergebnisse werden automatisch nach Name und in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.

Parameter

Name	Schlüssel	Typ	Beschreibung
pageNumber	pageNumber	integer	Seitenzahl beginnen. Der Standardwert ist 1.
pageSize	pageSize	integer	Seitengröße. Der Standardwert ist 500.
useMetric	useMetric	boolean	Verwenden Sie metrisches System oder nicht.

Gibt zurück

response: array of CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Abrufen einer Liste von Reisen

Vorgangs-ID:: TrackingController_GetTrips

Ruft eine Liste von Reisen für einen bestimmten Zeitraum ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben. Die Ergebnisse werden automatisch nach StartUtcTIme und in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
fromDate	fromDate	True	date-time	Anfang des Datumsbereichs. Empfehlung: Bitte verwenden Sie große Datumsbereiche (>=4 Stunden) anstelle kleiner Datumsbereiche.
toDate	toDate	True	date-time	Datumsbereichsende. Empfehlung: Bitte verwenden Sie große Datumsbereiche (>=4 Stunden) anstelle kleiner Datumsbereiche.
Mitarbeiternummer	employeeNumber		string	Mitarbeiternummer.
Vin	vin		string	Vinnummer des Fahrzeugs.
pageNumber	pageNumber		integer	Seitenzahl beginnen. Der Standardwert ist 1.
pageSize	pageSize		integer	Seitengröße. Der Standardwert lautet 1000.
useMetric	useMetric		boolean	Verwenden Sie metrisches System oder nicht.

Gibt zurück

response: array of CustomerAPI.Models.Tracking.TripApiModel

Abrufen einer Liste von Zeiterfassungseinträgen

Vorgangs-ID:: TimekeepingController_GetTimekeepingDataList

Ruft eine Liste von Zeiterfassungseinträgen basierend auf dem Datumsbereich ab. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben. Die Ergebnisse werden automatisch nach ClockInTime und dann nach TimekeepingStatusId und in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
fromDate	fromDate	True	date-time	Startdatum.
toDate	toDate	True	date-time	Enddatum.
Mitarbeiternummer	employeeNumber		string	Mitarbeiternummer.
gebilligt	approved		boolean	Filter nur für genehmigte Einträge.
closedOnly	closedOnly		boolean	Nur nach geschlossenem Eintrag filtern.
excludeFormData	excludeFormData		boolean	Filtern nach Ausschließen von Formulardaten.
pageNumber	pageNumber		integer	Seitenzahl der Startseite (Standard 1).
pageSize	pageSize		integer	Seitengröße (Standard 1000).

Gibt zurück

response: array of CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Abrufen eines Benutzers

Vorgangs-ID:: UserController_Get

Ruft einen Benutzer anhand seiner ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Die externe oder interne ID hängt vom Wert im Parameter "use-external-id" ab.
use-external-id	use-external-id		boolean	Verwenden Sie externe ID oder nicht.

Gibt zurück

Body: CustomerAPI.Models.User.ReadUserApiModel

Abrufen eines Clients

Vorgangs-ID:: ClientController_Get

Ruft ein Clientobjekt anhand seiner ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Client-ID.
use-external-id	use-external-id		boolean	Verwenden Sie externe ID oder nicht.

Gibt zurück

Body: CustomerAPI.Models.Client.ReadClientApiModel

Abrufen eines Fahrzeugs nach ID

Vorgangs-ID:: VehicleController_GetVehicle

Ruft ein einzelnes Fahrzeug nach ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Die externe oder interne ID hängt vom Wert im Parameter "use-external-id" ab.
use-external-id	use-external-id		boolean	Verwenden Sie externe ID oder nicht.

Gibt zurück

Fahrzeugdatenmodell.

Body: CustomerAPI.Models.Vehicles.VehicleReadApi

Abrufen eines Formulars

Vorgangs-ID:: FormController_GetFormAsync

Ruft ein Formular anhand seiner ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	integer	Formular-ID.

Gibt zurück

Body: CustomerAPI.Models.Forms.StandaloneFormApiModel

Abrufen eines Geofence-Standorts

Vorgangs-ID:: GeofenceController_GetGeofence

Ruft einen Geofence anhand seiner ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	integer	Geofence-ID.
useMetric	useMetric		boolean	Verwenden Sie metrisches System oder nicht.

Gibt zurück

Body: CustomerAPI.Models.Geofence.GeofenceApiModel

Abrufen eines Zeiterfassungseintrags

Vorgangs-ID:: TimekeepingController_GetTimekeepingEntryAsync

Ruft einen Eintrag anhand seiner ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	ID des Datensatzes.

Gibt zurück

Body: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Abrufen einzelner Datensätze aus einer benutzerdefinierten Liste

Vorgangs-ID:: CustomListController_GetSingleRecord

Ruft einen einzelnen benutzerdefinierten Listendatensatz ab, der von CustomListId und einem eindeutigen Spaltenwert gefunden wurde.

Irrtümer:

404 – Es gibt keinen benutzerdefinierten Listendatensatz für die bereitgestellte customListId und einen eindeutigen Spaltenwert.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
customListId	customListId	True	integer	Benutzerdefinierte Listen-ID.
id	id	True	string	Eindeutiger Wert.

Gibt zurück

Container für benutzerdefinierte Listenspaltendatenarray.

Body: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Abrufen von GPS-Dateneinträgen

Vorgangs-ID:: TrackingController_GetGpsData

Ruft GPS-Dateneinträge für einen angegebenen Datumsbereich ab. Gibt außerdem ein Fortsetzungstoken und einen Link zum Abrufen des nächsten Datenteils zurück. Sie können die Anzahl der zurückgegebenen Seiten und die Anzahl der Elemente pro Seite angeben.

Positionen für gelöschte Nutzer/Fahrzeuge werden nicht zurückgegeben. Wenn der Benutzer/das Fahrzeug jedoch vorhanden ist, wenn Daten angefordert und später entfernt wurden, werden daten für den Benutzer/das Fahrzeug, das von einem Fortsetzungstoken angefordert wird, zurückgegeben.

Die Ergebnisse werden automatisch nach UtcTime und in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.

Parameter

Name	Schlüssel	Typ	Beschreibung
fromDate	fromDate	date-time	Anfang des Datumsbereichs. Empfehlung: Bitte verwenden Sie große Datumsbereiche (>=4 Stunden) anstelle kleiner Datumsbereiche.
toDate	toDate	date-time	Datumsbereichsende. Empfehlung: Bitte verwenden Sie große Datumsbereiche (>=4 Stunden) anstelle kleiner Datumsbereiche.
Mitarbeiternummer	employeeNumber	string	Mitarbeiternummer.
Vin	vin	string	Vinnummer des Fahrzeugs.
useMetric	useMetric	boolean	Verwenden Sie metrisches System oder nicht.
token	token	string	Fortsetzungstoken, das vom anfänglichen Aufruf zurückgegeben wird und im nachfolgenden Aufruf verwendet werden soll.

Gibt zurück

Body: CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Aktivieren eines Benutzers

Vorgangs-ID:: UserController_Activate

Aktiviert einen vorhandenen Benutzer anhand seiner ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Die externe oder interne ID hängt vom Wert im Parameter "use-external-id" ab.
use-external-id	use-external-id		boolean	Verwenden Sie externe ID oder nicht.

Aktivieren eines Fahrzeugs

Vorgangs-ID:: VehicleController_Activate

Aktivieren Sie ein Fahrzeug anhand der ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Die externe oder interne ID hängt vom Wert im Parameter "use-external-id" ab.
use-external-id	use-external-id		boolean	Verwenden Sie externe ID oder nicht.

Gibt zurück

response: integer

Aktualisieren einer Bestellung

Vorgangs-ID:: OrderController_Update

Aktualisiert eine vorhandene Bestellung.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Die externe oder interne ID hängt vom Wert im Parameter "use-external-id" ab.
ExternalOrderId	ExternalOrderId		string	Externe Use OrderId für den Client – API-Erweiterungseigenschaft.
IsClosed	IsClosed		boolean	Der Status wird angezeigt, wenn das UpdateOrderApiModel geschlossen wurde.
Breitengrad	Latitude		double
Längengrad	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 dieses LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 dieses LocationApiModel.
Stadt	City		string	Ort des LocationApiModel.
RegionName	RegionName		string	Regionsname des LocationApiModel.
Postleitzahl	PostalCode		string	Postleitzahl des LocationApiModel.
Ländercode	CountryCode		string	ISO 3166-1 Alpha-2-Code.
SubRegionName	SubRegionName		string	Unterregion des LocationApiModel.
SubRegionCode	SubRegionCode		string	SubRegion-Code des LocationApiModel.
RegionCode	RegionCode		string	Regionscode des LocationApiModel.
Name	Name		string	Name des ContactApiModel.
Telefonnummer	PhoneNumber		string	PhoneNumber des ContactApiModel.
Email	Email		string	E-Mail des ContactApiModel.
Fälligkeitsdatum	DueDate		date-time	Zeitpunkt, zu dem dieses BaseUpdateOrderApiModel abgeschlossen ist (in v1.3 veraltet).
StartTime	StartTime		date-time	Point in time this BaseUpdateOrderApiModel should start (introduced in v1.3).
EndTime	EndTime		date-time	Point in time this BaseUpdateOrderApiModel should end (introduced in v1.3).
Überschrift	Caption	True	string
Wert	Value			Wert des UpdateFormFieldApiModel. Feldwertformat "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Feldwertformat "Camera" (binäre Referenz): { "BinaryId": string, // Binary ID eines hochgeladenen Bilds (siehe Upload binary API) "Hinweis": Zeichenfolge // Hinweis für das referenzierte Bild } Feldwertformat "Signature" (binäre Referenz): { "BinaryId": string // Binary ID eines hochgeladenen Bilds (siehe Upload-Binär-API) } Feldwertformat "Audio" (binärer Bezug): { "BinaryId": string, // Binary ID eines hochgeladenen Audios (siehe Upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Der Zeitwert wurde erfasst.
Breitengrad	Latitude		double
Längengrad	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 dieses LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 dieses LocationApiModel.
Stadt	City		string	Ort des LocationApiModel.
RegionName	RegionName		string	Regionsname des LocationApiModel.
Postleitzahl	PostalCode		string	Postleitzahl des LocationApiModel.
Ländercode	CountryCode		string	ISO 3166-1 Alpha-2-Code.
SubRegionName	SubRegionName		string	Unterregion des LocationApiModel.
SubRegionCode	SubRegionCode		string	SubRegion-Code des LocationApiModel.
RegionCode	RegionCode		string	Regionscode des LocationApiModel.
Überschrift	Caption	True	string
Wert	Value			Wert des UpdateFormFieldApiModel. Feldwertformat "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Feldwertformat "Camera" (binäre Referenz): { "BinaryId": string, // Binary ID eines hochgeladenen Bilds (siehe Upload binary API) "Hinweis": Zeichenfolge // Hinweis für das referenzierte Bild } Feldwertformat "Signature" (binäre Referenz): { "BinaryId": string // Binary ID eines hochgeladenen Bilds (siehe Upload-Binär-API) } Feldwertformat "Audio" (binärer Bezug): { "BinaryId": string, // Binary ID eines hochgeladenen Audios (siehe Upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Der Zeitwert wurde erfasst.
Mitarbeiternummer	EmployeeNumber	True	string	EmployeeNumber des Benutzers, der dieses NewOrderStatusApiModel erstellt hat.
StatusLabel	StatusLabel	True	string	Bezeichnungsinhalt für das StatusLabel, das diesem NewOrderStatusApiModel zugeordnet ist.
StatusStartDateTime	StatusStartDateTime	True	date-time	Zeitpunkt, zu dem dieser NewOrderStatusApiModel-Status gestartet wurde.
Überschrift	Caption	True	string
Wert	Value			Wert des UpdateFormFieldApiModel. Feldwertformat "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Feldwertformat "Camera" (binäre Referenz): { "BinaryId": string, // Binary ID eines hochgeladenen Bilds (siehe Upload binary API) "Hinweis": Zeichenfolge // Hinweis für das referenzierte Bild } Feldwertformat "Signature" (binäre Referenz): { "BinaryId": string // Binary ID eines hochgeladenen Bilds (siehe Upload-Binär-API) } Feldwertformat "Audio" (binärer Bezug): { "BinaryId": string, // Binary ID eines hochgeladenen Audios (siehe Upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Der Zeitwert wurde erfasst.
Breitengrad	Latitude		double
Längengrad	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 dieses LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 dieses LocationApiModel.
Stadt	City		string	Ort des LocationApiModel.
RegionName	RegionName		string	Regionsname des LocationApiModel.
Postleitzahl	PostalCode		string	Postleitzahl des LocationApiModel.
Ländercode	CountryCode		string	ISO 3166-1 Alpha-2-Code.
SubRegionName	SubRegionName		string	Unterregion des LocationApiModel.
SubRegionCode	SubRegionCode		string	SubRegion-Code des LocationApiModel.
RegionCode	RegionCode		string	Regionscode des LocationApiModel.
Überschrift	Caption	True	string
Wert	Value			Wert des UpdateFormFieldApiModel. Feldwertformat "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Feldwertformat "Camera" (binäre Referenz): { "BinaryId": string, // Binary ID eines hochgeladenen Bilds (siehe Upload binary API) "Hinweis": Zeichenfolge // Hinweis für das referenzierte Bild } Feldwertformat "Signature" (binäre Referenz): { "BinaryId": string // Binary ID eines hochgeladenen Bilds (siehe Upload-Binär-API) } Feldwertformat "Audio" (binärer Bezug): { "BinaryId": string, // Binary ID eines hochgeladenen Audios (siehe Upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Der Zeitwert wurde erfasst.
FieldIndex	FieldIndex		integer	Feldindex.
Wert	Value			Feldwert.
Geocode	geocode		boolean	Sollte die Adresse geocodiert sein oder nicht.
use-external-id	use-external-id		boolean	Verwenden Sie externe ID oder nicht.

Gibt zurück

Body: CustomerAPI.Models.ReturnIdApiModel

Aktualisieren eines Benutzers

Vorgangs-ID:: UserController_Update

Aktualisiert einen vorhandenen Benutzer.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Die externe oder interne ID hängt vom Wert im Parameter "use-external-id" ab.
Nutzername	UserName		string	Benutzername des Benutzers.
Kennwort	Password		password	Kennwort des Benutzers.
GroupName	GroupName		string	Name der Gruppe des Benutzers.
Vorname	FirstName		string	Vorname des Benutzers.
Nachname	LastName		string	Nachname des Benutzers.
Mitarbeiternummer	EmployeeNumber		string	Mitarbeiternummer des Benutzers.
Email	Email		string	E-Mail-Adresse des Benutzers.
Telefonnummer	Phone		string	Telefonnummer des Benutzers.
RoleId	RoleId		integer	RoleId des Benutzers - (Administrator: 1, Benutzer: 3, Power User: 5).
IsActive	IsActive		boolean	Aktiver Status des Benutzers.
EPTTEnabled	EPTTEnabled		boolean	Status der erweiterten Push-to-Talk-Funktion für Benutzer: boolean.
EPTTNumber	EPTTNumber		string	Telefonnummer für erweiterte Push-to-Talk-Funktion für Benutzer: Zeichenfolge.
EPTTWebMDN	EPTTWebMDN		string	Telefonnummer, die verwendet wird, um den Benutzer beim Kodiak EPTT-System zu authentifizieren - bereitgestellt von Kodiak.
EPTTToken	EPTTToken		string	API-Token zur Authentifizierung des Benutzers bei Kodiak EPTT-System - bereitgestellt von Kodiak.
GPSEnabled	GPSEnabled		boolean	Status des GPS-Features für den Benutzer.
MobileOnly	MobileOnly		boolean	Status des Desktopwebanwendungszugriffs für CAB - (No WebApp Access: True, Full App Access: False).
LicenseType	LicenseType		integer	Dem Benutzer zugewiesener Lizenztyp: - 0 für "Nicht definiert", "1" für "Normal", "2" für "WebOnly" und "3 für Mitarbeiter".
use-external-id	use-external-id		boolean	Verwenden Sie externe ID oder nicht.

Gibt zurück

Body: CustomerAPI.Models.ReturnIdApiModel

Aktualisieren eines Clients

Vorgangs-ID:: ClientController_Update

Aktualisiert einen vorhandenen Client.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Die externe oder interne ID hängt vom Wert im Parameter "use-external-id" ab.
ExternalId	ExternalId		string	Externe Verwendungs-ID für den Client – API-Erweiterungseigenschaft.
FieldIndex	FieldIndex		integer	Feldindex.
Wert	Value			Feldwert.
Name	Name		string	Name des Clients.
Breitengrad	Latitude		double
Längengrad	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 dieses LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 dieses LocationApiModel.
Stadt	City		string	Ort des LocationApiModel.
RegionName	RegionName		string	Regionsname des LocationApiModel.
Postleitzahl	PostalCode		string	Postleitzahl des LocationApiModel.
Ländercode	CountryCode		string	ISO 3166-1 Alpha-2-Code.
SubRegionName	SubRegionName		string	Unterregion des LocationApiModel.
SubRegionCode	SubRegionCode		string	SubRegion-Code des LocationApiModel.
RegionCode	RegionCode		string	Regionscode des LocationApiModel.
Name	Name		string	Name des ContactApiModel.
Telefonnummer	PhoneNumber		string	PhoneNumber des ContactApiModel.
Email	Email		string	E-Mail des ContactApiModel.
Geocode	geocode		boolean	Sollte die Adresse geocodiert sein oder nicht.
use-external-id	use-external-id		boolean	Verwenden Sie externe ID oder nicht.

Gibt zurück

Body: CustomerAPI.Models.ReturnIdApiModel

Aktualisieren eines Fahrzeugs

Vorgangs-ID:: VehicleController_UpdateVehicle

Aktualisieren Sie ein Fahrzeug anhand der ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Die externe oder interne ID hängt vom Wert im Parameter "use-external-id" ab.
Number	Number		string
Name	Name		string
Typ	Type		string
Tag	Tag		string
UserEmployeeNumber	UserEmployeeNumber		string
GroupName	GroupName		string
TimeZone	TimeZone		string
Machen	Make		string
Jahr	Year		integer
Model	Model		string
Farbe	Color		string
VIN	VIN		string
IsActive	IsActive		boolean
Typ des Geräts	DeviceType		integer
DeviceSerialNumber	DeviceSerialNumber		string
use-external-id	use-external-id		boolean	Verwenden Sie externe ID oder nicht.

Gibt zurück

response: integer

Aktualisieren eines Teils eines Benutzers

Vorgangs-ID:: UserController_PartialUpdate

Aktualisiert einen Teil der Eigenschaften des Benutzers.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Die externe oder interne ID hängt vom Wert im Parameter "use-external-id" ab.
			object
use-external-id	use-external-id		boolean	Verwenden Sie externe ID oder nicht.

Gibt zurück

Body: CustomerAPI.Models.ReturnIdApiModel

Aktualisieren eines vorhandenen Geofence-Bereichs

Vorgangs-ID:: GeofenceController_UpdateGeofence

Aktualisiert einen vorhandenen Geofence durch seine ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	integer	Geofence-ID.
GroupNames	GroupNames		array of string	GroupPaths of the GeofenceUpdateApiModel.
Breitengrad	Latitude		double
Längengrad	Longitude		double
Name	Name		string	Name der GeofenceApiModelBase.
Typ	Type		string	Typ des GeofenceApiModel.
Shape	Shape		integer	Form: 0 für Kreis und 1 für Polygon.
Breitengrad	Latitude		double
Längengrad	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 dieses LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 dieses LocationApiModel.
Stadt	City		string	Ort des LocationApiModel.
RegionName	RegionName		string	Regionsname des LocationApiModel.
Postleitzahl	PostalCode		string	Postleitzahl des LocationApiModel.
Ländercode	CountryCode		string	ISO 3166-1 Alpha-2-Code.
SubRegionName	SubRegionName		string	Unterregion des LocationApiModel.
SubRegionCode	SubRegionCode		string	SubRegion-Code des LocationApiModel.
RegionCode	RegionCode		string	Regionscode des LocationApiModel.
Radius	Radius		double	Radius des GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress		boolean	UseGeofenceAddress des GeofenceApiModel.
useMetric	useMetric		boolean	Verwenden Sie metrisches System oder nicht.
Geocode	geocode		boolean	Sollte die Adresse geocodiert sein oder nicht.

Gibt zurück

Body: CustomerAPI.Models.ReturnIdApiModel

Anlagendatei hochladen

Vorgangs-ID:: BinaryController_UploadAttachment

Verwenden Sie diese Option, um Formulardateianlagen hochzuladen. Die Binäre Größe ist auf 25 MB begrenzt. Es wurde eine mehrteilige/Formulardatenanforderung mit einer einzelnen Datei erwartet.

Gibt zurück

Body: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Auftragsstatus aktualisieren

Vorgangs-ID:: OrderController_ChangeStatus

Ändert einen vorhandenen Bestellstatus.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Die externe oder interne ID hängt vom Wert im Parameter "use-external-id" ab.
Mitarbeiternummer	EmployeeNumber	True	string	EmployeeNumber des Benutzers, der dieses NewOrderStatusApiModel erstellt hat.
StatusLabel	StatusLabel	True	string	Bezeichnungsinhalt für das StatusLabel, das diesem NewOrderStatusApiModel zugeordnet ist.
StatusStartDateTime	StatusStartDateTime	True	date-time	Zeitpunkt, zu dem dieser NewOrderStatusApiModel-Status gestartet wurde.
Überschrift	Caption	True	string
Wert	Value			Wert des UpdateFormFieldApiModel. Feldwertformat "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Feldwertformat "Camera" (binäre Referenz): { "BinaryId": string, // Binary ID eines hochgeladenen Bilds (siehe Upload binary API) "Hinweis": Zeichenfolge // Hinweis für das referenzierte Bild } Feldwertformat "Signature" (binäre Referenz): { "BinaryId": string // Binary ID eines hochgeladenen Bilds (siehe Upload-Binär-API) } Feldwertformat "Audio" (binärer Bezug): { "BinaryId": string, // Binary ID eines hochgeladenen Audios (siehe Upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Der Zeitwert wurde erfasst.
Breitengrad	Latitude		double
Längengrad	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 dieses LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 dieses LocationApiModel.
Stadt	City		string	Ort des LocationApiModel.
RegionName	RegionName		string	Regionsname des LocationApiModel.
Postleitzahl	PostalCode		string	Postleitzahl des LocationApiModel.
Ländercode	CountryCode		string	ISO 3166-1 Alpha-2-Code.
SubRegionName	SubRegionName		string	Unterregion des LocationApiModel.
SubRegionCode	SubRegionCode		string	SubRegion-Code des LocationApiModel.
RegionCode	RegionCode		string	Regionscode des LocationApiModel.
Überschrift	Caption	True	string
Wert	Value			Wert des UpdateFormFieldApiModel. Feldwertformat "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Feldwertformat "Camera" (binäre Referenz): { "BinaryId": string, // Binary ID eines hochgeladenen Bilds (siehe Upload binary API) "Hinweis": Zeichenfolge // Hinweis für das referenzierte Bild } Feldwertformat "Signature" (binäre Referenz): { "BinaryId": string // Binary ID eines hochgeladenen Bilds (siehe Upload-Binär-API) } Feldwertformat "Audio" (binärer Bezug): { "BinaryId": string, // Binary ID eines hochgeladenen Audios (siehe Upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Der Zeitwert wurde erfasst.
use-external-id	use-external-id		boolean	Verwenden Sie externe ID oder nicht.

Gibt zurück

Body: CustomerAPI.Models.ReturnIdApiModel

Benutzerdefinierte Listendaten nach CustomListID abrufen

Vorgangs-ID:: CustomListController_GetCustomList

Ruft alle Datensätze in einer einzelnen benutzerdefinierten Liste mithilfe der CustomListID ab.

Die Ergebnisse werden nach Spalte sortiert, und das Paging wird unterstützt.

Irrtümer:

404 – es gibt keine benutzerdefinierte Liste für die bereitgestellte customListId.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
customListId	customListId	True	integer	Benutzerdefinierte Listen-ID.
pageNumber	pageNumber		integer	Seitenzahl beginnen.
pageSize	pageSize		integer	Seitengröße.

Gibt zurück

Container für benutzerdefinierte Listenspaltendatenarray.

Body: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Benutzerdefinierten Listendatensatz löschen

Vorgangs-ID:: CustomListController_DeleteRecord

Löscht vorhandenen Datensatz in einer benutzerdefinierten Liste anhand seiner customListId und ID.

id - ist eindeutiger Wert des benutzerdefinierten Listendatensatzes.

Irrtümer:

404 – customListId oder ID nicht gefunden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
customListId	customListId	True	integer	Benutzerdefinierte Listen-ID.
id	id	True	string	Eindeutiger Wert.

Bestellung abrufen

Vorgangs-ID:: OrderController_GetOrder

Ruft eine vorhandene Reihenfolge anhand der ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Die externe oder interne ID hängt vom Wert im Parameter "use-external-id" ab.
include-status-history	include-status-history		string	Wenn wahr, enthält die Antwort alle Statusverlaufs- und Formulardaten für diese Bestellung.
use-external-id	use-external-id		boolean	Verwenden Sie externe ID oder nicht.

Gibt zurück

Body: CustomerAPI.Models.Order.OrderApiModel

Binärdatei hochladen

Vorgangs-ID:: BinaryController_UploadBinary

Verwenden Sie diese Option, um Formularbilder und Audiodateien hochzuladen. Die Binäre Größe ist auf 10 MB begrenzt. Unterstützte Dateitypen sind: JPEG, PNG und MP4.

Gibt zurück

Body: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Deaktivieren eines Benutzers

Vorgangs-ID:: UserController_Deactivate

Deaktiviert einen vorhandenen Benutzer anhand seiner ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Die externe oder interne ID hängt vom Wert im Parameter "use-external-id" ab.
use-external-id	use-external-id		boolean	Verwenden Sie externe ID oder nicht.

Deaktivieren eines Fahrzeugs

Vorgangs-ID:: VehicleController_Deactivate

Deaktivieren Sie ein Fahrzeug nach ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Die externe oder interne ID hängt vom Wert im Parameter "use-external-id" ab.
use-external-id	use-external-id		boolean	Verwenden Sie externe ID oder nicht.

Gibt zurück

response: integer

Einen Client erstellen

Vorgangs-ID:: ClientController_Create

Erstellt einen neuen Client.

Parameter

Name	Schlüssel	Typ	Beschreibung
ExternalId	ExternalId	string	Externe Verwendungs-ID für den Client – API-Erweiterungseigenschaft.
FieldIndex	FieldIndex	integer	Feldindex.
Wert	Value		Feldwert.
Name	Name	string	Name des Clients.
Breitengrad	Latitude	double
Längengrad	Longitude	double
AddressLine1	AddressLine1	string	AddressLine1 dieses LocationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 dieses LocationApiModel.
Stadt	City	string	Ort des LocationApiModel.
RegionName	RegionName	string	Regionsname des LocationApiModel.
Postleitzahl	PostalCode	string	Postleitzahl des LocationApiModel.
Ländercode	CountryCode	string	ISO 3166-1 Alpha-2-Code.
SubRegionName	SubRegionName	string	Unterregion des LocationApiModel.
SubRegionCode	SubRegionCode	string	SubRegion-Code des LocationApiModel.
RegionCode	RegionCode	string	Regionscode des LocationApiModel.
Name	Name	string	Name des ContactApiModel.
Telefonnummer	PhoneNumber	string	PhoneNumber des ContactApiModel.
Email	Email	string	E-Mail des ContactApiModel.
Geocode	geocode	boolean	Sollte die Adresse geocodiert sein oder nicht.

Gibt zurück

Body: CustomerAPI.Models.ReturnIdApiModel

Erstellen eines Benutzers

Vorgangs-ID:: UserController_Create

Erstellt einen neuen Benutzer.

Parameter

Name	Schlüssel	Typ	Beschreibung
Nutzername	UserName	string	Benutzername des Benutzers.
Kennwort	Password	password	Kennwort des Benutzers.
GroupName	GroupName	string	Name der Gruppe des Benutzers.
Vorname	FirstName	string	Vorname des Benutzers.
Nachname	LastName	string	Nachname des Benutzers.
Mitarbeiternummer	EmployeeNumber	string	Mitarbeiternummer des Benutzers.
Email	Email	string	E-Mail-Adresse des Benutzers.
Telefonnummer	Phone	string	Telefonnummer des Benutzers.
RoleId	RoleId	integer	RoleId des Benutzers - (Administrator: 1, Benutzer: 3, Power User: 5).
IsActive	IsActive	boolean	Aktiver Status des Benutzers.
EPTTEnabled	EPTTEnabled	boolean	Status der erweiterten Push-to-Talk-Funktion für Benutzer: boolean.
EPTTNumber	EPTTNumber	string	Telefonnummer für erweiterte Push-to-Talk-Funktion für Benutzer: Zeichenfolge.
EPTTWebMDN	EPTTWebMDN	string	Telefonnummer, die verwendet wird, um den Benutzer beim Kodiak EPTT-System zu authentifizieren - bereitgestellt von Kodiak.
EPTTToken	EPTTToken	string	API-Token zur Authentifizierung des Benutzers bei Kodiak EPTT-System - bereitgestellt von Kodiak.
GPSEnabled	GPSEnabled	boolean	Status des GPS-Features für den Benutzer.
MobileOnly	MobileOnly	boolean	Status des Desktopwebanwendungszugriffs für CAB - (No WebApp Access: True, Full App Access: False).
LicenseType	LicenseType	integer	Dem Benutzer zugewiesener Lizenztyp: - 0 für "Nicht definiert", "1" für "Normal", "2" für "WebOnly" und "3 für Mitarbeiter".

Gibt zurück

Body: CustomerAPI.Models.ReturnIdApiModel

Erstellen eines Fahrzeugs

Vorgangs-ID:: VehicleController_CreateVehicle

Erstellt ein Fahrzeug.

Parameter

Name	Schlüssel	Typ
Number	Number	string
Name	Name	string
Typ	Type	string
Tag	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
TimeZone	TimeZone	string
Machen	Make	string
Jahr	Year	integer
Model	Model	string
Farbe	Color	string
VIN	VIN	string
IsActive	IsActive	boolean
Typ des Geräts	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

Gibt zurück

Body: CustomerAPI.Models.ReturnIdApiModel

Erstellen eines Formulars

Vorgangs-ID:: FormController_PostFormAsync

Fügt ein neues Formular hinzu.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ApiModuleId	ApiModuleId		string	Id des apiModule,das diesem CreateStandaloneFormApiModel zugeordnet ist.
Geprüft	Reviewed		boolean	Status der Überprüfung dieses CreateStandaloneFormApiModel.
UserId	UserId		integer	UserId des Benutzers.
Mitarbeiternummer	EmployeeNumber		string	Mitarbeiternummer des Benutzers.
Übermittelte Zeit	SubmittedTime	True	date-time	Zeitpunkt, zu dem das CreateStandaloneFormApiModel übermittelt wurde.
Breitengrad	Latitude		double
Längengrad	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 dieses LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 dieses LocationApiModel.
Stadt	City		string	Ort des LocationApiModel.
RegionName	RegionName		string	Regionsname des LocationApiModel.
Postleitzahl	PostalCode		string	Postleitzahl des LocationApiModel.
Ländercode	CountryCode		string	ISO 3166-1 Alpha-2-Code.
SubRegionName	SubRegionName		string	Unterregion des LocationApiModel.
SubRegionCode	SubRegionCode		string	SubRegion-Code des LocationApiModel.
RegionCode	RegionCode		string	Regionscode des LocationApiModel.
ApiFieldId	ApiFieldId	True	string	API-Feld-ID.
Wert	Value	True		Wert des FormFieldDataApiModel. Feldwertformat "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Feldwertformat "Camera" (binäre Referenz): { "BinaryId": string, // Binary ID eines hochgeladenen Bilds (siehe Upload binary API) "Hinweis": Zeichenfolge // Hinweis für das referenzierte Bild } "Sign"-Feldwertformat (binäre Referenz): { "BinaryId": string // Binary ID eines hochgeladenen Bilds (siehe Upload binary API) } Feldwertformat "Audio" (binärer Bezug): { "BinaryId": string, // Binary ID eines hochgeladenen Audios (siehe Upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Zeitpunkt, zu dem Binärdaten erfasst wurden. Format - Datum-Uhrzeit (als Datum-Uhrzeit in RFC3339) einschließlich Offset.
Breitengrad	Latitude		double
Längengrad	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 dieses LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 dieses LocationApiModel.
Stadt	City		string	Ort des LocationApiModel.
RegionName	RegionName		string	Regionsname des LocationApiModel.
Postleitzahl	PostalCode		string	Postleitzahl des LocationApiModel.
Ländercode	CountryCode		string	ISO 3166-1 Alpha-2-Code.
SubRegionName	SubRegionName		string	Unterregion des LocationApiModel.
SubRegionCode	SubRegionCode		string	SubRegion-Code des LocationApiModel.
RegionCode	RegionCode		string	Regionscode des LocationApiModel.
ApiFieldId	ApiFieldId	True	string	API-Feld-ID.
Wert	Value	True		Wert des FormFieldDataApiModel. Feldwertformat "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Feldwertformat "Camera" (binäre Referenz): { "BinaryId": string, // Binary ID eines hochgeladenen Bilds (siehe Upload binary API) "Hinweis": Zeichenfolge // Hinweis für das referenzierte Bild } "Sign"-Feldwertformat (binäre Referenz): { "BinaryId": string // Binary ID eines hochgeladenen Bilds (siehe Upload binary API) } Feldwertformat "Audio" (binärer Bezug): { "BinaryId": string, // Binary ID eines hochgeladenen Audios (siehe Upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Zeitpunkt, zu dem Binärdaten erfasst wurden. Format - Datum-Uhrzeit (als Datum-Uhrzeit in RFC3339) einschließlich Offset.

Gibt zurück

Body: CustomerAPI.Models.ReturnIdApiModel

Erstellen eines Geofence-Raums

Vorgangs-ID:: GeofenceController_CreateGeofence

Erstellt einen neuen Geofence-Raum.

Parameter

Name	Schlüssel	Typ	Beschreibung
GroupNames	GroupNames	array of string	GroupPaths of the GeofenceCreateApiModel.
Breitengrad	Latitude	double
Längengrad	Longitude	double
Name	Name	string	Name der GeofenceApiModelBase.
Typ	Type	string	Typ des GeofenceApiModel.
Shape	Shape	integer	Form: 0 für Kreis und 1 für Polygon.
Breitengrad	Latitude	double
Längengrad	Longitude	double
AddressLine1	AddressLine1	string	AddressLine1 dieses LocationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 dieses LocationApiModel.
Stadt	City	string	Ort des LocationApiModel.
RegionName	RegionName	string	Regionsname des LocationApiModel.
Postleitzahl	PostalCode	string	Postleitzahl des LocationApiModel.
Ländercode	CountryCode	string	ISO 3166-1 Alpha-2-Code.
SubRegionName	SubRegionName	string	Unterregion des LocationApiModel.
SubRegionCode	SubRegionCode	string	SubRegion-Code des LocationApiModel.
RegionCode	RegionCode	string	Regionscode des LocationApiModel.
Radius	Radius	double	Radius des GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress des GeofenceApiModel.
useMetric	useMetric	boolean	Verwenden Sie metrisches System oder nicht.
Geocode	geocode	boolean	Sollte die Adresse geocodiert sein oder nicht.

Gibt zurück

Body: CustomerAPI.Models.ReturnIdApiModel

Erstellen oder Aktualisieren einer benutzerdefinierten Ereignisdefinition

Vorgangs-ID:: EventController_Put

Erstellt oder aktualisiert eine benutzerdefinierte Ereignisdefinition.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Ereignisdefinitions-ID.
Name	Name		string
ReverseGeocode	ReverseGeocode		boolean
Name	Name		string
Typ	Type		integer
Überschrift	Caption		string
Erforderlich	Required		boolean

Erstellen oder Aktualisieren eines benutzerdefinierten Listendatensatzes

Vorgangs-ID:: CustomListController_PutRecord

Erstellt oder aktualisiert benutzerdefinierte Listendatensatz. Der Wert der eindeutigen Spalte kann weggelassen werden, aber wenn vorhanden, sollte er mit dem Eindeutigen ID-Wert im Abfrageparameter übereinstimmen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
customListId	customListId	True	integer	Benutzerdefinierte Listen-ID.
id	id	True	string	Eindeutiger Wert.
ColumnIndex	ColumnIndex		integer	Benutzerdefinierter Listenspaltenindex.
Überschrift	Caption		string	Benutzerdefinierte Listenspaltenbeschriftung.
Wert	Value			Benutzerdefinierter Listenspaltenwert.

Erstellt einen Auftrag.

Vorgangs-ID:: OrderController_Create

Fügt eine neue Bestellung hinzu.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Erstellungsdatum und -uhrzeit	CreatedDateTime		date-time	Zeitpunkt der Erstellung dieses CreateUpdateOrderApiModels.
ExternalClientId	ExternalClientId	True	string	Externe Verwendungs-ID für den Client – API-Erweiterungseigenschaft.
ServiceType	ServiceType	True	string	Der Diensttyp, der diesem CreateUpdateOrderApiModel zugeordnet ist.
ExternalOrderId	ExternalOrderId		string	Externe Use OrderId für den Client – API-Erweiterungseigenschaft.
Breitengrad	Latitude		double
Längengrad	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 dieses LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 dieses LocationApiModel.
Stadt	City		string	Ort des LocationApiModel.
RegionName	RegionName		string	Regionsname des LocationApiModel.
Postleitzahl	PostalCode		string	Postleitzahl des LocationApiModel.
Ländercode	CountryCode		string	ISO 3166-1 Alpha-2-Code.
SubRegionName	SubRegionName		string	Unterregion des LocationApiModel.
SubRegionCode	SubRegionCode		string	SubRegion-Code des LocationApiModel.
RegionCode	RegionCode		string	Regionscode des LocationApiModel.
Name	Name		string	Name des ContactApiModel.
Telefonnummer	PhoneNumber		string	PhoneNumber des ContactApiModel.
Email	Email		string	E-Mail des ContactApiModel.
Fälligkeitsdatum	DueDate		date-time	Zeitpunkt, zu dem dieses BaseUpdateOrderApiModel abgeschlossen ist (in v1.3 veraltet).
StartTime	StartTime		date-time	Point in time this BaseUpdateOrderApiModel should start (introduced in v1.3).
EndTime	EndTime		date-time	Point in time this BaseUpdateOrderApiModel should end (introduced in v1.3).
Überschrift	Caption	True	string
Wert	Value			Wert des UpdateFormFieldApiModel. Feldwertformat "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Feldwertformat "Camera" (binäre Referenz): { "BinaryId": string, // Binary ID eines hochgeladenen Bilds (siehe Upload binary API) "Hinweis": Zeichenfolge // Hinweis für das referenzierte Bild } Feldwertformat "Signature" (binäre Referenz): { "BinaryId": string // Binary ID eines hochgeladenen Bilds (siehe Upload-Binär-API) } Feldwertformat "Audio" (binärer Bezug): { "BinaryId": string, // Binary ID eines hochgeladenen Audios (siehe Upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Der Zeitwert wurde erfasst.
Breitengrad	Latitude		double
Längengrad	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 dieses LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 dieses LocationApiModel.
Stadt	City		string	Ort des LocationApiModel.
RegionName	RegionName		string	Regionsname des LocationApiModel.
Postleitzahl	PostalCode		string	Postleitzahl des LocationApiModel.
Ländercode	CountryCode		string	ISO 3166-1 Alpha-2-Code.
SubRegionName	SubRegionName		string	Unterregion des LocationApiModel.
SubRegionCode	SubRegionCode		string	SubRegion-Code des LocationApiModel.
RegionCode	RegionCode		string	Regionscode des LocationApiModel.
Überschrift	Caption	True	string
Wert	Value			Wert des UpdateFormFieldApiModel. Feldwertformat "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Feldwertformat "Camera" (binäre Referenz): { "BinaryId": string, // Binary ID eines hochgeladenen Bilds (siehe Upload binary API) "Hinweis": Zeichenfolge // Hinweis für das referenzierte Bild } Feldwertformat "Signature" (binäre Referenz): { "BinaryId": string // Binary ID eines hochgeladenen Bilds (siehe Upload-Binär-API) } Feldwertformat "Audio" (binärer Bezug): { "BinaryId": string, // Binary ID eines hochgeladenen Audios (siehe Upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Der Zeitwert wurde erfasst.
Mitarbeiternummer	EmployeeNumber	True	string	EmployeeNumber des Benutzers, der dieses NewOrderStatusApiModel erstellt hat.
StatusLabel	StatusLabel	True	string	Bezeichnungsinhalt für das StatusLabel, das diesem NewOrderStatusApiModel zugeordnet ist.
StatusStartDateTime	StatusStartDateTime	True	date-time	Zeitpunkt, zu dem dieser NewOrderStatusApiModel-Status gestartet wurde.
Überschrift	Caption	True	string
Wert	Value			Wert des UpdateFormFieldApiModel. Feldwertformat "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Feldwertformat "Camera" (binäre Referenz): { "BinaryId": string, // Binary ID eines hochgeladenen Bilds (siehe Upload binary API) "Hinweis": Zeichenfolge // Hinweis für das referenzierte Bild } Feldwertformat "Signature" (binäre Referenz): { "BinaryId": string // Binary ID eines hochgeladenen Bilds (siehe Upload-Binär-API) } Feldwertformat "Audio" (binärer Bezug): { "BinaryId": string, // Binary ID eines hochgeladenen Audios (siehe Upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Der Zeitwert wurde erfasst.
Breitengrad	Latitude		double
Längengrad	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 dieses LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 dieses LocationApiModel.
Stadt	City		string	Ort des LocationApiModel.
RegionName	RegionName		string	Regionsname des LocationApiModel.
Postleitzahl	PostalCode		string	Postleitzahl des LocationApiModel.
Ländercode	CountryCode		string	ISO 3166-1 Alpha-2-Code.
SubRegionName	SubRegionName		string	Unterregion des LocationApiModel.
SubRegionCode	SubRegionCode		string	SubRegion-Code des LocationApiModel.
RegionCode	RegionCode		string	Regionscode des LocationApiModel.
Überschrift	Caption	True	string
Wert	Value			Wert des UpdateFormFieldApiModel. Feldwertformat "NFC": { "Type": number, // 0 - Text "Payload": object, // Should be text for Type = 0 } Feldwertformat "Camera" (binäre Referenz): { "BinaryId": string, // Binary ID eines hochgeladenen Bilds (siehe Upload binary API) "Hinweis": Zeichenfolge // Hinweis für das referenzierte Bild } Feldwertformat "Signature" (binäre Referenz): { "BinaryId": string // Binary ID eines hochgeladenen Bilds (siehe Upload-Binär-API) } Feldwertformat "Audio" (binärer Bezug): { "BinaryId": string, // Binary ID eines hochgeladenen Audios (siehe Upload binary API) "DurationSeconds": number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	Der Zeitwert wurde erfasst.
FieldIndex	FieldIndex		integer	Feldindex.
Wert	Value			Feldwert.
Geocode	geocode		boolean	Sollte die Adresse geocodiert sein oder nicht.

Gibt zurück

Body: CustomerAPI.Models.ReturnIdApiModel

Gps-Datenwebhaken kündigen

Vorgangs-ID:: TrackingController_RemoveGpsDataFeedSubscription

Löscht ein GPS-Datenwebhaken-Abonnement anhand seiner ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
subscriptionId	subscriptionId	True	string	Zu löschende Abonnement-ID.

Löschen einer benutzerdefinierten Ereignisdefinition

Vorgangs-ID:: EventController_Delete

Löscht eine benutzerdefinierte Ereignisdefinition.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Ereignisdefinitions-ID.

Löschen eines Clients

Vorgangs-ID:: ClientController_Delete

Löscht einen vorhandenen Client anhand seiner ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Client-ID.
use-external-id	use-external-id		boolean	Verwenden Sie externe ID oder nicht.

Löschen eines Fahrzeugs

Vorgangs-ID:: VehicleController_Delete

Löschen Sie ein Fahrzeug nach ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Die externe oder interne ID hängt vom Wert im Parameter "use-external-id" ab.
use-external-id	use-external-id		boolean	Verwenden Sie externe ID oder nicht.

Löschen eines Geofence-Raums

Vorgangs-ID:: GeofenceController_DeleteGeofence

Löscht einen vorhandenen Geofence durch seine ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	integer	Geofence-ID.

Nebenversion abrufen

Vorgangs-ID:: VersionController_Get

Gibt die aktuelle Nebenversion der API zurück.

Setzt den Abonnementstatus zurück.

Vorgangs-ID:: TrackingController_ResetSubscriptionHealthStatus

Ändert den Abonnementstatus in den Status = 1 ("Läuft").

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
subscriptionId	subscriptionId	True	integer	Abonnement-ID.

Submit-Ereignis

Vorgangs-ID:: EventController_Post

Submits-Ereignis.

Parameter

Name	Schlüssel	Typ	Beschreibung
EventDefinitionId	EventDefinitionId	string	Ereignisdefinitions-ID.
Mitarbeiternummer	EmployeeNumber	string	Mitarbeiternummer.
VehicleNumber	VehicleNumber	string	Fahrzeugnummer.
DeviceSerialNumber	DeviceSerialNumber	string	GpsDeviceDto Seriennummer.
Breitengrad	Latitude	double
Längengrad	Longitude	double
AddressLine1	AddressLine1	string	AddressLine1 dieses LocationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 dieses LocationApiModel.
Stadt	City	string	Ort des LocationApiModel.
RegionName	RegionName	string	Regionsname des LocationApiModel.
Postleitzahl	PostalCode	string	Postleitzahl des LocationApiModel.
Ländercode	CountryCode	string	ISO 3166-1 Alpha-2-Code.
SubRegionName	SubRegionName	string	Unterregion des LocationApiModel.
SubRegionCode	SubRegionCode	string	SubRegion-Code des LocationApiModel.
RegionCode	RegionCode	string	Regionscode des LocationApiModel.
Uhrzeit	Time	date-time
Die Parameter	Parameters	object	Ereignisparameter.

Teilaktualisierung eines Fahrzeugs

Vorgangs-ID:: VehicleController_PartialUpdateVehicle

Teilaktualisierung eines Fahrzeugs nach ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
id	id	True	string	Die externe oder interne ID hängt vom Wert im Parameter "use-external-id" ab.
			object
use-external-id	use-external-id		boolean	Verwenden Sie externe ID oder nicht.

Gibt zurück

Body: CustomerAPI.Models.ReturnIdApiModel

Web-Hook-Rückruf mit Ereignisfeed

Vorgangs-ID:: EventController_subscribe_callback

Diese Beispielmethode wird von Ereignissen/Abonnieren von Postback-Ereignisdatenfeed mithilfe der vom Kunden bereitgestellten URL verwendet.

Parameter

Name	Schlüssel	Typ	Beschreibung
Id	Id	string	Url mit der Adresse des WebHookSubscriptionParamsApiModel.
Eventtyp	EventType	integer
EventCode	EventCode	string
EventTime	EventTime	date-time	ISO-Format mit lokalem und Offset.
DeviceId	DeviceId	string	GpsDeviceDto-ID, die dem Abonnement zugeordnet ist.
Typ des Geräts	DeviceType	integer	GpsDeviceDto Typ: Handset (0), CalAmp (1), Geotab (2), Xirgo (3).
UserId	UserId	integer	Benutzer-ID.
VehicleId	VehicleId	integer	Fahrzeug-ID.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Ob ein Benutzer mit dem Fahrzeug verknüpft ist.
Lat	Lat	double	Breite.
Lon	Lon	double	Länge.
CustomEventDefinitionId	CustomEventDefinitionId	string
EventParams	EventParams	object	Ereignisparameter.

Gibt zurück

response: object

Webhook-Rückruf mit GPS-Datenfeed

Vorgangs-ID:: TrackingController_subscribe_callback

Diese Beispielmethode wird von gpsdata/subscribe verwendet, um den Datenfeed mithilfe der vom Kunden bereitgestellten URL zu posten.

Parameter

Name	Schlüssel	Typ	Beschreibung
Id	Id	string	Url mit der Adresse des WebHookSubscriptionParamsApiModel.
DeviceId	DeviceId	string	GpsDeviceDto-ID, die dem Abonnement zugeordnet ist.
Typ des Geräts	DeviceType	integer	GpsDeviceDto Typ: Handset(0), CalAmp(1), Geotab (2), Xirgo (3).
Zeitstempel	Timestamp	date-time	ISO-Format mit lokalem und Offset.
CompanyId	CompanyId	integer	Firmen-ID.
UserId	UserId	integer	Benutzer-ID.
VehicleId	VehicleId	integer	Fahrzeug-ID.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Ob ein Benutzer mit dem Fahrzeug verknüpft ist.
LocationProvider	LocationProvider	string	Name des Standortanbieters.
Lat	Lat	double	Breite.
Lon	Lon	double	Länge.
Genauigkeitsdiebstahl	AccuracyFt	double	Positionsgenauigkeit (Füße).
Höhenmeter	AltitudeFt	double	Höhe (Füße).
Heading	Heading	integer	Kompassrichtung in Grad.
SpeedMph	SpeedMph	double	Geschwindigkeit der Bewegung (Mph).
BatteryStatus	BatteryStatus	integer	Akkustatus: Nicht aufladen(0), Ladevorgang(1).
BatteryLevel	BatteryLevel	integer	Akkustand in Prozent.
ActivityState	ActivityState	integer	Aktivitätszustand: Staying(1), Modving(2).
IsNetworkConnected	IsNetworkConnected	boolean	Ist das Gerät zurzeit mit dem Netzwerk verbunden.
Rssi	Rssi	integer	Signalstärkeindikator für empfangene Signale.
DOdoMl	DOdoMl	double	GpsDeviceDto Odometer (Miles).
VOdoMl	VOdoMl	double	Fahrzeug-Odometer (Meilen).

Gibt zurück

response: object

Zurücksetzen des Ereignisweb hook-Abonnementstatus

Vorgangs-ID:: EventController_ResetSubscriptionHealthStatus

Ändert den Abonnementstatus in den Status = 1 ("Läuft").

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
subscriptionId	subscriptionId	True	integer	Abonnement-ID.

Auslöser

Abruf der Bestellstatus	Der Api-Abrufendpunkt "Order Statuses" ermöglicht Es Ihrer Anwendung, die letzten Änderungen an Aufträgen kontinuierlich abzufragen und zu verarbeiten. Integration: Dieser Endpunkt ist so konzipiert, dass microsoft Flow als Abruftriggerintegration sofort einsatzbereit ist. Alternativ können Sie ihre eigene benutzerdefinierte Integration mit einer beliebigen Sprache entwickeln. Verwendung: In einem typischen Szenario sollte die erste Anforderung an diesen Endpunkt keine Parameter bereitstellen. Es gibt zwei (2) mögliche erfolgreiche Antworten: HTTP-Antwortcode 200 – Zuletzt geänderte Bestellstatusdatensätze sind vorhanden; Der Antworttext zeigt Bestellstatusdaten an. HTTP-Antwortcode 202 – Es sind keine kürzlich übermittelten Datensätze vorhanden; Der Antworttext ist leer. In beiden Fällen gibt es zwei (2) wichtige Header in der Antwort: Speicherort : Die URL für die nächste Anforderung. Retry-After – Das empfohlene Zeitintervall in Sekunden für die nächste Anforderung. Wenn beispielsweise Daten abgerufen werden sollen, hat der Retry-After Header den Wert 1 oder 60. Wenn keine Daten abgerufen werden sollen, lautet der Wert des Retry-After Headers 300. Hinweis: Dies sind nur empfohlene Werte – Ihre Anwendung kann je nach Ihren Anforderungen eine andere Häufigkeit abfragen. Nach der ersten Anforderung sollten alle nachfolgenden Anforderungen die im Location-Header der letzten Antwort angegebene URL verwenden. Fügen Sie der URL keine weiteren Parameter hinzu, da sie bereits die erforderlichen Parameter enthält, um sicherzustellen, dass die Bestellstatus der Anforderung nicht fehlen. Die Ergebnisse werden nach ModifiedUtc und dann nach StatusId in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar. ModifiedUtc-Definition: internes Zeittag = Uhrzeit der änderung der aktuellen Auftragsstatusdaten.
Formulardatenabfragung	Der Endpunkt für die Formular-API-Abfrage ermöglicht Es Ihrer Anwendung, zuletzt übermittelte eigenständige Formulare kontinuierlich abzufragen und zu verarbeiten. Integration: Dieser Endpunkt ist so konzipiert, dass microsoft Flow als Abruftriggerintegration sofort einsatzbereit ist. Alternativ können Sie ihre eigene benutzerdefinierte Integration mit einer beliebigen Sprache entwickeln. Verwendung: In einem typischen Szenario sollte die erste Anforderung an diesen Endpunkt keine Parameter bereitstellen. Es gibt zwei (2) mögliche erfolgreiche Antworten: HTTP-Antwortcode 200 – Zuletzt übermittelte Formulardatensätze sind vorhanden; Der Antworttext zeigt Formulardaten an. HTTP-Antwortcode 202 – Es sind keine kürzlich übermittelten Datensätze vorhanden; Der Antworttext ist leer. In beiden Fällen gibt es zwei (2) wichtige Header in der Antwort: Speicherort : Die URL für die nächste Anforderung. Retry-After – Das empfohlene Zeitintervall in Sekunden für die nächste Anforderung. Wenn beispielsweise Daten abgerufen werden sollen, hat der Retry-After Header den Wert 1 oder 60. Wenn keine Daten abgerufen werden sollen, lautet der Wert des Retry-After Headers 300. Hinweis: Dies sind nur empfohlene Werte – Ihre Anwendung kann je nach Ihren Anforderungen eine andere Häufigkeit abfragen. Nach der ersten Anforderung sollten alle nachfolgenden Anforderungen die im Location-Header der letzten Antwort angegebene URL verwenden. Fügen Sie der URL keine weiteren Parameter hinzu, da sie bereits die erforderlichen Parameter enthält, um sicherzustellen, dass Formulare in der Anforderung nicht fehlen. Die Ergebnisse werden automatisch nach ModifiedUtc und dann nach FormHeaderId in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar. ModifiedUtc-Definition: internes Zeittag = Uhrzeit der änderung der neuesten Formulardaten.
Umfrage "Bestellungen"	Der Endpunkt "Orders-API-Abruf" ermöglicht Es Ihrer Anwendung, aktuelle Änderungen an Bestellungen kontinuierlich abzufragen und zu verarbeiten. Integration: Dieser Endpunkt ist so konzipiert, dass microsoft Flow als Abruftriggerintegration sofort einsatzbereit ist. Alternativ können Sie ihre eigene benutzerdefinierte Integration mit einer beliebigen Sprache entwickeln. Verwendung: In einem typischen Szenario sollte die erste Anforderung an diesen Endpunkt keine Parameter bereitstellen. Es gibt zwei (2) mögliche erfolgreiche Antworten: HTTP-Antwortcode 200 – Zuletzt geänderte Bestellungen sind vorhanden; Der Antworttext zeigt Bestelldaten an. HTTP-Antwortcode 202 – Es sind keine kürzlich geänderten Bestellungen vorhanden; Der Antworttext ist leer. In beiden Fällen gibt es zwei (2) wichtige Header in der Antwort: Speicherort : Die URL für die nächste Anforderung. Retry-After – Das empfohlene Zeitintervall in Sekunden für die nächste Anforderung. Wenn beispielsweise Daten abgerufen werden sollen, hat der Retry-After Header den Wert 1 oder 60. Wenn keine Daten abgerufen werden sollen, lautet der Wert des Retry-After Headers 300. Hinweis: Dies sind nur empfohlene Werte – Ihre Anwendung kann je nach Ihren Anforderungen eine andere Häufigkeit abfragen. Nach der ersten Anforderung sollten alle nachfolgenden Anforderungen die im Location-Header der letzten Antwort angegebene URL verwenden. Fügen Sie der URL keine weiteren Parameter hinzu, da sie bereits die erforderlichen Parameter enthält, um sicherzustellen, dass Bestelländerungen in der Anforderung nicht fehlen. Die Ergebnisse werden automatisch nach ModifiedUtc und dann nach OrderId in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar. ModifiedUtc-Definition: internes Zeittag = Uhrzeit der letzten Änderung der Bestelldaten.
Zeiterfassungsumfrage	Der Abrufendpunkt der Timekeeping-API ermöglicht Es Ihrer Anwendung, kürzlich übermittelte Zeiterfassungseinträge kontinuierlich abzufragen und zu verarbeiten. Integration: Dieser Endpunkt ist so konzipiert, dass microsoft Flow als Abruftriggerintegration sofort einsatzbereit ist. Alternativ können Sie ihre eigene benutzerdefinierte Integration mit einer beliebigen Sprache entwickeln. Verwendung: In einem typischen Szenario sollte die erste Anforderung an diesen Endpunkt keine Parameter bereitstellen. Es gibt zwei (2) mögliche erfolgreiche Antworten: HTTP-Antwortcode 200 – Kürzlich übermittelte Zeiterfassungsdatensätze sind vorhanden; Der Antworttext zeigt Zeiterfassungsdaten an. HTTP-Antwortcode 202 – Es sind keine kürzlich übermittelten Datensätze vorhanden; Der Antworttext ist leer. In beiden Fällen gibt es zwei (2) wichtige Header in der Antwort: Speicherort : Die URL für die nächste Anforderung. Retry-After – Das empfohlene Zeitintervall in Sekunden für die nächste Anforderung. Wenn beispielsweise Daten abgerufen werden sollen, hat der Retry-After Header den Wert 1 oder 60. Wenn keine Daten abgerufen werden sollen, lautet der Wert des Retry-After Headers 300. Hinweis: Dies sind nur empfohlene Werte – Ihre Anwendung kann je nach Ihren Anforderungen eine andere Häufigkeit abfragen. Nach der ersten Anforderung sollten alle nachfolgenden Anforderungen die im Location-Header der letzten Antwort angegebene URL verwenden. Fügen Sie der URL keine weiteren Parameter hinzu, da sie bereits diejenigen enthält, die erforderlich sind, um sicherzustellen, dass Zeiterfassungseinträge in der Anforderung nicht fehlen. Die Ergebnisse werden automatisch nach ModifiedUtc und dann nach TimekeepingStatusId und dann in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar. ModifiedUtc-Definition: internes Zeittag = Uhrzeit der änderung des aktuellen Zeiterfassungsstatus.

Abruf der Bestellstatus

Vorgangs-ID:: OrderController_StatusPoll

Der Api-Abrufendpunkt "Order Statuses" ermöglicht Es Ihrer Anwendung, die letzten Änderungen an Aufträgen kontinuierlich abzufragen und zu verarbeiten.

Integration:

Dieser Endpunkt ist so konzipiert, dass microsoft Flow als Abruftriggerintegration sofort einsatzbereit ist. Alternativ können Sie ihre eigene benutzerdefinierte Integration mit einer beliebigen Sprache entwickeln.

Verwendung:

In einem typischen Szenario sollte die erste Anforderung an diesen Endpunkt keine Parameter bereitstellen. Es gibt zwei (2) mögliche erfolgreiche Antworten:

HTTP-Antwortcode 200 – Zuletzt geänderte Bestellstatusdatensätze sind vorhanden; Der Antworttext zeigt Bestellstatusdaten an.
HTTP-Antwortcode 202 – Es sind keine kürzlich übermittelten Datensätze vorhanden; Der Antworttext ist leer.

In beiden Fällen gibt es zwei (2) wichtige Header in der Antwort:

Speicherort : Die URL für die nächste Anforderung.
Retry-After – Das empfohlene Zeitintervall in Sekunden für die nächste Anforderung. Wenn beispielsweise Daten abgerufen werden sollen, hat der Retry-After Header den Wert 1 oder 60. Wenn keine Daten abgerufen werden sollen, lautet der Wert des Retry-After Headers 300.

Hinweis: Dies sind nur empfohlene Werte – Ihre Anwendung kann je nach Ihren Anforderungen eine andere Häufigkeit abfragen. Nach der ersten Anforderung sollten alle nachfolgenden Anforderungen die im Location-Header der letzten Antwort angegebene URL verwenden. Fügen Sie der URL keine weiteren Parameter hinzu, da sie bereits die erforderlichen Parameter enthält, um sicherzustellen, dass die Bestellstatus der Anforderung nicht fehlen.

Die Ergebnisse werden nach ModifiedUtc und dann nach StatusId in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.

ModifiedUtc-Definition: internes Zeittag = Uhrzeit der änderung der aktuellen Auftragsstatusdaten.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
excludeFormData	excludeFormData		boolean	Wenn "true", ist FieldValues immer ein leeres Array.

Gibt zurück

Body: CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Formulardatenabfragung

Vorgangs-ID:: FormController_Poll

Der Endpunkt für die Formular-API-Abfrage ermöglicht Es Ihrer Anwendung, zuletzt übermittelte eigenständige Formulare kontinuierlich abzufragen und zu verarbeiten.

Integration:

Verwendung:

In einem typischen Szenario sollte die erste Anforderung an diesen Endpunkt keine Parameter bereitstellen. Es gibt zwei (2) mögliche erfolgreiche Antworten:

HTTP-Antwortcode 200 – Zuletzt übermittelte Formulardatensätze sind vorhanden; Der Antworttext zeigt Formulardaten an.
HTTP-Antwortcode 202 – Es sind keine kürzlich übermittelten Datensätze vorhanden; Der Antworttext ist leer.

In beiden Fällen gibt es zwei (2) wichtige Header in der Antwort:

Speicherort : Die URL für die nächste Anforderung.
Retry-After – Das empfohlene Zeitintervall in Sekunden für die nächste Anforderung. Wenn beispielsweise Daten abgerufen werden sollen, hat der Retry-After Header den Wert 1 oder 60. Wenn keine Daten abgerufen werden sollen, lautet der Wert des Retry-After Headers 300.

Die Ergebnisse werden automatisch nach ModifiedUtc und dann nach FormHeaderId in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.

ModifiedUtc-Definition: internes Zeittag = Uhrzeit der änderung der neuesten Formulardaten.

Gibt zurück

Body: CustomerAPI.Models.Forms.StandaloneFormApiModel

Umfrage "Bestellungen"

Vorgangs-ID:: OrderController_Poll

Der Endpunkt "Orders-API-Abruf" ermöglicht Es Ihrer Anwendung, aktuelle Änderungen an Bestellungen kontinuierlich abzufragen und zu verarbeiten.

Integration:

Verwendung:

In einem typischen Szenario sollte die erste Anforderung an diesen Endpunkt keine Parameter bereitstellen. Es gibt zwei (2) mögliche erfolgreiche Antworten:

HTTP-Antwortcode 200 – Zuletzt geänderte Bestellungen sind vorhanden; Der Antworttext zeigt Bestelldaten an.
HTTP-Antwortcode 202 – Es sind keine kürzlich geänderten Bestellungen vorhanden; Der Antworttext ist leer.

In beiden Fällen gibt es zwei (2) wichtige Header in der Antwort:

Speicherort : Die URL für die nächste Anforderung.
Retry-After – Das empfohlene Zeitintervall in Sekunden für die nächste Anforderung. Wenn beispielsweise Daten abgerufen werden sollen, hat der Retry-After Header den Wert 1 oder 60. Wenn keine Daten abgerufen werden sollen, lautet der Wert des Retry-After Headers 300.

Die Ergebnisse werden automatisch nach ModifiedUtc und dann nach OrderId in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.

ModifiedUtc-Definition: internes Zeittag = Uhrzeit der letzten Änderung der Bestelldaten.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
excludeFormData	excludeFormData		boolean	Bei "true" ist "OrderFormFields" immer ein leeres Array.
excludeCustomFieldData	excludeCustomFieldData		boolean	Wenn wahr, wird CustomFields nicht zurückgegeben.

Gibt zurück

Body: CustomerAPI.Models.Order.OrderHeaderApiModel

Zeiterfassungsumfrage

Vorgangs-ID:: TimekeepingController_Poll

Der Abrufendpunkt der Timekeeping-API ermöglicht Es Ihrer Anwendung, kürzlich übermittelte Zeiterfassungseinträge kontinuierlich abzufragen und zu verarbeiten.

Integration:

Verwendung:

In einem typischen Szenario sollte die erste Anforderung an diesen Endpunkt keine Parameter bereitstellen. Es gibt zwei (2) mögliche erfolgreiche Antworten:

HTTP-Antwortcode 200 – Kürzlich übermittelte Zeiterfassungsdatensätze sind vorhanden; Der Antworttext zeigt Zeiterfassungsdaten an.
HTTP-Antwortcode 202 – Es sind keine kürzlich übermittelten Datensätze vorhanden; Der Antworttext ist leer.

In beiden Fällen gibt es zwei (2) wichtige Header in der Antwort:

Speicherort : Die URL für die nächste Anforderung.
Retry-After – Das empfohlene Zeitintervall in Sekunden für die nächste Anforderung. Wenn beispielsweise Daten abgerufen werden sollen, hat der Retry-After Header den Wert 1 oder 60. Wenn keine Daten abgerufen werden sollen, lautet der Wert des Retry-After Headers 300.

Hinweis: Dies sind nur empfohlene Werte – Ihre Anwendung kann je nach Ihren Anforderungen eine andere Häufigkeit abfragen. Nach der ersten Anforderung sollten alle nachfolgenden Anforderungen die im Location-Header der letzten Antwort angegebene URL verwenden. Fügen Sie der URL keine weiteren Parameter hinzu, da sie bereits diejenigen enthält, die erforderlich sind, um sicherzustellen, dass Zeiterfassungseinträge in der Anforderung nicht fehlen.

Die Ergebnisse werden automatisch nach ModifiedUtc und dann nach TimekeepingStatusId und dann in aufsteigender Reihenfolge sortiert. Sortierparameter sind nicht konfigurierbar.

ModifiedUtc-Definition: internes Zeittag = Uhrzeit der änderung des aktuellen Zeiterfassungsstatus.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
excludeFormData	excludeFormData		boolean	Ist "true", ist "ClockInFormData" und "ClockOutFormData" immer null.

Gibt zurück

Body: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Definitionen

CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Name	Pfad	Typ	Beschreibung
Id	Id	string

CustomerAPI.Models.Client.ReadClientApiModel

Name	Pfad	Typ	Beschreibung
Id	Id	integer	ID des Clients.
ExternalId	ExternalId	string	Externe Verwendungs-ID für den Client – API-Erweiterungseigenschaft.
CreatedUtc	CreatedUtc	date-time	Der ursprüngliche Zeitpunkt, zu dem der Client erstellt wurde.
ModifiedUtc	ModifiedUtc	date-time	Der letzte Zeitpunkt, zu dem der Client aktualisiert wurde.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Name	Name	string	Name des Clients.
Adresse	Address	CustomerAPI.Models.LocationApiModel
Kontakt	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

Name	Pfad	Typ	Beschreibung
FieldIndex	FieldIndex	integer	Feldindex.
Überschrift	Caption	string	Feldbeschriftung.
Datentyp	DataType	integer	Felddatentyp.
DateTimeFormat	DateTimeFormat	integer	DateTime-Format.
Wert	Value		Feldwert.

CustomerAPI.Models.LocationApiModel

Name	Pfad	Typ	Beschreibung
LatLon	LatLon	System.Nullable_1_Actsoft.Core.Geo.LatLon_
AddressLine1	AddressLine1	string	AddressLine1 dieses LocationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 dieses LocationApiModel.
Stadt	City	string	Ort des LocationApiModel.
RegionName	RegionName	string	Regionsname des LocationApiModel.
Postleitzahl	PostalCode	string	Postleitzahl des LocationApiModel.
Ländercode	CountryCode	string	ISO 3166-1 Alpha-2-Code.
SubRegionName	SubRegionName	string	Unterregion des LocationApiModel.
SubRegionCode	SubRegionCode	string	SubRegion-Code des LocationApiModel.
RegionCode	RegionCode	string	Regionscode des LocationApiModel.

CustomerAPI.Models.Client.ContactApiModel

Name	Pfad	Typ	Beschreibung
Name	Name	string	Name des ContactApiModel.
Telefonnummer	PhoneNumber	string	PhoneNumber des ContactApiModel.
Email	Email	string	E-Mail des ContactApiModel.

System.Nullable_1_Actsoft.Core.Geo.LatLon_

Name	Pfad	Typ	Beschreibung
Breitengrad	Latitude	double
Längengrad	Longitude	double

CustomerAPI.Models.ReturnIdApiModel

Name	Pfad	Typ	Beschreibung
Id	Id	integer	Objekt-ID.

CustomerAPI.Models.CustomLists.CustomListListItemApiModel

Definiert das API-Modell für benutzerdefinierte Listendefinitionslistenelemente.

Name	Pfad	Typ	Beschreibung
CustomListId	CustomListId	integer	Benutzerdefinierte Listen-ID.
Name	Name	string	Benutzerdefinierter Listenname.
Version	Version	string	Benutzerdefinierte Listenversion.

CustomerAPI.Models.CustomLists.CustomListApiModel

Benutzerdefiniertes Listenmodell.

Name	Pfad	Typ	Beschreibung
CustomListId	CustomListId	integer	Benutzerdefinierte Listen-ID.
Name	Name	string	Benutzerdefinierter Listenname.
Version	Version	string	Benutzerdefinierte Listenversion.
Definition	Definition	CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel	Definiert das API-Modell der benutzerdefinierten Listendefinition.

CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

Definiert das API-Modell der benutzerdefinierten Listendefinition.

Name	Pfad	Typ	Beschreibung
Columns	Columns	array of CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel	Benutzerdefinierte Listenspalten.
UniqueColumnIndex	UniqueColumnIndexIndex	integer	Eindeutiger Spaltenindex.

CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

Definiert das API-Modell für benutzerdefinierte Listendefinitionsspalten.

Name	Pfad	Typ	Beschreibung
Index	Index	integer	Spaltenindex.
Datentyp	DataType	integer	Spaltendatentyp (Text: 0, Numerisch: 1, Datum: 2, Uhrzeit: 3, DateTime: 4, E-Mail: 5).
Name	Name	string	Spaltenname.

CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Container für benutzerdefinierte Listenspaltendatenarray.

Name	Pfad	Typ	Beschreibung
ColumnValues	ColumnValues	array of CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel	Array von Spalten mit Daten.

CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

Dieses Modell definiert einen benutzerdefinierten Listenspaltenwert.

Name	Pfad	Typ	Beschreibung
ColumnIndex	ColumnIndex	integer	Benutzerdefinierter Listenspaltenindex.
Überschrift	Caption	string	Benutzerdefinierte Listenspaltenbeschriftung.
Wert	Value		Benutzerdefinierter Listenspaltenwert.

CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Benutzerdefiniertes Ereignisdefinitionsmodell.

Name	Pfad	Typ
Id	Id	string
Name	Name	string
ReverseGeocode	ReverseGeocode	boolean
Die Parameter	Parameters	array of CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

Name	Pfad	Typ
Name	Name	string
Typ	Type	integer
Überschrift	Caption	string
Erforderlich	Required	boolean

CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Name	Pfad	Typ	Beschreibung
EventId	EventId	integer	Ereignis-ID.
Eventtyp	EventType	integer
EventCode	EventCode	string	Ereigniscode.
EventTime	EventTime	date-time	ISO-Format mit lokalem und Offset.
Benutzer	User	CustomerAPI.Models.UserReferenceApiModel
Fahrzeug	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Wenn dies aktiviert ist, hat das Fahrzeug des Ereignisses dem Benutzer zugewiesen.
Standort	Location	CustomerAPI.Models.LocationApiModel
PrimaryGeofence	PrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
CustomEventDefinitionId	CustomEventDefinitionId	string	Id der externen Ereignisdefinition.
EventParams	EventParams	object	Ereignisparameter.

CustomerAPI.Models.UserReferenceApiModel

Name	Pfad	Typ	Beschreibung
UserId	UserId	integer	UserId des Benutzers.
Vorname	FirstName	string	Vorname des Benutzers.
Nachname	LastName	string	Nachname des Benutzers.
Mitarbeiternummer	EmployeeNumber	string	Mitarbeiternummer des Benutzers.
GroupName	GroupName	string	Der Name der Gruppe, die dem Benutzer zugewiesen ist.

CustomerAPI.Models.ReadVehicleApiModel

Name	Pfad	Typ	Beschreibung
VehicleId	VehicleId	integer	ID des BaseVehicleApiModel.
Name	Name	string	Name des BaseVehicleApiModel.
VIN	VIN	string	Fahrzeugidentifikationsnummer des BaseVehicleApiModel.
Gerätename	DeviceName	string	Name von GpsDeviceDto, das dem BaseVehicleApiModel zugeordnet ist.
Seriennummer	SerialNumber	string	SerialNumber des BaseVehicleApiModel.
GroupName	GroupName	string	GroupName des BaseVehicleApiModel.

CustomerAPI.Models.Geofence.GeofenceInfoApiModel

Name	Pfad	Typ	Beschreibung
GeofenceId	GeofenceId	integer	ID des Geofence-Bereichs.
Name	Name	string	Name des Geofence-Bereichs.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Name	Pfad	Typ	Beschreibung
Abonnement-ID	SubscriptionId	string	ID des WebHookSubscriptionResultApiModel.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Name	Pfad	Typ	Beschreibung
Abonnement-ID	SubscriptionId	string
URL	Url	string
Der Status	Status	integer	Abonnementstatus - (Läuft: 1, beendet: 2).

CustomerAPI.Models.Forms.StandaloneFormApiModel

Name	Pfad	Typ	Beschreibung
Id	Id	integer	Id, die diesem StandaloneFormApiModel - (Legacykommentar: FormHeaderId) zugeordnet ist.
FormId	FormId	integer	Id des Formulars, auf das von diesem StandaloneFormApiModel verwiesen wird.
FormName	FormName	string	Name des Formulars, auf das von diesem StandaloneFormApiModel verwiesen wird.
EntryNumber	EntryNumber	string	Formulardateneingabenummer.
Geprüft	Reviewed	boolean	Status der Überprüfung dieses StandaloneFormApiModel.
Benutzer	User	CustomerAPI.Models.UserReferenceApiModel
Übermittelte Zeit	SubmittedTime	date-time	Zeitpunkt, zu dem das StandaloneFormApiModel übermittelt wurde.
StartTime	StartTime	date-time	Zeitpunkt, zu dem das StandaloneFormApiModel gestartet wurde.
SubmittedLocation	SubmittedLocation	CustomerAPI.Models.LocationApiModel
FormData	FormData	array of CustomerAPI.Models.Forms.FormFieldDataApiModel	Liste der Felder, die diesem StandaloneFormApiModel zugeordnet sind.
ApiModuleId	ApiModuleId	string	Id des apiModule,das diesem StandaloneFormApiModel zugeordnet ist.
SharedUrl	SharedUrl	string	Freigegebene URL dieses StandaloneFormApiModel.
ReviewByUser	ReviewedByUser	CustomerAPI.Models.UserReferenceApiModel
ReviewByTime	ReviewedByTime	date-time	Zeitpunkt der Formularüberprüfung

CustomerAPI.Models.Forms.FormFieldDataApiModel

Name	Pfad	Typ	Beschreibung
Wiederholbare	Repeatables	array of array
items	Repeatables	array of CustomerAPI.Models.Forms.FormFieldDataBaseApiModel
Id	Id	string	ID des FormFieldDataApiModel.
Wert	Value		Wert des FormFieldDataApiModel.
DisplayValue	DisplayValue		DisplayValue des FormFieldDataApiModel.
CapturedTime	CapturedTime	date-time	Der Zeitwert wurde vom FormFieldDataApiModel erfasst.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Überschrift	Caption	string	Beschriftungsinhalt des FormFieldDataApiModel.
ApiFieldId	ApiFieldId	string	ID des ApiField des FormFieldDataApiModel.

CustomerAPI.Models.Forms.FormFieldDataBaseApiModel

Name	Pfad	Typ	Beschreibung
Id	Id	string	ID des FormFieldDataApiModel.
Wert	Value		Wert des FormFieldDataApiModel.
DisplayValue	DisplayValue		DisplayValue des FormFieldDataApiModel.
CapturedTime	CapturedTime	date-time	Der Zeitwert wurde vom FormFieldDataApiModel erfasst.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Überschrift	Caption	string	Beschriftungsinhalt des FormFieldDataApiModel.
ApiFieldId	ApiFieldId	string	ID des ApiField des FormFieldDataApiModel.

CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Name	Pfad	Typ	Beschreibung
GeofenceId	GeofenceId	integer	GeofenceId des GeofenceApiModel.
CreatedUtc	CreatedUtc	date-time	CreatedUtc des GeofenceApiModel.
ModifiedUtc	ModifiedUtc	date-time	ModifiedUtc des GeofenceApiModel.
GroupNames	GroupNames	array of string	GroupPaths of the GeofenceApiModel.
Name	Name	string	Name der GeofenceApiModelBase.
Typ	Type	string	Typ des GeofenceApiModel.
Shape	Shape	integer	Form: 0 für Kreis und 1 für Polygon.
Adresse	Address	CustomerAPI.Models.LocationApiModel
Radius	Radius	double	Radius des GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress des GeofenceApiModel.

Actsoft.Core.Geo.LatLon

Name	Pfad	Typ	Beschreibung
Breitengrad	Latitude	double
Längengrad	Longitude	double

CustomerAPI.Models.Geofence.GeofenceApiModel

Name	Pfad	Typ	Beschreibung
GeofenceId	GeofenceId	integer	GeofenceId des GeofenceApiModel.
CreatedUtc	CreatedUtc	date-time	CreatedUtc des GeofenceApiModel.
ModifiedUtc	ModifiedUtc	date-time	ModifiedUtc des GeofenceApiModel.
GroupNames	GroupNames	array of string	GroupPaths of the GeofenceApiModel.
Polygon	Polygon	array of Actsoft.Core.Geo.LatLon	Polygonpunkte. Sollte gefüllt werden, wenn Form gleich 1 ist.
Name	Name	string	Name der GeofenceApiModelBase.
Typ	Type	string	Typ des GeofenceApiModel.
Shape	Shape	integer	Form: 0 für Kreis und 1 für Polygon.
Adresse	Address	CustomerAPI.Models.LocationApiModel
Radius	Radius	double	Radius des GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress des GeofenceApiModel.

CustomerAPI.Models.Order.OrderListItemApiModel

Name	Pfad	Typ	Beschreibung
Bestell-ID	OrderId	integer	ID des OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	Externe Use OrderId für den Client – API-Erweiterungseigenschaft.
Fälligkeitsdatum	DueDate	date-time	Zeitpunkt, zu dem dieses OrderBaseApiModel abgeschlossen ist (in Version 1.3 veraltet).
StartTime	StartTime	date-time	Punkt in der Zeit sollte dieses OrderBaseApiModel gestartet werden (in Version 1.3 eingeführt).
EndTime	EndTime	date-time	Zeitpunkt, zu dem dieses OrderBaseApiModel abgeschlossen ist (in Version 1.3 eingeführt).
ServiceType	ServiceType	string	ServiceType, der diesem OrderBaseApiModel zugeordnet ist.
CreatedUTCDate	CreatedUTCDate	date-time	Zeitpunkt der Erstellung dieses OrderBaseApiModels.
Bestellnummer	OrderNumber	string	Bestellnummer, die diesem OrderBaseApiModel zugeordnet ist.
IsClosed	IsClosed	boolean	Status, der anzeigt, ob das OrderBaseApiModel geschlossen ist.
Der Status	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	Externe Verwendungs-ID für den Client – API-Erweiterungseigenschaft.
ClientId	ClientId	integer	interne Verwendungs-ID für den Client – API-Erweiterungseigenschaft.
Kunde	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	Die ID des apiService, der diesem OrderBaseApiModel zugeordnet ist.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Version des Moduls für benutzerdefinierte Felder.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusApiModel

Name	Pfad	Typ	Beschreibung
StatusIndex	StatusIndex	integer	Index des OrderStatusApiModel.
StatusType	StatusType	integer	Auftragsstatus: 0 für neue Bestellung, 1 für versandfertig, 2 für in Bearbeitung, 3 für abgeschlossen und 4 für die Kündigung.
StatusLabel	StatusLabel	string	Bezeichnungsinhalt des OrderStatusApiModel.
StatusId	StatusId	integer	ID des OrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	date-time	Point in time of Start of the OrderStatusApiModel.
Benutzer	User	CustomerAPI.Models.UserReferenceApiModel

CustomerAPI.Models.Order.OrderClientReadApiModel

Name	Pfad	Typ	Beschreibung
GroupNames	GroupNames	array of string	Hierarchische Namen der Clientgruppe.
Name	Name	string	Name des Clients.
Adresse	Address	CustomerAPI.Models.LocationApiModel
Kontakt	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Order.OrderApiModel

Name	Pfad	Typ	Beschreibung
StatusHistory	StatusHistory	array of CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel	Liste der OrderStatusListItems, die diesem OrderApiModel zugeordnet sind.
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
Bestell-ID	OrderId	integer	ID des OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	Externe Use OrderId für den Client – API-Erweiterungseigenschaft.
Fälligkeitsdatum	DueDate	date-time	Zeitpunkt, zu dem dieses OrderBaseApiModel abgeschlossen ist (in Version 1.3 veraltet).
StartTime	StartTime	date-time	Punkt in der Zeit sollte dieses OrderBaseApiModel gestartet werden (in Version 1.3 eingeführt).
EndTime	EndTime	date-time	Zeitpunkt, zu dem dieses OrderBaseApiModel abgeschlossen ist (in Version 1.3 eingeführt).
ServiceType	ServiceType	string	ServiceType, der diesem OrderBaseApiModel zugeordnet ist.
CreatedUTCDate	CreatedUTCDate	date-time	Zeitpunkt der Erstellung dieses OrderBaseApiModels.
Bestellnummer	OrderNumber	string	Bestellnummer, die diesem OrderBaseApiModel zugeordnet ist.
IsClosed	IsClosed	boolean	Status, der anzeigt, ob das OrderBaseApiModel geschlossen ist.
Der Status	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	Externe Verwendungs-ID für den Client – API-Erweiterungseigenschaft.
ClientId	ClientId	integer	interne Verwendungs-ID für den Client – API-Erweiterungseigenschaft.
Kunde	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	Die ID des apiService, der diesem OrderBaseApiModel zugeordnet ist.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Version des Moduls für benutzerdefinierte Felder.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Name	Pfad	Typ	Beschreibung
StatusStartDateTime	StatusStartDateTime	date-time	Zeitpunkt, zu dem dieser OrderStatusHistoryListItemApiModel Status gestartet wurde.
StatusEndDateTime	StatusEndDateTime	date-time	Zeitpunkt, zu dem dieser OrderStatusHistoryListItemApiModel Status beendet wurde.
StatusId	StatusId	integer	Id, die diesem OrderStatusHistoryListItemApiModel zugeordnet ist.
StatusIndex	StatusIndex	integer	Index, der diesem OrderStatusHistoryListItemApiModel zugeordnet ist.
StatusLabel	StatusLabel	string	Bezeichnungsinhalt, der diesem OrderStatusHistoryListItemApiModel zugeordnet ist.
StatusType	StatusType	integer	Auftragsstatus: 0 für neue Bestellung, 1 für versandfertig, 2 für in Bearbeitung, 3 für abgeschlossen und 4 für die Kündigung.
ExternalOrderId	ExternalOrderId	string	Externe Use OrderId für den Client – API-Erweiterungseigenschaft.
Bestell-ID	OrderId	integer	OrderId, die diesem OrderStatusHistoryListItemApiModel zugeordnet ist.
Benutzer	User	CustomerAPI.Models.UserReferenceApiModel
StartAddress	StartAddress	CustomerAPI.Models.LocationApiModel
EndAddress	EndAddress	CustomerAPI.Models.LocationApiModel
ApiServiceId	ApiServiceId	string	Id des ApiService, der diesem OrderStatusHistoryListItemApiModel zugeordnet ist.
FieldValues	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

CustomerAPI.Models.Order.OrderHeaderApiModel

Name	Pfad	Typ	Beschreibung
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
Bestell-ID	OrderId	integer	ID des OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	Externe Use OrderId für den Client – API-Erweiterungseigenschaft.
Fälligkeitsdatum	DueDate	date-time	Zeitpunkt, zu dem dieses OrderBaseApiModel abgeschlossen ist (in Version 1.3 veraltet).
StartTime	StartTime	date-time	Punkt in der Zeit sollte dieses OrderBaseApiModel gestartet werden (in Version 1.3 eingeführt).
EndTime	EndTime	date-time	Zeitpunkt, zu dem dieses OrderBaseApiModel abgeschlossen ist (in Version 1.3 eingeführt).
ServiceType	ServiceType	string	ServiceType, der diesem OrderBaseApiModel zugeordnet ist.
CreatedUTCDate	CreatedUTCDate	date-time	Zeitpunkt der Erstellung dieses OrderBaseApiModels.
Bestellnummer	OrderNumber	string	Bestellnummer, die diesem OrderBaseApiModel zugeordnet ist.
IsClosed	IsClosed	boolean	Status, der anzeigt, ob das OrderBaseApiModel geschlossen ist.
Der Status	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	Externe Verwendungs-ID für den Client – API-Erweiterungseigenschaft.
ClientId	ClientId	integer	interne Verwendungs-ID für den Client – API-Erweiterungseigenschaft.
Kunde	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	Die ID des apiService, der diesem OrderBaseApiModel zugeordnet ist.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Version des Moduls für benutzerdefinierte Felder.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Name	Pfad	Typ	Beschreibung
Id	Id	integer	ID des Timekeepingeintrags (Legacykommentar: RootSubmittedStatusId).
Benutzer	User	CustomerAPI.Models.UserReferenceApiModel
ClockInTime	ClockInTime	date-time	Punkt in der Zeit, in der der Benutzer in das System eingetaktet ist.
ClockInLocation	ClockInLocation	CustomerAPI.Models.LocationApiModel
ClockOutTime	ClockOutTime	date-time	Punkt in der Zeit, in der der Benutzer das System ausgetaktet hat.
ClockOutLocation	ClockOutLocation	CustomerAPI.Models.LocationApiModel
TotalHours	TotalHours	double	Gesamtanzahl der Stunden für diesen Timekeeping-Eintrag.
TotalBreakHours	TotalBreakHours	double	Die Gesamtanzahl der Unterbrechungsstunden (arbeitsfreie Arbeitszeiten) für diesen Zeiterfassungseintrag.
NetHours	NetHours	double	Die Gesamtzahl der für diesen Timekeepingeintrag anfallenden Stunden.
genehmigt	Approved	boolean	Status der Aufsichtsgenehmigung für diesen Timekeeping-Eintrag.
Unterbrechungen	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	Die ID des Zum Übermitteln dieses Timekeeping-Eintrags verwendeten Unternehmensmoduls.

CustomerAPI.Models.Timekeeping.TimekeepingBreakModel

Name	Pfad	Typ	Beschreibung
Id	Id	integer	SubmittedStatusId.
StartTime	StartTime	date-time	Startzeit.
StartLocation	StartLocation	CustomerAPI.Models.LocationApiModel
EndTime	EndTime	date-time	Endzeit.
EndLocation	EndLocation	CustomerAPI.Models.LocationApiModel
DurationHours	DurationHours	double	Dauer in Stunden. Er kann null sein, wenn EndTime null ist.
StatusType	StatusType	integer	Statustyp: 1 für Pause und 2 zum Mittagessen.
StartLabel	StartLabel	string	Bezeichnung starten.
EndLabel	EndLabel	string	Endbezeichnung.
Überschrift	Caption	string	Überschrift.

CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel

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

System.Version

Name	Pfad	Typ
_Haupt	_Major	integer
_Kleiner	_Minor	integer
_Bauen	_Build	integer
_Revision	_Revision	integer

CustomerAPI.Models.Tracking.TripApiModel

Name	Pfad	Typ	Beschreibung
Benutzer	User	CustomerAPI.Models.UserReferenceApiModel
Fahrzeug	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
StartTime	StartTime	date-time	Zeitpunkt, zu dem dieser TripApiModel-Status gestartet wurde.
EndTime	EndTime	date-time	Zeitpunkt, zu dem dieser TripApiModel-Status beendet wurde.
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	Die Dauer der Stoppzeit in Stunden, die diesem TripApiModel zugeordnet ist.
TotalIdleTime	TotalIdleTime	double	Die Anzahl der Leerlaufzeiten in Stunden, die diesem TripApiModel zugeordnet sind.
TotalDuration	TotalDuration	double	Volle Zeit in Stunden, die diesem TripApiModel zugeordnet sind.
Distanz	Distance	double	Entfernung in lokalisierten Einheiten, die diesem TripApiModel zugeordnet sind.

CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Name	Pfad	Typ	Beschreibung
Datensätze	Records	array of CustomerAPI.Models.Tracking.GpsDataRecordApiModel
ContinuationToken	ContinuationToken	string

CustomerAPI.Models.Tracking.GpsDataRecordApiModel

Name	Pfad	Typ	Beschreibung
Benutzer	User	CustomerAPI.Models.UserReferenceApiModel
Fahrzeug	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
TimeTag	TimeTag	date-time	TimeTag, das diesem GpsDataRecordApiModel zugeordnet ist.
Standort	Location	System.Nullable_1_Actsoft.Core.Geo.LatLon_
Geofence	Geofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
Speed	Speed	double	Geschwindigkeit der Bewegung, die diesem GpsDataRecordApiModel zugeordnet ist.
Heading	Heading	double	Kompassrichtung in Grad, die diesem GpsDataRecordApiModel zugeordnet sind.
Der Status	Status	integer	ApiMovementStatus zugeordnet mit orderBaseApiModel - (Stopped: 1, Idle: 2, Moving: 3, NotTracking: 4) : OrderStatusApiModel.
StatusTime	StatusTime	string	Zeitpunkt der Festlegung dieses GpsDataRecordApiModel-Status.
Distanz	Distance	double	Entfernung in lokalisierten Einheiten, die diesem TripApiModel zugeordnet sind.
Zündung	IgnitionOn	boolean	Status der Fahrzeugzündung im Zusammenhang mit diesem GpsDataRecordApiModel.
LocationProvider	LocationProvider	integer	Api Location Provider zugeordnet mit diesem GpsDataRecordApiModel - (GPS: 1, Netzwerk: 2).

CustomerAPI.Models.User.ReadUserApiModel

Name	Pfad	Typ	Beschreibung
Nutzername	UserName	string	Benutzername des Benutzers.
UserId	UserId	integer	ID-Wert des Benutzers.
GroupName	GroupName	string	Name der Gruppe des Benutzers.
Vorname	FirstName	string	Vorname des Benutzers.
Nachname	LastName	string	Nachname des Benutzers.
Mitarbeiternummer	EmployeeNumber	string	Mitarbeiternummer des Benutzers.
Email	Email	string	E-Mail-Adresse des Benutzers.
Telefonnummer	Phone	string	Telefonnummer des Benutzers.
RoleId	RoleId	integer	RoleId des Benutzers - (Administrator: 1, Benutzer: 3, Power User: 5).
IsActive	IsActive	boolean	Aktiver Status des Benutzers.
EPTTEnabled	EPTTEnabled	boolean	Status der erweiterten Push-to-Talk-Funktion für Benutzer: boolean.
EPTTNumber	EPTTNumber	string	Telefonnummer für erweiterte Push-to-Talk-Funktion für Benutzer: Zeichenfolge.
EPTTWebMDN	EPTTWebMDN	string	Telefonnummer, die verwendet wird, um den Benutzer beim Kodiak EPTT-System zu authentifizieren - bereitgestellt von Kodiak.
EPTTToken	EPTTToken	string	API-Token zur Authentifizierung des Benutzers bei Kodiak EPTT-System - bereitgestellt von Kodiak.
GPSEnabled	GPSEnabled	boolean	Status des GPS-Features für den Benutzer.
MobileOnly	MobileOnly	boolean	Status des Desktopwebanwendungszugriffs für CAB - (No WebApp Access: True, Full App Access: False).
LicenseType	LicenseType	integer	Dem Benutzer zugewiesener Lizenztyp: - 0 für "Nicht definiert", "1" für "Normal", "2" für "WebOnly" und "3 für Mitarbeiter".

CustomerAPI.Models.User.ReadUserListItemApiModel

Name	Pfad	Typ	Beschreibung
UserId	UserId	integer	ID-Wert des Benutzers.
Vorname	FirstName	string	Vorname des Benutzers.
Nachname	LastName	string	Nachname des Benutzers.
Mitarbeiternummer	EmployeeNumber	string	Mitarbeiternummer des Benutzers.
Email	Email	string	E-Mail-Adresse des Benutzers.
Telefonnummer	Phone	string	Telefonnummer des Benutzers.
RoleId	RoleId	integer	RoleId des Benutzers - (Administrator: 1, Benutzer: 3, Power User: 5).
IsActive	IsActive	boolean	Aktiver Status des Benutzers.
EPTTEnabled	EPTTEnabled	boolean	Status der erweiterten Push-to-Talk-Funktion für Benutzer: boolean.
EPTTNumber	EPTTNumber	string	Telefonnummer für erweiterte Push-to-Talk-Funktion für Benutzer: Zeichenfolge.
EPTTWebMDN	EPTTWebMDN	string	Telefonnummer, die verwendet wird, um den Benutzer beim Kodiak EPTT-System zu authentifizieren - bereitgestellt von Kodiak.
EPTTToken	EPTTToken	string	API-Token zur Authentifizierung des Benutzers bei Kodiak EPTT-System - bereitgestellt von Kodiak.
GPSEnabled	GPSEnabled	boolean	Status des GPS-Features für den Benutzer.
MobileOnly	MobileOnly	boolean	Status des Desktopwebanwendungszugriffs für CAB - (No WebApp Access: True, Full App Access: False).
LicenseType	LicenseType	integer	Dem Benutzer zugewiesener Lizenztyp: - 0 für "Nicht definiert", "1" für "Normal", "2" für "WebOnly" und "3 für Mitarbeiter".

CustomerAPI.Models.Vehicles.VehicleReadApi

Fahrzeugdatenmodell.

Name	Pfad	Typ
InternalId	InternalId	integer
Number	Number	string
Name	Name	string
Typ	Type	string
Tag	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
TimeZone	TimeZone	string
Machen	Make	string
Jahr	Year	integer
Model	Model	string
Farbe	Color	string
VIN	VIN	string
IsActive	IsActive	boolean
Typ des Geräts	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

Integer

Dies ist der grundlegende Datentyp "integer".

Objekt

Dies ist der Typ „Objekt“.

Freigeben über

TeamWherx

Erstellen einer Verbindung

Vorgabe

Drosselungsgrenzwerte

Aktionen

Abmelden von Ereignisse-Web-Hooks

Parameter

Abonnieren des GPS-Datenwebhakens

Parameter

Gibt zurück

Abonnieren von Ereignisse-Web-Hooks

Parameter

Gibt zurück

Abrufen benutzerdefinierter Listendefinitionen

Gibt zurück

Abrufen einer benutzerdefinierten Ereignisdefinition nach ID

Parameter

Gibt zurück

Abrufen einer benutzerdefinierten Listenfelderauflistung nach CustomListID

Parameter

Gibt zurück

Abrufen einer Fahrzeugliste

Parameter

Gibt zurück

Abrufen einer Liste von Abonnements

Gibt zurück

Abrufen einer Liste von benutzerdefinierten Ereignisdefinitionen

Gibt zurück

Abrufen einer Liste von Benutzern

Parameter

Gibt zurück

Abrufen einer Liste von Bestellungen

Parameter

Gibt zurück

Abrufen einer Liste von Clients

Parameter

Gibt zurück

Abrufen einer Liste von Ereignissen

Parameter

Gibt zurück

Abrufen einer Liste von Ereigniswebhakenabonnements

Gibt zurück

Abrufen einer Liste von Formularen

Parameter

Gibt zurück

Abrufen einer Liste von Geofences

Parameter

Gibt zurück

Abrufen einer Liste von Reisen

Parameter

Gibt zurück

Abrufen einer Liste von Zeiterfassungseinträgen

Parameter

Gibt zurück

Abrufen eines Benutzers

Parameter

Gibt zurück

Abrufen eines Clients

Parameter

Gibt zurück

Abrufen eines Fahrzeugs nach ID

Parameter

Gibt zurück

Abrufen eines Formulars

Parameter

Gibt zurück

Abrufen eines Geofence-Standorts

Parameter

Gibt zurück

Abrufen eines Zeiterfassungseintrags

Parameter

Gibt zurück

Abrufen einzelner Datensätze aus einer benutzerdefinierten Liste

Parameter

Gibt zurück

Abrufen von GPS-Dateneinträgen

Parameter

Gibt zurück

Aktivieren eines Benutzers