TeamWherx

TeamWherx(TW) est une plateforme de gestion des services tout-en-un qui vous aide à gérer plus efficacement vos équipes distantes d’employés et les opérations commerciales générales loin du bureau. En tant que solution basée sur le cloud, TW permet la collecte de données distantes et l’affiche via son tableau de bord d’application web, fournissant aux gestionnaires les informations supplémentaires dont ils ont besoin pour créer des stratégies plus intelligentes pour accroître l’efficacité, la productivité et réduire les coûts tout en coordonnant leurs effectifs mobiles.

Ce connecteur est disponible dans les produits et régions suivants :

Service	classe	Régions
Copilot Studio	Premium	Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)
Applications logiques	Norme	Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD)
Power Apps	Premium	Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)
Power Automate	Premium	Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)

Contact
Nom	Actsoft Support
URL	https://www.actsoft.com/self-help-wizards
Messagerie électronique	support@actsoft.com

Métadonnées du connecteur
Éditeur	Actsoft
Site internet	https://actsoft.com
Politique de confidentialité	https://www.actsoft.com/privacy
Catégories	Productivité

Description du connecteur :

TeamWherx vous permet de créer et de capturer des informations de formulaire numériques, des informations de chronométrage des employés et de gérer les commandes de travail avec un système de répartition.

Description détaillée

Le connecteur TeamWherx permet aux utilisateurs de se connecter et d’échanger des informations entre plusieurs plateformes. Vous pouvez animer vos données pour créer des flux de processus, piloter vos autres applications internes et informer de puissantes analyses. Automatisez et rationalisez vos processus quotidiens, hebdomadaires ou mensuels avec accès à up-todonnées actionnables.

## Prérequis

Pour utiliser ce connecteur, vous aurez besoin des éléments suivants :

Compte TeamWherx
Clé API TeamWherx
Plan Microsoft Power Apps ou Power Automate

## Comment obtenir des informations d’identification

Portail des développeurs d’API

Pour accéder au connecteur, vous devez d’abord configurer un nom d’utilisateur et un mot de passe pour le portail des développeurs d’API et vous abonner à l’API client :

À partir de l’application, accédez au programme d’installation del’APIParamètres>d’administration>.
Choisissez Créer des informations d’identification.
Entrez votre prénom et votre nom dans les champs appropriés.
Entrez votre adresse e-mail dans le champ Adressee-mail.
Choisissez Enregistrer et envoyer une invitation par e-mail. Ensuite, consultez votre e-mail pour obtenir des instructions sur la création d’un mot de passe.
Une fois dans l’e-mail d’invitation, cliquez sur Choisir un mot de passe, ce qui ouvre une boîte de dialogue qui vous permettra de créer un mot de passe.
Choisissez Enregistrer le mot de passe.
Pour passer au portail des développeurs, à partir de l’application, accédez àParamètres>d’administration>accédez au portail des développeurs.
Dans le portail des développeurs, choisissez Produits, puis sélectionnez APIclient.
Choisissez S’abonner.

Clé API

Maintenant que vous êtes un utilisateur d’API inscrit, une séquence alphanumérique, appelée clé, a été générée pour vous. Vous aurez besoin de cette clé pour utiliser vos données dans l’API.

Pour localiser votre clé API :

Choisissez Produits dans le menu du portail des développeurs. Les produits API disponibles dans votre licence s’affichent.
Sélectionnez la version de l’API client , sous « Vous disposez d’un ou plusieurs abonnements X » pour ce produit.
Choisissez Afficher en regard de la clé primaire de votre abonnement.
Sélectionnez le contenu du champ, cliquez avec le bouton droit et choisissez Copier. La clé est maintenant enregistrée dans votre Presse-papiers et prête à coller.

## Prise en main de votre connecteur

Accédez à Mon>flux Nouveau flux, puis sélectionnez Flux cloud automatisé.
Choisissez Déclencher manuellement un flux à partir de la boîte de dialogue Générer un flux cloud automatisé.
Nommez votre flux ou laissez le système en générer automatiquement.
Recherchez et choisissez un déclencheur pour votre flux.
Sélectionnez Créer.
Dans le champ de recherche, recherchez et choisissez le connecteur TeamWherx.
Recherchez l’action que vous souhaitez effectuer avec le connecteur.

Le système vous invite à vous connecter à toutes les applications requises pour effectuer votre action choisie, en ignorant tout ce que vous êtes déjà connecté.

Entrez un nom pour votre nouveau connecteur dans le champ Connecteur.
Ensuite, entrez votre clé API.
Sélectionnez Créer. La première étape de votre flux de processus s’affiche en tant que première « box » dans un organigramme.
Choisissez Nouvelleétape pour continuer à ajouter d’autres actions et étapes à votre flux de processus de connecteur.
Choisissez Enregistrer.

**Utilisation du connecteur - Exemple d’interrogation d’état de commande
** Les instructions ci-dessous vous montrent comment créer un flux de processus pour insérer des lignes dans une feuille de calcul et insérer des données d’identification de l’employé qui a mis à jour l’ordre lorsqu’un état de commande est mis à jour.

Accédez aux connecteurs.
Recherchez et choisissez le connecteur [TeamWherx].
Choisissez l’interrogation des états de commande dans la liste des actions.
Entrez un nom pour votre nouvelle connexion dans le champ Nom de la connexion.
Ensuite, entrez votre clé API.
Sélectionnez Créer. La première étape de votre flux de processus s’affiche en tant que première « box » dans un organigramme.

Chaque boîte de dialogue d’action dans les étapes de votre flux de connexion aura des champs de propriété que vous pouvez personnaliser pour contrôler l’action effectuée.

Continuez avec l’exemple, indiquez si vous souhaitez que les valeurs de champ Forms s’affichent (paramètre excludeFormData).
Choisissez la version X-API pour la connexion.
Choisissez l’étape suivante pour définir l’action que vous souhaitez effectuer lorsqu’un état de commande est modifié.
Dans la boîte de dialogue Choisir une opération , utilisez le champ de recherche pour localiser l’application, puis l’action souhaitée. Par exemple, si vous souhaitez insérer une ligne dans une feuille de calcul Google chaque fois qu’un état de commande est modifié, vous devez choisir GoogleSheets , puis insérerune ligne pour l’action.
Dans la boîte de dialogue Insérerune ligne qui suit, cliquez dans le champ Fichier , puis choisissez le fichier qui contiendra vos résultats.
Dans le champ Feuille de calcul , choisissez le type de feuille de calcul de données . Les champs qui s’affichent dynamiquement sont les colonnes de données de la feuille de calcul.
Cliquez dans le champ de chaque colonne, puis choisissez une propriété dans la liste des propriétés du sondage d’état commande . Vous pouvez également utiliser le champ de recherche pour rechercher une propriété spécifique.
Vous pouvez entrer plusieurs propriétés dans chaque champ de colonne ; dans la colonne Événement, choisissez StatusLabel, insérez un tiret, puis choisissez StatusStartDate. Cela signifie que pour chaque mise à jour de l’état de la commande, l’étiquette d’état et la date de début de l’état écrivent dans la colonne Événement dans la nouvelle ligne.
Sélectionnez Nouvelleétape. À titre de remarque de côté, vous pouvez toujours pointer et cliquer sur le connecteur de flèche pour insérer une nouvelle étape
Dans la boîte de dialogue Choisir une opération, sélectionnez à nouveau le connecteur TeamWherx, puis créez un client pour l’action.

Là encore, chaque champ affiché dans la boîte de dialogue représente une colonne dans la feuille de calcul Google Sheets. Cliquez dans chaque champ pour activer la liste des propriétés de sondage d’état de commande , puis sélectionnez les propriétés souhaitées.

Pour cet exemple, choisissez EmployeeNumber pour le champ Nom pour identifier l’employé qui a mis à jour l’état de la commande.
Choisissez GroupName et insérez-le également dans le champ Nom .
Choisissez Enregistrer.

Vous avez maintenant créé un flux de processus qui mettra à jour votre feuille de calcul avec le numéro d’employé et le groupe associé chaque fois qu’un état de commande est mis à jour.

## Problèmes connus et limitations

Les chargements binaires de fichiers audio (POST) pour tous les points de terminaison sont limités à MP4 uniquement.
Les dates de tous les points de terminaison qui nécessitent des informations de date/heure doivent être spécifiées conformément aux instructions RFC3339, comme dans l’exemple suivant : 2021-09-22T02:36:56.52Z. Il n’est pas nécessaire de spécifier les secondes exactes dans l’horodatage ; 00 est acceptable.

## Erreurs et solutions courantes

Vous trouverez des exemples d’erreurs courantes qui peuvent se produire, des codes de réponse et des corrections sur le ou les portails des développeurs d’API :

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

## FAQ

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :


Par défaut	Paramètres de création de connexion.	Toutes les régions	Non partageable

Faire défaut

Applicable : Toutes les régions

Paramètres de création de connexion.

Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.

Nom	Type	Descriptif	Obligatoire
Clé d’API	securestring	Clé API pour cette API	Vrai

Limitations

Nom	Appels	Période de renouvellement
Appels d’API par connexion	100	60 secondes

Actions

Abonnez-vous au web hook de données GPS	Ajoute de nouvelles données de suivi GPS (positions GPS) web hook. Les crochets web vous permettent de recevoir des positions GPS sur une URL spécifiée.
Activer un utilisateur	Active un utilisateur existant par son ID.
Activer un véhicule	Activez un véhicule par ID.
Charger le fichier de pièce jointe	Utilisez cette option pour charger des pièces jointes de fichier de formulaire. La taille binaire est limitée à 25 Mo. Demande de données multipart/formulaire attendue avec un seul fichier.
Charger un fichier binaire	Utilisez cette option pour charger des images de formulaire et des fichiers audio. La taille binaire est limitée à 10 Mo. Les types de fichiers pris en charge sont : JPEG, PNG et MP4.
Créer ou mettre à jour un enregistrement de liste personnalisé	Crée ou met à jour un enregistrement de données de liste personnalisé. La valeur d’une colonne unique peut être omise, mais si elle est présente, elle doit correspondre à la valeur d’ID unique dans le paramètre de requête.
Créer ou mettre à jour une définition d’événement personnalisée	Crée ou met à jour une définition d’événement personnalisée.
Créer un client	Crée un client.
Créer un formulaire	Ajoute un nouveau formulaire.
Créer un utilisateur	Crée un utilisateur.
Créer un véhicule	Crée un véhicule.
Créer une commande	Ajoute une nouvelle commande.
Créer une limite géographique	Crée une nouvelle limite géographique.
Désabonner le web hook de données GPS	Supprime un abonnement web de données GPS par son ID.
Désactiver un utilisateur	Désactive un utilisateur existant par son ID.
Désactiver un véhicule	Désactivez un véhicule par ID.
Envoyer un événement	Envoi d’un événement.
Mettre à jour un client	Met à jour un client existant.
Mettre à jour un utilisateur	Met à jour un utilisateur existant.
Mettre à jour un véhicule	Mettre à jour un véhicule par ID.
Mettre à jour une commande	Met à jour une commande existante.
Mettre à jour une limite géographique existante	Met à jour une limite géographique existante par son ID.
Mettre à jour une partie d’un utilisateur	Met à jour une partie des propriétés de l’utilisateur.
Mise à jour partielle d’un véhicule	Mise à jour partielle d’un véhicule par ID.
Obtenir des données de liste personnalisées par CustomListID	Récupère tous les enregistrements de données d’une seule liste personnalisée à l’aide de CustomListID. Les résultats sont triés par colonne et la pagination est prise en charge. Erreurs: 404 : il n’existe aucune liste personnalisée pour customListId fourni.
Obtenir des définitions de liste personnalisées	Récupère une liste de définitions de liste personnalisée. La liste de définitions contient l’ID customListID, le nom et la version de toutes les listes personnalisées existantes.
Obtenir des entrées de données GPS	Récupère les entrées de données GPS pour une plage de dates spécifiée. Retourne également un jeton de continuation et un lien pour obtenir la partie de données suivante. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page. Les positions des utilisateurs/véhicules supprimés ne sont pas retournées. Toutefois, si l’utilisateur/véhicule existait quand des données ont été demandées et ont été supprimées ultérieurement, les données de l’utilisateur/véhicule demandé par un jeton de continuation sont retournées. Les résultats sont automatiquement triés par UtcTime et dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.
Obtenir la liste des abonnements	Récupère une liste d’abonnements web hook. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page. Les résultats sont automatiquement triés par SubscriptionId et dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.
Obtenir la liste des abonnements de hook web d’événements	Récupère une liste d’abonnements de hook web d’événements. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page. Les résultats sont automatiquement triés par SubscriptionId et dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.
Obtenir la liste des champs de liste personnalisés par CustomListID	Récupère une liste de champs pour une seule liste personnalisée, à l’aide de CustomListID.
Obtenir la liste des clients	Récupère une liste de clients. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page. Les résultats sont automatiquement triés par nom et dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.
Obtenir la liste des commandes	Récupère une liste de commandes à l’aide des filtres des paramètres de requête indiqués ci-dessous. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page. Les résultats sont automatiquement triés par Client.Name et dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.
Obtenir la liste des définitions d’événements personnalisées	Récupère une liste de définitions d’événements personnalisées.
Obtenir la liste des entrées de chronométrage	Récupère une liste d’entrées de chronométrage en fonction de la plage de dates. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page. Les résultats sont automatiquement triés par ClockInTime, puis par TimekeepingStatusId et dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.
Obtenir la liste des formulaires	Récupère une liste de formulaires à l’aide de l’un des filtres des paramètres de requête indiqués ci-dessous. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page. Les résultats sont triés automatiquement par SubmittedTime et dans l’ordre décroissant. Les paramètres de tri ne sont pas configurables.
Obtenir la liste des limites géographiques	Récupère une liste de limites géographiques. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page, ainsi que si les coordonnées de limite géographique sont métriques. Les résultats sont automatiquement triés par nom et dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.
Obtenir la liste des utilisateurs	Récupère une liste d’utilisateurs. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page. Les résultats sont automatiquement triés par UserId et dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.
Obtenir la liste des voyages	Récupère une liste de voyages pour une période spécifique. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page. Les résultats sont automatiquement triés par StartUtcTIme et dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.
Obtenir la liste des événements	Récupère une liste d’événements pour une période spécifique. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page. Filtrez par type d’événement pour obtenir des événements spécifiques. Les événements de véhicule peuvent être retournés pour un employé si l’employé est associé au véhicule.
Obtenir un client	Récupère un objet client par son ID.
Obtenir un enregistrement unique à partir d’une liste personnalisée	Récupère un enregistrement de données de liste personnalisé unique trouvé par CustomListId et une valeur de colonne unique. Erreurs: 404 : il n’existe aucun enregistrement de liste personnalisé pour la valeur de colonne personnalisée fournie et customListId et une valeur de colonne unique
Obtenir un formulaire	Récupère un formulaire par son ID.
Obtenir un utilisateur	Obtient un utilisateur par son ID.
Obtenir un véhicule par ID	Récupère un véhicule unique par ID.
Obtenir une commande	Obtient une commande existante par son ID.
Obtenir une définition d’événement personnalisée par ID	Récupère une définition d’événement personnalisée unique par ID.
Obtenir une entrée de chronométrage	Récupère une entrée par son ID.
Obtenir une limite géographique	Récupère une limite géographique par son ID.
Obtenir une liste de véhicules	Récupère une liste de véhicules.
Obtenir une version mineure	Retourne la version mineure actuelle de l’API.
Rappel de hook web avec flux d’événements	Cet exemple de méthode est utilisé par les événements/s’abonnent pour publier le flux de données d’événement à l’aide de l’URL fournie par le client.
Rappel webhook avec flux de données GPS	Cet exemple de méthode est utilisé par gpsdata/s’abonner pour publier le flux de données à l’aide de l’URL fournie par le client.
Réinitialise l’état de l’abonnement	Remplace l’état de l’abonnement par l’état = 1 (« En cours d’exécution »).
Réinitialise l’état de l’abonnement web hook d’événement	Remplace l’état de l’abonnement par l’état = 1 (« En cours d’exécution »).
Se désabonner du web hook d’événements	Supprime un abonnement de hook web d’événements par son ID.
Supprimer un client	Supprime un client existant par son ID.
Supprimer un enregistrement de liste personnalisé	Supprime l’enregistrement existant dans la liste personnalisée par son customListId et son ID. id : valeur unique de l’enregistrement de liste personnalisé. Erreurs: 404 - customListId ou ID introuvable.
Supprimer un véhicule	Supprimez un véhicule par ID.
Supprimer une définition d’événement personnalisée	Supprime une définition d’événement personnalisée.
Supprimer une limite géographique	Supprime une limite géographique existante par son ID.
S’abonner au web hook d’événements	Ajoute un nouvel abonnement de hook web d’événements. Les hooks web vous permettent de recevoir des notifications automatiques sur les événements d’entreprise se produisant sur une URL spécifiée.
État de l’ordre de mise à jour	Modifie un état de commande existant.

Abonnez-vous au web hook de données GPS

ID d’opération :: TrackingController_SubscribeToGpsDataFeed

Ajoute de nouvelles données de suivi GPS (positions GPS) web hook. Les crochets web vous permettent de recevoir des positions GPS sur une URL spécifiée.

Paramètres

Nom	Clé	Obligatoire	Type	Description
URL	Url		string	URL contenant l’adresse du WebHookSubscriptionParamsApiModel.
SecurityToken	SecurityToken		string	Jeton de sécurité associé à ce WebHookSubscriptionParamsApiModel.

Retours

Corps: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Activer un utilisateur

ID d’opération :: UserController_Activate

Active un utilisateur existant par son ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	L’ID externe ou interne dépend de la valeur du paramètre use-external-id.
use-external-id	use-external-id		boolean	Utilisez l’ID externe ou non.

Activer un véhicule

ID d’opération :: VehicleController_Activate

Activez un véhicule par ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	L’ID externe ou interne dépend de la valeur du paramètre use-external-id.
use-external-id	use-external-id		boolean	Utilisez l’ID externe ou non.

Retours

response: integer

Charger le fichier de pièce jointe

ID d’opération :: BinaryController_UploadAttachment

Utilisez cette option pour charger des pièces jointes de fichier de formulaire. La taille binaire est limitée à 25 Mo. Demande de données multipart/formulaire attendue avec un seul fichier.

Retours

Corps: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Charger un fichier binaire

ID d’opération :: BinaryController_UploadBinary

Utilisez cette option pour charger des images de formulaire et des fichiers audio. La taille binaire est limitée à 10 Mo. Les types de fichiers pris en charge sont : JPEG, PNG et MP4.

Retours

Corps: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Créer ou mettre à jour un enregistrement de liste personnalisé

ID d’opération :: CustomListController_PutRecord

Crée ou met à jour un enregistrement de données de liste personnalisé. La valeur d’une colonne unique peut être omise, mais si elle est présente, elle doit correspondre à la valeur d’ID unique dans le paramètre de requête.

Paramètres

Nom	Clé	Obligatoire	Type	Description
customListId	customListId	True	integer	ID de liste personnalisé.
pièce d'identité	id	True	string	Valeur unique.
ColumnIndex	ColumnIndex		integer	Index de colonne de liste personnalisée.
Légende	Caption		string	Légende de colonne de liste personnalisée.
Valeur	Value			Valeur de colonne de liste personnalisée.

Créer ou mettre à jour une définition d’événement personnalisée

ID d’opération :: EventController_Put

Crée ou met à jour une définition d’événement personnalisée.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	ID de définition d’événement.
Nom	Name		string
ReverseGeocode	ReverseGeocode		boolean
Nom	Name		string
Type	Type		integer
Légende	Caption		string
Obligatoire	Required		boolean

Créer un client

ID d’opération :: ClientController_Create

Crée un client.

Paramètres

Nom	Clé	Type	Description
ExternalId	ExternalId	string	ID d’utilisation externe pour le client - Propriété d’extension d’API.
FieldIndex	FieldIndex	integer	Index de champ.
Valeur	Value		Valeur du champ.
Nom	Name	string	Nom du client.
Latitude	Latitude	double
Longitude	Longitude	double
AddressLine1	AddressLine1	string	AddressLine1 de ce LocationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 de ce LocationApiModel.
Ville	City	string	Ville de LocationApiModel.
Nom de la région	RegionName	string	Nom de la région de LocationApiModel.
Code postal	PostalCode	string	Code postal de LocationApiModel.
Code du pays	CountryCode	string	Code ISO 3166-1 alpha-2.
SubRegionName	SubRegionName	string	Sous-région de LocationApiModel.
SubRegionCode	SubRegionCode	string	Code de sous-région de LocationApiModel.
RegionCode	RegionCode	string	Code de région de LocationApiModel.
Nom	Name	string	Nom du ContactApiModel.
Numéro de téléphone	PhoneNumber	string	PhoneNumber du ContactApiModel.
Messagerie électronique	Email	string	E-mail du ContactApiModel.
géocode	geocode	boolean	Doit être géocodée ou non.

Retours

Corps: CustomerAPI.Models.ReturnIdApiModel

Créer un formulaire

ID d’opération :: FormController_PostFormAsync

Ajoute un nouveau formulaire.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ApiModuleId	ApiModuleId		string	ID de l’ApiModule associé à ce CreateStandaloneFormApiModel.
Revu	Reviewed		boolean	État de la révision de ce CreateStandaloneFormApiModel.
UserId	UserId		integer	UserId de l’utilisateur.
EmployeeNumber	EmployeeNumber		string	Numéro d’employé de l’utilisateur.
SubmittedTime	SubmittedTime	True	date-time	Point dans le temps où createStandaloneFormApiModel a été envoyé.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de ce LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de ce LocationApiModel.
Ville	City		string	Ville de LocationApiModel.
Nom de la région	RegionName		string	Nom de la région de LocationApiModel.
Code postal	PostalCode		string	Code postal de LocationApiModel.
Code du pays	CountryCode		string	Code ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	Sous-région de LocationApiModel.
SubRegionCode	SubRegionCode		string	Code de sous-région de LocationApiModel.
RegionCode	RegionCode		string	Code de région de LocationApiModel.
ApiFieldId	ApiFieldId	True	string	ID du champ API.
Valeur	Value	True		Valeur de FormFieldDataApiModel. Format de valeur de champ « NFC » : { « Type » : number, // 0 - Text « Payload » : object, // Doit être texte pour Type = 0 } Format de valeur de champ « Caméra » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’une image chargée (voir l’API binaire de chargement) « Remarque » : chaîne // Remarque pour l’image référencée } Format de valeur de champ « Sign » (référence binaire) : { « BinaryId » : chaîne // ID binaire d’une image chargée (voir l’API binaire de chargement) } Format de valeur de champ « Audio » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’un audio chargé (voir l’API binaire de chargement) « DurationSeconds » : nombre // Durée audio en secondes }
CapturedTime	CapturedTime		date-time	Heure à laquelle les données binaires ont été capturées. Format : date-heure (en tant que date-heure dans RFC3339) y compris le décalage.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de ce LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de ce LocationApiModel.
Ville	City		string	Ville de LocationApiModel.
Nom de la région	RegionName		string	Nom de la région de LocationApiModel.
Code postal	PostalCode		string	Code postal de LocationApiModel.
Code du pays	CountryCode		string	Code ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	Sous-région de LocationApiModel.
SubRegionCode	SubRegionCode		string	Code de sous-région de LocationApiModel.
RegionCode	RegionCode		string	Code de région de LocationApiModel.
ApiFieldId	ApiFieldId	True	string	ID du champ API.
Valeur	Value	True		Valeur de FormFieldDataApiModel. Format de valeur de champ « NFC » : { « Type » : number, // 0 - Text « Payload » : object, // Doit être texte pour Type = 0 } Format de valeur de champ « Caméra » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’une image chargée (voir l’API binaire de chargement) « Remarque » : chaîne // Remarque pour l’image référencée } Format de valeur de champ « Sign » (référence binaire) : { « BinaryId » : chaîne // ID binaire d’une image chargée (voir l’API binaire de chargement) } Format de valeur de champ « Audio » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’un audio chargé (voir l’API binaire de chargement) « DurationSeconds » : nombre // Durée audio en secondes }
CapturedTime	CapturedTime		date-time	Heure à laquelle les données binaires ont été capturées. Format : date-heure (en tant que date-heure dans RFC3339) y compris le décalage.

Retours

Corps: CustomerAPI.Models.ReturnIdApiModel

Créer un utilisateur

ID d’opération :: UserController_Create

Crée un utilisateur.

Paramètres

Nom	Clé	Type	Description
Nom d’utilisateur	UserName	string	Nom d’utilisateur de l’utilisateur.
Mot de passe	Password	password	Mot de passe de l’utilisateur.
GroupName	GroupName	string	Nom du groupe de l’utilisateur.
Prénom	FirstName	string	Prénom de l’utilisateur.
nom de famille	LastName	string	Nom de l’utilisateur.
EmployeeNumber	EmployeeNumber	string	Numéro d’employé de l’utilisateur.
Messagerie électronique	Email	string	Adresse e-mail de l’utilisateur.
Téléphone	Phone	string	Numéro de téléphone de l’utilisateur.
RoleId	RoleId	integer	RoleId de l’utilisateur : (Administrateur : 1, Utilisateur : 3, Power User : 5).
IsActive	IsActive	boolean	État actif de l’utilisateur.
EPTTEnabled	EPTTEnabled	boolean	État de la fonctionnalité Push-to-Talk améliorée pour l’utilisateur : booléen.
EPTTNumber	EPTTNumber	string	Numéro de téléphone pour la fonctionnalité Push-to-Talk améliorée pour l’utilisateur : chaîne.
EPTTWebMDN	EPTTWebMDN	string	Numéro de téléphone utilisé pour authentifier l’utilisateur auprès du système EPTT DeNceak - Fourni par Celui-ci.
EPTTToken	EPTTToken	string	Jeton d’API utilisé pour authentifier l’utilisateur auprès du système EPTT de L’utilisateur - Fourni par Jeffreyak.
GPSEnabled	GPSEnabled	boolean	État de la fonctionnalité GPS pour l’utilisateur.
MobileOnly	MobileOnly	boolean	État de l’accès aux applications web de bureau pour CAB - (No WebApp Access : True, Full App Access : False).
LicenseType	LicenseType	integer	Type de licence affecté à l’utilisateur : - 0 pour Undefined, 1 pour Regular, 2 pour WebOnly et 3 pour Employee.

Retours

Corps: CustomerAPI.Models.ReturnIdApiModel

Créer un véhicule

ID d’opération :: VehicleController_CreateVehicle

Crée un véhicule.

Paramètres

Nom	Clé	Type
Number	Number	string
Nom	Name	string
Type	Type	string
Tag	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
TimeZone	TimeZone	string
Faire	Make	string
Année	Year	integer
Model	Model	string
Color	Color	string
VIN	VIN	string
IsActive	IsActive	boolean
Type de périphérique	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

Retours

Corps: CustomerAPI.Models.ReturnIdApiModel

Créer une commande

ID d’opération :: OrderController_Create

Ajoute une nouvelle commande.

Paramètres

Nom	Clé	Obligatoire	Type	Description
CreatedDateTime	CreatedDateTime		date-time	Point dans le temps, cette createUpdateOrderApiModel a été créée.
ExternalClientId	ExternalClientId	True	string	ID d’utilisation externe pour le client - Propriété d’extension d’API.
ServiceType	ServiceType	True	string	Type de service associé à ce CreateUpdateOrderApiModel.
ExternalOrderId	ExternalOrderId		string	External Use OrderId for the Client - API Extension Property.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de ce LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de ce LocationApiModel.
Ville	City		string	Ville de LocationApiModel.
Nom de la région	RegionName		string	Nom de la région de LocationApiModel.
Code postal	PostalCode		string	Code postal de LocationApiModel.
Code du pays	CountryCode		string	Code ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	Sous-région de LocationApiModel.
SubRegionCode	SubRegionCode		string	Code de sous-région de LocationApiModel.
RegionCode	RegionCode		string	Code de région de LocationApiModel.
Nom	Name		string	Nom du ContactApiModel.
Numéro de téléphone	PhoneNumber		string	PhoneNumber du ContactApiModel.
Messagerie électronique	Email		string	E-mail du ContactApiModel.
Date d’échéance	DueDate		date-time	Point dans le temps, cette BaseUpdateOrderApiModel est due à l’achèvement (obsolète dans la version 1.3).
StartTime	StartTime		date-time	Point dans le temps, cette BaseUpdateOrderApiModel doit démarrer (introduite dans la version 1.3).
EndTime	EndTime		date-time	Point dans le temps, cette BaseUpdateOrderApiModel doit se terminer (introduite dans la version 1.3).
Légende	Caption	True	string
Valeur	Value			Valeur de UpdateFormFieldApiModel. Format de valeur de champ « NFC » : { « Type » : number, // 0 - Text « Payload » : object, // Doit être texte pour Type = 0 } Format de valeur de champ « Caméra » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’une image chargée (voir l’API binaire de chargement) « Remarque » : chaîne // Remarque pour l’image référencée } Format de valeur de champ « Signature » (référence binaire) : { « BinaryId » : chaîne // ID binaire d’une image chargée (voir l’API binaire de chargement) } Format de valeur de champ « Audio » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’un audio chargé (voir l’API binaire de chargement) « DurationSeconds » : nombre // Durée audio en secondes }
CapturedTime	CapturedTime		date-time	La valeur de point dans le temps a été capturée.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de ce LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de ce LocationApiModel.
Ville	City		string	Ville de LocationApiModel.
Nom de la région	RegionName		string	Nom de la région de LocationApiModel.
Code postal	PostalCode		string	Code postal de LocationApiModel.
Code du pays	CountryCode		string	Code ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	Sous-région de LocationApiModel.
SubRegionCode	SubRegionCode		string	Code de sous-région de LocationApiModel.
RegionCode	RegionCode		string	Code de région de LocationApiModel.
Légende	Caption	True	string
Valeur	Value			Valeur de UpdateFormFieldApiModel. Format de valeur de champ « NFC » : { « Type » : number, // 0 - Text « Payload » : object, // Doit être texte pour Type = 0 } Format de valeur de champ « Caméra » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’une image chargée (voir l’API binaire de chargement) « Remarque » : chaîne // Remarque pour l’image référencée } Format de valeur de champ « Signature » (référence binaire) : { « BinaryId » : chaîne // ID binaire d’une image chargée (voir l’API binaire de chargement) } Format de valeur de champ « Audio » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’un audio chargé (voir l’API binaire de chargement) « DurationSeconds » : nombre // Durée audio en secondes }
CapturedTime	CapturedTime		date-time	La valeur de point dans le temps a été capturée.
EmployeeNumber	EmployeeNumber	True	string	EmployeeNumber de l’utilisateur qui a créé ce NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Contenu d’étiquette pour StatusLabel associé à ce NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	Point dans le temps où cet état NewOrderStatusApiModel a été démarré.
Légende	Caption	True	string
Valeur	Value			Valeur de UpdateFormFieldApiModel. Format de valeur de champ « NFC » : { « Type » : number, // 0 - Text « Payload » : object, // Doit être texte pour Type = 0 } Format de valeur de champ « Caméra » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’une image chargée (voir l’API binaire de chargement) « Remarque » : chaîne // Remarque pour l’image référencée } Format de valeur de champ « Signature » (référence binaire) : { « BinaryId » : chaîne // ID binaire d’une image chargée (voir l’API binaire de chargement) } Format de valeur de champ « Audio » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’un audio chargé (voir l’API binaire de chargement) « DurationSeconds » : nombre // Durée audio en secondes }
CapturedTime	CapturedTime		date-time	La valeur de point dans le temps a été capturée.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de ce LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de ce LocationApiModel.
Ville	City		string	Ville de LocationApiModel.
Nom de la région	RegionName		string	Nom de la région de LocationApiModel.
Code postal	PostalCode		string	Code postal de LocationApiModel.
Code du pays	CountryCode		string	Code ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	Sous-région de LocationApiModel.
SubRegionCode	SubRegionCode		string	Code de sous-région de LocationApiModel.
RegionCode	RegionCode		string	Code de région de LocationApiModel.
Légende	Caption	True	string
Valeur	Value			Valeur de UpdateFormFieldApiModel. Format de valeur de champ « NFC » : { « Type » : number, // 0 - Text « Payload » : object, // Doit être texte pour Type = 0 } Format de valeur de champ « Caméra » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’une image chargée (voir l’API binaire de chargement) « Remarque » : chaîne // Remarque pour l’image référencée } Format de valeur de champ « Signature » (référence binaire) : { « BinaryId » : chaîne // ID binaire d’une image chargée (voir l’API binaire de chargement) } Format de valeur de champ « Audio » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’un audio chargé (voir l’API binaire de chargement) « DurationSeconds » : nombre // Durée audio en secondes }
CapturedTime	CapturedTime		date-time	La valeur de point dans le temps a été capturée.
FieldIndex	FieldIndex		integer	Index de champ.
Valeur	Value			Valeur du champ.
géocode	geocode		boolean	Doit être géocodée ou non.

Retours

Corps: CustomerAPI.Models.ReturnIdApiModel

Créer une limite géographique

ID d’opération :: GeofenceController_CreateGeofence

Crée une nouvelle limite géographique.

Paramètres

Nom	Clé	Type	Description
GroupNames	GroupNames	array of string	GroupPaths de GeofenceCreateApiModel.
Latitude	Latitude	double
Longitude	Longitude	double
Nom	Name	string	Nom de GeofenceApiModelBase.
Type	Type	string	Type de GeofenceApiModel.
Forme	Shape	integer	Forme : 0 pour le cercle et 1 pour le polygone.
Latitude	Latitude	double
Longitude	Longitude	double
AddressLine1	AddressLine1	string	AddressLine1 de ce LocationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 de ce LocationApiModel.
Ville	City	string	Ville de LocationApiModel.
Nom de la région	RegionName	string	Nom de la région de LocationApiModel.
Code postal	PostalCode	string	Code postal de LocationApiModel.
Code du pays	CountryCode	string	Code ISO 3166-1 alpha-2.
SubRegionName	SubRegionName	string	Sous-région de LocationApiModel.
SubRegionCode	SubRegionCode	string	Code de sous-région de LocationApiModel.
RegionCode	RegionCode	string	Code de région de LocationApiModel.
Radius	Radius	double	Rayon de GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress de GeofenceApiModel.
useMetric	useMetric	boolean	Utilisez le système de métriques ou non.
géocode	geocode	boolean	Doit être géocodée ou non.

Retours

Corps: CustomerAPI.Models.ReturnIdApiModel

Désabonner le web hook de données GPS

ID d’opération :: TrackingController_RemoveGpsDataFeedSubscription

Supprime un abonnement web de données GPS par son ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
subscriptionId	subscriptionId	True	string	ID d’abonnement à supprimer.

Désactiver un utilisateur

ID d’opération :: UserController_Deactivate

Désactive un utilisateur existant par son ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	L’ID externe ou interne dépend de la valeur du paramètre use-external-id.
use-external-id	use-external-id		boolean	Utilisez l’ID externe ou non.

Désactiver un véhicule

ID d’opération :: VehicleController_Deactivate

Désactivez un véhicule par ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	L’ID externe ou interne dépend de la valeur du paramètre use-external-id.
use-external-id	use-external-id		boolean	Utilisez l’ID externe ou non.

Retours

response: integer

Envoyer un événement

ID d’opération :: EventController_Post

Envoi d’un événement.

Paramètres

Nom	Clé	Type	Description
EventDefinitionId	EventDefinitionId	string	ID de définition d’événement.
EmployeeNumber	EmployeeNumber	string	Numéro d’employé.
VehicleNumber	VehicleNumber	string	Numéro de véhicule.
DeviceSerialNumber	DeviceSerialNumber	string	GpsDeviceDto numéro de série.
Latitude	Latitude	double
Longitude	Longitude	double
AddressLine1	AddressLine1	string	AddressLine1 de ce LocationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 de ce LocationApiModel.
Ville	City	string	Ville de LocationApiModel.
Nom de la région	RegionName	string	Nom de la région de LocationApiModel.
Code postal	PostalCode	string	Code postal de LocationApiModel.
Code du pays	CountryCode	string	Code ISO 3166-1 alpha-2.
SubRegionName	SubRegionName	string	Sous-région de LocationApiModel.
SubRegionCode	SubRegionCode	string	Code de sous-région de LocationApiModel.
RegionCode	RegionCode	string	Code de région de LocationApiModel.
Heure	Time	date-time
Paramètres	Parameters	object	Paramètres d’événement.

Mettre à jour un client

ID d’opération :: ClientController_Update

Met à jour un client existant.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	L’ID externe ou interne dépend de la valeur du paramètre use-external-id.
ExternalId	ExternalId		string	ID d’utilisation externe pour le client - Propriété d’extension d’API.
FieldIndex	FieldIndex		integer	Index de champ.
Valeur	Value			Valeur du champ.
Nom	Name		string	Nom du client.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de ce LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de ce LocationApiModel.
Ville	City		string	Ville de LocationApiModel.
Nom de la région	RegionName		string	Nom de la région de LocationApiModel.
Code postal	PostalCode		string	Code postal de LocationApiModel.
Code du pays	CountryCode		string	Code ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	Sous-région de LocationApiModel.
SubRegionCode	SubRegionCode		string	Code de sous-région de LocationApiModel.
RegionCode	RegionCode		string	Code de région de LocationApiModel.
Nom	Name		string	Nom du ContactApiModel.
Numéro de téléphone	PhoneNumber		string	PhoneNumber du ContactApiModel.
Messagerie électronique	Email		string	E-mail du ContactApiModel.
géocode	geocode		boolean	Doit être géocodée ou non.
use-external-id	use-external-id		boolean	Utilisez l’ID externe ou non.

Retours

Corps: CustomerAPI.Models.ReturnIdApiModel

Mettre à jour un utilisateur

ID d’opération :: UserController_Update

Met à jour un utilisateur existant.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	L’ID externe ou interne dépend de la valeur du paramètre use-external-id.
Nom d’utilisateur	UserName		string	Nom d’utilisateur de l’utilisateur.
Mot de passe	Password		password	Mot de passe de l’utilisateur.
GroupName	GroupName		string	Nom du groupe de l’utilisateur.
Prénom	FirstName		string	Prénom de l’utilisateur.
nom de famille	LastName		string	Nom de l’utilisateur.
EmployeeNumber	EmployeeNumber		string	Numéro d’employé de l’utilisateur.
Messagerie électronique	Email		string	Adresse e-mail de l’utilisateur.
Téléphone	Phone		string	Numéro de téléphone de l’utilisateur.
RoleId	RoleId		integer	RoleId de l’utilisateur : (Administrateur : 1, Utilisateur : 3, Power User : 5).
IsActive	IsActive		boolean	État actif de l’utilisateur.
EPTTEnabled	EPTTEnabled		boolean	État de la fonctionnalité Push-to-Talk améliorée pour l’utilisateur : booléen.
EPTTNumber	EPTTNumber		string	Numéro de téléphone pour la fonctionnalité Push-to-Talk améliorée pour l’utilisateur : chaîne.
EPTTWebMDN	EPTTWebMDN		string	Numéro de téléphone utilisé pour authentifier l’utilisateur auprès du système EPTT DeNceak - Fourni par Celui-ci.
EPTTToken	EPTTToken		string	Jeton d’API utilisé pour authentifier l’utilisateur auprès du système EPTT de L’utilisateur - Fourni par Jeffreyak.
GPSEnabled	GPSEnabled		boolean	État de la fonctionnalité GPS pour l’utilisateur.
MobileOnly	MobileOnly		boolean	État de l’accès aux applications web de bureau pour CAB - (No WebApp Access : True, Full App Access : False).
LicenseType	LicenseType		integer	Type de licence affecté à l’utilisateur : - 0 pour Undefined, 1 pour Regular, 2 pour WebOnly et 3 pour Employee.
use-external-id	use-external-id		boolean	Utilisez l’ID externe ou non.

Retours

Corps: CustomerAPI.Models.ReturnIdApiModel

Mettre à jour un véhicule

ID d’opération :: VehicleController_UpdateVehicle

Mettre à jour un véhicule par ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	L’ID externe ou interne dépend de la valeur du paramètre use-external-id.
Number	Number		string
Nom	Name		string
Type	Type		string
Tag	Tag		string
UserEmployeeNumber	UserEmployeeNumber		string
GroupName	GroupName		string
TimeZone	TimeZone		string
Faire	Make		string
Année	Year		integer
Model	Model		string
Color	Color		string
VIN	VIN		string
IsActive	IsActive		boolean
Type de périphérique	DeviceType		integer
DeviceSerialNumber	DeviceSerialNumber		string
use-external-id	use-external-id		boolean	Utilisez l’ID externe ou non.

Retours

response: integer

Mettre à jour une commande

ID d’opération :: OrderController_Update

Met à jour une commande existante.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	L’ID externe ou interne dépend de la valeur du paramètre use-external-id.
ExternalOrderId	ExternalOrderId		string	External Use OrderId for the Client - API Extension Property.
IsClosed	IsClosed		boolean	État montrant si UpdateOrderApiModel a fermé.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de ce LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de ce LocationApiModel.
Ville	City		string	Ville de LocationApiModel.
Nom de la région	RegionName		string	Nom de la région de LocationApiModel.
Code postal	PostalCode		string	Code postal de LocationApiModel.
Code du pays	CountryCode		string	Code ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	Sous-région de LocationApiModel.
SubRegionCode	SubRegionCode		string	Code de sous-région de LocationApiModel.
RegionCode	RegionCode		string	Code de région de LocationApiModel.
Nom	Name		string	Nom du ContactApiModel.
Numéro de téléphone	PhoneNumber		string	PhoneNumber du ContactApiModel.
Messagerie électronique	Email		string	E-mail du ContactApiModel.
Date d’échéance	DueDate		date-time	Point dans le temps, cette BaseUpdateOrderApiModel est due à l’achèvement (obsolète dans la version 1.3).
StartTime	StartTime		date-time	Point dans le temps, cette BaseUpdateOrderApiModel doit démarrer (introduite dans la version 1.3).
EndTime	EndTime		date-time	Point dans le temps, cette BaseUpdateOrderApiModel doit se terminer (introduite dans la version 1.3).
Légende	Caption	True	string
Valeur	Value			Valeur de UpdateFormFieldApiModel. Format de valeur de champ « NFC » : { « Type » : number, // 0 - Text « Payload » : object, // Doit être texte pour Type = 0 } Format de valeur de champ « Caméra » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’une image chargée (voir l’API binaire de chargement) « Remarque » : chaîne // Remarque pour l’image référencée } Format de valeur de champ « Signature » (référence binaire) : { « BinaryId » : chaîne // ID binaire d’une image chargée (voir l’API binaire de chargement) } Format de valeur de champ « Audio » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’un audio chargé (voir l’API binaire de chargement) « DurationSeconds » : nombre // Durée audio en secondes }
CapturedTime	CapturedTime		date-time	La valeur de point dans le temps a été capturée.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de ce LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de ce LocationApiModel.
Ville	City		string	Ville de LocationApiModel.
Nom de la région	RegionName		string	Nom de la région de LocationApiModel.
Code postal	PostalCode		string	Code postal de LocationApiModel.
Code du pays	CountryCode		string	Code ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	Sous-région de LocationApiModel.
SubRegionCode	SubRegionCode		string	Code de sous-région de LocationApiModel.
RegionCode	RegionCode		string	Code de région de LocationApiModel.
Légende	Caption	True	string
Valeur	Value			Valeur de UpdateFormFieldApiModel. Format de valeur de champ « NFC » : { « Type » : number, // 0 - Text « Payload » : object, // Doit être texte pour Type = 0 } Format de valeur de champ « Caméra » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’une image chargée (voir l’API binaire de chargement) « Remarque » : chaîne // Remarque pour l’image référencée } Format de valeur de champ « Signature » (référence binaire) : { « BinaryId » : chaîne // ID binaire d’une image chargée (voir l’API binaire de chargement) } Format de valeur de champ « Audio » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’un audio chargé (voir l’API binaire de chargement) « DurationSeconds » : nombre // Durée audio en secondes }
CapturedTime	CapturedTime		date-time	La valeur de point dans le temps a été capturée.
EmployeeNumber	EmployeeNumber	True	string	EmployeeNumber de l’utilisateur qui a créé ce NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Contenu d’étiquette pour StatusLabel associé à ce NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	Point dans le temps où cet état NewOrderStatusApiModel a été démarré.
Légende	Caption	True	string
Valeur	Value			Valeur de UpdateFormFieldApiModel. Format de valeur de champ « NFC » : { « Type » : number, // 0 - Text « Payload » : object, // Doit être texte pour Type = 0 } Format de valeur de champ « Caméra » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’une image chargée (voir l’API binaire de chargement) « Remarque » : chaîne // Remarque pour l’image référencée } Format de valeur de champ « Signature » (référence binaire) : { « BinaryId » : chaîne // ID binaire d’une image chargée (voir l’API binaire de chargement) } Format de valeur de champ « Audio » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’un audio chargé (voir l’API binaire de chargement) « DurationSeconds » : nombre // Durée audio en secondes }
CapturedTime	CapturedTime		date-time	La valeur de point dans le temps a été capturée.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de ce LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de ce LocationApiModel.
Ville	City		string	Ville de LocationApiModel.
Nom de la région	RegionName		string	Nom de la région de LocationApiModel.
Code postal	PostalCode		string	Code postal de LocationApiModel.
Code du pays	CountryCode		string	Code ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	Sous-région de LocationApiModel.
SubRegionCode	SubRegionCode		string	Code de sous-région de LocationApiModel.
RegionCode	RegionCode		string	Code de région de LocationApiModel.
Légende	Caption	True	string
Valeur	Value			Valeur de UpdateFormFieldApiModel. Format de valeur de champ « NFC » : { « Type » : number, // 0 - Text « Payload » : object, // Doit être texte pour Type = 0 } Format de valeur de champ « Caméra » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’une image chargée (voir l’API binaire de chargement) « Remarque » : chaîne // Remarque pour l’image référencée } Format de valeur de champ « Signature » (référence binaire) : { « BinaryId » : chaîne // ID binaire d’une image chargée (voir l’API binaire de chargement) } Format de valeur de champ « Audio » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’un audio chargé (voir l’API binaire de chargement) « DurationSeconds » : nombre // Durée audio en secondes }
CapturedTime	CapturedTime		date-time	La valeur de point dans le temps a été capturée.
FieldIndex	FieldIndex		integer	Index de champ.
Valeur	Value			Valeur du champ.
géocode	geocode		boolean	Doit être géocodée ou non.
use-external-id	use-external-id		boolean	Utilisez l’ID externe ou non.

Retours

Corps: CustomerAPI.Models.ReturnIdApiModel

Mettre à jour une limite géographique existante

ID d’opération :: GeofenceController_UpdateGeofence

Met à jour une limite géographique existante par son ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	integer	ID de limite géographique.
GroupNames	GroupNames		array of string	GroupPaths du GeofenceUpdateApiModel.
Latitude	Latitude		double
Longitude	Longitude		double
Nom	Name		string	Nom de GeofenceApiModelBase.
Type	Type		string	Type de GeofenceApiModel.
Forme	Shape		integer	Forme : 0 pour le cercle et 1 pour le polygone.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de ce LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de ce LocationApiModel.
Ville	City		string	Ville de LocationApiModel.
Nom de la région	RegionName		string	Nom de la région de LocationApiModel.
Code postal	PostalCode		string	Code postal de LocationApiModel.
Code du pays	CountryCode		string	Code ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	Sous-région de LocationApiModel.
SubRegionCode	SubRegionCode		string	Code de sous-région de LocationApiModel.
RegionCode	RegionCode		string	Code de région de LocationApiModel.
Radius	Radius		double	Rayon de GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress		boolean	UseGeofenceAddress de GeofenceApiModel.
useMetric	useMetric		boolean	Utilisez le système de métriques ou non.
géocode	geocode		boolean	Doit être géocodée ou non.

Retours

Corps: CustomerAPI.Models.ReturnIdApiModel

Mettre à jour une partie d’un utilisateur

ID d’opération :: UserController_PartialUpdate

Met à jour une partie des propriétés de l’utilisateur.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	L’ID externe ou interne dépend de la valeur du paramètre use-external-id.
			object
use-external-id	use-external-id		boolean	Utilisez l’ID externe ou non.

Retours

Corps: CustomerAPI.Models.ReturnIdApiModel

Mise à jour partielle d’un véhicule

ID d’opération :: VehicleController_PartialUpdateVehicle

Mise à jour partielle d’un véhicule par ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	L’ID externe ou interne dépend de la valeur du paramètre use-external-id.
			object
use-external-id	use-external-id		boolean	Utilisez l’ID externe ou non.

Retours

Corps: CustomerAPI.Models.ReturnIdApiModel

Obtenir des données de liste personnalisées par CustomListID

ID d’opération :: CustomListController_GetCustomList

Récupère tous les enregistrements de données d’une seule liste personnalisée à l’aide de CustomListID.

Les résultats sont triés par colonne et la pagination est prise en charge.

Erreurs:

404 : il n’existe aucune liste personnalisée pour customListId fourni.

Paramètres

Nom	Clé	Obligatoire	Type	Description
customListId	customListId	True	integer	ID de liste personnalisé.
pageNumber	pageNumber		integer	Numéro de page de démarrage.
pageSize	pageSize		integer	Taille de la page.

Retours

Conteneur pour le tableau de données de colonne de liste personnalisée.

Corps: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Obtenir des définitions de liste personnalisées

ID d’opération :: CustomListController_Get

Récupère une liste de définitions de liste personnalisée. La liste de définitions contient l’ID customListID, le nom et la version de toutes les listes personnalisées existantes.

Retours

response: array of CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Obtenir des entrées de données GPS

ID d’opération :: TrackingController_GetGpsData

Récupère les entrées de données GPS pour une plage de dates spécifiée. Retourne également un jeton de continuation et un lien pour obtenir la partie de données suivante. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page.

Les positions des utilisateurs/véhicules supprimés ne sont pas retournées. Toutefois, si l’utilisateur/véhicule existait quand des données ont été demandées et ont été supprimées ultérieurement, les données de l’utilisateur/véhicule demandé par un jeton de continuation sont retournées.

Les résultats sont automatiquement triés par UtcTime et dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.

Paramètres

Nom	Clé	Type	Description
fromDate	fromDate	date-time	Début de la plage de dates. Recommandation : Utilisez des plages de dates volumineuses (>=4 heures) au lieu de petites plages de dates.
toDate	toDate	date-time	Fin de la plage de dates. Recommandation : Utilisez des plages de dates volumineuses (>=4 heures) au lieu de petites plages de dates.
numéroEmployé	employeeNumber	string	Numéro d’employé.
vin	vin	string	Numéro DE VIN du véhicule.
useMetric	useMetric	boolean	Utilisez le système de métriques ou non.
token	token	string	Jeton de continuation retourné par l’appel initial et doit être utilisé dans l’appel successif.

Retours

Corps: CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Obtenir la liste des abonnements

ID d’opération :: TrackingController_GetSubscriptions

Récupère une liste d’abonnements web hook. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page. Les résultats sont automatiquement triés par SubscriptionId et dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.

Retours

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Obtenir la liste des abonnements de hook web d’événements

ID d’opération :: EventController_GetSubscriptions

Récupère une liste d’abonnements de hook web d’événements. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page. Les résultats sont automatiquement triés par SubscriptionId et dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.

Retours

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Obtenir la liste des champs de liste personnalisés par CustomListID

ID d’opération :: CustomListController_GetById

Récupère une liste de champs pour une seule liste personnalisée, à l’aide de CustomListID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
customListId	customListId	True	integer	ID de liste personnalisé.

Retours

Modèle de liste personnalisé.

Corps: CustomerAPI.Models.CustomLists.CustomListApiModel

Obtenir la liste des clients

ID d’opération :: ClientController_GetClients

Récupère une liste de clients. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page. Les résultats sont automatiquement triés par nom et dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pageNumber	pageNumber		integer	Numéro de page de démarrage.
pageSize	pageSize		integer	Taille de la page.

Retours

response: array of CustomerAPI.Models.Client.ReadClientApiModel

Obtenir la liste des commandes

ID d’opération :: OrderController_GetOrders

Récupère une liste de commandes à l’aide des filtres des paramètres de requête indiqués ci-dessous. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page. Les résultats sont automatiquement triés par Client.Name et dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.

Paramètres

Nom	Clé	Obligatoire	Type	Description
dueDateFrom	dueDateFrom	True	date-time	Filtrez la date de début de la date d’échéance.
dueDateTo	dueDateTo	True	date-time	Filtrer par date de fin de date d’échéance.
numéroEmployé	employeeNumber		string	Filtrez par numéro d’employé.
pageNumber	pageNumber		integer	Numéro de page de démarrage (par défaut 1).
pageSize	pageSize		integer	Taille de page (par défaut 500).

Retours

response: array of CustomerAPI.Models.Order.OrderListItemApiModel

Obtenir la liste des définitions d’événements personnalisées

ID d’opération :: EventController_GetList

Récupère une liste de définitions d’événements personnalisées.

Retours

response: array of CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Obtenir la liste des entrées de chronométrage

ID d’opération :: TimekeepingController_GetTimekeepingDataList

Récupère une liste d’entrées de chronométrage en fonction de la plage de dates. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page. Les résultats sont automatiquement triés par ClockInTime, puis par TimekeepingStatusId et dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.

Paramètres

Nom	Clé	Obligatoire	Type	Description
fromDate	fromDate	True	date-time	Date de début.
toDate	toDate	True	date-time	Date de fin.
numéroEmployé	employeeNumber		string	Numéro d’employé.
approuvé	approved		boolean	Filtre pour l’entrée approuvée uniquement.
closedOnly	closedOnly		boolean	Filtrez uniquement pour l’entrée fermée.
excludeFormData	excludeFormData		boolean	Filtre pour exclure les données de formulaire.
pageNumber	pageNumber		integer	Numéro de page de démarrage (par défaut 1).
pageSize	pageSize		integer	Taille de page (par défaut 1000).

Retours

response: array of CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Obtenir la liste des formulaires

ID d’opération :: FormController_GetFormsAsync

Récupère une liste de formulaires à l’aide de l’un des filtres des paramètres de requête indiqués ci-dessous. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page. Les résultats sont triés automatiquement par SubmittedTime et dans l’ordre décroissant. Les paramètres de tri ne sont pas configurables.

Paramètres

Nom	Clé	Obligatoire	Type	Description
submittedStartDate	submittedStartDate	True	date-time	Date de début du formulaire soumis.
submittedEndDate	submittedEndDate	True	date-time	Date de fin du formulaire soumis.
apiModuleId	apiModuleId		string	ID du module de formulaire.
numéroEmployé	employeeNumber		string	Numéro d’employé.
reviewed	reviewed		boolean	Récupère uniquement les formulaires examinés ou non. La valeur par défaut est Null pour tous.
pageNumber	pageNumber		integer	Numéro de page de départ. La valeur par défaut est 1.
pageSize	pageSize		integer	Taille de la page. La valeur par défaut est 1000.

Retours

response: array of CustomerAPI.Models.Forms.StandaloneFormApiModel

Obtenir la liste des limites géographiques

ID d’opération :: GeofenceController_GetGeofences

Récupère une liste de limites géographiques. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page, ainsi que si les coordonnées de limite géographique sont métriques. Les résultats sont automatiquement triés par nom et dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.

Paramètres

Nom	Clé	Type	Description
pageNumber	pageNumber	integer	Numéro de page de démarrage. La valeur par défaut est 1.
pageSize	pageSize	integer	Taille de la page. La valeur par défaut est 500.
useMetric	useMetric	boolean	Utilisez le système de métriques ou non.

Retours

response: array of CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Obtenir la liste des utilisateurs

ID d’opération :: UserController_GetUsers

Récupère une liste d’utilisateurs. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page. Les résultats sont automatiquement triés par UserId et dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pageNumber	pageNumber		integer	Numéro de page de démarrage. La valeur par défaut est 1.
pageSize	pageSize		integer	Taille de la page. La valeur par défaut est 500.

Retours

response: array of CustomerAPI.Models.User.ReadUserListItemApiModel

Obtenir la liste des voyages

ID d’opération :: TrackingController_GetTrips

Récupère une liste de voyages pour une période spécifique. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page. Les résultats sont automatiquement triés par StartUtcTIme et dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.

Paramètres

Nom	Clé	Obligatoire	Type	Description
fromDate	fromDate	True	date-time	Début de la plage de dates. Recommandation : Utilisez des plages de dates volumineuses (>=4 heures) au lieu de petites plages de dates.
toDate	toDate	True	date-time	Fin de la plage de dates. Recommandation : Utilisez des plages de dates volumineuses (>=4 heures) au lieu de petites plages de dates.
numéroEmployé	employeeNumber		string	Numéro d’employé.
vin	vin		string	Numéro DE VIN du véhicule.
pageNumber	pageNumber		integer	Numéro de page de démarrage. La valeur par défaut est 1.
pageSize	pageSize		integer	Taille de la page. La valeur par défaut est 1000.
useMetric	useMetric		boolean	Utilisez le système de métriques ou non.

Retours

response: array of CustomerAPI.Models.Tracking.TripApiModel

Obtenir la liste des événements

ID d’opération :: EventController_GetEvents

Récupère une liste d’événements pour une période spécifique. Vous pouvez spécifier le nombre de pages retournées et le nombre d’éléments par page.

Filtrez par type d’événement pour obtenir des événements spécifiques. Les événements de véhicule peuvent être retournés pour un employé si l’employé est associé au véhicule.

Paramètres

Nom	Clé	Obligatoire	Type	Description
fromDate	fromDate	True	date-time	Début de la plage de dates.
toDate	toDate	True	date-time	Fin de la plage de dates.
numéroEmployé	employeeNumber		string	Numéro d’employé.
vehicleNumber	vehicleNumber		string	Numéro de véhicule.
pageNumber	pageNumber		integer	Numéro de page de démarrage.
pageSize	pageSize		integer	Taille de la page.
eventType	eventType		integer	Filtrez par type d’événement. le numéro d’employé est spécifié : UserEvents(0) : seuls les événements utilisateur. VehicleEvents(1) : seuls les événements de véhicule, y compris les événements de capteur. ExternalEvents(2) : seuls les événements externes. le numéro de véhicule est spécifié : UserEvents(0) - N/A. VehicleEvents(1) : seuls les événements de véhicule, y compris les événements de capteur. ExternalEvents(2) : seuls les événements externes. Aucun numéro d’employé ni numéro de véhicule n’est spécifié : UserEvents(0) : seuls les événements utilisateur. VehicleEvents(1) : seuls les événements de véhicule, y compris les événements de capteur. ExternalEvents(2) : seuls les événements externes.

Retours

response: array of CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Obtenir un client

ID d’opération :: ClientController_Get

Récupère un objet client par son ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	ID client.
use-external-id	use-external-id		boolean	Utilisez l’ID externe ou non.

Retours

Corps: CustomerAPI.Models.Client.ReadClientApiModel

Obtenir un enregistrement unique à partir d’une liste personnalisée

ID d’opération :: CustomListController_GetSingleRecord

Récupère un enregistrement de données de liste personnalisé unique trouvé par CustomListId et une valeur de colonne unique.

Erreurs:

404 : il n’existe aucun enregistrement de liste personnalisé pour la valeur de colonne personnalisée fournie et customListId et une valeur de colonne unique

Paramètres

Nom	Clé	Obligatoire	Type	Description
customListId	customListId	True	integer	ID de liste personnalisé.
pièce d'identité	id	True	string	Valeur unique.

Retours

Conteneur pour le tableau de données de colonne de liste personnalisée.

Corps: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Obtenir un formulaire

ID d’opération :: FormController_GetFormAsync

Récupère un formulaire par son ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	integer	ID de formulaire.

Retours

Corps: CustomerAPI.Models.Forms.StandaloneFormApiModel

Obtenir un utilisateur

ID d’opération :: UserController_Get

Obtient un utilisateur par son ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	L’ID externe ou interne dépend de la valeur du paramètre use-external-id.
use-external-id	use-external-id		boolean	Utilisez l’ID externe ou non.

Retours

Corps: CustomerAPI.Models.User.ReadUserApiModel

Obtenir un véhicule par ID

ID d’opération :: VehicleController_GetVehicle

Récupère un véhicule unique par ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	L’ID externe ou interne dépend de la valeur du paramètre use-external-id.
use-external-id	use-external-id		boolean	Utilisez l’ID externe ou non.

Retours

Modèle de données de véhicule.

Corps: CustomerAPI.Models.Vehicles.VehicleReadApi

Obtenir une commande

ID d’opération :: OrderController_GetOrder

Obtient une commande existante par son ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	L’ID externe ou interne dépend de la valeur du paramètre use-external-id.
include-status-history	include-status-history		string	Si la valeur est true, la réponse contient tous les données d’historique d’état et de formulaire pour cet ordre.
use-external-id	use-external-id		boolean	Utilisez l’ID externe ou non.

Retours

Corps: CustomerAPI.Models.Order.OrderApiModel

Obtenir une définition d’événement personnalisée par ID

ID d’opération :: EventController_Get

Récupère une définition d’événement personnalisée unique par ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	ID de définition d’événement.

Retours

Modèle de définition d’événement personnalisé.

Corps: CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Obtenir une entrée de chronométrage

ID d’opération :: TimekeepingController_GetTimekeepingEntryAsync

Récupère une entrée par son ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	ID de l’enregistrement.

Retours

Corps: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Obtenir une limite géographique

ID d’opération :: GeofenceController_GetGeofence

Récupère une limite géographique par son ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	integer	ID de limite géographique.
useMetric	useMetric		boolean	Utilisez le système de métriques ou non.

Retours

Corps: CustomerAPI.Models.Geofence.GeofenceApiModel

Obtenir une liste de véhicules

ID d’opération :: VehicleController_GetVehicles

Récupère une liste de véhicules.

Paramètres

Nom	Clé	Type	Description
pageNumber	pageNumber	integer	Numéro de page.
pageSize	pageSize	integer	Nombre maximal d’éléments d’une page. Valeur par défaut = 1 000. Valeur maximale = 2000.
activeOnly	activeOnly	boolean	si la valeur est true : retourne uniquement les véhicules actifs. Valeur par défaut = false.

Retours

response: array of CustomerAPI.Models.Vehicles.VehicleReadApi

Obtenir une version mineure

ID d’opération :: VersionController_Get

Retourne la version mineure actuelle de l’API.

Rappel de hook web avec flux d’événements

ID d’opération :: EventController_subscribe_callback

Cet exemple de méthode est utilisé par les événements/s’abonnent pour publier le flux de données d’événement à l’aide de l’URL fournie par le client.

Paramètres

Nom	Clé	Type	Description
Id	Id	string	URL contenant l’adresse du WebHookSubscriptionParamsApiModel.
EventType	EventType	integer
EventCode	EventCode	string
EventTime	EventTime	date-time	Format ISO avec Local et Offset.
DeviceId	DeviceId	string	GpsDeviceDto Id associé à l’abonnement.
Type de périphérique	DeviceType	integer	GpsDeviceDto type : Handset (0), CalAmp (1), Geotab (2), Xirgo (3).
UserId	UserId	integer	Identifiant.
VehicleId	VehicleId	integer	ID du véhicule.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Indique si un utilisateur est lié au véhicule.
Lat	Lat	double	Latitude.
Lon	Lon	double	Longitude.
CustomEventDefinitionId	CustomEventDefinitionId	string
EventParams	EventParams	object	Paramètres d’événement.

Retours

response: object

Rappel webhook avec flux de données GPS

ID d’opération :: TrackingController_subscribe_callback

Cet exemple de méthode est utilisé par gpsdata/s’abonner pour publier le flux de données à l’aide de l’URL fournie par le client.

Paramètres

Nom	Clé	Type	Description
Id	Id	string	URL contenant l’adresse du WebHookSubscriptionParamsApiModel.
DeviceId	DeviceId	string	GpsDeviceDto Id associé à l’abonnement.
Type de périphérique	DeviceType	integer	GpsDeviceDto type : Handset(0), CalAmp(1), Geotab (2), Xirgo (3).
Timestamp	Timestamp	date-time	Format ISO avec Local et Offset.
CompanyId	CompanyId	integer	ID d’entreprise.
UserId	UserId	integer	Identifiant.
VehicleId	VehicleId	integer	ID du véhicule.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Indique si un utilisateur est lié au véhicule.
LocationProvider	LocationProvider	string	Nom du fournisseur d’emplacement.
Lat	Lat	double	Latitude.
Lon	Lon	double	Longitude.
AccuracyFt	AccuracyFt	double	Précision de position (pieds).
AltitudeFt	AltitudeFt	double	Altitude (pieds).
Heading	Heading	integer	Direction de boussole en degrés.
SpeedMph	SpeedMph	double	Vitesse de mouvement (Mph).
BatteryStatus	BatteryStatus	integer	État de la batterie : Pas de charge(0), Chargement(1).
BatteryLevel	BatteryLevel	integer	Niveau de la batterie en pourcentage.
ActivityState	ActivityState	integer	État de l’activité : Séjour(1), Modving(2).
IsNetworkConnected	IsNetworkConnected	boolean	L’appareil est-il connecté au réseau pour le moment.
Rssi	Rssi	integer	Indicateur de force du signal reçu.
DOdoMl	DOdoMl	double	GpsDeviceDto Odometer (Miles).
VOdoMl	VOdoMl	double	Odomètre de véhicule (Miles).

Retours

response: object

Réinitialise l’état de l’abonnement

ID d’opération :: TrackingController_ResetSubscriptionHealthStatus

Remplace l’état de l’abonnement par l’état = 1 (« En cours d’exécution »).

Paramètres

Nom	Clé	Obligatoire	Type	Description
subscriptionId	subscriptionId	True	integer	ID d’abonnement.

Réinitialise l’état de l’abonnement web hook d’événement

ID d’opération :: EventController_ResetSubscriptionHealthStatus

Remplace l’état de l’abonnement par l’état = 1 (« En cours d’exécution »).

Paramètres

Nom	Clé	Obligatoire	Type	Description
subscriptionId	subscriptionId	True	integer	ID d’abonnement.

Se désabonner du web hook d’événements

ID d’opération :: EventController_RemoveEventDataFeedSubscription

Supprime un abonnement de hook web d’événements par son ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
subscriptionId	subscriptionId	True	string	ID d’abonnement à supprimer.

Supprimer un client

ID d’opération :: ClientController_Delete

Supprime un client existant par son ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	ID client.
use-external-id	use-external-id		boolean	Utilisez l’ID externe ou non.

Supprimer un enregistrement de liste personnalisé

ID d’opération :: CustomListController_DeleteRecord

Supprime l’enregistrement existant dans la liste personnalisée par son customListId et son ID.

id : valeur unique de l’enregistrement de liste personnalisé.

Erreurs:

404 - customListId ou ID introuvable.

Paramètres

Nom	Clé	Obligatoire	Type	Description
customListId	customListId	True	integer	ID de liste personnalisé.
pièce d'identité	id	True	string	Valeur unique.

Supprimer un véhicule

ID d’opération :: VehicleController_Delete

Supprimez un véhicule par ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	L’ID externe ou interne dépend de la valeur du paramètre use-external-id.
use-external-id	use-external-id		boolean	Utilisez l’ID externe ou non.

Supprimer une définition d’événement personnalisée

ID d’opération :: EventController_Delete

Supprime une définition d’événement personnalisée.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	ID de définition d’événement.

Supprimer une limite géographique

ID d’opération :: GeofenceController_DeleteGeofence

Supprime une limite géographique existante par son ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	integer	ID de limite géographique.

S’abonner au web hook d’événements

ID d’opération :: EventController_SubscribeToEventDataFeed

Ajoute un nouvel abonnement de hook web d’événements. Les hooks web vous permettent de recevoir des notifications automatiques sur les événements d’entreprise se produisant sur une URL spécifiée.

Paramètres

Nom	Clé	Obligatoire	Type	Description
URL	Url		string	URL contenant l’adresse du WebHookSubscriptionParamsApiModel.
SecurityToken	SecurityToken		string	Jeton de sécurité associé à ce WebHookSubscriptionParamsApiModel.

Retours

Corps: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

État de l’ordre de mise à jour

ID d’opération :: OrderController_ChangeStatus

Modifie un état de commande existant.

Paramètres

Nom	Clé	Obligatoire	Type	Description
pièce d'identité	id	True	string	L’ID externe ou interne dépend de la valeur du paramètre use-external-id.
EmployeeNumber	EmployeeNumber	True	string	EmployeeNumber de l’utilisateur qui a créé ce NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Contenu d’étiquette pour StatusLabel associé à ce NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	Point dans le temps où cet état NewOrderStatusApiModel a été démarré.
Légende	Caption	True	string
Valeur	Value			Valeur de UpdateFormFieldApiModel. Format de valeur de champ « NFC » : { « Type » : number, // 0 - Text « Payload » : object, // Doit être texte pour Type = 0 } Format de valeur de champ « Caméra » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’une image chargée (voir l’API binaire de chargement) « Remarque » : chaîne // Remarque pour l’image référencée } Format de valeur de champ « Signature » (référence binaire) : { « BinaryId » : chaîne // ID binaire d’une image chargée (voir l’API binaire de chargement) } Format de valeur de champ « Audio » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’un audio chargé (voir l’API binaire de chargement) « DurationSeconds » : nombre // Durée audio en secondes }
CapturedTime	CapturedTime		date-time	La valeur de point dans le temps a été capturée.
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 de ce LocationApiModel.
AddressLine2	AddressLine2		string	AddressLine2 de ce LocationApiModel.
Ville	City		string	Ville de LocationApiModel.
Nom de la région	RegionName		string	Nom de la région de LocationApiModel.
Code postal	PostalCode		string	Code postal de LocationApiModel.
Code du pays	CountryCode		string	Code ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	Sous-région de LocationApiModel.
SubRegionCode	SubRegionCode		string	Code de sous-région de LocationApiModel.
RegionCode	RegionCode		string	Code de région de LocationApiModel.
Légende	Caption	True	string
Valeur	Value			Valeur de UpdateFormFieldApiModel. Format de valeur de champ « NFC » : { « Type » : number, // 0 - Text « Payload » : object, // Doit être texte pour Type = 0 } Format de valeur de champ « Caméra » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’une image chargée (voir l’API binaire de chargement) « Remarque » : chaîne // Remarque pour l’image référencée } Format de valeur de champ « Signature » (référence binaire) : { « BinaryId » : chaîne // ID binaire d’une image chargée (voir l’API binaire de chargement) } Format de valeur de champ « Audio » (référence binaire) : { « BinaryId » : chaîne, // ID binaire d’un audio chargé (voir l’API binaire de chargement) « DurationSeconds » : nombre // Durée audio en secondes }
CapturedTime	CapturedTime		date-time	La valeur de point dans le temps a été capturée.
use-external-id	use-external-id		boolean	Utilisez l’ID externe ou non.

Retours

Corps: CustomerAPI.Models.ReturnIdApiModel

Déclencheurs

Sondage commandes	Le point de terminaison d’interrogation de l’API Orders permet à votre application d’interroger et de traiter continuellement les modifications récentes apportées aux commandes. Intégration: Ce point de terminaison est conçu pour fonctionner hors de la boîte de dialogue avec Microsoft Flow comme intégration de déclencheur d’interrogation. Vous pouvez également développer votre propre intégration personnalisée à l’aide de n’importe quel langage. Utilisation : Dans un scénario classique, la première requête adressée à ce point de terminaison ne doit pas fournir de paramètres. Il existe deux (2) réponses réussies possibles : Code de réponse HTTP 200 - Les commandes récemment modifiées existent ; le corps de la réponse affiche les données de commande. Code de réponse HTTP 202 - Aucune commande récemment modifiée n’existe ; le corps de la réponse est vide. Dans les deux cas, il existe deux (2) en-têtes importants dans la réponse : Emplacement : URL de la requête suivante. Retry-After : intervalle de temps recommandé en secondes pour la requête suivante. Par exemple, s’il existe des données à récupérer, l’en-tête Retry-After aura la valeur 1 ou 60. S’il n’existe aucune donnée à récupérer, la valeur de l’en-tête Retry-After est 300. Remarque : Il s’agit simplement de valeurs recommandées : votre application peut choisir d’interroger à une fréquence différente en fonction de vos besoins. Après la première requête, toutes les requêtes suivantes doivent utiliser l’URL fournie dans l’en-tête Emplacement de la réponse la plus récente. N’ajoutez pas d’autres paramètres à l’URL, car il contient déjà les paramètres nécessaires pour vous assurer que les modifications de commande ne sont pas manquantes dans la requête. Les résultats sont automatiquement triés par ModifiedUtc, puis par OrderId, dans l’ordre croissant. Les paramètres de tri ne sont pas configurables. Définition ModifiedUtc : balise de temps interne = heure de la dernière modification des données de commande.
Sondage de chronométrage	Le point de terminaison d’interrogation de l’API Timekeeping permet à votre application d’interroger et de traiter continuellement les entrées de conservation récemment envoyées. Intégration: Ce point de terminaison est conçu pour fonctionner hors de la boîte de dialogue avec Microsoft Flow comme intégration de déclencheur d’interrogation. Vous pouvez également développer votre propre intégration personnalisée à l’aide de n’importe quel langage. Utilisation : Dans un scénario classique, la première requête adressée à ce point de terminaison ne doit pas fournir de paramètres. Il existe deux (2) réponses réussies possibles : Code de réponse HTTP 200 - Les enregistrements de conservation récemment envoyés existent ; le corps de la réponse affiche les données d’entrée de temps. Code de réponse HTTP 202 - Aucun enregistrement récemment envoyé n’existe ; le corps de la réponse est vide. Dans les deux cas, il existe deux (2) en-têtes importants dans la réponse : Emplacement : URL de la requête suivante. Retry-After : intervalle de temps recommandé en secondes pour la requête suivante. Par exemple, s’il existe des données à récupérer, l’en-tête Retry-After aura la valeur 1 ou 60. S’il n’existe aucune donnée à récupérer, la valeur de l’en-tête Retry-After est 300. Remarque : Il s’agit simplement de valeurs recommandées : votre application peut choisir d’interroger à une fréquence différente en fonction de vos besoins. Après la première requête, toutes les requêtes suivantes doivent utiliser l’URL fournie dans l’en-tête Emplacement de la réponse la plus récente. N’ajoutez pas d’autres paramètres à l’URL, car il contient déjà ceux nécessaires pour garantir que les entrées de conservation de temps ne sont pas manquantes dans la requête. Les résultats sont automatiquement triés par ModifiedUtc, puis par TimekeepingStatusId, puis dans l’ordre croissant. Les paramètres de tri ne sont pas configurables. Définition ModifiedUtc : balise d’heure interne = heure de la dernière modification de l’état de l’horloge.
Sondage de données de formulaire	Le point de terminaison d’interrogation de l’API Forms permet à votre application d’interroger et de traiter continuellement les formulaires autonomes récemment envoyés. Intégration: Ce point de terminaison est conçu pour fonctionner hors de la boîte de dialogue avec Microsoft Flow comme intégration de déclencheur d’interrogation. Vous pouvez également développer votre propre intégration personnalisée à l’aide de n’importe quel langage. Utilisation : Dans un scénario classique, la première requête adressée à ce point de terminaison ne doit pas fournir de paramètres. Il existe deux (2) réponses réussies possibles : Code de réponse HTTP 200 - Les enregistrements de formulaire récemment envoyés existent ; le corps de la réponse affiche les données de formulaire. Code de réponse HTTP 202 - Aucun enregistrement récemment envoyé n’existe ; le corps de la réponse est vide. Dans les deux cas, il existe deux (2) en-têtes importants dans la réponse : Emplacement : URL de la requête suivante. Retry-After : intervalle de temps recommandé en secondes pour la requête suivante. Par exemple, s’il existe des données à récupérer, l’en-tête Retry-After aura la valeur 1 ou 60. S’il n’existe aucune donnée à récupérer, la valeur de l’en-tête Retry-After est 300. Remarque : Il s’agit simplement de valeurs recommandées : votre application peut choisir d’interroger à une fréquence différente en fonction de vos besoins. Après la première requête, toutes les requêtes suivantes doivent utiliser l’URL fournie dans l’en-tête Emplacement de la réponse la plus récente. N’ajoutez pas d’autres paramètres à l’URL, car il contient déjà les paramètres nécessaires pour vous assurer que les formulaires ne sont pas manquants dans la requête. Les résultats sont automatiquement triés par ModifiedUtc, puis par FormHeaderId, dans l’ordre croissant. Les paramètres de tri ne sont pas configurables. Définition ModifiedUtc : balise de temps interne = heure de la dernière modification des données de formulaire.
Sondage des états des commandes	Le point de terminaison d’interrogation de l’API Order Statuses permet à votre application d’interroger et de traiter continuellement les modifications récentes apportées aux commandes. Intégration: Ce point de terminaison est conçu pour fonctionner hors de la boîte de dialogue avec Microsoft Flow comme intégration de déclencheur d’interrogation. Vous pouvez également développer votre propre intégration personnalisée à l’aide de n’importe quel langage. Utilisation : Dans un scénario classique, la première requête adressée à ce point de terminaison ne doit pas fournir de paramètres. Il existe deux (2) réponses réussies possibles : Code de réponse HTTP 200 - Les enregistrements d’état de commande récemment modifiés existent ; le corps de la réponse affiche les données d’état de l’ordre Code de réponse HTTP 202 - Aucun enregistrement récemment envoyé n’existe ; le corps de la réponse est vide. Dans les deux cas, il existe deux (2) en-têtes importants dans la réponse : Emplacement : URL de la requête suivante. Retry-After : intervalle de temps recommandé en secondes pour la requête suivante. Par exemple, s’il existe des données à récupérer, l’en-tête Retry-After aura la valeur 1 ou 60. S’il n’existe aucune donnée à récupérer, la valeur de l’en-tête Retry-After est 300. Remarque : Il s’agit simplement de valeurs recommandées : votre application peut choisir d’interroger à une fréquence différente en fonction de vos besoins. Après la première requête, toutes les requêtes suivantes doivent utiliser l’URL fournie dans l’en-tête Emplacement de la réponse la plus récente. N’ajoutez pas d’autres paramètres à l’URL, car il contient déjà ceux nécessaires pour vous assurer que les états de commande ne sont pas manquants dans la requête. Les résultats sont triés par ModifiedUtc, puis par StatusId, dans l’ordre croissant. Les paramètres de tri ne sont pas configurables. Définition ModifiedUtc : balise de temps interne = heure de la dernière modification des données d’état de commande.

Sondage commandes

ID d’opération :: OrderController_Poll

Le point de terminaison d’interrogation de l’API Orders permet à votre application d’interroger et de traiter continuellement les modifications récentes apportées aux commandes.

Intégration:

Ce point de terminaison est conçu pour fonctionner hors de la boîte de dialogue avec Microsoft Flow comme intégration de déclencheur d’interrogation. Vous pouvez également développer votre propre intégration personnalisée à l’aide de n’importe quel langage.

Utilisation :

Dans un scénario classique, la première requête adressée à ce point de terminaison ne doit pas fournir de paramètres. Il existe deux (2) réponses réussies possibles :

Code de réponse HTTP 200 - Les commandes récemment modifiées existent ; le corps de la réponse affiche les données de commande.
Code de réponse HTTP 202 - Aucune commande récemment modifiée n’existe ; le corps de la réponse est vide.

Dans les deux cas, il existe deux (2) en-têtes importants dans la réponse :

Emplacement : URL de la requête suivante.
Retry-After : intervalle de temps recommandé en secondes pour la requête suivante. Par exemple, s’il existe des données à récupérer, l’en-tête Retry-After aura la valeur 1 ou 60. S’il n’existe aucune donnée à récupérer, la valeur de l’en-tête Retry-After est 300.

Remarque : Il s’agit simplement de valeurs recommandées : votre application peut choisir d’interroger à une fréquence différente en fonction de vos besoins. Après la première requête, toutes les requêtes suivantes doivent utiliser l’URL fournie dans l’en-tête Emplacement de la réponse la plus récente. N’ajoutez pas d’autres paramètres à l’URL, car il contient déjà les paramètres nécessaires pour vous assurer que les modifications de commande ne sont pas manquantes dans la requête.

Les résultats sont automatiquement triés par ModifiedUtc, puis par OrderId, dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.

Définition ModifiedUtc : balise de temps interne = heure de la dernière modification des données de commande.

Paramètres

Nom	Clé	Obligatoire	Type	Description
excludeFormData	excludeFormData		boolean	Si la valeur est true, OrderFormFields est toujours un tableau vide.
excludeCustomFieldData	excludeCustomFieldData		boolean	Si la valeur est true, CustomFields ne sera pas retourné.

Retours

Corps: CustomerAPI.Models.Order.OrderHeaderApiModel

Sondage de chronométrage

ID d’opération :: TimekeepingController_Poll

Le point de terminaison d’interrogation de l’API Timekeeping permet à votre application d’interroger et de traiter continuellement les entrées de conservation récemment envoyées.

Intégration:

Utilisation :

Dans un scénario classique, la première requête adressée à ce point de terminaison ne doit pas fournir de paramètres. Il existe deux (2) réponses réussies possibles :

Code de réponse HTTP 200 - Les enregistrements de conservation récemment envoyés existent ; le corps de la réponse affiche les données d’entrée de temps.
Code de réponse HTTP 202 - Aucun enregistrement récemment envoyé n’existe ; le corps de la réponse est vide.

Dans les deux cas, il existe deux (2) en-têtes importants dans la réponse :

Emplacement : URL de la requête suivante.
Retry-After : intervalle de temps recommandé en secondes pour la requête suivante. Par exemple, s’il existe des données à récupérer, l’en-tête Retry-After aura la valeur 1 ou 60. S’il n’existe aucune donnée à récupérer, la valeur de l’en-tête Retry-After est 300.

Remarque : Il s’agit simplement de valeurs recommandées : votre application peut choisir d’interroger à une fréquence différente en fonction de vos besoins. Après la première requête, toutes les requêtes suivantes doivent utiliser l’URL fournie dans l’en-tête Emplacement de la réponse la plus récente. N’ajoutez pas d’autres paramètres à l’URL, car il contient déjà ceux nécessaires pour garantir que les entrées de conservation de temps ne sont pas manquantes dans la requête.

Les résultats sont automatiquement triés par ModifiedUtc, puis par TimekeepingStatusId, puis dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.

Définition ModifiedUtc : balise d’heure interne = heure de la dernière modification de l’état de l’horloge.

Paramètres

Nom	Clé	Obligatoire	Type	Description
excludeFormData	excludeFormData		boolean	Si la valeur est true, ClockInFormData et ClockOutFormData sont toujours null.

Retours

Corps: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Sondage de données de formulaire

ID d’opération :: FormController_Poll

Le point de terminaison d’interrogation de l’API Forms permet à votre application d’interroger et de traiter continuellement les formulaires autonomes récemment envoyés.

Intégration:

Utilisation :

Dans un scénario classique, la première requête adressée à ce point de terminaison ne doit pas fournir de paramètres. Il existe deux (2) réponses réussies possibles :

Code de réponse HTTP 200 - Les enregistrements de formulaire récemment envoyés existent ; le corps de la réponse affiche les données de formulaire.
Code de réponse HTTP 202 - Aucun enregistrement récemment envoyé n’existe ; le corps de la réponse est vide.

Dans les deux cas, il existe deux (2) en-têtes importants dans la réponse :

Emplacement : URL de la requête suivante.
Retry-After : intervalle de temps recommandé en secondes pour la requête suivante. Par exemple, s’il existe des données à récupérer, l’en-tête Retry-After aura la valeur 1 ou 60. S’il n’existe aucune donnée à récupérer, la valeur de l’en-tête Retry-After est 300.

Remarque : Il s’agit simplement de valeurs recommandées : votre application peut choisir d’interroger à une fréquence différente en fonction de vos besoins. Après la première requête, toutes les requêtes suivantes doivent utiliser l’URL fournie dans l’en-tête Emplacement de la réponse la plus récente. N’ajoutez pas d’autres paramètres à l’URL, car il contient déjà les paramètres nécessaires pour vous assurer que les formulaires ne sont pas manquants dans la requête.

Les résultats sont automatiquement triés par ModifiedUtc, puis par FormHeaderId, dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.

Définition ModifiedUtc : balise de temps interne = heure de la dernière modification des données de formulaire.

Retours

Corps: CustomerAPI.Models.Forms.StandaloneFormApiModel

Sondage des états des commandes

ID d’opération :: OrderController_StatusPoll

Le point de terminaison d’interrogation de l’API Order Statuses permet à votre application d’interroger et de traiter continuellement les modifications récentes apportées aux commandes.

Intégration:

Utilisation :

Dans un scénario classique, la première requête adressée à ce point de terminaison ne doit pas fournir de paramètres. Il existe deux (2) réponses réussies possibles :

Code de réponse HTTP 200 - Les enregistrements d’état de commande récemment modifiés existent ; le corps de la réponse affiche les données d’état de l’ordre
Code de réponse HTTP 202 - Aucun enregistrement récemment envoyé n’existe ; le corps de la réponse est vide.

Dans les deux cas, il existe deux (2) en-têtes importants dans la réponse :

Emplacement : URL de la requête suivante.
Retry-After : intervalle de temps recommandé en secondes pour la requête suivante. Par exemple, s’il existe des données à récupérer, l’en-tête Retry-After aura la valeur 1 ou 60. S’il n’existe aucune donnée à récupérer, la valeur de l’en-tête Retry-After est 300.

Remarque : Il s’agit simplement de valeurs recommandées : votre application peut choisir d’interroger à une fréquence différente en fonction de vos besoins. Après la première requête, toutes les requêtes suivantes doivent utiliser l’URL fournie dans l’en-tête Emplacement de la réponse la plus récente. N’ajoutez pas d’autres paramètres à l’URL, car il contient déjà ceux nécessaires pour vous assurer que les états de commande ne sont pas manquants dans la requête.

Les résultats sont triés par ModifiedUtc, puis par StatusId, dans l’ordre croissant. Les paramètres de tri ne sont pas configurables.

Définition ModifiedUtc : balise de temps interne = heure de la dernière modification des données d’état de commande.

Paramètres

Nom	Clé	Obligatoire	Type	Description
excludeFormData	excludeFormData		boolean	Si la valeur est true, FieldValues est toujours un tableau vide.

Retours

Corps: CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Définitions

CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Nom	Chemin d’accès	Type	Description
Id	Id	string

CustomerAPI.Models.Client.ReadClientApiModel

Nom	Chemin d’accès	Type	Description
Id	Id	integer	ID du client.
ExternalId	ExternalId	string	ID d’utilisation externe pour le client - Propriété d’extension d’API.
CreatedUtc	CreatedUtc	date-time	Point d’origine dans le temps où le client a été créé.
ModifiedUtc	ModifiedUtc	date-time	Dernier point dans le temps où le client a été mis à jour.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Nom	Name	string	Nom du client.
Adresse	Address	CustomerAPI.Models.LocationApiModel
Contact	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

Nom	Chemin d’accès	Type	Description
FieldIndex	FieldIndex	integer	Index de champ.
Légende	Caption	string	Légende de champ.
Type de données	DataType	integer	Type de données de champ.
DateTimeFormat	DateTimeFormat	integer	Format DateTime.
Valeur	Value		Valeur du champ.

CustomerAPI.Models.LocationApiModel

Nom	Chemin d’accès	Type	Description
LatLon	LatLon	System.Nullable_1_Actsoft.Core.Geo.LatLon_
AddressLine1	AddressLine1	string	AddressLine1 de ce LocationApiModel.
AddressLine2	AddressLine2	string	AddressLine2 de ce LocationApiModel.
Ville	City	string	Ville de LocationApiModel.
Nom de la région	RegionName	string	Nom de la région de LocationApiModel.
Code postal	PostalCode	string	Code postal de LocationApiModel.
Code du pays	CountryCode	string	Code ISO 3166-1 alpha-2.
SubRegionName	SubRegionName	string	Sous-région de LocationApiModel.
SubRegionCode	SubRegionCode	string	Code de sous-région de LocationApiModel.
RegionCode	RegionCode	string	Code de région de LocationApiModel.

CustomerAPI.Models.Client.ContactApiModel

Nom	Chemin d’accès	Type	Description
Nom	Name	string	Nom du ContactApiModel.
Numéro de téléphone	PhoneNumber	string	PhoneNumber du ContactApiModel.
Messagerie électronique	Email	string	E-mail du ContactApiModel.

System.Nullable_1_Actsoft.Core.Geo.LatLon_

Nom	Chemin d’accès	Type	Description
Latitude	Latitude	double
Longitude	Longitude	double

CustomerAPI.Models.ReturnIdApiModel

Nom	Chemin d’accès	Type	Description
Id	Id	integer	ID d’objet.

CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Définit le modèle d’API d’élément de liste de définition de liste personnalisé.

Nom	Chemin d’accès	Type	Description
CustomListId	CustomListId	integer	ID de liste personnalisé.
Nom	Name	string	Nom de liste personnalisé.
Version	Version	string	Version de liste personnalisée.

CustomerAPI.Models.CustomLists.CustomListApiModel

Modèle de liste personnalisé.

Nom	Chemin d’accès	Type	Description
CustomListId	CustomListId	integer	ID de liste personnalisé.
Nom	Name	string	Nom de liste personnalisé.
Version	Version	string	Version de liste personnalisée.
Definition	Definition	CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel	Définit le modèle d’API de définition de liste personnalisée.

CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

Définit le modèle d’API de définition de liste personnalisée.

Nom	Chemin d’accès	Type	Description
Columns	Columns	array of CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel	Colonnes de liste personnalisées.
UniqueColumnIndexIndex	UniqueColumnIndexIndex	integer	Index de colonne unique.

CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

Définit le modèle d’API de colonne de définition de liste personnalisée.

Nom	Chemin d’accès	Type	Description
Index	Index	integer	Index de colonne.
Type de données	DataType	integer	Type de données de colonne (Texte : 0, Numérique : 1, Date : 2, Heure : 3, DateTime : 4, E-mail : 5).
Nom	Name	string	Nom de colonne.

CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Conteneur pour le tableau de données de colonne de liste personnalisée.

Nom	Chemin d’accès	Type	Description
ColumnValues	ColumnValues	array of CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel	Tableau de colonnes avec des données.

CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

Ce modèle définit la valeur de colonne de liste personnalisée.

Nom	Chemin d’accès	Type	Description
ColumnIndex	ColumnIndex	integer	Index de colonne de liste personnalisée.
Légende	Caption	string	Légende de colonne de liste personnalisée.
Valeur	Value		Valeur de colonne de liste personnalisée.

CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Modèle de définition d’événement personnalisé.

Nom	Chemin d’accès	Type
Id	Id	string
Nom	Name	string
ReverseGeocode	ReverseGeocode	boolean
Paramètres	Parameters	array of CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

Nom	Chemin d’accès	Type
Nom	Name	string
Type	Type	integer
Légende	Caption	string
Obligatoire	Required	boolean

CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Nom	Chemin d’accès	Type	Description
EventId	EventId	integer	ID d’événement.
EventType	EventType	integer
EventCode	EventCode	string	Code d’événement.
EventTime	EventTime	date-time	Format ISO avec Local et Offset.
Utilisateur	User	CustomerAPI.Models.UserReferenceApiModel
Véhicule	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Si cette option est activée, le véhicule de l’événement a affecté l’utilisateur.
Emplacement	Location	CustomerAPI.Models.LocationApiModel
PrimaryGeofence	PrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
CustomEventDefinitionId	CustomEventDefinitionId	string	ID de définition d’événement externe.
EventParams	EventParams	object	Paramètres d’événement.

CustomerAPI.Models.UserReferenceApiModel

Nom	Chemin d’accès	Type	Description
UserId	UserId	integer	UserId de l’utilisateur.
Prénom	FirstName	string	Prénom de l’utilisateur.
nom de famille	LastName	string	Nom de l’utilisateur.
EmployeeNumber	EmployeeNumber	string	Numéro d’employé de l’utilisateur.
GroupName	GroupName	string	Nom du groupe affecté à l’utilisateur.

CustomerAPI.Models.ReadVehicleApiModel

Nom	Chemin d’accès	Type	Description
VehicleId	VehicleId	integer	ID de BaseVehicleApiModel.
Nom	Name	string	Nom de BaseVehicleApiModel.
VIN	VIN	string	Numéro d’identification du véhicule de baseVehicleApiModel.
Nom du dispositif	DeviceName	string	Nom de GpsDeviceDto associé à BaseVehicleApiModel.
Numéro de série	SerialNumber	string	SerialNumber de baseVehicleApiModel.
GroupName	GroupName	string	GroupName de BaseVehicleApiModel.

CustomerAPI.Models.Geofence.GeofenceInfoApiModel

Nom	Chemin d’accès	Type	Description
GeofenceId	GeofenceId	integer	ID de la limite géographique.
Nom	Name	string	Nom de la limite géographique.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Nom	Chemin d’accès	Type	Description
Identifiant d'abonnement (SubscriptionId)	SubscriptionId	string	ID du WebHookSubscriptionResultApiModel.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Nom	Chemin d’accès	Type	Description
Identifiant d'abonnement (SubscriptionId)	SubscriptionId	string
URL	Url	string
Statut	Status	integer	État de l’abonnement - (En cours d’exécution : 1, Arrêté : 2).

CustomerAPI.Models.Forms.StandaloneFormApiModel

Nom	Chemin d’accès	Type	Description
Id	Id	integer	ID associé à ce StandaloneFormApiModel - (commentaire hérité : FormHeaderId).
FormId	FormId	integer	ID du formulaire référencé par ce Modèle AutonomeFormApiModel.
FormName	FormName	string	Nom du formulaire référencé par ce Modèle AutonomeFormApiModel.
EntryNumber	EntryNumber	string	Numéro d’entrée de données de formulaire.
Revu	Reviewed	boolean	État de la révision de ce modèle AutonomeFormApiModel.
Utilisateur	User	CustomerAPI.Models.UserReferenceApiModel
SubmittedTime	SubmittedTime	date-time	Point dans le temps où le StandaloneFormApiModel a été envoyé.
StartTime	StartTime	date-time	Point dans le temps où le StandaloneFormApiModel a été démarré.
SubmittedLocation	SubmittedLocation	CustomerAPI.Models.LocationApiModel
FormData	FormData	array of CustomerAPI.Models.Forms.FormFieldDataApiModel	Liste des champs associés à ce StandaloneFormApiModel.
ApiModuleId	ApiModuleId	string	ID de l’ApiModule associé à ce ModèleApiModel autonome.
SharedUrl	SharedUrl	string	URL partagée de ce modèle AutonomeFormApiModel.
ReviewedByUser	ReviewedByUser	CustomerAPI.Models.UserReferenceApiModel
RévisionByTime	ReviewedByTime	date-time	Heure de la révision du formulaire

CustomerAPI.Models.Forms.FormFieldDataApiModel

Nom	Chemin d’accès	Type	Description
Répétables	Repeatables	array of array
items	Repeatables	array of CustomerAPI.Models.Forms.FormFieldDataBaseApiModel
Id	Id	string	ID de FormFieldDataApiModel.
Valeur	Value		Valeur de FormFieldDataApiModel.
DisplayValue	DisplayValue		DisplayValue de FormFieldDataApiModel.
CapturedTime	CapturedTime	date-time	La valeur de point dans le temps a été capturée de FormFieldDataApiModel.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Légende	Caption	string	Contenu de légende du FormFieldDataApiModel.
ApiFieldId	ApiFieldId	string	ID de l’ApiField du FormFieldDataApiModel.

CustomerAPI.Models.Forms.FormFieldDataBaseApiModel

Nom	Chemin d’accès	Type	Description
Id	Id	string	ID de FormFieldDataApiModel.
Valeur	Value		Valeur de FormFieldDataApiModel.
DisplayValue	DisplayValue		DisplayValue de FormFieldDataApiModel.
CapturedTime	CapturedTime	date-time	La valeur de point dans le temps a été capturée de FormFieldDataApiModel.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Légende	Caption	string	Contenu de légende du FormFieldDataApiModel.
ApiFieldId	ApiFieldId	string	ID de l’ApiField du FormFieldDataApiModel.

CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Nom	Chemin d’accès	Type	Description
GeofenceId	GeofenceId	integer	GeofenceId du GeofenceApiModel.
CreatedUtc	CreatedUtc	date-time	CreatedUtc de GeofenceApiModel.
ModifiedUtc	ModifiedUtc	date-time	ModifiedUtc du GeofenceApiModel.
GroupNames	GroupNames	array of string	GroupPaths du GeofenceApiModel.
Nom	Name	string	Nom de GeofenceApiModelBase.
Type	Type	string	Type de GeofenceApiModel.
Forme	Shape	integer	Forme : 0 pour le cercle et 1 pour le polygone.
Adresse	Address	CustomerAPI.Models.LocationApiModel
Radius	Radius	double	Rayon de GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress de GeofenceApiModel.

Actsoft.Core.Geo.LatLon

Nom	Chemin d’accès	Type	Description
Latitude	Latitude	double
Longitude	Longitude	double

CustomerAPI.Models.Geofence.GeofenceApiModel

Nom	Chemin d’accès	Type	Description
GeofenceId	GeofenceId	integer	GeofenceId du GeofenceApiModel.
CreatedUtc	CreatedUtc	date-time	CreatedUtc de GeofenceApiModel.
ModifiedUtc	ModifiedUtc	date-time	ModifiedUtc du GeofenceApiModel.
GroupNames	GroupNames	array of string	GroupPaths du GeofenceApiModel.
Polygon	Polygon	array of Actsoft.Core.Geo.LatLon	Points de polygones. Doit être rempli lorsque la forme est égale à 1.
Nom	Name	string	Nom de GeofenceApiModelBase.
Type	Type	string	Type de GeofenceApiModel.
Forme	Shape	integer	Forme : 0 pour le cercle et 1 pour le polygone.
Adresse	Address	CustomerAPI.Models.LocationApiModel
Radius	Radius	double	Rayon de GeofenceApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress de GeofenceApiModel.

CustomerAPI.Models.Order.OrderListItemApiModel

Nom	Chemin d’accès	Type	Description
Identifiant de commande	OrderId	integer	ID de OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	External Use OrderId for the Client - API Extension Property.
Date d’échéance	DueDate	date-time	Point dans le temps, cette OrderBaseApiModel est due à l’achèvement (obsolète dans la version 1.3).
StartTime	StartTime	date-time	Point dans le temps, cette OrderBaseApiModel doit démarrer (introduite dans la version 1.3).
EndTime	EndTime	date-time	Point dans le temps, cet OrderBaseApiModel est dû à l’achèvement (introduit dans la version 1.3).
ServiceType	ServiceType	string	ServiceType associé à ce OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	Point dans le temps, cet OrderBaseApiModel a été créé.
Numéro de commande	OrderNumber	string	Numéro de commande associé à ce OrderBaseApiModel.
IsClosed	IsClosed	boolean	État montrant si OrderBaseApiModel est fermé.
Statut	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	ID d’utilisation externe pour le client - Propriété d’extension d’API.
ClientId	ClientId	integer	ID d’utilisation interne pour le client - Propriété d’extension d’API.
Client	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	ID de l’ApiService associé à ce OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Version du module Champs personnalisés.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusApiModel

Nom	Chemin d’accès	Type	Description
StatusIndex	StatusIndex	integer	Index de OrderStatusApiModel.
Type de statut	StatusType	integer	État de la commande : 0 pour la nouvelle commande, 1 pour la distribution, 2 pour l’exécution, 3 pour terminé et 4 pour annulé.
StatusLabel	StatusLabel	string	Contenu d’étiquette de OrderStatusApiModel.
StatusId	StatusId	integer	ID de OrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	date-time	Point dans l’heure de début de OrderStatusApiModel.
Utilisateur	User	CustomerAPI.Models.UserReferenceApiModel

CustomerAPI.Models.Order.OrderClientReadApiModel

Nom	Chemin d’accès	Type	Description
GroupNames	GroupNames	array of string	Noms de hiérarchie de groupe client.
Nom	Name	string	Nom du client.
Adresse	Address	CustomerAPI.Models.LocationApiModel
Contact	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Order.OrderApiModel

Nom	Chemin d’accès	Type	Description
StatusHistory	StatusHistory	array of CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel	Liste des orderStatusListItems associés à ce OrderApiModel.
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
Identifiant de commande	OrderId	integer	ID de OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	External Use OrderId for the Client - API Extension Property.
Date d’échéance	DueDate	date-time	Point dans le temps, cette OrderBaseApiModel est due à l’achèvement (obsolète dans la version 1.3).
StartTime	StartTime	date-time	Point dans le temps, cette OrderBaseApiModel doit démarrer (introduite dans la version 1.3).
EndTime	EndTime	date-time	Point dans le temps, cet OrderBaseApiModel est dû à l’achèvement (introduit dans la version 1.3).
ServiceType	ServiceType	string	ServiceType associé à ce OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	Point dans le temps, cet OrderBaseApiModel a été créé.
Numéro de commande	OrderNumber	string	Numéro de commande associé à ce OrderBaseApiModel.
IsClosed	IsClosed	boolean	État montrant si OrderBaseApiModel est fermé.
Statut	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	ID d’utilisation externe pour le client - Propriété d’extension d’API.
ClientId	ClientId	integer	ID d’utilisation interne pour le client - Propriété d’extension d’API.
Client	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	ID de l’ApiService associé à ce OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Version du module Champs personnalisés.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Nom	Chemin d’accès	Type	Description
StatusStartDateTime	StatusStartDateTime	date-time	Point dans le temps, cet état OrderStatusHistoryListItemApiModel a été démarré.
StatusEndDateTime	StatusEndDateTime	date-time	Point dans le temps, cet état OrderStatusHistoryListItemApiModel a été terminé.
StatusId	StatusId	integer	ID associé à ce OrderStatusHistoryListItemApiModel.
StatusIndex	StatusIndex	integer	Index associé à ce OrderStatusHistoryListItemApiModel.
StatusLabel	StatusLabel	string	Contenu d’étiquette associé à ce OrderStatusHistoryListItemApiModel.
Type de statut	StatusType	integer	État de la commande : 0 pour la nouvelle commande, 1 pour la distribution, 2 pour l’exécution, 3 pour terminé et 4 pour annulé.
ExternalOrderId	ExternalOrderId	string	External Use OrderId for the Client - API Extension Property.
Identifiant de commande	OrderId	integer	OrderId associé à ce OrderStatusHistoryListItemApiModel.
Utilisateur	User	CustomerAPI.Models.UserReferenceApiModel
StartAddress	StartAddress	CustomerAPI.Models.LocationApiModel
EndAddress	EndAddress	CustomerAPI.Models.LocationApiModel
ApiServiceId	ApiServiceId	string	ID de l’ApiService associé à ce OrderStatusHistoryListItemApiModel.
FieldValues	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

CustomerAPI.Models.Order.OrderHeaderApiModel

Nom	Chemin d’accès	Type	Description
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
Identifiant de commande	OrderId	integer	ID de OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	External Use OrderId for the Client - API Extension Property.
Date d’échéance	DueDate	date-time	Point dans le temps, cette OrderBaseApiModel est due à l’achèvement (obsolète dans la version 1.3).
StartTime	StartTime	date-time	Point dans le temps, cette OrderBaseApiModel doit démarrer (introduite dans la version 1.3).
EndTime	EndTime	date-time	Point dans le temps, cet OrderBaseApiModel est dû à l’achèvement (introduit dans la version 1.3).
ServiceType	ServiceType	string	ServiceType associé à ce OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	Point dans le temps, cet OrderBaseApiModel a été créé.
Numéro de commande	OrderNumber	string	Numéro de commande associé à ce OrderBaseApiModel.
IsClosed	IsClosed	boolean	État montrant si OrderBaseApiModel est fermé.
Statut	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	ID d’utilisation externe pour le client - Propriété d’extension d’API.
ClientId	ClientId	integer	ID d’utilisation interne pour le client - Propriété d’extension d’API.
Client	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	ID de l’ApiService associé à ce OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Version du module Champs personnalisés.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Nom	Chemin d’accès	Type	Description
Id	Id	integer	ID de l’entrée de conservation de temps (commentaire hérité : RootSubmittedStatusId).
Utilisateur	User	CustomerAPI.Models.UserReferenceApiModel
ClockInTime	ClockInTime	date-time	Point dans le temps où l’utilisateur s’est connecté au système.
ClockInLocation	ClockInLocation	CustomerAPI.Models.LocationApiModel
ClockOutTime	ClockOutTime	date-time	Point dans le temps où l’utilisateur est sorti du système.
ClockOutLocation	ClockOutLocation	CustomerAPI.Models.LocationApiModel
TotalHours	TotalHours	double	Nombre total d’heures pour cette entrée de chronométrage.
TotalBreakHours	TotalBreakHours	double	Nombre total d’heures de pause (non ouvrées) pour cette entrée de l’horaire.
NetHours	NetHours	double	Nombre total d’heures facturables pour cette entrée de chronométrage.
Approuvé	Approved	boolean	État de l’approbation du superviseur pour cette entrée de délai.
Interruptions	Breaks	array of CustomerAPI.Models.Timekeeping.TimekeepingBreakModel
ClockInFormData	ClockInFormData	CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ClockOutFormData	ClockOutFormData	CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ModuleVersion	ModuleVersion	System.Version
CompanyModuleId	CompanyModuleId	integer	ID du module d’entreprise utilisé pour envoyer cette entrée de chronométrage.

CustomerAPI.Models.Timekeeping.TimekeepingBreakModel

Nom	Chemin d’accès	Type	Description
Id	Id	integer	SubmittedStatusId.
StartTime	StartTime	date-time	Heure de début.
StartLocation	StartLocation	CustomerAPI.Models.LocationApiModel
EndTime	EndTime	date-time	Heure de fin.
EndLocation	EndLocation	CustomerAPI.Models.LocationApiModel
DurationHours	DurationHours	double	Durée en heures. Elle peut être null si EndTime a la valeur Null.
Type de statut	StatusType	integer	Type d’état : 1 pour la pause et 2 pour le déjeuner.
StartLabel	StartLabel	string	Étiquette de début.
EndLabel	EndLabel	string	Étiquette de fin.
Légende	Caption	string	Légende.

CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel

Nom	Chemin d’accès	Type
CompanyModuleId	CompanyModuleId	integer
ModuleVersion	ModuleVersion	System.Version
FieldValues	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

System.Version

Nom	Chemin d’accès	Type
_Majeur	_Major	integer
_Mineur	_Minor	integer
_Construire	_Build	integer
_Révision	_Revision	integer

CustomerAPI.Models.Tracking.TripApiModel

Nom	Chemin d’accès	Type	Description
Utilisateur	User	CustomerAPI.Models.UserReferenceApiModel
Véhicule	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
StartTime	StartTime	date-time	Point dans le temps où cet état TripApiModel a été démarré.
EndTime	EndTime	date-time	Point dans le temps où cet état TripApiModel a été terminé.
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	Durée d’arrêt en heures associée à ce TripApiModel.
TotalIdleTime	TotalIdleTime	double	Durée d’inactivité en heures associée à ce TripApiModel.
TotalDuration	TotalDuration	double	Durée totale en heures associée à ce TripApiModel.
Distance	Distance	double	Distance parcourue en unités localisées associées à ce TripApiModel.

CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Nom	Chemin d’accès	Type	Description
Enregistrements	Records	array of CustomerAPI.Models.Tracking.GpsDataRecordApiModel
ContinuationToken	ContinuationToken	string

CustomerAPI.Models.Tracking.GpsDataRecordApiModel

Nom	Chemin d’accès	Type	Description
Utilisateur	User	CustomerAPI.Models.UserReferenceApiModel
Véhicule	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
TimeTag	TimeTag	date-time	TimeTag associé à ce GpsDataRecordApiModel.
Emplacement	Location	System.Nullable_1_Actsoft.Core.Geo.LatLon_
Limite géographique	Geofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
Vitesse	Speed	double	Vitesse de mouvement associée à ce GpsDataRecordApiModel.
Heading	Heading	double	Direction de boussole en degrés associés à ce GpsDataRecordApiModel.
Statut	Status	integer	ApiMovementStatus associé au OrderBaseApiModel - (Arrêté : 1, Idle : 2, Moving : 3, NotTracking : 4) : OrderStatusApiModel.
StatusTime	StatusTime	string	Point dans le temps, cet état GpsDataRecordApiModel a été défini.
Distance	Distance	double	Distance parcourue en unités localisées associées à ce TripApiModel.
InflammationOn	IgnitionOn	boolean	État de l’inflammation du véhicule associé à ce GpsDataRecordApiModel.
LocationProvider	LocationProvider	integer	Fournisseur d’emplacement d’API associé à ce GpsDataRecordApiModel - (GPS : 1, Réseau : 2).

CustomerAPI.Models.User.ReadUserApiModel

Nom	Chemin d’accès	Type	Description
Nom d’utilisateur	UserName	string	Nom d’utilisateur de l’utilisateur.
UserId	UserId	integer	Valeur d’ID de l’utilisateur.
GroupName	GroupName	string	Nom du groupe de l’utilisateur.
Prénom	FirstName	string	Prénom de l’utilisateur.
nom de famille	LastName	string	Nom de l’utilisateur.
EmployeeNumber	EmployeeNumber	string	Numéro d’employé de l’utilisateur.
Messagerie électronique	Email	string	Adresse e-mail de l’utilisateur.
Téléphone	Phone	string	Numéro de téléphone de l’utilisateur.
RoleId	RoleId	integer	RoleId de l’utilisateur : (Administrateur : 1, Utilisateur : 3, Power User : 5).
IsActive	IsActive	boolean	État actif de l’utilisateur.
EPTTEnabled	EPTTEnabled	boolean	État de la fonctionnalité Push-to-Talk améliorée pour l’utilisateur : booléen.
EPTTNumber	EPTTNumber	string	Numéro de téléphone pour la fonctionnalité Push-to-Talk améliorée pour l’utilisateur : chaîne.
EPTTWebMDN	EPTTWebMDN	string	Numéro de téléphone utilisé pour authentifier l’utilisateur auprès du système EPTT DeNceak - Fourni par Celui-ci.
EPTTToken	EPTTToken	string	Jeton d’API utilisé pour authentifier l’utilisateur auprès du système EPTT de L’utilisateur - Fourni par Jeffreyak.
GPSEnabled	GPSEnabled	boolean	État de la fonctionnalité GPS pour l’utilisateur.
MobileOnly	MobileOnly	boolean	État de l’accès aux applications web de bureau pour CAB - (No WebApp Access : True, Full App Access : False).
LicenseType	LicenseType	integer	Type de licence affecté à l’utilisateur : - 0 pour Undefined, 1 pour Regular, 2 pour WebOnly et 3 pour Employee.

CustomerAPI.Models.User.ReadUserListItemApiModel

Nom	Chemin d’accès	Type	Description
UserId	UserId	integer	Valeur d’ID de l’utilisateur.
Prénom	FirstName	string	Prénom de l’utilisateur.
nom de famille	LastName	string	Nom de l’utilisateur.
EmployeeNumber	EmployeeNumber	string	Numéro d’employé de l’utilisateur.
Messagerie électronique	Email	string	Adresse e-mail de l’utilisateur.
Téléphone	Phone	string	Numéro de téléphone de l’utilisateur.
RoleId	RoleId	integer	RoleId de l’utilisateur : (Administrateur : 1, Utilisateur : 3, Power User : 5).
IsActive	IsActive	boolean	État actif de l’utilisateur.
EPTTEnabled	EPTTEnabled	boolean	État de la fonctionnalité Push-to-Talk améliorée pour l’utilisateur : booléen.
EPTTNumber	EPTTNumber	string	Numéro de téléphone pour la fonctionnalité Push-to-Talk améliorée pour l’utilisateur : chaîne.
EPTTWebMDN	EPTTWebMDN	string	Numéro de téléphone utilisé pour authentifier l’utilisateur auprès du système EPTT DeNceak - Fourni par Celui-ci.
EPTTToken	EPTTToken	string	Jeton d’API utilisé pour authentifier l’utilisateur auprès du système EPTT de L’utilisateur - Fourni par Jeffreyak.
GPSEnabled	GPSEnabled	boolean	État de la fonctionnalité GPS pour l’utilisateur.
MobileOnly	MobileOnly	boolean	État de l’accès aux applications web de bureau pour CAB - (No WebApp Access : True, Full App Access : False).
LicenseType	LicenseType	integer	Type de licence affecté à l’utilisateur : - 0 pour Undefined, 1 pour Regular, 2 pour WebOnly et 3 pour Employee.

CustomerAPI.Models.Vehicle.VehicleReadApi

Modèle de données de véhicule.

Nom	Chemin d’accès	Type
InternalId	InternalId	integer
Number	Number	string
Nom	Name	string
Type	Type	string
Tag	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
TimeZone	TimeZone	string
Faire	Make	string
Année	Year	integer
Model	Model	string
Color	Color	string
VIN	VIN	string
IsActive	IsActive	boolean
Type de périphérique	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

entier

Il s’agit du type de données de base 'integer'.

objet

Il s’agit du type "objet".

Partager via

TeamWherx

Création d’une connexion

Faire défaut

Limitations

Actions

Abonnez-vous au web hook de données GPS

Paramètres

Retours

Activer un utilisateur

Paramètres

Activer un véhicule

Paramètres

Retours

Charger le fichier de pièce jointe

Retours

Charger un fichier binaire

Retours

Créer ou mettre à jour un enregistrement de liste personnalisé

Paramètres

Créer ou mettre à jour une définition d’événement personnalisée

Paramètres

Créer un client

Paramètres

Retours

Créer un formulaire

Paramètres

Retours

Créer un utilisateur

Paramètres

Retours

Créer un véhicule

Paramètres

Retours

Créer une commande

Paramètres

Retours

Créer une limite géographique

Paramètres

Retours

Désabonner le web hook de données GPS

Paramètres

Désactiver un utilisateur

Paramètres

Désactiver un véhicule

Paramètres

Retours

Envoyer un événement

Paramètres

Mettre à jour un client

Paramètres

Retours

Mettre à jour un utilisateur

Paramètres

Retours

Mettre à jour un véhicule

Paramètres

Retours

Mettre à jour une commande

Paramètres

Retours

Mettre à jour une limite géographique existante

Paramètres

Retours

Mettre à jour une partie d’un utilisateur

Paramètres

Retours

Mise à jour partielle d’un véhicule

Paramètres

Retours

Obtenir des données de liste personnalisées par CustomListID

Paramètres

Retours

Obtenir des définitions de liste personnalisées

Retours

Obtenir des entrées de données GPS

Paramètres

Retours

Obtenir la liste des abonnements

Retours