API de liste des itinéraires (lister les itinéraires enregistrés)

Utilisez l’API de liste des itinéraires TrackRoad pour récupérer des itinéraires précédemment enregistrés à l’aide de filtres tels que la plage de dates, le propriétaire et le nom de l’itinéraire. Pour les intégrations SOAP, la méthode équivalente est GetRouteList.

API de liste des itinéraires TrackRoad affichant des itinéraires enregistrés filtrés par plage de dates, propriétaire et nom d’itinéraire
Listez et filtrez les itinéraires précédemment enregistrés pour les rapports, les tableaux de bord et les recherches d’historique d’itinéraires.

Besoin du contrat complet ?

Swagger inclut les modèles et champs des endpoints REST, tandis que le WSDL expose le contrat SOAP pour GetRouteList et les méthodes associées.

Voir Swagger UI Voir le WSDL SOAP Vue d’ensemble de la référence API

Table des matières

  1. Ce que fait l’API de liste des itinéraires
  2. Endpoints et URL de base
  3. Authentification
  4. Schéma de requête
  5. Schéma de réponse
  6. Exemples
  7. Erreurs courantes
  8. Bonnes pratiques
  9. FAQ
  10. Endpoints associés

Ce que fait l’API de liste des itinéraires#

L’API de liste des itinéraires renvoie une liste des itinéraires enregistrés pour votre compte. Elle est couramment utilisée pour les vues d’historique d’itinéraires, les tableaux de bord et les écrans de recherche où les utilisateurs doivent retrouver des itinéraires générés précédemment.

Les filtres typiques incluent la plage de dates de création, le propriétaire et le nom de l’itinéraire. Cela permet de garder les recherches d’itinéraires rapides, ciblées et plus faciles à gérer dans les flottes plus importantes.

Si vous avez besoin des détails complets d’un itinéraire, y compris les arrêts, les indications et les temps, utilisez l’ API Route .

Endpoints et URL de base#

La documentation ci-dessous pour Routes List se concentre sur le modèle d’intégration SOAP illustré par GetRouteList. Suivez la documentation de votre compte et Swagger lorsque des détails spécifiques au déploiement diffèrent.

SOAP

Élément Valeur
Endpoint https://trackservice.trackroad.com/TrackService.asmx
WSDL https://trackservice.trackroad.com/TrackService.asmx?WSDL
Méthode GetRouteList
SOAPAction http://TrackService.TrackRoad.com/GetRouteList

Authentification#

Pour SOAP, envoyez votre TrackServiceKey dans SessionIDHeader comme SessionID. Login et Logout ne sont pas requis lors de l’utilisation de TrackServiceKey.

Conservez les clés API côté serveur et évitez d’exposer des valeurs d’authentification dans le code du navigateur ou des clients mobiles.

Schéma de requête#

La requête décrit les filtres utilisés pour trouver les itinéraires enregistrés. En SOAP, ces valeurs sont transmises comme paramètres de GetRouteList.

Champs de filtre de la liste des itinéraires

Champ Type Obligatoire Description
FromDate string (date-time) Non Filtre les itinéraires créés ou mis à jour à partir de cet horodatage au format ISO 8601.
ToDate string (date-time) Non Filtre les itinéraires créés ou mis à jour jusqu’à cet horodatage au format ISO 8601.
Owner string Non Filtre par propriétaire ou nom d’utilisateur, si cette option est prise en charge par la configuration de votre compte.
RouteName string Non Filtre par nom d’itinéraire avec une correspondance exacte ou partielle, selon l’implémentation.

Si votre implémentation expose des filtres supplémentaires tels que le statut, la pagination ou le nombre maximal de résultats, documentez également ces champs ici.

Schéma de réponse#

Une réponse réussie renvoie une liste d’itinéraires correspondant à vos filtres ainsi que les éventuelles informations de statut ou d’erreur renvoyées par le service.

Résultat Routes

Propriété Type Description
Routes RouteSummary[] Liste des enregistrements récapitulatifs d’itinéraires correspondants.
Errors Error[] Erreurs ou avertissements facultatifs renvoyés par le service.
Status int (enum) Code d’état, généralement 0=None, 1=Success, 2=Failed, 3=SuccessWithErrors.

Résumé d’itinéraire

Propriété Type Description
RouteID string / int Identifiant de l’itinéraire utilisé ensuite pour récupérer les détails complets de l’itinéraire.
RouteName string Nom d’itinéraire lisible par l’utilisateur.
Distance double Distance totale de l’itinéraire.
Time int Temps total de l’itinéraire, généralement en secondes sauf configuration différente.
Owner string Identifiant du propriétaire ou du créateur, lorsqu’il est disponible.
DateCreated string (date-time) Horodatage indiquant quand l’itinéraire a été créé.

SOAP renvoie le même concept de liste d’itinéraires à l’intérieur d’une enveloppe SOAP, le résultat étant encapsulé dans les éléments de réponse GetRouteList.

Exemples#

Placez dans cette section la requête SOAP d’exemple, la réponse d’exemple et des exemples de code multilingues. Le code d’exemple lui-même n’a pas besoin d’être localisé.

SOAP: request examples (multiple languages)#

SOAP requires SessionIDHeader (SessionID = TrackServiceKey) and the SOAPAction header http://TrackService.TrackRoad.com/GetRouteList.

<!-- POST https://trackservice.trackroad.com/TrackService.asmx -->
<!-- Content-Type: text/xml; charset=utf-8 -->
<!-- SOAPAction: "http://TrackService.TrackRoad.com/GetRouteList" -->

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>

  <soap:Body>
    <GetRouteList xmlns="http://TrackService.TrackRoad.com/">
      <FromDate>2026-01-01T00:00:00Z</FromDate>
      <ToDate>2026-01-31T23:59:59Z</ToDate>
      <Owner>dispatcher@company.com</Owner>
      <RouteName>January</RouteName>
    </GetRouteList>
  </soap:Body>
</soap:Envelope>

SOAP: response example (shape)#

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetRouteListResponse xmlns="http://TrackService.TrackRoad.com/">
      <GetRouteListResult>
        <Routes>
          <RouteSummary>
            <RouteID>12345</RouteID>
            <RouteName>January - North Zone</RouteName>
            <Distance>82.4</Distance>
            <Time>14250</Time>
            <Owner>dispatcher@company.com</Owner>
            <DateCreated>2026-01-12T16:21:00Z</DateCreated>
          </RouteSummary>
        </Routes>
        <Status>1</Status>
        <Errors />
      </GetRouteListResult>
    </GetRouteListResponse>
  </soap:Body>
</soap:Envelope>

Erreurs courantes#

  • Erreur d’authentification : SessionIDHeader manquant ou invalide. La valeur SessionID doit être votre TrackServiceKey.
  • Format de date invalide : fournissez les dates au format ISO 8601, par exemple 2026-01-31T23:59:59Z.
  • Aucun itinéraire correspondant : votre plage de filtres, le propriétaire ou le nom d’itinéraire peuvent être trop restrictifs.
  • Problème de service ou d’autorisation : la clé peut être valide, mais bloquée, expirée ou limitée pour le périmètre de compte demandé.

Bonnes pratiques#

  • Utilisez des filtres de date pour garder des réponses rapides et prévisibles, en particulier pour les vues d’historique d’itinéraires.
  • Mettez en cache les listes d’itinéraires pour les tableaux de bord chargés fréquemment, puis actualisez-les à la demande lorsque les utilisateurs recherchent à nouveau.
  • Chargez les détails d’itinéraire uniquement lorsque nécessaire plutôt que de récupérer les données complètes de chaque ligne de résultat.
  • Documentez les champs spécifiques au compte lorsque votre déploiement prend en charge des filtres supplémentaires ou des propriétés de réponse personnalisées.

FAQ#

Que fait l’API de liste des itinéraires ?
L’API de liste des itinéraires renvoie une liste d’itinéraires précédemment enregistrés, généralement filtrés par plage de dates, propriétaire ou nom d’itinéraire.
Quel est l’équivalent SOAP de l’API de liste des itinéraires ?
Le nom de la méthode SOAP est GetRouteList.
Comment puis-je m’authentifier ?
Pour SOAP, envoyez votre TrackServiceKey dans SessionIDHeader comme SessionID. Login et Logout ne sont pas requis lors de l’utilisation de TrackServiceKey.
Quand dois-je utiliser l’API de liste des itinéraires au lieu de l’API Route ?
Utilisez l’API de liste des itinéraires pour rechercher et lister les itinéraires enregistrés. Utilisez l’API Route lorsque vous avez besoin des détails complets de l’itinéraire, comme les arrêts, les indications et les temps.

Vous voulez les détails d’un itinéraire ?

Utilisez Routes List pour trouver les valeurs RouteID enregistrées, puis ouvrez la documentation de l’API Route pour charger les listes complètes d’arrêts, les distances d’itinéraire et les détails de temps.

Aller à l’API Route Voir Swagger UI