API voor Routelijst (Opgeslagen Routes Weergeven)

Gebruik de TrackRoad API voor Routelijst om eerder opgeslagen routes op te halen met filters zoals datumbereik, eigenaar en routenaam. Voor SOAP-integraties is de equivalente methode GetRouteList.

TrackRoad API voor Routelijst die opgeslagen routes toont gefilterd op datumbereik, eigenaar en routenaam
Toon en filter eerder opgeslagen routes voor rapportage, dashboards en opzoekingen in routegeschiedenis.

Hebt u het volledige contract nodig?

Swagger bevat endpointmodellen en velden voor REST, terwijl de WSDL het SOAP-contract voor GetRouteList en gerelateerde methoden beschikbaar maakt.

Swagger UI bekijken SOAP WSDL bekijken Overzicht API-referentie

Inhoudsopgave

  1. Wat de API voor Routelijst doet
  2. Endpoints en basis-URL's
  3. Authenticatie
  4. Aanvraagschema
  5. Antwoordschema
  6. Voorbeelden
  7. Veelvoorkomende fouten
  8. Best practices
  9. FAQ
  10. Gerelateerde endpoints

Wat de API voor Routelijst doet#

De API voor Routelijst geeft een lijst met opgeslagen routes voor uw account terug. Ze wordt vaak gebruikt voor weergaven van routegeschiedenis, dashboards en zoekschermen waar gebruikers eerder gegenereerde routes moeten kunnen vinden.

Typische filters zijn het aanmaakdatumbereik, eigenaar en routenaam. Dit helpt om routezoekopdrachten snel, gericht en beter beheersbaar te houden in grotere wagenparken.

Als u de volledige details van één route nodig hebt, inclusief stops, routebeschrijvingen en timing, gebruik dan de Route API .

Endpoints en basis-URL's#

De onderstaande documentatie voor Routelijst richt zich op het SOAP-integratiepatroon dat door GetRouteList wordt getoond. Volg uw accountdocumentatie en Swagger wanneer implementatiespecifieke details afwijken.

SOAP

Item Waarde
Endpoint https://trackservice.trackroad.com/TrackService.asmx
WSDL https://trackservice.trackroad.com/TrackService.asmx?WSDL
Methode GetRouteList
SOAPAction http://TrackService.TrackRoad.com/GetRouteList

Authenticatie#

Voor SOAP verzendt u uw TrackServiceKey in SessionIDHeader als SessionID. Login en Logout zijn niet vereist wanneer u TrackServiceKey gebruikt.

Bewaar API-sleutels aan de serverzijde en voorkom dat authenticatiewaarden zichtbaar worden in browser- of mobiele clientcode.

Aanvraagschema#

De aanvraag beschrijft de filters die worden gebruikt om opgeslagen routes te vinden. In SOAP worden deze waarden doorgegeven als parameters van GetRouteList.

Filtervelden voor routelijst

Veld Type Vereist Beschrijving
FromDate string (date-time) Nee Filter routes die op of na deze tijdstempel zijn gemaakt of bijgewerkt, in ISO 8601-formaat.
ToDate string (date-time) Nee Filter routes die op of vóór deze tijdstempel zijn gemaakt of bijgewerkt, in ISO 8601-formaat.
Owner string Nee Filter op eigenaar of gebruikersnaam, als dit wordt ondersteund door uw accountconfiguratie.
RouteName string Nee Filter op routenaam met exacte of gedeeltelijke overeenkomst, afhankelijk van de implementatie.

Als uw implementatie extra filters ondersteunt, zoals status, paginering of maximumaantal resultaten, documenteer die extra velden hier dan ook.

Antwoordschema#

Een succesvol antwoord geeft een lijst terug van routes die overeenkomen met uw filters en eventuele status- of foutinformatie die door de service wordt teruggegeven.

Routeresultaat

Eigenschap Type Beschrijving
Routes RouteSummary[] Lijst met overeenkomende records van routesamenvattingen.
Errors Error[] Optionele fouten of waarschuwingen die door de service worden teruggegeven.
Status int (enum) Statuscode, meestal 0=None, 1=Success, 2=Failed, 3=SuccessWithErrors.

Routesamenvatting

Eigenschap Type Beschrijving
RouteID string / int Route-id die later wordt gebruikt om volledige routedetails op te halen.
RouteName string Gebruiksvriendelijke routenaam.
Distance double Totale routeafstand.
Time int Totale routetijd, meestal in seconden tenzij anders geconfigureerd.
Owner string Id van eigenaar of maker, indien beschikbaar.
DateCreated string (date-time) Tijdstempel die aangeeft wanneer de route is aangemaakt.

SOAP geeft hetzelfde concept van een routelijst terug binnen een SOAP-envelope, waarbij het resultaat is verpakt in GetRouteList-antwoordelementen.

Voorbeelden#

Plaats in deze sectie het voorbeeld van de SOAP-aanvraag, het voorbeeldantwoord en codevoorbeelden in meerdere talen. De voorbeeldcode zelf hoeft niet gelokaliseerd te worden.

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>

Veelvoorkomende fouten#

  • Authenticatiefout: Ontbrekende of ongeldige SessionIDHeader. De waarde van SessionID moet uw TrackServiceKey zijn.
  • Ongeldig datumformaat: Geef datums op in ISO 8601-formaat, bijvoorbeeld 2026-01-31T23:59:59Z.
  • Geen overeenkomende routes: Uw filterbereik, eigenaar of routenaam kan te beperkend zijn.
  • Service- of machtigingsprobleem: De sleutel kan geldig zijn, maar geblokkeerd, verlopen of beperkt voor het gevraagde accountbereik.

Best practices#

  • Gebruik datumfilters om antwoorden snel en voorspelbaar te houden, vooral voor schermen met routegeschiedenis.
  • Cache routelijsten voor dashboards die vaak worden geladen en vernieuw ze op aanvraag wanneer gebruikers opnieuw zoeken.
  • Laad routedetails alleen wanneer nodig in plaats van volledige routegegevens op te halen voor elke resultaatrij.
  • Documenteer accountspecifieke velden wanneer uw implementatie extra filters of aangepaste antwoordeigenschappen ondersteunt.

FAQ#

Wat doet de API voor Routelijst?
De API voor Routelijst geeft een lijst terug van eerder opgeslagen routes, meestal gefilterd op datumbereik, eigenaar of routenaam.
Wat is het SOAP-equivalent van de API voor Routelijst?
De naam van de SOAP-methode is GetRouteList.
Hoe authenticeer ik mij?
Voor SOAP verzendt u uw TrackServiceKey in SessionIDHeader als SessionID. Login en Logout zijn niet vereist wanneer u TrackServiceKey gebruikt.
Wanneer moet ik de API voor Routelijst gebruiken in plaats van de Route API?
Gebruik de API voor Routelijst om opgeslagen routes te zoeken en weer te geven. Gebruik de Route API wanneer u volledige routedetails nodig hebt, zoals stops, routebeschrijvingen en timing.

Wilt u routedetails?

Gebruik Routelijst om opgeslagen RouteID-waarden te vinden en open daarna de documentatie van de Route API om volledige stoplijsten, routeafstanden en tijdsdetails te laden.

Ga naar Route API Swagger UI bekijken