What does the Routes API do?

Routes API calculates one or many routes in one request. Each route contains an ordered list of locations plus distance/time information, and may include a map output depending on options.

How do I authenticate to Routes (REST and SOAP)?

REST: send TrackServiceKey in the X-API-Key header. SOAP: send TrackServiceKey in SessionIDHeader as SessionID for each CalculateRoutes call.

When should I use Routes vs Route?

Use Route when you need to calculate a single route. Use Routes when you want to calculate multiple routes (batch) in one call.

Routes API (Batch Route Calculation)

Use Routes to calculate multiple routes in one request. REST returns JSON. SOAP uses CalculateRoutes.

Routes calculates multiple routes in one call—useful for matrix-style comparisons, bulk planning, and faster batch workflows.

Need the full contract?

Swagger includes REST models. SOAP is available via the WSDL.

View Swagger UI View SOAP WSDL API Reference Overview

What Routes does
Endpoints and base URLs
Authentication (REST & SOAP)
Request schema
Response schema
Examples (REST JSON + SOAP)
Common errors
Best practices
Related endpoints

What Routes does#

Routes calculates one or many routes in a single request. Each route uses an ordered list of Location inputs and optional RouteOptions. You can also set a global RoutesOptions applied to all routes.

Tip: If you only need one route, use Route API. If you need multiple routes at once (batch), use this Routes API.

Endpoints and base URLs#

REST (JSON)#

Item	Value
Base URL	https://trackservice.trackroad.com
Endpoint	`POST /rest/routes`
Full URL	https://trackservice.trackroad.com/rest/routes
Content-Type	`application/json`

SOAP (CalculateRoutes)#

Item	Value
SOAP URL	https://trackservice.trackroad.com/TrackService.asmx
WSDL	https://trackservice.trackroad.com/TrackService.asmx?WSDL
Method	`CalculateRoutes`
SOAPAction	http://TrackService.TrackRoad.com/CalculateRoutes
Content-Type	`text/xml; charset=utf-8`

SOAP and REST share the same conceptual models (RouteSpecification, RouteOptions, Location). The transport differs (JSON vs SOAP envelope + SessionIDHeader).

Authentication (REST & SOAP)#

REST authentication (X-API-Key)#

Include your TrackServiceKey in the X-API-Key header on every REST request. See: API Authentication.

curl -X POST "https://trackservice.trackroad.com/rest/routes" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_TRACKSERVICEKEY" \
  -d '{ "Specifications": [], "RoutesOptions": { "RoutingService": 0, "DistanceUnit": 0, "RouteOptimize": 0 } }'

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

var url = "https://trackservice.trackroad.com/rest/routes";
using var http = new HttpClient();
http.DefaultRequestHeaders.Add("X-API-Key", "YOUR_TRACKSERVICEKEY");

var json = @"{
  ""Specifications"": [],
  ""RoutesOptions"": { ""RoutingService"": 0, ""DistanceUnit"": 0, ""RouteOptimize"": 0 }
}";
using var content = new StringContent(json, Encoding.UTF8, "application/json");

var resp = await http.PostAsync(url, content);
Console.WriteLine(await resp.Content.ReadAsStringAsync());

const url = "https://trackservice.trackroad.com/rest/routes";

const payload = {
  Specifications: [],
  RoutesOptions: { RoutingService: 0, DistanceUnit: 0, RouteOptimize: 0 }
};

const res = await fetch(url, {
  method: "POST",
  headers: { "Content-Type": "application/json", "X-API-Key": "YOUR_TRACKSERVICEKEY" },
  body: JSON.stringify(payload)
});

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

import okhttp3.*;

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

    String json = "{"
      + "\"Specifications\":[],"
      + "\"RoutesOptions\":{\"RoutingService\":0,\"DistanceUnit\":0,\"RouteOptimize\":0}"
      + "}";

    RequestBody body = RequestBody.create(json, MediaType.parse("application/json"));
    Request req = new Request.Builder()
      .url("https://trackservice.trackroad.com/rest/routes")
      .post(body)
      .addHeader("Content-Type", "application/json")
      .addHeader("X-API-Key", "YOUR_TRACKSERVICEKEY")
      .build();

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

import requests

url = "https://trackservice.trackroad.com/rest/routes"
headers = { "Content-Type": "application/json", "X-API-Key": "YOUR_TRACKSERVICEKEY" }
payload = {
  "Specifications": [],
  "RoutesOptions": { "RoutingService": 0, "DistanceUnit": 0, "RouteOptimize": 0 }
}

r = requests.post(url, headers=headers, json=payload)
print(r.text)

<?php
$url = "https://trackservice.trackroad.com/rest/routes";
$payload = json_encode([
  "Specifications" => [],
  "RoutesOptions" => ["RoutingService" => 0, "DistanceUnit" => 0, "RouteOptimize" => 0]
]);

$ch = curl_init($url);
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ["Content-Type: application/json", "X-API-Key: YOUR_TRACKSERVICEKEY"],
  CURLOPT_POSTFIELDS => $payload
]);

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

require "net/http"
require "json"

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

payload = {
  Specifications: [],
  RoutesOptions: { RoutingService: 0, DistanceUnit: 0, RouteOptimize: 0 }
}

req = Net::HTTP::Post.new(uri)
req["Content-Type"] = "application/json"
req["X-API-Key"] = "YOUR_TRACKSERVICEKEY"
req.body = payload.to_json

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

package main

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

func main() {
  url := "https://trackservice.trackroad.com/rest/routes"
  body := []byte(`{"Specifications":[],"RoutesOptions":{"RoutingService":0,"DistanceUnit":0,"RouteOptimize":0}}`)

  req, _ := http.NewRequest("POST", url, bytes.NewBuffer(body))
  req.Header.Set("Content-Type", "application/json")
  req.Header.Set("X-API-Key", "YOUR_TRACKSERVICEKEY")

  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/rest/routes"
  val json = """{"Specifications":[],"RoutesOptions":{"RoutingService":0,"DistanceUnit":0,"RouteOptimize":0}}"""

  val client = HttpClient.newHttpClient()
  val req = HttpRequest.newBuilder()
    .uri(URI.create(url))
    .header("Content-Type", "application/json")
    .header("X-API-Key", "YOUR_TRACKSERVICEKEY")
    .POST(HttpRequest.BodyPublishers.ofString(json))
    .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/rest/routes";
  const char *json = "{\"Specifications\":[],\"RoutesOptions\":{\"RoutingService\":0,\"DistanceUnit\":0,\"RouteOptimize\":0}}";

  struct curl_slist *headers = NULL;
  headers = curl_slist_append(headers, "Content-Type: application/json");
  headers = curl_slist_append(headers, "X-API-Key: YOUR_TRACKSERVICEKEY");

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

  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/rest/routes";
  std::string json = R"({"Specifications":[],"RoutesOptions":{"RoutingService":0,"DistanceUnit":0,"RouteOptimize":0}})";

  struct curl_slist* headers = NULL;
  headers = curl_slist_append(headers, "Content-Type: application/json");
  headers = curl_slist_append(headers, "X-API-Key: YOUR_TRACKSERVICEKEY");

  curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  curl_easy_setopt(curl, CURLOPT_POSTFIELDS, json.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/rest/routes"];
    NSMutableURLRequest *req = [NSMutableURLRequest requestWithURL:url];
    [req setHTTPMethod:@"POST"];
    [req setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [req setValue:@"YOUR_TRACKSERVICEKEY" forHTTPHeaderField:@"X-API-Key"];

    NSData *body = [@"{\"Specifications\":[],\"RoutesOptions\":{\"RoutingService\":0,\"DistanceUnit\":0,\"RouteOptimize\":0}}"
                    dataUsingEncoding:NSUTF8StringEncoding];
    [req setHTTPBody:body];

    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/rest/routes")!
var req = URLRequest(url: url)
req.httpMethod = "POST"
req.setValue("application/json", forHTTPHeaderField: "Content-Type")
req.setValue("YOUR_TRACKSERVICEKEY", forHTTPHeaderField: "X-API-Key")

let json = #"{"Specifications":[],"RoutesOptions":{"RoutingService":0,"DistanceUnit":0,"RouteOptimize":0}}"#
req.httpBody = json.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 authentication (SessionIDHeader)#

SOAP requests use SessionIDHeader. Send your TrackServiceKey as SessionID for each call.

Recommended: use REST unless you must integrate with an existing SOAP-only system.

Request schema#

REST request body is a single object (batch): RoutesSpecification with a list of RouteSpecification. SOAP uses the same logical specification inside <CalculateRoutes>.

Shared models#

Location, LatLong, and Address are shared across endpoints. See: Dispatch API (shared models).

RoutesSpecification (REST)#

Property	Type	Required	Description
`Specifications`	RouteSpecification[]	Yes*	One item per route you want to calculate (batch).
`RoutesOptions`	RouteOptions	No	Global defaults applied to each route unless overridden by per-route RouteOptions.

RouteSpecification#

Property	Type	Required	Description
`Locations`	Location[]	Yes*	Stops for this route (order may be optimized based on RouteOptions).
`RouteOptions`	RouteOptions	No	Per-route overrides (routing engine, units, optimize mode, map options).

RouteOptions (summary)#

RouteOptions fields (RoutingService / DistanceUnit / RouteOptimize / Culture / Map options) are similar to the Route endpoint.

Response schema#

REST response (RoutesResult)#

Property	Type	Description
`Results`	RouteResult[]	One result per input RouteSpecification.
`Map`	string	Optional map output (depends on options; can be empty).
`Errors`	Error[]	Optional warnings/errors.
`Status`	int (enum)	0=None, 1=Success, 2=Failed, 3=SuccessWithErrors.

SOAP response (CalculateRoutesResult)#

SOAP response wraps the same logical shape under <CalculateRoutesResponse>.

Examples (REST JSON + SOAP)#

REST JSON request example (batch)#

This example calculates two routes in one request. Each route has its own Locations list.

{
  "Specifications": [
    {
      "Locations": [
        { "Name": "A", "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 1 },
        { "Name": "B", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 }, "LocationType": 0 },
        { "Name": "C", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 }, "LocationType": 2 }
      ],
      "RouteOptions": { "RoutingService": 0, "DistanceUnit": 0, "RouteOptimize": 0 }
    },
    {
      "Locations": [
        { "Name": "Start", "LatLong": { "Latitude": 34.0522, "Longitude": -118.2437 }, "LocationType": 1 },
        { "Name": "Stop 1", "LatLong": { "Latitude": 34.0407, "Longitude": -118.2468 }, "LocationType": 0 },
        { "Name": "Finish", "LatLong": { "Latitude": 34.0522, "Longitude": -118.2437 }, "LocationType": 2 }
      ]
    }
  ],
  "RoutesOptions": { "RoutingService": 0, "DistanceUnit": 0, "RouteOptimize": 0 }
}

REST request examples (multiple languages)#

curl -X POST "https://trackservice.trackroad.com/rest/routes" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_TRACKSERVICEKEY" \
  -d '{
    "Specifications": [
      {
        "Locations": [
          { "Name": "A", "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 1 },
          { "Name": "B", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 }, "LocationType": 0 },
          { "Name": "C", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 }, "LocationType": 2 }
        ],
        "RouteOptions": { "RoutingService": 0, "DistanceUnit": 0, "RouteOptimize": 0 }
      }
    ],
    "RoutesOptions": { "RoutingService": 0, "DistanceUnit": 0, "RouteOptimize": 0 }
  }'

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

var url = "https://trackservice.trackroad.com/rest/routes";
using var http = new HttpClient();
http.DefaultRequestHeaders.Add("X-API-Key", "YOUR_TRACKSERVICEKEY");

var json = @"{
  ""Specifications"": [
    {
      ""Locations"": [
        { ""Name"": ""A"", ""LatLong"": { ""Latitude"": 37.7946, ""Longitude"": -122.3950 }, ""LocationType"": 1 },
        { ""Name"": ""B"", ""LatLong"": { ""Latitude"": 37.7897, ""Longitude"": -122.4011 }, ""LocationType"": 0 },
        { ""Name"": ""C"", ""LatLong"": { ""Latitude"": 37.7810, ""Longitude"": -122.4110 }, ""LocationType"": 2 }
      ],
      ""RouteOptions"": { ""RoutingService"": 0, ""DistanceUnit"": 0, ""RouteOptimize"": 0 }
    }
  ],
  ""RoutesOptions"": { ""RoutingService"": 0, ""DistanceUnit"": 0, ""RouteOptimize"": 0 }
}";
using var content = new StringContent(json, Encoding.UTF8, "application/json");

var resp = await http.PostAsync(url, content);
Console.WriteLine(await resp.Content.ReadAsStringAsync());

const url = "https://trackservice.trackroad.com/rest/routes";

const payload = {
  Specifications: [{
    Locations: [
      { Name: "A", LatLong: { Latitude: 37.7946, Longitude: -122.3950 }, LocationType: 1 },
      { Name: "B", LatLong: { Latitude: 37.7897, Longitude: -122.4011 }, LocationType: 0 },
      { Name: "C", LatLong: { Latitude: 37.7810, Longitude: -122.4110 }, LocationType: 2 }
    ],
    RouteOptions: { RoutingService: 0, DistanceUnit: 0, RouteOptimize: 0 }
  }],
  RoutesOptions: { RoutingService: 0, DistanceUnit: 0, RouteOptimize: 0 }
};

const res = await fetch(url, {
  method: "POST",
  headers: { "Content-Type": "application/json", "X-API-Key": "YOUR_TRACKSERVICEKEY" },
  body: JSON.stringify(payload)
});

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

import okhttp3.*;

public class Main {
  public static void main(String[] args) throws Exception {
    OkHttpClient client = new OkHttpClient();
    String json = "{"
      + "\"Specifications\":[{"
        + "\"Locations\":["
          + "{\"Name\":\"A\",\"LatLong\":{\"Latitude\":37.7946,\"Longitude\":-122.3950},\"LocationType\":1},"
          + "{\"Name\":\"B\",\"LatLong\":{\"Latitude\":37.7897,\"Longitude\":-122.4011},\"LocationType\":0},"
          + "{\"Name\":\"C\",\"LatLong\":{\"Latitude\":37.7810,\"Longitude\":-122.4110},\"LocationType\":2}"
        + "],"
        + "\"RouteOptions\":{\"RoutingService\":0,\"DistanceUnit\":0,\"RouteOptimize\":0}"
      + "}],"
      + "\"RoutesOptions\":{\"RoutingService\":0,\"DistanceUnit\":0,\"RouteOptimize\":0}"
    + "}";

    RequestBody body = RequestBody.create(json, MediaType.parse("application/json"));
    Request req = new Request.Builder()
      .url("https://trackservice.trackroad.com/rest/routes")
      .post(body)
      .addHeader("Content-Type", "application/json")
      .addHeader("X-API-Key", "YOUR_TRACKSERVICEKEY")
      .build();

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

import requests

url = "https://trackservice.trackroad.com/rest/routes"
headers = { "Content-Type": "application/json", "X-API-Key": "YOUR_TRACKSERVICEKEY" }
payload = {
  "Specifications": [{
    "Locations": [
      { "Name": "A", "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 1 },
      { "Name": "B", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 }, "LocationType": 0 },
      { "Name": "C", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 }, "LocationType": 2 }
    ],
    "RouteOptions": { "RoutingService": 0, "DistanceUnit": 0, "RouteOptimize": 0 }
  }],
  "RoutesOptions": { "RoutingService": 0, "DistanceUnit": 0, "RouteOptimize": 0 }
}

r = requests.post(url, headers=headers, json=payload)
print(r.text)

<?php
$url = "https://trackservice.trackroad.com/rest/routes";
$payload = json_encode([
  "Specifications" => [[
    "Locations" => [
      ["Name" => "A", "LatLong" => ["Latitude" => 37.7946, "Longitude" => -122.3950], "LocationType" => 1],
      ["Name" => "B", "LatLong" => ["Latitude" => 37.7897, "Longitude" => -122.4011], "LocationType" => 0],
      ["Name" => "C", "LatLong" => ["Latitude" => 37.7810, "Longitude" => -122.4110], "LocationType" => 2]
    ],
    "RouteOptions" => ["RoutingService" => 0, "DistanceUnit" => 0, "RouteOptimize" => 0]
  ]],
  "RoutesOptions" => ["RoutingService" => 0, "DistanceUnit" => 0, "RouteOptimize" => 0]
]);

$ch = curl_init($url);
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ["Content-Type: application/json", "X-API-Key: YOUR_TRACKSERVICEKEY"],
  CURLOPT_POSTFIELDS => $payload
]);

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

require "net/http"
require "json"

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

payload = {
  Specifications: [{
    Locations: [
      { Name: "A", LatLong: { Latitude: 37.7946, Longitude: -122.3950 }, LocationType: 1 },
      { Name: "B", LatLong: { Latitude: 37.7897, Longitude: -122.4011 }, LocationType: 0 },
      { Name: "C", LatLong: { Latitude: 37.7810, Longitude: -122.4110 }, LocationType: 2 }
    ],
    RouteOptions: { RoutingService: 0, DistanceUnit: 0, RouteOptimize: 0 }
  }],
  RoutesOptions: { RoutingService: 0, DistanceUnit: 0, RouteOptimize: 0 }
}

req = Net::HTTP::Post.new(uri)
req["Content-Type"] = "application/json"
req["X-API-Key"] = "YOUR_TRACKSERVICEKEY"
req.body = payload.to_json

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

package main

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

func main() {
  url := "https://trackservice.trackroad.com/rest/routes"
  body := []byte(`{
    "Specifications":[
      {
        "Locations":[
          {"Name":"A","LatLong":{"Latitude":37.7946,"Longitude":-122.3950},"LocationType":1},
          {"Name":"B","LatLong":{"Latitude":37.7897,"Longitude":-122.4011},"LocationType":0},
          {"Name":"C","LatLong":{"Latitude":37.7810,"Longitude":-122.4110},"LocationType":2}
        ],
        "RouteOptions":{"RoutingService":0,"DistanceUnit":0,"RouteOptimize":0}
      }
    ],
    "RoutesOptions":{"RoutingService":0,"DistanceUnit":0,"RouteOptimize":0}
  }`)

  req, _ := http.NewRequest("POST", url, bytes.NewBuffer(body))
  req.Header.Set("Content-Type", "application/json")
  req.Header.Set("X-API-Key", "YOUR_TRACKSERVICEKEY")

  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/rest/routes"
  val json = """
    {
      "Specifications": [
        {
          "Locations": [
            { "Name": "A", "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 1 },
            { "Name": "B", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 }, "LocationType": 0 },
            { "Name": "C", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 }, "LocationType": 2 }
          ],
          "RouteOptions": { "RoutingService": 0, "DistanceUnit": 0, "RouteOptimize": 0 }
        }
      ],
      "RoutesOptions": { "RoutingService": 0, "DistanceUnit": 0, "RouteOptimize": 0 }
    }
  """.trimIndent()

  val client = HttpClient.newHttpClient()
  val req = HttpRequest.newBuilder()
    .uri(URI.create(url))
    .header("Content-Type", "application/json")
    .header("X-API-Key", "YOUR_TRACKSERVICEKEY")
    .POST(HttpRequest.BodyPublishers.ofString(json))
    .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/rest/routes";
  const char *json =
    "{"
      "\"Specifications\":[{"
        "\"Locations\":["
          "{\"Name\":\"A\",\"LatLong\":{\"Latitude\":37.7946,\"Longitude\":-122.3950},\"LocationType\":1},"
          "{\"Name\":\"B\",\"LatLong\":{\"Latitude\":37.7897,\"Longitude\":-122.4011},\"LocationType\":0},"
          "{\"Name\":\"C\",\"LatLong\":{\"Latitude\":37.7810,\"Longitude\":-122.4110},\"LocationType\":2}"
        "],"
        "\"RouteOptions\":{\"RoutingService\":0,\"DistanceUnit\":0,\"RouteOptimize\":0}"
      "}],"
      "\"RoutesOptions\":{\"RoutingService\":0,\"DistanceUnit\":0,\"RouteOptimize\":0}"
    "}";

  struct curl_slist *headers = NULL;
  headers = curl_slist_append(headers, "Content-Type: application/json");
  headers = curl_slist_append(headers, "X-API-Key: YOUR_TRACKSERVICEKEY");

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

  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/rest/routes";
  std::string json = R"({
    "Specifications":[
      {
        "Locations":[
          {"Name":"A","LatLong":{"Latitude":37.7946,"Longitude":-122.3950},"LocationType":1},
          {"Name":"B","LatLong":{"Latitude":37.7897,"Longitude":-122.4011},"LocationType":0},
          {"Name":"C","LatLong":{"Latitude":37.7810,"Longitude":-122.4110},"LocationType":2}
        ],
        "RouteOptions":{"RoutingService":0,"DistanceUnit":0,"RouteOptimize":0}
      }
    ],
    "RoutesOptions":{"RoutingService":0,"DistanceUnit":0,"RouteOptimize":0}
  })";

  struct curl_slist* headers = NULL;
  headers = curl_slist_append(headers, "Content-Type: application/json");
  headers = curl_slist_append(headers, "X-API-Key: YOUR_TRACKSERVICEKEY");

  curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  curl_easy_setopt(curl, CURLOPT_POSTFIELDS, json.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/rest/routes"];
    NSMutableURLRequest *req = [NSMutableURLRequest requestWithURL:url];
    [req setHTTPMethod:@"POST"];
    [req setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [req setValue:@"YOUR_TRACKSERVICEKEY" forHTTPHeaderField:@"X-API-Key"];

    NSString *json = @"{\"Specifications\":[{\"Locations\":[{\"Name\":\"A\",\"LatLong\":{\"Latitude\":37.7946,\"Longitude\":-122.3950},\"LocationType\":1},{\"Name\":\"B\",\"LatLong\":{\"Latitude\":37.7897,\"Longitude\":-122.4011},\"LocationType\":0},{\"Name\":\"C\",\"LatLong\":{\"Latitude\":37.7810,\"Longitude\":-122.4110},\"LocationType\":2}],\"RouteOptions\":{\"RoutingService\":0,\"DistanceUnit\":0,\"RouteOptimize\":0}}],\"RoutesOptions\":{\"RoutingService\":0,\"DistanceUnit\":0,\"RouteOptimize\":0}}";
    [req setHTTPBody:[json 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/rest/routes")!
var req = URLRequest(url: url)
req.httpMethod = "POST"
req.setValue("application/json", forHTTPHeaderField: "Content-Type")
req.setValue("YOUR_TRACKSERVICEKEY", forHTTPHeaderField: "X-API-Key")

let json = """
{
  "Specifications": [
    {
      "Locations": [
        { "Name": "A", "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 1 },
        { "Name": "B", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 }, "LocationType": 0 },
        { "Name": "C", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 }, "LocationType": 2 }
      ],
      "RouteOptions": { "RoutingService": 0, "DistanceUnit": 0, "RouteOptimize": 0 }
    }
  ],
  "RoutesOptions": { "RoutingService": 0, "DistanceUnit": 0, "RouteOptimize": 0 }
}
"""
req.httpBody = json.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()

REST JSON response example (shape)#

{
  "Results": [
    {
      "Route": {
        "Distance": 12.34,
        "Time": 1880,
        "Locations": [
          { "Name": "A", "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 } },
          { "Name": "B", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 } },
          { "Name": "C", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 } }
        ]
      }
    }
  ],
  "Map": "",
  "Errors": [],
  "Status": 1
}

SOAP request example (CalculateRoutes) — raw XML#

SOAP uses SessionIDHeader with SessionID = TrackServiceKey and SOAPAction http://TrackService.TrackRoad.com/CalculateRoutes.

<!-- POST https://trackservice.trackroad.com/TrackService.asmx -->
<!-- Content-Type: text/xml; charset=utf-8 -->
<!-- SOAPAction: "http://TrackService.TrackRoad.com/CalculateRoutes" -->

<?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>
    <CalculateRoutes xmlns="http://TrackService.TrackRoad.com/">
      <specification>
        <Specifications>
          <RouteSpecification>
            <Locations>
              <Location>
                <Name>A</Name>
                <LocationType>Start</LocationType>
                <LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong>
              </Location>
              <Location>
                <Name>B</Name>
                <LocationType>Midway</LocationType>
                <LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong>
              </Location>
              <Location>
                <Name>C</Name>
                <LocationType>Finish</LocationType>
                <LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong>
              </Location>
            </Locations>

            <RouteOptions>
              <RoutingService>NetRoad</RoutingService>
              <DistanceUnit>Mile</DistanceUnit>
              <RouteOptimize>MinimizeTime</RouteOptimize>
            </RouteOptions>
          </RouteSpecification>
        </Specifications>

        <RoutesOptions>
          <RoutingService>NetRoad</RoutingService>
          <DistanceUnit>Mile</DistanceUnit>
          <RouteOptimize>MinimizeTime</RouteOptimize>
        </RoutesOptions>
      </specification>
    </CalculateRoutes>
  </soap:Body>
</soap:Envelope>

SOAP request examples (multiple languages)#

Place this block right below the “SOAP request example (CalculateRoutes) — raw XML” section above. Each language example sends the same 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/CalculateRoutes" \
  -d @calculateRoutes.xml

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

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

var 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>
    <CalculateRoutes xmlns=""http://TrackService.TrackRoad.com/"">
      <specification>
        <Specifications>
          <RouteSpecification>
            <Locations>
              <Location>
                <Name>A</Name>
                <LocationType>Start</LocationType>
                <LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong>
              </Location>
              <Location>
                <Name>B</Name>
                <LocationType>Midway</LocationType>
                <LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong>
              </Location>
              <Location>
                <Name>C</Name>
                <LocationType>Finish</LocationType>
                <LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong>
              </Location>
            </Locations>
            <RouteOptions>
              <RoutingService>NetRoad</RoutingService>
              <DistanceUnit>Mile</DistanceUnit>
              <RouteOptimize>MinimizeTime</RouteOptimize>
            </RouteOptions>
          </RouteSpecification>
        </Specifications>
        <RoutesOptions>
          <RoutingService>NetRoad</RoutingService>
          <DistanceUnit>Mile</DistanceUnit>
          <RouteOptimize>MinimizeTime</RouteOptimize>
        </RoutesOptions>
      </specification>
    </CalculateRoutes>
  </soap:Body>
</soap:Envelope>";

using var http = new HttpClient();
var content = new StringContent(soap, Encoding.UTF8, "text/xml");
content.Headers.Add("SOAPAction", "http://TrackService.TrackRoad.com/CalculateRoutes");

var resp = await http.PostAsync(url, content);
Console.WriteLine(await resp.Content.ReadAsStringAsync());

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

const 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>
    <CalculateRoutes xmlns="http://TrackService.TrackRoad.com/">
      <specification>
        <Specifications>
          <RouteSpecification>
            <Locations>
              <Location><Name>A</Name><LocationType>Start</LocationType><LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong></Location>
              <Location><Name>B</Name><LocationType>Midway</LocationType><LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong></Location>
              <Location><Name>C</Name><LocationType>Finish</LocationType><LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong></Location>
            </Locations>
            <RouteOptions><RoutingService>NetRoad</RoutingService><DistanceUnit>Mile</DistanceUnit><RouteOptimize>MinimizeTime</RouteOptimize></RouteOptions>
          </RouteSpecification>
        </Specifications>
        <RoutesOptions><RoutingService>NetRoad</RoutingService><DistanceUnit>Mile</DistanceUnit><RouteOptimize>MinimizeTime</RouteOptimize></RoutesOptions>
      </specification>
    </CalculateRoutes>
  </soap:Body>
</soap:Envelope>`;

const res = await fetch(url, {
  method: "POST",
  headers: {
    "Content-Type": "text/xml; charset=utf-8",
    "SOAPAction": "http://TrackService.TrackRoad.com/CalculateRoutes"
  },
  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 =
      "<?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>"
    + "  <CalculateRoutes xmlns=\"http://TrackService.TrackRoad.com/\">"
    + "   <specification>"
    + "    <Specifications>"
    + "     <RouteSpecification>"
    + "      <Locations>"
    + "       <Location><Name>A</Name><LocationType>Start</LocationType><LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong></Location>"
    + "       <Location><Name>B</Name><LocationType>Midway</LocationType><LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong></Location>"
    + "       <Location><Name>C</Name><LocationType>Finish</LocationType><LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong></Location>"
    + "      </Locations>"
    + "      <RouteOptions><RoutingService>NetRoad</RoutingService><DistanceUnit>Mile</DistanceUnit><RouteOptimize>MinimizeTime</RouteOptimize></RouteOptions>"
    + "     </RouteSpecification>"
    + "    </Specifications>"
    + "    <RoutesOptions><RoutingService>NetRoad</RoutingService><DistanceUnit>Mile</DistanceUnit><RouteOptimize>MinimizeTime</RouteOptimize></RoutesOptions>"
    + "   </specification>"
    + "  </CalculateRoutes>"
    + " </soap:Body>"
    + "</soap:Envelope>";

    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("Content-Type", "text/xml; charset=utf-8")
      .addHeader("SOAPAction", "http://TrackService.TrackRoad.com/CalculateRoutes")
      .build();

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

import requests

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>
    <CalculateRoutes xmlns="http://TrackService.TrackRoad.com/">
      <specification>
        <Specifications>
          <RouteSpecification>
            <Locations>
              <Location><Name>A</Name><LocationType>Start</LocationType><LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong></Location>
              <Location><Name>B</Name><LocationType>Midway</LocationType><LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong></Location>
              <Location><Name>C</Name><LocationType>Finish</LocationType><LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong></Location>
            </Locations>
            <RouteOptions>
              <RoutingService>NetRoad</RoutingService>
              <DistanceUnit>Mile</DistanceUnit>
              <RouteOptimize>MinimizeTime</RouteOptimize>
            </RouteOptions>
          </RouteSpecification>
        </Specifications>
        <RoutesOptions>
          <RoutingService>NetRoad</RoutingService>
          <DistanceUnit>Mile</DistanceUnit>
          <RouteOptimize>MinimizeTime</RouteOptimize>
        </RoutesOptions>
      </specification>
    </CalculateRoutes>
  </soap:Body>
</soap:Envelope>
"""

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

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

<?php
$url = "https://trackservice.trackroad.com/TrackService.asmx";
$soap = <<<XML
<?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>
    <CalculateRoutes xmlns="http://TrackService.TrackRoad.com/">
      <specification>
        <Specifications>
          <RouteSpecification>
            <Locations>
              <Location><Name>A</Name><LocationType>Start</LocationType><LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong></Location>
              <Location><Name>B</Name><LocationType>Midway</LocationType><LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong></Location>
              <Location><Name>C</Name><LocationType>Finish</LocationType><LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong></Location>
            </Locations>
            <RouteOptions><RoutingService>NetRoad</RoutingService><DistanceUnit>Mile</DistanceUnit><RouteOptimize>MinimizeTime</RouteOptimize></RouteOptions>
          </RouteSpecification>
        </Specifications>
        <RoutesOptions><RoutingService>NetRoad</RoutingService><DistanceUnit>Mile</DistanceUnit><RouteOptimize>MinimizeTime</RouteOptimize></RoutesOptions>
      </specification>
    </CalculateRoutes>
  </soap:Body>
</soap:Envelope>
XML;

$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/CalculateRoutes"
  ],
  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
<?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>
    <CalculateRoutes xmlns="http://TrackService.TrackRoad.com/">
      <specification>
        <Specifications>
          <RouteSpecification>
            <Locations>
              <Location><Name>A</Name><LocationType>Start</LocationType><LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong></Location>
              <Location><Name>B</Name><LocationType>Midway</LocationType><LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong></Location>
              <Location><Name>C</Name><LocationType>Finish</LocationType><LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong></Location>
            </Locations>
          </RouteSpecification>
        </Specifications>
      </specification>
    </CalculateRoutes>
  </soap:Body>
</soap:Envelope>
XML

req = Net::HTTP::Post.new(uri)
req["Content-Type"] = "text/xml; charset=utf-8"
req["SOAPAction"] = "http://TrackService.TrackRoad.com/CalculateRoutes"
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(`<?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>
    <CalculateRoutes xmlns="http://TrackService.TrackRoad.com/">
      <specification>
        <Specifications>
          <RouteSpecification>
            <Locations>
              <Location><Name>A</Name><LocationType>Start</LocationType><LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong></Location>
            </Locations>
          </RouteSpecification>
        </Specifications>
      </specification>
    </CalculateRoutes>
  </soap:Body>
</soap:Envelope>`)

  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/CalculateRoutes")

  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 = """
    <?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>
        <CalculateRoutes xmlns="http://TrackService.TrackRoad.com/">
          <specification>
            <Specifications>
              <RouteSpecification>
                <Locations>
                  <Location>
                    <Name>A</Name>
                    <LocationType>Start</LocationType>
                    <LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong>
                  </Location>
                </Locations>
              </RouteSpecification>
            </Specifications>
          </specification>
        </CalculateRoutes>
      </soap:Body>
    </soap:Envelope>
  """.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/CalculateRoutes")
    .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 =
    "<?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><CalculateRoutes xmlns=\"http://TrackService.TrackRoad.com/\">"
    "<specification><Specifications><RouteSpecification><Locations>"
    "<Location><Name>A</Name><LocationType>Start</LocationType>"
    "<LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong>"
    "</Location></Locations></RouteSpecification></Specifications></specification>"
    "</CalculateRoutes></soap:Body></soap:Envelope>";

  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/CalculateRoutes");

  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 =
    "<?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><CalculateRoutes xmlns=\"http://TrackService.TrackRoad.com/\">"
    "<specification><Specifications><RouteSpecification><Locations>"
    "<Location><Name>A</Name><LocationType>Start</LocationType><LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong></Location>"
    "</Locations></RouteSpecification></Specifications></specification>"
    "</CalculateRoutes></soap:Body></soap:Envelope>";

  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/CalculateRoutes");

  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/CalculateRoutes" forHTTPHeaderField:@"SOAPAction"];

    NSString *soap =
      @""
       ""
       "YOUR_TRACKSERVICEKEY"
       ""
       "AStart37.7946-122.3950"
       "";

    [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/CalculateRoutes", forHTTPHeaderField: "SOAPAction")

let 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>
    <CalculateRoutes xmlns="http://TrackService.TrackRoad.com/">
      <specification>
        <Specifications>
          <RouteSpecification>
            <Locations>
              <Location>
                <Name>A</Name>
                <LocationType>Start</LocationType>
                <LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong>
              </Location>
            </Locations>
          </RouteSpecification>
        </Specifications>
      </specification>
    </CalculateRoutes>
  </soap:Body>
</soap:Envelope>
"""
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)#

Place this below your REST JSON response example.

<?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:Body>
    <CalculateRoutesResponse xmlns="http://TrackService.TrackRoad.com/">
      <CalculateRoutesResult>
        <Results>
          <RouteResult>
            <Route>
              <Distance>12.34</Distance>
              <Time>1880</Time>
              <Locations>
                <Location>
                  <Name>A</Name>
                  <LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong>
                </Location>
                <Location>
                  <Name>B</Name>
                  <LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong>
                </Location>
                <Location>
                  <Name>C</Name>
                  <LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong>
                </Location>
              </Locations>
            </Route>
          </RouteResult>
        </Results>
        <Map></Map>
      </CalculateRoutesResult>
    </CalculateRoutesResponse>
  </soap:Body>
</soap:Envelope>

Common errors#

REST 401 / Unauthorized: Missing or invalid X-API-Key.
REST 403 / Forbidden: Key valid but blocked, expired, or lacks credit.
SOAP auth failure: Missing/invalid SessionIDHeader (SessionID must be your TrackServiceKey).
Validation: Missing Locations, invalid coordinates, or invalid enum values.

Best practices#

Batch smartly: Put multiple route calculations into one Routes call to reduce overhead.
Prefer LatLong: Provide coordinates to avoid geocoding ambiguity/cost.
Use global RoutesOptions: Set defaults once, override only when needed per route.
Keep options consistent: Mixing units/engines across routes can make comparisons harder.

Next step: optimize across vehicles

If you need to assign stops to multiple vehicles and optimize stop order per vehicle, use Dispatch.

Go to Dispatch Swagger UI

Table of Contents