Routes List API (List Saved Routes)

Q: What is the SOAP equivalent of the Routes List API?

The SOAP method name is GetRouteList.

Q: How do I authenticate?

For SOAP, send your TrackServiceKey in SessionIDHeader as SessionID. Login and Logout are not required when using TrackServiceKey.

Use the TrackRoad Routes List API to retrieve previously saved routes using filters such as date range, owner, and route name. For SOAP integrations, the equivalent method is GetRouteList.

List and filter previously saved routes for reporting, dashboards, and route history lookups.

Need the full contract?

Swagger includes endpoint models and fields for REST, while the WSDL exposes the SOAP contract for GetRouteList and related methods.

View Swagger UI View SOAP WSDL API Reference Overview

What Routes List API does
Endpoints and base URLs
Authentication
Request schema
Response schema
Examples
Common errors
Best practices
FAQ
Related endpoints

What Routes List API does#

The Routes List API returns a list of saved routes for your account. It is commonly used for route history views, dashboards, and search screens where users need to find previously generated routes.

Typical filters include creation date range, owner, and route name. This helps keep route searches fast, focused, and easier to manage in larger fleets.

If you need the full details for one route, including stops, directions, and timing, use the Route API .

Endpoints and base URLs#

The Routes List documentation below focuses on the SOAP integration pattern shown by GetRouteList. Follow your account documentation and Swagger where deployment-specific details differ.

SOAP

Item	Value
Endpoint	https://trackservice.trackroad.com/TrackService.asmx
WSDL	https://trackservice.trackroad.com/TrackService.asmx?WSDL
Method	`GetRouteList`
SOAPAction	http://TrackService.TrackRoad.com/GetRouteList

Authentication#

For SOAP, send your TrackServiceKey in SessionIDHeader as SessionID. Login and Logout are not required when using TrackServiceKey.

Keep API keys server-side and avoid exposing authentication values in browser or mobile client code.

Request schema#

The request describes the filters used to find saved routes. In SOAP, these values are passed as GetRouteList parameters.

Route list filter fields

Field	Type	Required	Description
`FromDate`	string (date-time)	No	Filter routes created or updated on or after this timestamp in ISO 8601 format.
`ToDate`	string (date-time)	No	Filter routes created or updated on or before this timestamp in ISO 8601 format.
`Owner`	string	No	Filter by owner or username, if this is supported by your account configuration.
`RouteName`	string	No	Filter by route name using exact or partial matching, depending on implementation.

If your implementation exposes extra filters such as status, paging, or maximum results, document those additional fields here as well.

Response schema#

A successful response returns a list of routes that match your filters and any status or error information returned by the service.

Routes result

Property	Type	Description
`Routes`	RouteSummary[]	List of matching route summary records.
`Errors`	Error[]	Optional errors or warnings returned by the service.
`Status`	int (enum)	Status code, commonly 0=None, 1=Success, 2=Failed, 3=SuccessWithErrors.

Route summary

Property	Type	Description
`RouteID`	string / int	Route identifier used later to fetch full route details.
`RouteName`	string	Human-friendly route name.
`Distance`	double	Total route distance.
`Time`	int	Total route time, usually in seconds unless configured differently.
`Owner`	string	Owner or creator identifier, when available.
`DateCreated`	string (date-time)	Timestamp showing when the route was created.

SOAP returns the same route list concept inside a SOAP envelope, with the result wrapped by GetRouteList response elements.

Examples#

Place the SOAP example request, example response, and multi-language code samples in this section. Example code itself does not need to be localized.

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>

curl -X POST "https://trackservice.trackroad.com/TrackService.asmx" \
  -H "Content-Type: text/xml; charset=utf-8" \
  -H "SOAPAction: \"http://TrackService.TrackRoad.com/GetRouteList\"" \
  --data-binary @getroutelist.soap.xml

using System.Net.Http;
using System.Text;

var url = "https://trackservice.trackroad.com/TrackService.asmx";

var soap = @"

  
    
      YOUR_TRACKSERVICEKEY
    
  
  
    
      2026-01-01T00:00:00Z
      2026-01-31T23:59:59Z
      dispatcher@company.com
      January
    
  
";

using var http = new HttpClient();
using var content = new StringContent(soap, Encoding.UTF8, "text/xml");

content.Headers.Clear();
content.Headers.TryAddWithoutValidation("Content-Type", "text/xml; charset=utf-8");

var req = new HttpRequestMessage(HttpMethod.Post, url);
req.Headers.TryAddWithoutValidation("SOAPAction", "\"http://TrackService.TrackRoad.com/GetRouteList\"");
req.Content = content;

var resp = await http.SendAsync(req);
Console.WriteLine(await resp.Content.ReadAsStringAsync());

const url = "https://trackservice.trackroad.com/TrackService.asmx";

const soap = `

  
    
      YOUR_TRACKSERVICEKEY
    
  
  
    
      2026-01-01T00:00:00Z
      2026-01-31T23:59:59Z
      dispatcher@company.com
      January
    
  
`;

const res = await fetch(url, {
  method: "POST",
  headers: {
    "Content-Type": "text/xml; charset=utf-8",
    "SOAPAction": "\"http://TrackService.TrackRoad.com/GetRouteList\""
  },
  body: soap
});

console.log(await res.text());

import okhttp3.*;

public class Main {
  public static void main(String[] args) throws Exception {
    OkHttpClient client = new OkHttpClient();

    String soap = ""
      + ""
      + ""
      + ""
      + "YOUR_TRACKSERVICEKEY"
      + ""
      + ""
      + ""
      + ""
      + "2026-01-01T00:00:00Z"
      + "2026-01-31T23:59:59Z"
      + "dispatcher@company.com"
      + "January"
      + ""
      + ""
      + "";

    RequestBody body = RequestBody.create(soap, MediaType.parse("text/xml; charset=utf-8"));
    Request request = new Request.Builder()
      .url("https://trackservice.trackroad.com/TrackService.asmx")
      .post(body)
      .addHeader("SOAPAction", "\"http://TrackService.TrackRoad.com/GetRouteList\"")
      .build();

    try (Response response = client.newCall(request).execute()) {
      System.out.println(response.body().string());
    }
  }
}

import requests

url = "https://trackservice.trackroad.com/TrackService.asmx"
soap = """

  
    
      YOUR_TRACKSERVICEKEY
    
  
  
    
      2026-01-01T00:00:00Z
      2026-01-31T23:59:59Z
      dispatcher@company.com
      January
    
  
"""

headers = {
  "Content-Type": "text/xml; charset=utf-8",
  "SOAPAction": "\"http://TrackService.TrackRoad.com/GetRouteList\""
}

r = requests.post(url, data=soap.encode("utf-8"), headers=headers)
print(r.text)

<?php
$url = "https://trackservice.trackroad.com/TrackService.asmx";

$soap = '<?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>';

$ch = curl_init($url);
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Content-Type: text/xml; charset=utf-8",
    "SOAPAction: \"http://TrackService.TrackRoad.com/GetRouteList\""
  ],
  CURLOPT_POSTFIELDS => $soap
]);

echo curl_exec($ch);
curl_close($ch);

require "net/http"

uri = URI("https://trackservice.trackroad.com/TrackService.asmx")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

soap = <<~XML


  
    
      YOUR_TRACKSERVICEKEY
    
  
  
    
      2026-01-01T00:00:00Z
      2026-01-31T23:59:59Z
      dispatcher@company.com
      January
    
  

XML

req = Net::HTTP::Post.new(uri)
req["Content-Type"] = "text/xml; charset=utf-8"
req["SOAPAction"] = "\"http://TrackService.TrackRoad.com/GetRouteList\""
req.body = soap

res = http.request(req)
puts res.body

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  url := "https://trackservice.trackroad.com/TrackService.asmx"

  soap := []byte(`

  
    
      YOUR_TRACKSERVICEKEY
    
  
  
    
      2026-01-01T00:00:00Z
      2026-01-31T23:59:59Z
      dispatcher@company.com
      January
    
  
`)

  req, _ := http.NewRequest("POST", url, bytes.NewBuffer(soap))
  req.Header.Set("Content-Type", "text/xml; charset=utf-8")
  req.Header.Set("SOAPAction", "\"http://TrackService.TrackRoad.com/GetRouteList\"")

  resp, err := http.DefaultClient.Do(req)
  if err != nil { panic(err) }
  defer resp.Body.Close()

  b, _ := io.ReadAll(resp.Body)
  fmt.Println(string(b))
}

import java.net.URI
import java.net.http.HttpClient
import java.net.http.HttpRequest
import java.net.http.HttpResponse

fun main() {
  val url = "https://trackservice.trackroad.com/TrackService.asmx"
  val soap = """
    
    
      
        
          YOUR_TRACKSERVICEKEY
        
      
      
        
          2026-01-01T00:00:00Z
          2026-01-31T23:59:59Z
          dispatcher@company.com
          January
        
      
    
  """.trimIndent()

  val client = HttpClient.newHttpClient()
  val req = HttpRequest.newBuilder()
    .uri(URI.create(url))
    .header("Content-Type", "text/xml; charset=utf-8")
    .header("SOAPAction", "\"http://TrackService.TrackRoad.com/GetRouteList\"")
    .POST(HttpRequest.BodyPublishers.ofString(soap))
    .build()

  val resp = client.send(req, HttpResponse.BodyHandlers.ofString())
  println(resp.body())
}

#include <stdio.h>
#include <curl/curl.h>

int main(void) {
  CURL *curl = curl_easy_init();
  if(!curl) return 1;

  const char *url = "https://trackservice.trackroad.com/TrackService.asmx";
  const char *soap =
    ""
    ""
    ""
    ""
    "YOUR_TRACKSERVICEKEY"
    ""
    ""
    ""
    ""
    "2026-01-01T00:00:00Z"
    "2026-01-31T23:59:59Z"
    "dispatcher@company.com"
    "January"
    ""
    ""
    "";

  struct curl_slist *headers = NULL;
  headers = curl_slist_append(headers, "Content-Type: text/xml; charset=utf-8");
  headers = curl_slist_append(headers, "SOAPAction: \"http://TrackService.TrackRoad.com/GetRouteList\"");

  curl_easy_setopt(curl, CURLOPT_URL, url);
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  curl_easy_setopt(curl, CURLOPT_POSTFIELDS, soap);

  CURLcode res = curl_easy_perform(curl);

  curl_slist_free_all(headers);
  curl_easy_cleanup(curl);

  return (res == CURLE_OK) ? 0 : 1;
}

#include <curl/curl.h>
#include <string>

int main() {
  CURL* curl = curl_easy_init();
  if(!curl) return 1;

  std::string url = "https://trackservice.trackroad.com/TrackService.asmx";
  std::string soap =
    ""
    ""
    ""
    ""
    "YOUR_TRACKSERVICEKEY"
    ""
    ""
    ""
    ""
    "2026-01-01T00:00:00Z"
    "2026-01-31T23:59:59Z"
    "dispatcher@company.com"
    "January"
    ""
    ""
    "";

  struct curl_slist* headers = NULL;
  headers = curl_slist_append(headers, "Content-Type: text/xml; charset=utf-8");
  headers = curl_slist_append(headers, "SOAPAction: \"http://TrackService.TrackRoad.com/GetRouteList\"");

  curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  curl_easy_setopt(curl, CURLOPT_POSTFIELDS, soap.c_str());

  CURLcode res = curl_easy_perform(curl);

  curl_slist_free_all(headers);
  curl_easy_cleanup(curl);

  return (res == CURLE_OK) ? 0 : 1;
}

#import <Foundation/Foundation.h>

int main() {
  @autoreleasepool {
    NSURL *url = [NSURL URLWithString:@"https://trackservice.trackroad.com/TrackService.asmx"];
    NSMutableURLRequest *req = [NSMutableURLRequest requestWithURL:url];
    [req setHTTPMethod:@"POST"];
    [req setValue:@"text/xml; charset=utf-8" forHTTPHeaderField:@"Content-Type"];
    [req setValue:@"\"http://TrackService.TrackRoad.com/GetRouteList\"" forHTTPHeaderField:@"SOAPAction"];

    NSString *soap = @""
      ""
      ""
      ""
      "YOUR_TRACKSERVICEKEY"
      ""
      ""
      ""
      ""
      "2026-01-01T00:00:00Z"
      "2026-01-31T23:59:59Z"
      "dispatcher@company.com"
      "January"
      ""
      ""
      "";

    [req setHTTPBody:[soap dataUsingEncoding:NSUTF8StringEncoding]];

    NSURLSessionDataTask *task =
      [[NSURLSession sharedSession] dataTaskWithRequest:req
      completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        if (error) { NSLog(@"%@", error); return; }
        NSString *text = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", text);
      }];

    [task resume];
    [[NSRunLoop currentRunLoop] run];
  }
  return 0;
}

import Foundation

let url = URL(string: "https://trackservice.trackroad.com/TrackService.asmx")!
var req = URLRequest(url: url)
req.httpMethod = "POST"
req.setValue("text/xml; charset=utf-8", forHTTPHeaderField: "Content-Type")
req.setValue("\"http://TrackService.TrackRoad.com/GetRouteList\"", forHTTPHeaderField: "SOAPAction")

let soap = """


  
    
      YOUR_TRACKSERVICEKEY
    
  
  
    
      2026-01-01T00:00:00Z
      2026-01-31T23:59:59Z
      dispatcher@company.com
      January
    
  

"""

req.httpBody = soap.data(using: .utf8)

let task = URLSession.shared.dataTask(with: req) { data, _, error in
  if let error = error { print(error); return }
  print(String(data: data ?? Data(), encoding: .utf8) ?? "")
}
task.resume()
RunLoop.main.run()

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>

Common errors#

Authentication error: Missing or invalid SessionIDHeader. The SessionID value must be your TrackServiceKey.
Invalid date format: Provide dates in ISO 8601 format, for example 2026-01-31T23:59:59Z.
No matching routes: Your filter range, owner, or route name may be too restrictive.
Service or permission issue: The key may be valid but blocked, expired, or limited for the requested account scope.

Best practices#

Use date filters to keep responses fast and predictable, especially for route history screens.
Cache route lists for dashboards that load frequently, then refresh on demand when users search again.
Load route details only when needed instead of fetching full route data for every result row.
Document account-specific fields when your deployment supports extra filters or custom response properties.

FAQ#

What does the Routes List API do?

The Routes List API returns a list of previously saved routes, usually filtered by date range, owner, or route name.

What is the SOAP equivalent of the Routes List API?

The SOAP method name is GetRouteList.

How do I authenticate?