API elenco percorsi (elenca percorsi salvati)

Usa l'API elenco percorsi di TrackRoad per recuperare percorsi precedentemente salvati usando filtri come intervallo di date, proprietario e nome del percorso. Per le integrazioni SOAP, il metodo equivalente è GetRouteList.

API elenco percorsi di TrackRoad che mostra percorsi salvati filtrati per intervallo di date, proprietario e nome del percorso
Elenca e filtra i percorsi precedentemente salvati per report, dashboard e ricerche nella cronologia dei percorsi.

Ti serve il contratto completo?

Swagger include modelli e campi degli endpoint per REST, mentre il WSDL espone il contratto SOAP per GetRouteList e i metodi correlati.

Visualizza Swagger UI Visualizza WSDL SOAP Panoramica riferimento API

Indice dei contenuti

  1. Cosa fa l'API elenco percorsi
  2. Endpoint e URL di base
  3. Autenticazione
  4. Schema della richiesta
  5. Schema della risposta
  6. Esempi
  7. Errori comuni
  8. Best practice
  9. FAQ
  10. Endpoint correlati

Cosa fa l'API elenco percorsi#

L'API elenco percorsi restituisce un elenco dei percorsi salvati per il tuo account. Viene comunemente usata per viste cronologiche dei percorsi, dashboard e schermate di ricerca in cui gli utenti devono trovare percorsi generati in precedenza.

I filtri tipici includono intervallo di date di creazione, proprietario e nome del percorso. Questo aiuta a mantenere le ricerche dei percorsi veloci, mirate e più facili da gestire in flotte più grandi.

Se hai bisogno dei dettagli completi di un singolo percorso, incluse fermate, indicazioni e tempi, usa la API Route .

Endpoint e URL di base#

La documentazione seguente di Routes List si concentra sul modello di integrazione SOAP mostrato da GetRouteList. Segui la documentazione del tuo account e Swagger quando i dettagli specifici della distribuzione sono diversi.

SOAP

Elemento Valore
Endpoint https://trackservice.trackroad.com/TrackService.asmx
WSDL https://trackservice.trackroad.com/TrackService.asmx?WSDL
Metodo GetRouteList
SOAPAction http://TrackService.TrackRoad.com/GetRouteList

Autenticazione#

Per SOAP, invia il tuo TrackServiceKey in SessionIDHeader come SessionID. Login e Logout non sono richiesti quando si usa TrackServiceKey.

Conserva le chiavi API lato server ed evita di esporre valori di autenticazione nel codice del browser o delle app mobili.

Schema della richiesta#

La richiesta descrive i filtri usati per trovare i percorsi salvati. In SOAP, questi valori vengono passati come parametri di GetRouteList.

Campi di filtro dell'elenco percorsi

Campo Tipo Obbligatorio Descrizione
FromDate string (date-time) No Filtra i percorsi creati o aggiornati a partire da questo timestamp in formato ISO 8601.
ToDate string (date-time) No Filtra i percorsi creati o aggiornati fino a questo timestamp in formato ISO 8601.
Owner string No Filtra per proprietario o nome utente, se supportato dalla configurazione del tuo account.
RouteName string No Filtra per nome del percorso con corrispondenza esatta o parziale, a seconda dell'implementazione.

Se la tua implementazione espone filtri aggiuntivi come stato, paginazione o numero massimo di risultati, documenta anche questi campi qui.

Schema della risposta#

Una risposta riuscita restituisce un elenco di percorsi che corrispondono ai tuoi filtri insieme a eventuali informazioni di stato o errore restituite dal servizio.

Risultato Routes

Proprietà Tipo Descrizione
Routes RouteSummary[] Elenco dei record di riepilogo dei percorsi corrispondenti.
Errors Error[] Errori o avvisi facoltativi restituiti dal servizio.
Status int (enum) Codice di stato, comunemente 0=None, 1=Success, 2=Failed, 3=SuccessWithErrors.

Riepilogo percorso

Proprietà Tipo Descrizione
RouteID string / int Identificatore del percorso usato successivamente per recuperare i dettagli completi del percorso.
RouteName string Nome del percorso leggibile dall'utente.
Distance double Distanza totale del percorso.
Time int Tempo totale del percorso, di solito in secondi salvo configurazione diversa.
Owner string Identificatore del proprietario o del creatore, quando disponibile.
DateCreated string (date-time) Timestamp che indica quando il percorso è stato creato.

SOAP restituisce lo stesso concetto di elenco percorsi all'interno di una busta SOAP, con il risultato racchiuso negli elementi di risposta di GetRouteList.

Esempi#

Inserisci in questa sezione la richiesta SOAP di esempio, la risposta di esempio e gli esempi di codice multilingua. Il codice di esempio in sé non deve essere localizzato.

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>

Errori comuni#

  • Errore di autenticazione: SessionIDHeader mancante o non valido. Il valore di SessionID deve essere il tuo TrackServiceKey.
  • Formato data non valido: fornisci le date in formato ISO 8601, ad esempio 2026-01-31T23:59:59Z.
  • Nessun percorso corrispondente: l'intervallo di filtri, il proprietario o il nome del percorso potrebbero essere troppo restrittivi.
  • Problema di servizio o autorizzazione: la chiave può essere valida ma bloccata, scaduta o limitata per l'ambito account richiesto.

Best practice#

  • Usa filtri di data per mantenere risposte veloci e prevedibili, soprattutto nelle viste della cronologia dei percorsi.
  • Memorizza nella cache gli elenchi percorsi per dashboard caricate frequentemente e aggiornali su richiesta quando gli utenti cercano di nuovo.
  • Carica i dettagli del percorso solo quando necessario invece di recuperare i dati completi per ogni riga di risultato.
  • Documenta i campi specifici dell'account quando la tua distribuzione supporta filtri aggiuntivi o proprietà di risposta personalizzate.

FAQ#

Cosa fa l'API elenco percorsi?
L'API elenco percorsi restituisce un elenco di percorsi precedentemente salvati, solitamente filtrati per intervallo di date, proprietario o nome del percorso.
Qual è l'equivalente SOAP dell'API elenco percorsi?
Il nome del metodo SOAP è GetRouteList.
Come mi autentico?
Per SOAP, invia il tuo TrackServiceKey in SessionIDHeader come SessionID. Login e Logout non sono richiesti quando si usa TrackServiceKey.
Quando dovrei usare l'API elenco percorsi invece dell'API Route?
Usa l'API elenco percorsi per cercare ed elencare i percorsi salvati. Usa la API Route quando hai bisogno dei dettagli completi del percorso, come fermate, indicazioni e tempi.

Vuoi i dettagli del percorso?

Usa Routes List per trovare i valori RouteID salvati, poi apri la documentazione dell'API Route per caricare elenchi completi delle fermate, distanze del percorso e dettagli temporali.

Vai all'API Route Visualizza Swagger UI