Aller au contenu

GetLocations

Renvoie tous les lieux d’un pays : les ports, parcs, entrepôts, bureaux, sites clients et autres lieux situés sous ses villes dans Geo Data. Chaque lieu est accompagné de son code, de sa position, de ses adresses et de ses champs de données de lieu. Utilisez-le pour faire correspondre les lieux de TrakIT avec les lieux de votre propre système.

Comment se connecter et lire la réponse : Authentification, Réponses.

GET /api/v1/GetLocations?CountryCode=KE
Token: your-token
Paramètre Obligatoire Signification
CountryCode Oui Le code ISO à 2 lettres du pays, comme dans Geo Data, par exemple KE. Les majuscules n’ont pas d’importance.

Sans CountryCode, la requête n’atteint pas le point de terminaison, et TrakIT répond avec le statut HTTP 404 (voir Erreurs).

Règle Info en cas d’échec
L’en-tête Token contient un jeton valide. Token missing in header, Token invalid or expired, ou une autre réponse listée dans Jeton de connexion
L’utilisateur est un administrateur système disposant de l’accès à l’API. API User must be SysAdmin with API Access
CountryCode n’est pas vide. CountryCode is required

En cas de succès, RetInfo liste les lieux du pays, par ordre d’identifiant, et RowsAffected indique leur nombre. La liste inclut les lieux inactifs. Les heures sont en UTC, sans fuseau horaire (voir Dates et heures).

{
"Code": 1,
"Info": "",
"RetInfo": [
{
"ID": 1204,
"Code": "KEMBA01",
"Name": "Mombasa - Port",
"CityCode": "MBA",
"Latitude": -4.067500,
"Longitude": 39.658667,
"LocalName": null,
"Addr": "1 Example Road, Mombasa",
"LocalAddr": null,
"Disabled": false,
"Data": []
},
{
"ID": 1388,
"Code": "KEMBA03",
"Name": "Mombasa - Main Yard",
"CityCode": "MBA",
"Latitude": null,
"Longitude": null,
"LocalName": null,
"Addr": null,
"LocalAddr": null,
"Disabled": false,
"Data": [
{
"FieldName": "Opening Hours",
"Value": "06:00-22:00",
"ValueID": null,
"Remarks": null,
"Updated": "2026-10-12T09:00:21.120",
"UpdatedBy": "JSMITH"
}
]
}
],
"RowsAffected": 2,
"Scalar": null,
"Identity": 0
}

Les libellés en gras sont ceux des détails du lieu.

Champ Signification
ID L’identifiant du lieu.
Code Code, unique dans tout Geo Data.
Name Name, précédé du nom de sa ville, comme TrakIT l’affiche partout : par exemple Mombasa - Port.
CityCode Le code de la ville où se trouve le lieu.
Latitude, Longitude La position du lieu, en degrés décimaux, ou null quand la position n’est pas définie.
LocalName Local Name, ou null.
Addr, LocalAddr Address et Local Address, ou null.
Disabled true quand le lieu est inactif (Active désactivé).
Data Les champs de données du lieu qui ont été enregistrés. Une liste vide s’il n’y en a aucun.

Chaque élément de Data :

Champ Signification
FieldName Le nom du champ de données.
Value La valeur, sous forme de texte.
ValueID Pour un champ qui contient une entité, l’identifiant de l’entité ; sinon null.
Remarks Les remarques, ou null.
Updated Quand la valeur a été enregistrée pour la dernière fois.
UpdatedBy L’identifiant utilisateur de l’utilisateur qui l’a enregistrée, ou null pour un champ calculé.

Quand le pays n’a aucun lieu, ou qu’aucun pays n’a ce code, la réponse a Code 0 et Info No locations found.

La réponse contient tous les lieux du pays avec leurs champs de données : pour un pays qui compte de nombreux lieux, elle peut donc prendre un certain temps. Appelez ce point de terminaison quand vous devez actualiser votre liste de lieux, pas avant chaque autre appel.