Aller au contenu

GetList

Renvoie une liste pour le client dont la clé est envoyée. Il existe une seule liste, AssetLocations : chaque ordre de travail ouvert des dossiers du client, avec la dernière position signalée pour un actif de cet ordre de travail, comme le camion qui transporte le conteneur. Le système d’un client l’utilise pour afficher en une seule fois tous ses conteneurs sur une carte. Pour un seul conteneur, avec le dernier événement que le client peut voir, utilisez GetAssetLocation.

Dans TrakIT, les actifs sont ajoutés à un ordre de travail dans son encadré Assets, et les positions d’un actif suivi par GPS figurent dans l’onglet Positions de l’actif.

Comment envoyer la clé et lire la réponse : Clés d’API des entités, Réponses.

GET /api/public/GetList?APIKey=your-entity-key&ListType=AssetLocations

Envoyez la clé dans le paramètre APIKey de la chaîne de requête. C’est la propre clé du client : l’API Key affichée sur la page de l’entité quand Enable API Access est activé pour l’entité (voir champs de l’entité). Encodez-la pour l’URL. La clé fait partie de l’adresse : tenez donc ces URL à l’écart des journaux que vous partagez.

Paramètre Obligatoire Signification
APIKey Oui La clé de l’entité du client, pour l’année en cours.
ListType Oui La liste à renvoyer : AssetLocations, la seule. Les majuscules n’ont pas d’importance.

Les deux doivent figurer dans la chaîne de requête : sans l’un d’eux, TrakIT répond avec le statut HTTP 404.

Règle Info en cas d’échec
APIKey n’est pas vide. API Key is required
APIKey est une clé émise par TrakIT. API Key is invalid
La clé est celle de cette année. La clé de chaque entité change le 1er janvier : obtenez la nouvelle sur la page de l’entité. API Key expiry not found, API Key has expired. Please obtain new key.
La clé est la clé d’une entité. Expecting numeric ID, Invalid Key Type
L’entité existe. No such entity
Enable API Access est activé pour l’entité. API access is disabled
ListType vaut AssetLocations. Invalid List Type

En cas de succès, Code vaut 1, RetInfo liste les ordres de travail ouverts des dossiers dont le client est l’entité de la clé, et RowsAffected indique leur nombre. Ouvert signifie actif ou abandonné : les ordres de travail clôturés et annulés sont exclus (voir Clôturer, annuler ou rouvrir). La liste est triée par numéro de conteneur, puis par référence du dossier.

Un ordre de travail dont les actifs n’ont signalé aucune position est listé aussi, avec des champs de position à null. Sans ordre de travail ouvert, RetInfo est une liste vide et RowsAffected vaut 0.

{
"Code": 1,
"Info": "",
"RetInfo": [
{
"containerno": "ABCU1234560",
"bookingno": "EXL-2610-0042",
"gpsdate": "2026-10-20T09:42:00",
"gpslat": 5.6312,
"gpslong": -0.0174
},
{
"containerno": "ABCU7654321",
"bookingno": "EXL-2610-0042",
"gpsdate": null,
"gpslat": null,
"gpslong": null
}
],
"RowsAffected": 2,
"Scalar": null,
"Identity": 0
}
Champ Signification
containerno Le numéro du conteneur de l’ordre de travail.
bookingno La référence du dossier.
gpsdate Quand la dernière position d’un actif de l’ordre de travail a été signalée, en UTC. Voir Dates et heures.
gpslat, gpslong La latitude et la longitude de cette position, en degrés décimaux.