Dispatch API (Routenoptimierung)

Q: Wie authentifiziere ich mich bei Dispatch REST und SOAP?

REST verwendet Ihren TrackServiceKey im X-API-Key-Header. SOAP verwendet denselben TrackServiceKey im SessionIDHeader als SessionID.

Q: Benötige ich LatLong oder Address für Stopps?

LatLong wird bevorzugt. Wenn LatLong nicht angegeben ist, ist Address erforderlich, damit TrackRoad den Stopp geokodieren kann.

Verwenden Sie Dispatch, um Routen über mehrere Fahrzeuge und viele Stopps zu optimieren. Dispatch liefert eine geordnete Route pro Fahrzeug mit Zeit-, Distanz- und Zuordnungsausgaben für Lieferrouting, Field Service, Kurierdienste und Flottenplanung.

Dispatch verteilt Stopps auf mehrere Fahrzeuge und liefert optimierte Routen mit Stopp-Reihenfolge, ETA, Distanz und Dauer für jedes Fahrzeug zurück.

Benötigen Sie den vollständigen Vertrag?

Verwenden Sie Swagger für REST-Modelle und WSDL für SOAP-Integrationsdetails.

Swagger UI anzeigen SOAP WSDL anzeigen Übersicht der API-Referenz

Inhaltsverzeichnis

Was Dispatch macht
Optima-Modus, Time Window & TimeWindowDepot
Mehrere Abholungen und Lieferungen
Endpunkte und Basis-URLs
Authentifizierung
Anfrageschema
Antwortschema
Häufige Fehler
Best Practices
Verwandte Endpunkte
FAQ

Was Dispatch macht#

Dispatch löst ein Routingproblem mit mehreren Fahrzeugen. Es weist Stopps Fahrzeugen zu und ordnet jede Route unter Berücksichtigung von Einschränkungen wie Zeitfenstern, Kapazität, Priorität sowie Start- oder Zielorten.

LatLong wird bevorzugt. Jeder Stopp sollte nach Möglichkeit LatLong enthalten. Wenn LatLong nicht angegeben wird, müssen Sie eine Address angeben, damit der Dienst den Stopp geokodieren kann.

Die Dispatch-Methode akzeptiert eine Liste von Fahrzeugen und eine Liste von Stopp-Standorten. Jedes Fahrzeug kann einen Startort und optional einen Zielort enthalten. Jeder Standort kann einen Namen, Adressfelder sowie Breiten- und Längengrad enthalten.

Wenn Breiten- und Längengrad vorhanden sind, verwendet TrackRoad diese direkt. Andernfalls geokodiert der Dienst die Adresse, um Koordinaten zu erhalten.

Dispatch gibt Fahrzeugobjekte zurück. Jedes Fahrzeugobjekt enthält die zugewiesene Route als geordnete Liste von Stopps, optimiert nach Standort, Kapazität, Zeit und anderen Routingfaktoren.

Wenn nur ein Fahrzeug verfügbar ist, führt Dispatch nur eine Routenoptimierung durch. Dispatch-Modi sind vor allem relevant, wenn mehrere Fahrzeuge verfügbar sind.

Wenn Sie nicht sicher sind, welchen Dispatch-Modus Sie verwenden sollen, beginnen Sie mit Auto. Für hochgenaue Optimierung mit einem einzelnen Fahrzeug verwenden Sie Optima.

Optima-Modus, Time Window & TimeWindowDepot#

In manchen Sprachen ist es möglicherweise nicht möglich, einen null-Datetime-Wert zu übergeben. Verwenden Sie in diesem Fall 0001-01-01T00:00:00. Daten, die älter als der Systemschwellenwert sind, werden als Nullwerte behandelt.

Für beste Ergebnisse verwenden Sie DispatchMode Optima.

Drei Variablen beeinflussen das Verhalten der Zeitfenster-Disposition:

CanArriveEarly
TimeConstraintArrival
TimeConstraintDeparture

Option 1: CanArriveEarly = true

Wenn CanArriveEarly true ist, beginnt das Zeitfenster zu Tagesbeginn. Wenn TimeConstraintArrival null ist, kann der Stopp jederzeit während des Tages besucht werden. Wenn TimeConstraintArrival gesetzt ist, definiert es die späteste zulässige Ankunftszeit. Die Abfahrtszeit wird ignoriert.

Option 2: CanArriveEarly = false

Wenn CanArriveEarly false ist, definieren Ankunft und Abfahrt das zulässige Zeitfenster. Wenn die Ankunft gesetzt ist und die Abfahrt null ist, wird der Stopp wie ein fester Termin behandelt. Wenn beide gesetzt sind, versucht TrackRoad, den Stopp innerhalb dieses Zeitbereichs zu besuchen.

Option 3: Zwei Zeitfenster

Sie können auch ein zweites Zeitfenster mit TimeConstraintArrival2 und TimeConstraintDeparture2 angeben. Das ist nützlich, wenn ein Stopp nur in zwei getrennten Zeiträumen besucht werden kann, etwa bei eingeschränkten Lieferzeiten in Innenstädten. TimeWindowDepot folgt derselben Logik, geht aber davon aus, dass Fahrzeuge an einem gemeinsamen Depot starten und enden.

Pausen können mit LocationType = Break modelliert werden. Mehrere Abhol- und Lieferketten unterstützen auf Lieferebene nur ein Lieferzeitfenster, und diese untergeordnete Zeitvorgabe darf nicht enger sein als die übergeordnete Einschränkung.

Mehrere Abholungen und Lieferungen#

Dispatch unterstützt Pickup- und Delivery-Verkettungen. Das ist nützlich für Kurierdienste und Workflows, bei denen ein Stopp vor einem anderen besucht werden muss.

Verwenden Sie Midway für den ersten Stopp in einer Kette und Delivery, um den nächsten verknüpften Standort anzugeben. Verwenden Sie DeliveryNonStop, um festzulegen, ob die nächste verknüpfte Lieferung sofort oder später auf derselben Route erfolgen muss.

Wenn zum Beispiel ein Paket an Standort B abgeholt und an Standort M zugestellt wird, bewahrt TrackRoad die erforderliche Beziehung zwischen Abholung und Lieferung und optimiert gleichzeitig die Route rund um die übrigen Stopps.

DeliveryNonStop = true

Wenn DeliveryNonStop true ist, muss der verknüpfte Lieferstopp unmittelbar nach dem Abholstopp besucht werden.

DeliveryNonStop = false

Wenn DeliveryNonStop false ist, muss die verknüpfte Lieferung zwar nach der Abholung erfolgen, aber nicht unmittelbar danach.

Sie können mehrere Lieferungen verketten, z. B. B → M → N, indem Sie Delivery und KeepSameOrder an jedem verknüpften Stopp setzen.

Für Rundtouren definieren Sie Abhol-, Liefer- und Rückgabeorte als Kette. Eine gängige Empfehlung ist DeliveryNonStop = false und KeepSameOrder = true, um flexiblere Optimierung bei gleichzeitiger Wahrung der Geschäftsreihenfolge zu ermöglichen.

TrackRoad API Beispiel für Rundtour-Stopps — Beispiel: Stopps einer Rundtour.

TrackRoad API Beispiel für Rundtour-Route — Beispiel: Route einer Rundtour.

Endpunkte und Basis-URLs#

REST

Element	Wert
Basis-URL	https://trackservice.trackroad.com
Endpunkt	`POST /rest/dispatch`
Vollständige URL	https://trackservice.trackroad.com/rest/dispatch
Content-Type	`application/json`

SOAP

Element	Wert
Endpunkt	https://trackservice.trackroad.com/TrackService.asmx
WSDL	https://trackservice.trackroad.com/TrackService.asmx?WSDL
Methode	`Dispatch`
SOAPAction	http://trackservice.trackroad.com/Dispatch

SOAP verwendet dieselben Modelle DispatchSpecification und DispatchResult. Der Hauptunterschied besteht im SOAP-Envelope und der headerbasierten Authentifizierung.

Authentifizierung#

REST-Authentifizierung (X-API-Key)

Fügen Sie Ihren TrackServiceKey in jedem Request in den Header X-API-Key ein. Erstellen Sie den Schlüssel in Ihrem TrackRoad-Konto unter API-Authentifizierung .

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

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

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

var json = @"{
  ""RoutingService"": 0,
  ""DistanceUnit"": 0,
  ""RouteOptimize"": 0,
  ""Vehicles"": [],
  ""Locations"": []
}";
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/dispatch";

const res = await fetch(url, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": "YOUR_TRACKSERVICEKEY"
  },
  body: JSON.stringify({
    RoutingService: 0,
    DistanceUnit: 0,
    RouteOptimize: 0,
    Vehicles: [],
    Locations: []
  })
});

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

import okhttp3.*;

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

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

    RequestBody body = RequestBody.create(json, MediaType.parse("application/json"));

    Request request = new Request.Builder()
      .url("https://trackservice.trackroad.com/rest/dispatch")
      .post(body)
      .addHeader("Content-Type", "application/json")
      .addHeader("X-API-Key", "YOUR_TRACKSERVICEKEY")
      .build();

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

import requests

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

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

<?php
$url = "https://trackservice.trackroad.com/rest/dispatch";

$payload = json_encode([
  "RoutingService" => 0,
  "DistanceUnit" => 0,
  "RouteOptimize" => 0,
  "Vehicles" => [],
  "Locations" => []
]);

$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/dispatch")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri)
req["Content-Type"] = "application/json"
req["X-API-Key"] = "YOUR_TRACKSERVICEKEY"
req.body = {
  RoutingService: 0,
  DistanceUnit: 0,
  RouteOptimize: 0,
  Vehicles: [],
  Locations: []
}.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/dispatch"
  jsonBody := []byte(`{"RoutingService":0,"DistanceUnit":0,"RouteOptimize":0,"Vehicles":[],"Locations":[]}`)

  req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonBody))
  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/dispatch"
  val json = """{"RoutingService":0,"DistanceUnit":0,"RouteOptimize":0,"Vehicles":[],"Locations":[]}"""

  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/dispatch";
  const char *json = "{\"RoutingService\":0,\"DistanceUnit\":0,\"RouteOptimize\":0,\"Vehicles\":[],\"Locations\":[]}";

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

  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/dispatch"];
    NSMutableURLRequest *req = [NSMutableURLRequest requestWithURL:url];
    [req setHTTPMethod:@"POST"];
    [req setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [req setValue:@"YOUR_TRACKSERVICEKEY" forHTTPHeaderField:@"X-API-Key"];

    NSDictionary *payload = @{
      @"RoutingService": @0,
      @"DistanceUnit": @0,
      @"RouteOptimize": @0,
      @"Vehicles": @[],
      @"Locations": @[]
    };

    NSData *body = [NSJSONSerialization dataWithJSONObject:payload options:0 error:nil];
    [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/dispatch")!
var req = URLRequest(url: url)
req.httpMethod = "POST"
req.setValue("application/json", forHTTPHeaderField: "Content-Type")
req.setValue("YOUR_TRACKSERVICEKEY", forHTTPHeaderField: "X-API-Key")

let payload: [String: Any] = [
  "RoutingService": 0,
  "DistanceUnit": 0,
  "RouteOptimize": 0,
  "Vehicles": [],
  "Locations": []
]
req.httpBody = try! JSONSerialization.data(withJSONObject: payload)

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()

Bewahren Sie API-Schlüssel serverseitig auf. Betten Sie Schlüssel nicht in Browser- oder mobilen Client-Code ein.

SOAP-Authentifizierung (SessionIDHeader)

Für SOAP-Requests senden Sie Ihren TrackServiceKey im SessionIDHeader als SessionID. Veraltete Login- und Logout-Aufrufe sind nicht erforderlich, wenn Sie TrackServiceKey-Authentifizierung verwenden.

<?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>
    <Dispatch xmlns="http://trackservice.trackroad.com/">
      <specification>
        <RoutingService>0</RoutingService>
        <DistanceUnit>0</DistanceUnit>
        <RouteOptimize>0</RouteOptimize>
        <Vehicles />
        <Locations />
      </specification>
    </Dispatch>
  </soap:Body>
</soap:Envelope>

/*
  1) Add Service Reference to:
     https://trackservice.trackroad.com/TrackService.asmx?WSDL

  2) Set SessionIDHeader.SessionID = YOUR_TRACKSERVICEKEY
     then call Dispatch(spec).
*/

var client = new TrackService.TrackServiceSoapClient();
var header = new TrackService.SessionIDHeader { SessionID = "YOUR_TRACKSERVICEKEY" };

var spec = new TrackService.DispatchSpecification
{
    RoutingService = TrackService.RoutingService.NetRoad,
    DistanceUnit = TrackService.DistanceUnit.Mile,
    RouteOptimize = TrackService.RouteOptimize.MinimizeTime,
    Vehicles = new TrackService.Vehicle[] { },
    Locations = new TrackService.Location[] { }
};

var result = client.Dispatch(header, spec);

SOAP-Namespaces und Präfixe können je nach Tooling variieren. Ein aus dem WSDL generierter Client ist meist die einfachste Option.

Anfrageschema#

Der Request-Body ist ein einzelnes Objekt: DispatchSpecification. Mindestens müssen Fahrzeuge und Standorte angegeben werden.

DispatchSpecification

Eigenschaft	Typ	Erforderlich	Beschreibung
`RoutingService`	int (enum)	Nein	Routing-Engine. 0 = NetRoad, 1 = TrackRoad, 2 = Bing. Empfohlen: 0 = NetRoad.
`IsNeedMatchCode`	bool	Nein	Wenn true, werden Geokodierungs-Match-Qualitätscodes eingebunden, sofern relevant.
`CurrentTime`	string (date-time)	Nein	Aktuelle Zeitreferenz für Zeiteinschränkungen im ISO-8601-Format.
`DispatchMode`	int (enum)	Nein	Optimierungsstrategie. Empfehlungen zu Modi finden Sie unter Dispatch-Modi.
`MinimumOptimization`	int	Nein	Schwellenwert für Optimierungsintensität. Typischer Bereich: 1 bis 10.
`DistanceUnit`	int (enum)	Nein	0 = Meile, 1 = Kilometer.
`RouteOptimize`	int (enum)	Nein	0 = MinimizeTime, 1 = MinimizeDistance. Empfohlen: 0 = MinimizeTime.
`Vehicles`	Vehicle[]	Nein	Für die Disposition verfügbare Fahrzeuge.
`Locations`	Location[]	Ja	Stopps, die zugewiesen und geordnet werden.

DispatchMode

Eigenschaft	Typ	Wert	Beschreibung
`Auto`	int	0	Wählt automatisch eine geeignete Dispositionsstrategie aus. Bester Standard-Startpunkt.
`EqualStop`	int	1	Versucht, eine gleiche Anzahl von Stopps auf die Fahrzeuge zu verteilen.
`SingleRegion`	int	2	Nützlich, wenn Fahrzeuge geografisch verteilt sind, aber Stopps in ähnlichen Gebieten bedienen.
`MultipleRegion`	int	3	Nützlich für Fahrzeuge in verschiedenen Städten oder weit entfernten Regionen sowie für Echtzeit-Field-Dispatch.
`EqualHour`	int	4	Versucht, Arbeit in Routen mit ähnlicher Gesamtzeit aufzuteilen.
`EqualDistance`	int	5	Versucht, Arbeit in Routen mit ähnlicher Gesamtdistanz aufzuteilen.
`TimeWindow`	int	6	Priorisiert Termin- und Lieferzeitfenster. Die Optimierung kann reduziert werden, um Zeitvorgaben einzuhalten.
`TimeWindowDepot`	int	7	Zeitfenstermodus, der von einem zentralen Depot für alle Fahrzeuge ausgeht.
`Optima`	int	8	Hochgenauer Modus für ein einzelnes Fahrzeug, mit oder ohne Zeitfenster.
`BalanceLocation`	int	9	Balanciert die Anzahl zugewiesener Stopps über mehrere Fahrer.
`BalanceTime`	int	10	Balanciert die Routenzeit über mehrere Fahrer.
`MinimumVehicles`	int	11	Wählt die minimale Anzahl an Fahrzeugen, die erforderlich ist, um alle Stopps unter Berücksichtigung der Routingfaktoren zu bedienen.

Vehicle

Eigenschaft	Typ	Erforderlich	Beschreibung
`Name`	string	Empfohlen	Fahrzeugkennzeichnung, die in den Ergebnissen angezeigt wird.
`Email`	string	Nein	Optionaler Fahrer- oder Fahrzeugkontakt.
`Group`	string	Nein	Optionales Gruppierungsfeld wie Team, Depot oder Region.
`Speed`	int	Nein	Optionale Geschwindigkeitsüberschreibung. Wenn auf 0 gesetzt, wird die Standard-Straßengeschwindigkeit verwendet.
`MaxStops`	int	Nein	Maximale Anzahl von Stopps pro Route für das Fahrzeug.
`MaxWeight`	double	Nein	Maximale Gewichtskapazität des Fahrzeugs.
`MaxSkids`	int	Nein	Maximale Kapazität für Skids des Fahrzeugs.
`MaxVolume`	double	Nein	Maximale Volumenkapazität des Fahrzeugs.
`MaxMinutes`	int	Nein	Maximale Routendauer für das Fahrzeug.
`FuelCost`	double	Nein	Optionaler Kostenparameter, der von einigen Optimierungsmodi verwendet wird.
`OnTheRoad`	bool	Nein	Wenn true, kann eine mehrtägige Route vom Endort des Vortags fortgesetzt werden, statt zum ursprünglichen Startpunkt zurückzukehren.
`Tin`	string (date-time)	Nein	Zeitstempel, ab dem das Fahrzeug verfügbar ist.
`Tout`	string (date-time)	Nein	Zeitstempel, bis zu dem das Fahrzeug verfügbar ist.
`StartLocation`	Location	Nein	Optionales Startdepot oder Startposition für das Fahrzeug.
`FinishLocation`	Location	Nein	Optionales Zieldepot oder Endposition für das Fahrzeug.
`Roles`	string	Nein	Optionale Rollen-Zeichenfolge, die mit Stopp-Bedingungen abgeglichen werden kann.
`TransportType`	int (enum)	Nein	Transportmodus wie Auto, Lkw, Bus, Motorrad, Fußgänger, Roller oder Fahrrad.
`ExcludeTolls`	bool	Nein	Gibt an, ob mautpflichtige Straßen vermieden werden sollen.
`ExcludeHighways`	bool	Nein	Gibt an, ob Autobahnen vermieden werden sollen.
`UseTruckRoute`	bool	Nein	Gibt an, ob Lkw-Routen bevorzugt oder zugelassen werden sollen.
`Width`	float	Nein	Fahrzeugbreite in Metern.
`Height`	float	Nein	Fahrzeughöhe in Metern.
`Length`	float	Nein	Fahrzeuglänge in Metern.
`AxleLoad`	float	Nein	Achslast des Fahrzeugs in metrischen Tonnen.
`AxleCount`	int	Nein	Anzahl der Achsen.

TrackRoad API Beispiel für die OnTheRoad-Funktion eines Fahrzeugs — Beispiel: Verhalten täglicher Routen mit aktiviertem bzw. deaktiviertem OnTheRoad.

Location

Jeder Standort sollte nach Möglichkeit LatLong enthalten. Wenn Koordinaten fehlen, ist Address erforderlich, damit TrackRoad den Stopp geokodieren kann.

Eigenschaft	Typ	Erforderlich	Beschreibung
`MatchCode`	int (enum)	Nein	Geocode-Match-Qualitätscode.
`Name`	string	Nein	Stopp-Bezeichnung, die in den Ergebnissen angezeigt wird.
`Delivery`	string	Nein	Name des verknüpften Lieferorts oder Kundenbezeichnung.
`DeliveryNonStop`	bool	Nein	Bestimmt, ob die verknüpfte Lieferung unmittelbar nach dem aktuellen Stopp erfolgen muss.
`KeepSameOrder`	bool	Nein	Wenn true, bleibt die im Request definierte relative Reihenfolge erhalten.
`Vehicle`	string	Nein	Optionale Vorzuweisung zu einem bestimmten Fahrzeug über den Namen.
`Description`	string	Nein	Optionale Hinweise oder Beschreibung.
`Phone`	string	Nein	Optionale Kontakttelefonnummer.
`LatLong`	LatLong	Bedingt	Bevorzugte Koordinateneingabe. Erforderlich, wenn keine Address angegeben wird.
`Address`	Address	Bedingt	Adresseingabe, die zur Geokodierung verwendet wird, wenn LatLong nicht angegeben ist.
`Priority`	int	Nein	Prioritätshinweis für die Optimierung.
`Wait`	int	Nein	Service- oder Wartezeit am Stopp.
`Volume`	double	Nein	Volumenbedarf, der von der Fahrzeugkapazität verbraucht wird.
`Weight`	double	Nein	Gewichtsbedarf, der von der Fahrzeugkapazität verbraucht wird.
`Skids`	int	Nein	Skid-Bedarf, der von der Fahrzeugkapazität verbraucht wird.
`TimeConstraintArrival`	string (date-time)	Nein	Primärer Ankunftswert des Zeitfensters.
`TimeConstraintDeparture`	string (date-time)	Nein	Primärer Abfahrtswert des Zeitfensters.
`TimeConstraintArrival2`	string (date-time)	Nein	Optionaler zweiter Ankunftswert des Zeitfensters.
`TimeConstraintDeparture2`	string (date-time)	Nein	Optionaler zweiter Abfahrtswert des Zeitfensters.
`LocationType`	int (enum)	Nein	0 = Midway, 1 = Start, 2 = Finish, 3 = Delivery, 4 = MidwayDrop, 5 = Break.
`CanArriveEarly`	bool	Nein	Wenn false, ist eine Ankunft vor dem zulässigen Zeitfenster nicht erlaubt.
`Conditions`	string	Nein	Optionale Geschäftsregel oder Rollen-Matching-Bedingung.

LatLong

Eigenschaft	Typ	Erforderlich	Beschreibung
`Latitude`	double	Ja	Breitengrad in Grad (-90 bis 90).
`Longitude`	double	Ja	Längengrad in Grad (-180 bis 180).

Address

Eigenschaft	Typ	Erforderlich	Beschreibung
`Street`	string	Empfohlen	Straßenadresse.
`City`	string	Empfohlen	Stadt.
`State`	string	Nein	Bundesland oder Region.
`PostalCode`	string	Nein	Postleitzahl.
`Country`	string	Empfohlen	Land.

Antwortschema#

Eine erfolgreiche Antwort gibt DispatchResult mit fahrzeugbezogenen Routenelementen und optionalen Fehlern oder Warnungen zurück.

DispatchResult

Eigenschaft	Typ	Beschreibung
`Items`	VehicleItem[]	Fahrzeugbezogene Ergebniselemente mit der zugewiesenen Route.
`Errors`	Error[]	Optionale Fehler oder Warnungen.
`Status`	int (enum)	Vorgangsstatus: 0 = None, 1 = Success, 2 = Failed, 3 = SuccessWithErrors.

VehicleItem

Eigenschaft	Typ	Beschreibung
`Vehicle`	Vehicle	Das Fahrzeug, das dieser Route zugeordnet ist.
`Locations`	Location[]	Geordnete Standorte, die diesem Fahrzeug zugewiesen sind.

Error

Eigenschaft	Typ	Beschreibung
`Message`	string	Menschenlesbare Fehler- oder Warnmeldung.

Beispiele#

Beispiel-Anfrage- und Antwort-Codeblöcke können unverändert bleiben und müssen nicht lokalisiert werden.

REST: Minimal request example (recommended pattern)#

{
  "RoutingService": 0,
  "DistanceUnit": 0,
  "RouteOptimize": 0,
  "DispatchMode": 0,
  "Vehicles": [
    {
      "Name": "Truck 1",
      "StartLocation": { "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 1 },
      "FinishLocation": { "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 2 }
    }
  ],
  "Locations": [
    { "Name": "Stop A", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 }, "LocationType": 0 },
    { "Name": "Stop B", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 }, "LocationType": 0 }
  ]
}

REST request examples (multiple languages)#

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

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

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

var json = @"{
  ""RoutingService"": 0,
  ""DistanceUnit"": 0,
  ""RouteOptimize"": 0,
  ""DispatchMode"": 0,
  ""Vehicles"": [
    {
      ""Name"": ""Truck 1"",
      ""StartLocation"": { ""LatLong"": { ""Latitude"": 37.7946, ""Longitude"": -122.3950 }, ""LocationType"": 1 },
      ""FinishLocation"": { ""LatLong"": { ""Latitude"": 37.7946, ""Longitude"": -122.3950 }, ""LocationType"": 2 }
    }
  ],
  ""Locations"": [
    { ""Name"": ""Stop A"", ""LatLong"": { ""Latitude"": 37.7897, ""Longitude"": -122.4011 }, ""LocationType"": 0 },
    { ""Name"": ""Stop B"", ""LatLong"": { ""Latitude"": 37.7810, ""Longitude"": -122.4110 }, ""LocationType"": 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/dispatch";

const payload = {
  RoutingService: 0,
  DistanceUnit: 0,
  RouteOptimize: 0,
  DispatchMode: 0,
  Vehicles: [
    {
      Name: "Truck 1",
      StartLocation: { LatLong: { Latitude: 37.7946, Longitude: -122.3950 }, LocationType: 1 },
      FinishLocation: { LatLong: { Latitude: 37.7946, Longitude: -122.3950 }, LocationType: 2 }
    }
  ],
  Locations: [
    { Name: "Stop A", LatLong: { Latitude: 37.7897, Longitude: -122.4011 }, LocationType: 0 },
    { Name: "Stop B", LatLong: { Latitude: 37.7810, Longitude: -122.4110 }, LocationType: 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 = "{"
      + "\"RoutingService\":0,"
      + "\"DistanceUnit\":0,"
      + "\"RouteOptimize\":0,"
      + "\"DispatchMode\":0,"
      + "\"Vehicles\":[{"
        + "\"Name\":\"Truck 1\","
        + "\"StartLocation\":{\"LatLong\":{\"Latitude\":37.7946,\"Longitude\":-122.3950},\"LocationType\":1},"
        + "\"FinishLocation\":{\"LatLong\":{\"Latitude\":37.7946,\"Longitude\":-122.3950},\"LocationType\":2}"
      + "}],"
      + "\"Locations\":[{"
        + "\"Name\":\"Stop A\","
        + "\"LatLong\":{\"Latitude\":37.7897,\"Longitude\":-122.4011},"
        + "\"LocationType\":0"
      + "},{"
        + "\"Name\":\"Stop B\","
        + "\"LatLong\":{\"Latitude\":37.7810,\"Longitude\":-122.4110},"
        + "\"LocationType\":0"
      + "}]"
      + "}";

    RequestBody body = RequestBody.create(json, MediaType.parse("application/json"));

    Request request = new Request.Builder()
      .url("https://trackservice.trackroad.com/rest/dispatch")
      .post(body)
      .addHeader("Content-Type", "application/json")
      .addHeader("X-API-Key", "YOUR_TRACKSERVICEKEY")
      .build();

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

import requests

url = "https://trackservice.trackroad.com/rest/dispatch"
headers = {
  "Content-Type": "application/json",
  "X-API-Key": "YOUR_TRACKSERVICEKEY"
}

payload = {
  "RoutingService": 0,
  "DistanceUnit": 0,
  "RouteOptimize": 0,
  "DispatchMode": 0,
  "Vehicles": [
    {
      "Name": "Truck 1",
      "StartLocation": { "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 1 },
      "FinishLocation": { "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 2 }
    }
  ],
  "Locations": [
    { "Name": "Stop A", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 }, "LocationType": 0 },
    { "Name": "Stop B", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 }, "LocationType": 0 }
  ]
}

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

<?php
$url = "https://trackservice.trackroad.com/rest/dispatch";

$payload = json_encode([
  "RoutingService" => 0,
  "DistanceUnit" => 0,
  "RouteOptimize" => 0,
  "DispatchMode" => 0,
  "Vehicles" => [[
    "Name" => "Truck 1",
    "StartLocation" => [ "LatLong" => [ "Latitude" => 37.7946, "Longitude" => -122.3950 ], "LocationType" => 1 ],
    "FinishLocation" => [ "LatLong" => [ "Latitude" => 37.7946, "Longitude" => -122.3950 ], "LocationType" => 2 ]
  ]],
  "Locations" => [
    [ "Name" => "Stop A", "LatLong" => [ "Latitude" => 37.7897, "Longitude" => -122.4011 ], "LocationType" => 0 ],
    [ "Name" => "Stop B", "LatLong" => [ "Latitude" => 37.7810, "Longitude" => -122.4110 ], "LocationType" => 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/dispatch")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

payload = {
  RoutingService: 0,
  DistanceUnit: 0,
  RouteOptimize: 0,
  DispatchMode: 0,
  Vehicles: [
    {
      Name: "Truck 1",
      StartLocation: { LatLong: { Latitude: 37.7946, Longitude: -122.3950 }, LocationType: 1 },
      FinishLocation: { LatLong: { Latitude: 37.7946, Longitude: -122.3950 }, LocationType: 2 }
    }
  ],
  Locations: [
    { Name: "Stop A", LatLong: { Latitude: 37.7897, Longitude: -122.4011 }, LocationType: 0 },
    { Name: "Stop B", LatLong: { Latitude: 37.7810, Longitude: -122.4110 }, LocationType: 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/dispatch"
  jsonBody := []byte(`{
    "RoutingService": 0,
    "DistanceUnit": 0,
    "RouteOptimize": 0,
    "DispatchMode": 0,
    "Vehicles": [
      {
        "Name": "Truck 1",
        "StartLocation": { "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 1 },
        "FinishLocation": { "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 2 }
      }
    ],
    "Locations": [
      { "Name": "Stop A", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 }, "LocationType": 0 },
      { "Name": "Stop B", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 }, "LocationType": 0 }
    ]
  }`)

  req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonBody))
  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/dispatch"
  val json = """
    {
      "RoutingService": 0,
      "DistanceUnit": 0,
      "RouteOptimize": 0,
      "DispatchMode": 0,
      "Vehicles": [
        {
          "Name": "Truck 1",
          "StartLocation": { "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 1 },
          "FinishLocation": { "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 2 }
        }
      ],
      "Locations": [
        { "Name": "Stop A", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 }, "LocationType": 0 },
        { "Name": "Stop B", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 }, "LocationType": 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/dispatch";
  const char *json =
    "{"
    "\"RoutingService\":0,"
    "\"DistanceUnit\":0,"
    "\"RouteOptimize\":0,"
    "\"DispatchMode\":0,"
    "\"Vehicles\":[{"
      "\"Name\":\"Truck 1\","
      "\"StartLocation\":{\"LatLong\":{\"Latitude\":37.7946,\"Longitude\":-122.3950},\"LocationType\":1},"
      "\"FinishLocation\":{\"LatLong\":{\"Latitude\":37.7946,\"Longitude\":-122.3950},\"LocationType\":2}"
    "}],"
    "\"Locations\":[{"
      "\"Name\":\"Stop A\","
      "\"LatLong\":{\"Latitude\":37.7897,\"Longitude\":-122.4011},"
      "\"LocationType\":0"
    "},{"
      "\"Name\":\"Stop B\","
      "\"LatLong\":{\"Latitude\":37.7810,\"Longitude\":-122.4110},"
      "\"LocationType\":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/dispatch";
  std::string json =
    "{"
    "\"RoutingService\":0,"
    "\"DistanceUnit\":0,"
    "\"RouteOptimize\":0,"
    "\"DispatchMode\":0,"
    "\"Vehicles\":[{"
      "\"Name\":\"Truck 1\","
      "\"StartLocation\":{\"LatLong\":{\"Latitude\":37.7946,\"Longitude\":-122.3950},\"LocationType\":1},"
      "\"FinishLocation\":{\"LatLong\":{\"Latitude\":37.7946,\"Longitude\":-122.3950},\"LocationType\":2}"
    "}],"
    "\"Locations\":[{"
      "\"Name\":\"Stop A\","
      "\"LatLong\":{\"Latitude\":37.7897,\"Longitude\":-122.4011},"
      "\"LocationType\":0"
    "},{"
      "\"Name\":\"Stop B\","
      "\"LatLong\":{\"Latitude\":37.7810,\"Longitude\":-122.4110},"
      "\"LocationType\":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/dispatch"];
    NSMutableURLRequest *req = [NSMutableURLRequest requestWithURL:url];
    [req setHTTPMethod:@"POST"];
    [req setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [req setValue:@"YOUR_TRACKSERVICEKEY" forHTTPHeaderField:@"X-API-Key"];

    NSDictionary *payload = @{
      @"RoutingService": @0,
      @"DistanceUnit": @0,
      @"RouteOptimize": @0,
      @"DispatchMode": @0,
      @"Vehicles": @[
        @{
          @"Name": @"Truck 1",
          @"StartLocation": @{@"LatLong": @{@"Latitude": @37.7946, @"Longitude": @-122.3950}, @"LocationType": @1},
          @"FinishLocation": @{@"LatLong": @{@"Latitude": @37.7946, @"Longitude": @-122.3950}, @"LocationType": @2}
        }
      ],
      @"Locations": @[
        @{@"Name": @"Stop A", @"LatLong": @{@"Latitude": @37.7897, @"Longitude": @-122.4011}, @"LocationType": @0},
        @{@"Name": @"Stop B", @"LatLong": @{@"Latitude": @37.7810, @"Longitude": @-122.4110}, @"LocationType": @0}
      ]
    };

    NSData *body = [NSJSONSerialization dataWithJSONObject:payload options:0 error:nil];
    [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/dispatch")!
var req = URLRequest(url: url)
req.httpMethod = "POST"
req.setValue("application/json", forHTTPHeaderField: "Content-Type")
req.setValue("YOUR_TRACKSERVICEKEY", forHTTPHeaderField: "X-API-Key")

let payload: [String: Any] = [
  "RoutingService": 0,
  "DistanceUnit": 0,
  "RouteOptimize": 0,
  "DispatchMode": 0,
  "Vehicles": [
    [
      "Name": "Truck 1",
      "StartLocation": ["LatLong": ["Latitude": 37.7946, "Longitude": -122.3950], "LocationType": 1],
      "FinishLocation": ["LatLong": ["Latitude": 37.7946, "Longitude": -122.3950], "LocationType": 2]
    ]
  ],
  "Locations": [
    ["Name": "Stop A", "LatLong": ["Latitude": 37.7897, "Longitude": -122.4011], "LocationType": 0],
    ["Name": "Stop B", "LatLong": ["Latitude": 37.7810, "Longitude": -122.4110], "LocationType": 0]
  ]
]

req.httpBody = try! JSONSerialization.data(withJSONObject: payload)

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 request examples (multiple languages)#

SOAP uses the same DispatchSpecification model, but it’s wrapped in a SOAP envelope and authenticated via SessionIDHeader (SessionID = TrackServiceKey).

curl -X POST "https://trackservice.trackroad.com/TrackService.asmx" \
  -H "Content-Type: text/xml; charset=utf-8" \
  -H "SOAPAction: http://trackservice.trackroad.com/Dispatch" \
  -d @dispatch-soap.xml

/*
  Recommended: use a WSDL-generated client for SOAP.

  1) Add Service Reference to:
     https://trackservice.trackroad.com/TrackService.asmx?WSDL

  2) Set SessionIDHeader.SessionID = YOUR_TRACKSERVICEKEY
     then call Dispatch(spec).
*/

var client = new TrackService.TrackServiceSoapClient();
var header = new TrackService.SessionIDHeader { SessionID = "YOUR_TRACKSERVICEKEY" };

var spec = new TrackService.DispatchSpecification
{
    RoutingService = TrackService.RoutingService.NetRoad,
    DistanceUnit = TrackService.DistanceUnit.Mile,
    RouteOptimize = TrackService.RouteOptimize.MinimizeTime,
    DispatchMode = TrackService.DispatchMode.Auto,
    Vehicles = new TrackService.Vehicle[]
    {
        new TrackService.Vehicle
        {
            Name = "Truck 1",
            StartLocation = new TrackService.Location
            {
                LatLong = new TrackService.LatLong { Latitude = 37.7946, Longitude = -122.3950 },
                LocationType = TrackService.LocationType.Start
            },
            FinishLocation = new TrackService.Location
            {
                LatLong = new TrackService.LatLong { Latitude = 37.7946, Longitude = -122.3950 },
                LocationType = TrackService.LocationType.Finish
            }
        }
    },
    Locations = new TrackService.Location[]
    {
        new TrackService.Location
        {
            Name = "Stop A",
            LatLong = new TrackService.LatLong { Latitude = 37.7897, Longitude = -122.4011 },
            LocationType = TrackService.LocationType.Midway
        },
        new TrackService.Location
        {
            Name = "Stop B",
            LatLong = new TrackService.LatLong { Latitude = 37.7810, Longitude = -122.4110 },
            LocationType = TrackService.LocationType.Midway
        }
    }
};

var result = client.Dispatch(header, spec);

// SOAP in browser JS is uncommon; use Node.js + fetch (undici) or axios.
// This example uses fetch in Node 18+.

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

const 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>
    <Dispatch xmlns="http://trackservice.trackroad.com/">
      <specification>
        <RoutingService>0</RoutingService>
        <DistanceUnit>0</DistanceUnit>
        <RouteOptimize>0</RouteOptimize>
        <DispatchMode>0</DispatchMode>
        <Vehicles>
          <Vehicle>
            <Name>Truck 1</Name>
            <StartLocation>
              <LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong>
              <LocationType>1</LocationType>
            </StartLocation>
            <FinishLocation>
              <LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong>
              <LocationType>2</LocationType>
            </FinishLocation>
          </Vehicle>
        </Vehicles>
        <Locations>
          <Location>
            <Name>Stop A</Name>
            <LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong>
            <LocationType>0</LocationType>
          </Location>
          <Location>
            <Name>Stop B</Name>
            <LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong>
            <LocationType>0</LocationType>
          </Location>
        </Locations>
      </specification>
    </Dispatch>
  </soap:Body>
</soap:Envelope>`;

const res = await fetch(endpoint, {
  method: "POST",
  headers: {
    "Content-Type": "text/xml; charset=utf-8",
    "SOAPAction": "http://trackservice.trackroad.com/Dispatch"
  },
  body: xml
});

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

// Option A (recommended): use a SOAP client generated from WSDL (JAX-WS).
// Option B: post raw XML (shown here) using OkHttp.

import okhttp3.*;

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

    String 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>"
    + "    <Dispatch xmlns=\"http://trackservice.trackroad.com/\">"
    + "      <specification>"
    + "        <RoutingService>0</RoutingService>"
    + "        <DistanceUnit>0</DistanceUnit>"
    + "        <RouteOptimize>0</RouteOptimize>"
    + "        <DispatchMode>0</DispatchMode>"
    + "        <Vehicles />"
    + "        <Locations />"
    + "      </specification>"
    + "    </Dispatch>"
    + "  </soap:Body>"
    + "</soap:Envelope>";

    RequestBody body = RequestBody.create(xml, 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/Dispatch")
      .build();

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

import requests

endpoint = "https://trackservice.trackroad.com/TrackService.asmx"

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>
    <Dispatch xmlns="http://trackservice.trackroad.com/">
      <specification>
        <RoutingService>0</RoutingService>
        <DistanceUnit>0</DistanceUnit>
        <RouteOptimize>0</RouteOptimize>
        <DispatchMode>0</DispatchMode>
        <Vehicles />
        <Locations />
      </specification>
    </Dispatch>
  </soap:Body>
</soap:Envelope>
"""

headers = {
  "Content-Type": "text/xml; charset=utf-8",
  "SOAPAction": "http://trackservice.trackroad.com/Dispatch"
}

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

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

$xml = <<<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>
    <Dispatch xmlns="http://trackservice.trackroad.com/">
      <specification>
        <RoutingService>0</RoutingService>
        <DistanceUnit>0</DistanceUnit>
        <RouteOptimize>0</RouteOptimize>
        <DispatchMode>0</DispatchMode>
        <Vehicles />
        <Locations />
      </specification>
    </Dispatch>
  </soap:Body>
</soap:Envelope>
XML;

$ch = curl_init($endpoint);
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Content-Type: text/xml; charset=utf-8",
    "SOAPAction: http://trackservice.trackroad.com/Dispatch"
  ],
  CURLOPT_POSTFIELDS => $xml
]);

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

require "net/http"

endpoint = URI("https://trackservice.trackroad.com/TrackService.asmx")

xml = <<~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>
      <Dispatch xmlns="http://trackservice.trackroad.com/">
        <specification>
          <RoutingService>0</RoutingService>
          <DistanceUnit>0</DistanceUnit>
          <RouteOptimize>0</RouteOptimize>
          <DispatchMode>0</DispatchMode>
          <Vehicles />
          <Locations />
        </specification>
      </Dispatch>
    </soap:Body>
  </soap:Envelope>
XML

http = Net::HTTP.new(endpoint.host, endpoint.port)
http.use_ssl = true

req = Net::HTTP::Post.new(endpoint)
req["Content-Type"] = "text/xml; charset=utf-8"
req["SOAPAction"] = "http://trackservice.trackroad.com/Dispatch"
req.body = xml

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

package main

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

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

  xml := []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>
    <Dispatch xmlns="http://trackservice.trackroad.com/">
      <specification>
        <RoutingService>0</RoutingService>
        <DistanceUnit>0</DistanceUnit>
        <RouteOptimize>0</RouteOptimize>
        <DispatchMode>0</DispatchMode>
        <Vehicles />
        <Locations />
      </specification>
    </Dispatch>
  </soap:Body>
</soap:Envelope>`)

  req, _ := http.NewRequest("POST", endpoint, bytes.NewBuffer(xml))
  req.Header.Set("Content-Type", "text/xml; charset=utf-8")
  req.Header.Set("SOAPAction", "http://trackservice.trackroad.com/Dispatch")

  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 endpoint = "https://trackservice.trackroad.com/TrackService.asmx"
  val 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>
        <Dispatch xmlns="http://trackservice.trackroad.com/">
          <specification>
            <RoutingService>0</RoutingService>
            <DistanceUnit>0</DistanceUnit>
            <RouteOptimize>0</RouteOptimize>
            <DispatchMode>0</DispatchMode>
            <Vehicles />
            <Locations />
          </specification>
        </Dispatch>
      </soap:Body>
    </soap:Envelope>
  """.trimIndent()

  val client = HttpClient.newHttpClient()
  val req = HttpRequest.newBuilder()
    .uri(URI.create(endpoint))
    .header("Content-Type", "text/xml; charset=utf-8")
    .header("SOAPAction", "http://trackservice.trackroad.com/Dispatch")
    .POST(HttpRequest.BodyPublishers.ofString(xml))
    .build()

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

#include <curl/curl.h>

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

  const char *endpoint = "https://trackservice.trackroad.com/TrackService.asmx";
  const char *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>"
    "    <Dispatch xmlns=\"http://trackservice.trackroad.com/\">"
    "      <specification>"
    "        <RoutingService>0</RoutingService>"
    "        <DistanceUnit>0</DistanceUnit>"
    "        <RouteOptimize>0</RouteOptimize>"
    "        <DispatchMode>0</DispatchMode>"
    "        <Vehicles />"
    "        <Locations />"
    "      </specification>"
    "    </Dispatch>"
    "  </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/Dispatch");

  curl_easy_setopt(curl, CURLOPT_URL, endpoint);
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  curl_easy_setopt(curl, CURLOPT_POSTFIELDS, xml);

  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 endpoint = "https://trackservice.trackroad.com/TrackService.asmx";
  std::string 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>"
    "    <Dispatch xmlns=\"http://trackservice.trackroad.com/\">"
    "      <specification>"
    "        <RoutingService>0</RoutingService>"
    "        <DistanceUnit>0</DistanceUnit>"
    "        <RouteOptimize>0</RouteOptimize>"
    "        <DispatchMode>0</DispatchMode>"
    "        <Vehicles />"
    "        <Locations />"
    "      </specification>"
    "    </Dispatch>"
    "  </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/Dispatch");

  curl_easy_setopt(curl, CURLOPT_URL, endpoint.c_str());
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  curl_easy_setopt(curl, CURLOPT_POSTFIELDS, xml.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/Dispatch" forHTTPHeaderField:@"SOAPAction"];

    NSString *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>"
     "    <Dispatch xmlns=\"http://trackservice.trackroad.com/\">"
     "      <specification>"
     "        <RoutingService>0</RoutingService>"
     "        <DistanceUnit>0</DistanceUnit>"
     "        <RouteOptimize>0</RouteOptimize>"
     "        <DispatchMode>0</DispatchMode>"
     "        <Vehicles />"
     "        <Locations />"
     "      </specification>"
     "    </Dispatch>"
     "  </soap:Body>"
     "</soap:Envelope>";

    NSData *body = [xml 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/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/Dispatch", forHTTPHeaderField: "SOAPAction")

let 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>
    <Dispatch xmlns="http://trackservice.trackroad.com/">
      <specification>
        <RoutingService>0</RoutingService>
        <DistanceUnit>0</DistanceUnit>
        <RouteOptimize>0</RouteOptimize>
        <DispatchMode>0</DispatchMode>
        <Vehicles />
        <Locations />
      </specification>
    </Dispatch>
  </soap:Body>
</soap:Envelope>
"""

req.httpBody = xml.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: Raw request (Envelope + SessionIDHeader)#

<?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>
    <Dispatch xmlns="http://trackservice.trackroad.com/">
      <specification>
        <RoutingService>0</RoutingService>
        <DistanceUnit>0</DistanceUnit>
        <RouteOptimize>0</RouteOptimize>
        <DispatchMode>0</DispatchMode>
        <Vehicles></Vehicles>
        <Locations></Locations>
      </specification>
    </Dispatch>
  </soap:Body>
</soap:Envelope>

JSON: Response example#

{
  "Items": [
    {
      "Vehicle": { "Name": "Truck 1" },
      "Locations": [
        { "Name": "Stop A", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 } },
        { "Name": "Stop B", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 } }
      ]
    }
  ],
  "Errors": [],
  "Status": 1
}

SOAP: Response example#

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DispatchResponse xmlns="http://trackservice.trackroad.com/">
      <DispatchResult>
        <Status>1</Status>
        <Errors />

        <Items>
          <VehicleItem>
            <Vehicle>
              <Name>Truck 1</Name>
            </Vehicle>

            <Locations>
              <Location>
                <Name>Stop A</Name>
                <LocationType>0</LocationType>
                <LatLong>
                  <Latitude>37.7897</Latitude>
                  <Longitude>-122.4011</Longitude>
                </LatLong>
              </Location>

              <Location>
                <Name>Stop B</Name>
                <LocationType>0</LocationType>
                <LatLong>
                  <Latitude>37.7810</Latitude>
                  <Longitude>-122.4110</Longitude>
                </LatLong>
              </Location>
            </Locations>
          </VehicleItem>
        </Items>

      </DispatchResult>
    </DispatchResponse>
  </soap:Body>
</soap:Envelope>

Häufige Fehler#

REST 401 / Unauthorized: Fehlender oder ungültiger X-API-Key.
REST 403 / Forbidden: Der Schlüssel ist gültig, aber blockiert, abgelaufen oder ohne Guthaben.
Validierungsfehler: Ein Stopp enthält weder LatLong noch Address, oder die Koordinaten sind ungültig.
SOAP-Authentifizierungsfehler: Fehlender/ungültiger SessionIDHeader oder leere SessionID.

Best Practices

Bevorzugen Sie LatLong, um Geokodierungsmehrdeutigkeiten zu vermeiden und die Routing-Konsistenz zu verbessern.
Verwenden Sie StartLocation und FinishLocation für depotbasiertes Routing und bessere ETAs.
Fügen Sie Kapazitätseinschränkungen wie Gewicht, Volumen und Skids hinzu, um realistischere Routenzuweisungen zu erhalten.
Verwenden Sie Zeitfenster, wenn Stopps innerhalb von Kunden- oder Betriebszeiten besucht werden müssen.
Verwenden Sie für SOAP den TrackServiceKey im SessionIDHeader. Der veraltete Login-Flow ist nicht erforderlich.

FAQ#

Was macht die Dispatch API?

Dispatch optimiert Stopps über mehrere Fahrzeuge und gibt geordnete Routen pro Fahrzeug mit Zeit- und Distanzausgaben zurück.

Wie authentifiziere ich mich bei Dispatch REST und SOAP?

REST verwendet Ihren TrackServiceKey im Header X-API-Key. SOAP verwendet denselben TrackServiceKey im SessionIDHeader als SessionID.

Benötige ich LatLong oder Address für Stopps?

LatLong wird bevorzugt. Wenn LatLong nicht angegeben ist, ist Address erforderlich, damit TrackRoad den Stopp geokodieren kann.

Bereit, Routen zu optimieren?

Erstellen Sie Ihren API-Schlüssel und beginnen Sie dann mit der Integration von Dispatch für Multi-Fahrzeug-Routenoptimierung über REST oder SOAP.

API-Schlüssel erhalten SOAP WSDL Swagger UI