API listy tras (lista zapisanych tras)

Użyj API listy tras TrackRoad, aby pobierać wcześniej zapisane trasy przy użyciu filtrów takich jak zakres dat, właściciel i nazwa trasy. W integracjach SOAP odpowiednią metodą jest GetRouteList.

API listy tras TrackRoad pokazujące zapisane trasy filtrowane według zakresu dat, właściciela i nazwy trasy
Wyświetlaj i filtruj wcześniej zapisane trasy na potrzeby raportów, pulpitów i wyszukiwania historii tras.

Potrzebujesz pełnego kontraktu?

Swagger zawiera modele i pola endpointów dla REST, a WSDL udostępnia kontrakt SOAP dla GetRouteList i powiązanych metod.

Zobacz Swagger UI Zobacz SOAP WSDL Przegląd dokumentacji API

Spis treści

  1. Co robi API listy tras
  2. Endpointy i bazowe adresy URL
  3. Uwierzytelnianie
  4. Schemat żądania
  5. Schemat odpowiedzi
  6. Przykłady
  7. Typowe błędy
  8. Najlepsze praktyki
  9. FAQ
  10. Powiązane endpointy

Co robi API listy tras#

API listy tras zwraca listę zapisanych tras dla Twojego konta. Jest powszechnie używane do widoków historii tras, pulpitów oraz ekranów wyszukiwania, w których użytkownicy muszą znaleźć wcześniej wygenerowane trasy.

Typowe filtry obejmują zakres dat utworzenia, właściciela oraz nazwę trasy. Pomaga to utrzymać szybkie, precyzyjne i łatwiejsze do zarządzania wyszukiwanie tras w większych flotach.

Jeśli potrzebujesz pełnych szczegółów jednej trasy, w tym przystanków, wskazówek i czasów, użyj API Route .

Endpointy i bazowe adresy URL#

Poniższa dokumentacja Routes List koncentruje się na wzorcu integracji SOAP pokazanym przez GetRouteList. Jeśli szczegóły wdrożenia są inne, kieruj się dokumentacją konta i Swaggerem.

SOAP

Element Wartość
Endpoint https://trackservice.trackroad.com/TrackService.asmx
WSDL https://trackservice.trackroad.com/TrackService.asmx?WSDL
Metoda GetRouteList
SOAPAction http://TrackService.TrackRoad.com/GetRouteList

Uwierzytelnianie#

W przypadku SOAP wyślij swój TrackServiceKey w SessionIDHeader jako SessionID. Login i Logout nie są wymagane przy użyciu TrackServiceKey.

Przechowuj klucze API po stronie serwera i nie ujawniaj wartości uwierzytelniających w kodzie przeglądarki ani aplikacji mobilnych.

Schemat żądania#

Żądanie opisuje filtry używane do znajdowania zapisanych tras. W SOAP wartości te są przekazywane jako parametry GetRouteList.

Pola filtrów listy tras

Pole Typ Wymagane Opis
FromDate string (date-time) Nie Filtruje trasy utworzone lub zaktualizowane od tego znacznika czasu w formacie ISO 8601.
ToDate string (date-time) Nie Filtruje trasy utworzone lub zaktualizowane do tego znacznika czasu w formacie ISO 8601.
Owner string Nie Filtruje według właściciela lub nazwy użytkownika, jeśli jest to obsługiwane przez konfigurację Twojego konta.
RouteName string Nie Filtruje według nazwy trasy z dopasowaniem dokładnym lub częściowym, w zależności od implementacji.

Jeśli Twoja implementacja udostępnia dodatkowe filtry, takie jak status, stronicowanie lub maksymalna liczba wyników, udokumentuj te pola również tutaj.

Schemat odpowiedzi#

Pomyślna odpowiedź zwraca listę tras pasujących do filtrów oraz wszelkie informacje o statusie lub błędach zwrócone przez usługę.

Wynik Routes

Właściwość Typ Opis
Routes RouteSummary[] Lista pasujących rekordów podsumowania tras.
Errors Error[] Opcjonalne błędy lub ostrzeżenia zwrócone przez usługę.
Status int (enum) Kod statusu, zazwyczaj 0=None, 1=Success, 2=Failed, 3=SuccessWithErrors.

Podsumowanie trasy

Właściwość Typ Opis
RouteID string / int Identyfikator trasy używany później do pobrania pełnych szczegółów trasy.
RouteName string Czytelna dla użytkownika nazwa trasy.
Distance double Całkowita długość trasy.
Time int Całkowity czas trasy, zwykle w sekundach, chyba że skonfigurowano inaczej.
Owner string Identyfikator właściciela lub twórcy, jeśli jest dostępny.
DateCreated string (date-time) Znacznik czasu pokazujący, kiedy trasa została utworzona.

SOAP zwraca tę samą koncepcję listy tras wewnątrz koperty SOAP, z wynikiem opakowanym w elementy odpowiedzi GetRouteList.

Przykłady#

Umieść w tej sekcji przykładowe żądanie SOAP, przykładową odpowiedź oraz przykłady kodu w wielu językach. Sam kod przykładowy nie musi być lokalizowany.

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>

Typowe błędy#

  • Błąd uwierzytelniania: brak SessionIDHeader lub jest on nieprawidłowy. Wartość SessionID musi być Twoim TrackServiceKey.
  • Nieprawidłowy format daty: podawaj daty w formacie ISO 8601, na przykład 2026-01-31T23:59:59Z.
  • Brak pasujących tras: zakres filtrów, właściciel lub nazwa trasy mogą być zbyt restrykcyjne.
  • Problem z usługą lub uprawnieniami: klucz może być poprawny, ale zablokowany, wygasły lub ograniczony dla żądanego zakresu konta.

Najlepsze praktyki#

  • Używaj filtrów dat, aby odpowiedzi były szybkie i przewidywalne, szczególnie w widokach historii tras.
  • Buforuj listy tras dla pulpitów ładowanych często i odświeżaj je na żądanie, gdy użytkownicy ponownie wyszukują.
  • Ładuj szczegóły trasy tylko wtedy, gdy są potrzebne, zamiast pobierać pełne dane trasy dla każdego wiersza wyniku.
  • Dokumentuj pola specyficzne dla konta, gdy Twoje wdrożenie obsługuje dodatkowe filtry lub niestandardowe właściwości odpowiedzi.

FAQ#

Co robi API listy tras?
API listy tras zwraca listę wcześniej zapisanych tras, zwykle filtrowanych według zakresu dat, właściciela lub nazwy trasy.
Jaki jest odpowiednik SOAP dla API listy tras?
Nazwa metody SOAP to GetRouteList.
Jak się uwierzytelnić?
W przypadku SOAP wyślij swój TrackServiceKey w SessionIDHeader jako SessionID. Login i Logout nie są wymagane przy użyciu TrackServiceKey.
Kiedy powinienem użyć API listy tras zamiast API Route?
Użyj API listy tras do wyszukiwania i wyświetlania zapisanych tras. Użyj API Route, gdy potrzebujesz pełnych szczegółów trasy, takich jak przystanki, wskazówki i czasy.

Chcesz poznać szczegóły trasy?

Użyj Routes List, aby znaleźć zapisane wartości RouteID, a następnie otwórz dokumentację API Route, aby załadować pełne listy przystanków, odległości tras i szczegóły czasowe.

Przejdź do API Route Zobacz Swagger UI