Routes-Listen-API (gespeicherte Routen auflisten)

Verwenden Sie die TrackRoad Routes-Listen-API, um zuvor gespeicherte Routen mit Filtern wie Datumsbereich, Eigentümer und Routenname abzurufen. Für SOAP-Integrationen ist die entsprechende Methode GetRouteList.

TrackRoad Routes-Listen-API mit gespeicherten Routen, gefiltert nach Datumsbereich, Eigentümer und Routenname
Gespeicherte Routen für Berichte, Dashboards und Routenverlaufsabfragen auflisten und filtern.

Benötigen Sie den vollständigen Vertrag?

Swagger enthält die Endpunktmodelle und Felder für REST, während die WSDL den SOAP-Vertrag für GetRouteList und verwandte Methoden bereitstellt.

Swagger UI öffnen SOAP-WSDL öffnen API-Referenzübersicht

Inhaltsverzeichnis

  1. Was die Routes-Listen-API macht
  2. Endpunkte und Basis-URLs
  3. Authentifizierung
  4. Anfrageschema
  5. Antwortschema
  6. Beispiele
  7. Häufige Fehler
  8. Best Practices
  9. FAQ
  10. Verwandte Endpunkte

Was die Routes-Listen-API macht#

Die Routes-Listen-API gibt eine Liste gespeicherter Routen für Ihr Konto zurück. Sie wird häufig für Routenverlaufsansichten, Dashboards und Suchmasken verwendet, in denen Benutzer zuvor erzeugte Routen finden müssen.

Typische Filter sind Erstellungsdatum, Eigentümer und Routenname. Dadurch bleiben Routensuchen schnell, präzise und in größeren Flotten leichter verwaltbar.

Wenn Sie die vollständigen Details einer einzelnen Route benötigen, einschließlich Stopps, Wegbeschreibung und Zeitangaben, verwenden Sie die Route-API .

Endpunkte und Basis-URLs#

Die folgende Routes-Listen-Dokumentation konzentriert sich auf das SOAP-Integrationsmuster der Methode GetRouteList. Wenn kontospezifische oder deploymentabhängige Details abweichen, folgen Sie Ihrer Dokumentation und Swagger.

SOAP

Eintrag Wert
Endpunkt https://trackservice.trackroad.com/TrackService.asmx
WSDL https://trackservice.trackroad.com/TrackService.asmx?WSDL
Methode GetRouteList
SOAPAction http://TrackService.TrackRoad.com/GetRouteList

Authentifizierung#

Für SOAP senden Sie Ihren TrackServiceKey im SessionIDHeader als SessionID. Login und Logout sind bei Verwendung des TrackServiceKey nicht erforderlich.

Bewahren Sie API-Schlüssel serverseitig auf und vermeiden Sie es, Authentifizierungswerte in Browser- oder Mobile-Client-Code offenzulegen.

Anfrageschema#

Die Anfrage beschreibt die Filter, mit denen gespeicherte Routen gefunden werden. Bei SOAP werden diese Werte als GetRouteList-Parameter übergeben.

Filterfelder der Routenliste

Feld Typ Erforderlich Beschreibung
FromDate string (date-time) Nein Filtert Routen, die ab diesem Zeitstempel erstellt oder aktualisiert wurden, im ISO-8601-Format.
ToDate string (date-time) Nein Filtert Routen, die bis zu diesem Zeitstempel erstellt oder aktualisiert wurden, im ISO-8601-Format.
Owner string Nein Filtert nach Eigentümer oder Benutzername, sofern dies in Ihrer Kontokonfiguration unterstützt wird.
RouteName string Nein Filtert nach Routenname mit exakter oder teilweiser Übereinstimmung, abhängig von der Implementierung.

Wenn Ihre Implementierung zusätzliche Filter wie Status, Paging oder maximale Ergebnisse unterstützt, dokumentieren Sie diese Felder ebenfalls hier.

Antwortschema#

Eine erfolgreiche Antwort enthält eine Liste von Routen, die Ihren Filtern entsprechen, sowie eventuelle Status- oder Fehlerinformationen des Dienstes.

Routes-Ergebnis

Eigenschaft Typ Beschreibung
Routes RouteSummary[] Liste der passenden Routenübersichtseinträge.
Errors Error[] Optionale Fehler oder Warnungen, die vom Dienst zurückgegeben werden.
Status int (enum) Statuscode, üblicherweise 0=None, 1=Success, 2=Failed, 3=SuccessWithErrors.

Routenübersicht

Eigenschaft Typ Beschreibung
RouteID string / int Routen-ID, die später zum Abruf der vollständigen Routendetails verwendet wird.
RouteName string Benutzerfreundlicher Routenname.
Distance double Gesamtdistanz der Route.
Time int Gesamtdauer der Route, normalerweise in Sekunden, sofern nicht anders konfiguriert.
Owner string Eigentümer- oder Erstellerkennung, falls verfügbar.
DateCreated string (date-time) Zeitstempel, der angibt, wann die Route erstellt wurde.

SOAP gibt dasselbe Konzept einer Routenliste innerhalb eines SOAP-Envelopes zurück, wobei das Ergebnis in den GetRouteList-Antwortelementen gekapselt ist.

Beispiele#

Platzieren Sie in diesem Abschnitt die SOAP-Beispielanfrage, die Beispielantwort und mehrsprachige Codebeispiele. Der Beispielcode selbst muss nicht lokalisiert werden.

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>

Häufige Fehler#

  • Authentifizierungsfehler: Fehlender oder ungültiger SessionIDHeader. Der Wert von SessionID muss Ihr TrackServiceKey sein.
  • Ungültiges Datumsformat: Verwenden Sie Datumswerte im ISO-8601-Format, zum Beispiel 2026-01-31T23:59:59Z.
  • Keine passenden Routen: Ihr Filterbereich, Eigentümer oder Routenname ist möglicherweise zu restriktiv.
  • Dienst- oder Berechtigungsproblem: Der Schlüssel kann gültig sein, aber gesperrt, abgelaufen oder für den angeforderten Kontobereich eingeschränkt sein.

Best Practices#

  • Verwenden Sie Datumsfilter, um Antworten schnell und vorhersehbar zu halten, besonders bei Routenverlaufsansichten.
  • Cachen Sie Routenlisten für Dashboards, die häufig geladen werden, und aktualisieren Sie sie bei Bedarf neu, wenn Benutzer erneut suchen.
  • Laden Sie Routendetails nur bei Bedarf, anstatt vollständige Routendaten für jede Ergebniszeile abzurufen.
  • Dokumentieren Sie kontospezifische Felder, wenn Ihre Bereitstellung zusätzliche Filter oder benutzerdefinierte Antwortfelder unterstützt.

FAQ#

Was macht die Routes-Listen-API?
Die Routes-Listen-API gibt eine Liste zuvor gespeicherter Routen zurück, normalerweise gefiltert nach Datumsbereich, Eigentümer oder Routenname.
Was ist die SOAP-Entsprechung der Routes-Listen-API?
Der Name der SOAP-Methode ist GetRouteList.
Wie authentifiziere ich mich?
Für SOAP senden Sie Ihren TrackServiceKey im SessionIDHeader als SessionID. Login und Logout sind bei Verwendung des TrackServiceKey nicht erforderlich.
Wann sollte ich die Routes-Listen-API statt der Route-API verwenden?
Verwenden Sie die Routes-Listen-API, um gespeicherte Routen zu suchen und aufzulisten. Verwenden Sie die Route-API, wenn Sie vollständige Routendetails wie Stopps, Wegbeschreibung und Zeitangaben benötigen.

Benötigen Sie Routendetails?

Verwenden Sie Routes List, um gespeicherte RouteID-Werte zu finden, und öffnen Sie anschließend die Route-API-Dokumentation, um vollständige Stopplisten, Routendistanzen und Zeitdetails zu laden.

Zur Route-API Swagger UI öffnen