TrackService Web Service

TrackService

Click here for a complete list of operations.

Dispatch

Dispatch & optimize 1000's of stops with multiple vehicles.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /TrackService.asmx HTTP/1.1
Host: ts6.trackroad.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://TrackService.TrackRoad.com/Dispatch"

<?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>string</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <Dispatch xmlns="http://TrackService.TrackRoad.com/">
      <specification>
        <RoutingService>NetRoad or TrackRoad or Bing</RoutingService>
        <IsNeedMatchCode>boolean</IsNeedMatchCode>
        <CurrentTime>dateTime</CurrentTime>
        <DispatchMode>Auto or EqualStop or SingleRegion or MultipleRegion or EqualHour or EqualDistance or Central or TimeWindow or TimeWindowDepot or Optima or BalanceLocation or BalanceTime or MinimumVehicles</DispatchMode>
        <MinimumOptimization>int</MinimumOptimization>
        <DistanceUnit>Mile or Kilometer</DistanceUnit>
        <RouteOptimize>MinimizeTime or MinimizeDistance</RouteOptimize>
        <Vehicles>
          <Vehicle>
            <Name>string</Name>
            <Email>string</Email>
            <Group>string</Group>
            <Speed>int</Speed>
            <MaxStops>int</MaxStops>
            <MaxWeight>double</MaxWeight>
            <MaxSkids>int</MaxSkids>
            <MaxVolume>double</MaxVolume>
            <MaxMinutes>int</MaxMinutes>
            <FuelCost>double</FuelCost>
            <OnTheRoad>boolean</OnTheRoad>
            <Tin>dateTime</Tin>
            <Tout>dateTime</Tout>
            <StartLocation xsi:nil="true" />
            <FinishLocation xsi:nil="true" />
            <Roles>string</Roles>
            <Shapes xsi:nil="true" />
          </Vehicle>
          <Vehicle>
            <Name>string</Name>
            <Email>string</Email>
            <Group>string</Group>
            <Speed>int</Speed>
            <MaxStops>int</MaxStops>
            <MaxWeight>double</MaxWeight>
            <MaxSkids>int</MaxSkids>
            <MaxVolume>double</MaxVolume>
            <MaxMinutes>int</MaxMinutes>
            <FuelCost>double</FuelCost>
            <OnTheRoad>boolean</OnTheRoad>
            <Tin>dateTime</Tin>
            <Tout>dateTime</Tout>
            <StartLocation xsi:nil="true" />
            <FinishLocation xsi:nil="true" />
            <Roles>string</Roles>
            <Shapes xsi:nil="true" />
          </Vehicle>
        </Vehicles>
        <Locations>
          <Location>
            <MatchCode>None or Poor or Approx or Good or Exact</MatchCode>
            <Name>string</Name>
            <Delivery>string</Delivery>
            <DeliveryNonStop>boolean</DeliveryNonStop>
            <KeepSameOrder>boolean</KeepSameOrder>
            <Vehicle>string</Vehicle>
            <Description>string</Description>
            <Phone>string</Phone>
            <LatLong xsi:nil="true" />
            <Address xsi:nil="true" />
            <Priority>int</Priority>
            <Wait>int</Wait>
            <Volume>double</Volume>
            <Weight>double</Weight>
            <Skids>int</Skids>
            <TimeConstraintArrival>dateTime</TimeConstraintArrival>
            <TimeConstraintDeparture>dateTime</TimeConstraintDeparture>
            <TimeConstraintArrival2>dateTime</TimeConstraintArrival2>
            <TimeConstraintDeparture2>dateTime</TimeConstraintDeparture2>
            <TimeEstimatedArrival>dateTime</TimeEstimatedArrival>
            <LocationType>Midway or Start or Finish or Delivery or MidwayDrop or Break</LocationType>
            <CanArriveEarly>boolean</CanArriveEarly>
            <Distance>double</Distance>
            <Time>int</Time>
            <Conditions>string</Conditions>
          </Location>
          <Location>
            <MatchCode>None or Poor or Approx or Good or Exact</MatchCode>
            <Name>string</Name>
            <Delivery>string</Delivery>
            <DeliveryNonStop>boolean</DeliveryNonStop>
            <KeepSameOrder>boolean</KeepSameOrder>
            <Vehicle>string</Vehicle>
            <Description>string</Description>
            <Phone>string</Phone>
            <LatLong xsi:nil="true" />
            <Address xsi:nil="true" />
            <Priority>int</Priority>
            <Wait>int</Wait>
            <Volume>double</Volume>
            <Weight>double</Weight>
            <Skids>int</Skids>
            <TimeConstraintArrival>dateTime</TimeConstraintArrival>
            <TimeConstraintDeparture>dateTime</TimeConstraintDeparture>
            <TimeConstraintArrival2>dateTime</TimeConstraintArrival2>
            <TimeConstraintDeparture2>dateTime</TimeConstraintDeparture2>
            <TimeEstimatedArrival>dateTime</TimeEstimatedArrival>
            <LocationType>Midway or Start or Finish or Delivery or MidwayDrop or Break</LocationType>
            <CanArriveEarly>boolean</CanArriveEarly>
            <Distance>double</Distance>
            <Time>int</Time>
            <Conditions>string</Conditions>
          </Location>
        </Locations>
      </specification>
    </Dispatch>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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>
    <DispatchResponse xmlns="http://TrackService.TrackRoad.com/">
      <DispatchResult>
        <Items>
          <VehicleItem>
            <Vehicle xsi:nil="true" />
            <Locations xsi:nil="true" />
          </VehicleItem>
          <VehicleItem>
            <Vehicle xsi:nil="true" />
            <Locations xsi:nil="true" />
          </VehicleItem>
        </Items>
      </DispatchResult>
    </DispatchResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /TrackService.asmx HTTP/1.1
Host: ts6.trackroad.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>string</SessionID>
    </SessionIDHeader>
  </soap12:Header>
  <soap12:Body>
    <Dispatch xmlns="http://TrackService.TrackRoad.com/">
      <specification>
        <RoutingService>NetRoad or TrackRoad or Bing</RoutingService>
        <IsNeedMatchCode>boolean</IsNeedMatchCode>
        <CurrentTime>dateTime</CurrentTime>
        <DispatchMode>Auto or EqualStop or SingleRegion or MultipleRegion or EqualHour or EqualDistance or Central or TimeWindow or TimeWindowDepot or Optima or BalanceLocation or BalanceTime or MinimumVehicles</DispatchMode>
        <MinimumOptimization>int</MinimumOptimization>
        <DistanceUnit>Mile or Kilometer</DistanceUnit>
        <RouteOptimize>MinimizeTime or MinimizeDistance</RouteOptimize>
        <Vehicles>
          <Vehicle>
            <Name>string</Name>
            <Email>string</Email>
            <Group>string</Group>
            <Speed>int</Speed>
            <MaxStops>int</MaxStops>
            <MaxWeight>double</MaxWeight>
            <MaxSkids>int</MaxSkids>
            <MaxVolume>double</MaxVolume>
            <MaxMinutes>int</MaxMinutes>
            <FuelCost>double</FuelCost>
            <OnTheRoad>boolean</OnTheRoad>
            <Tin>dateTime</Tin>
            <Tout>dateTime</Tout>
            <StartLocation xsi:nil="true" />
            <FinishLocation xsi:nil="true" />
            <Roles>string</Roles>
            <Shapes xsi:nil="true" />
          </Vehicle>
          <Vehicle>
            <Name>string</Name>
            <Email>string</Email>
            <Group>string</Group>
            <Speed>int</Speed>
            <MaxStops>int</MaxStops>
            <MaxWeight>double</MaxWeight>
            <MaxSkids>int</MaxSkids>
            <MaxVolume>double</MaxVolume>
            <MaxMinutes>int</MaxMinutes>
            <FuelCost>double</FuelCost>
            <OnTheRoad>boolean</OnTheRoad>
            <Tin>dateTime</Tin>
            <Tout>dateTime</Tout>
            <StartLocation xsi:nil="true" />
            <FinishLocation xsi:nil="true" />
            <Roles>string</Roles>
            <Shapes xsi:nil="true" />
          </Vehicle>
        </Vehicles>
        <Locations>
          <Location>
            <MatchCode>None or Poor or Approx or Good or Exact</MatchCode>
            <Name>string</Name>
            <Delivery>string</Delivery>
            <DeliveryNonStop>boolean</DeliveryNonStop>
            <KeepSameOrder>boolean</KeepSameOrder>
            <Vehicle>string</Vehicle>
            <Description>string</Description>
            <Phone>string</Phone>
            <LatLong xsi:nil="true" />
            <Address xsi:nil="true" />
            <Priority>int</Priority>
            <Wait>int</Wait>
            <Volume>double</Volume>
            <Weight>double</Weight>
            <Skids>int</Skids>
            <TimeConstraintArrival>dateTime</TimeConstraintArrival>
            <TimeConstraintDeparture>dateTime</TimeConstraintDeparture>
            <TimeConstraintArrival2>dateTime</TimeConstraintArrival2>
            <TimeConstraintDeparture2>dateTime</TimeConstraintDeparture2>
            <TimeEstimatedArrival>dateTime</TimeEstimatedArrival>
            <LocationType>Midway or Start or Finish or Delivery or MidwayDrop or Break</LocationType>
            <CanArriveEarly>boolean</CanArriveEarly>
            <Distance>double</Distance>
            <Time>int</Time>
            <Conditions>string</Conditions>
          </Location>
          <Location>
            <MatchCode>None or Poor or Approx or Good or Exact</MatchCode>
            <Name>string</Name>
            <Delivery>string</Delivery>
            <DeliveryNonStop>boolean</DeliveryNonStop>
            <KeepSameOrder>boolean</KeepSameOrder>
            <Vehicle>string</Vehicle>
            <Description>string</Description>
            <Phone>string</Phone>
            <LatLong xsi:nil="true" />
            <Address xsi:nil="true" />
            <Priority>int</Priority>
            <Wait>int</Wait>
            <Volume>double</Volume>
            <Weight>double</Weight>
            <Skids>int</Skids>
            <TimeConstraintArrival>dateTime</TimeConstraintArrival>
            <TimeConstraintDeparture>dateTime</TimeConstraintDeparture>
            <TimeConstraintArrival2>dateTime</TimeConstraintArrival2>
            <TimeConstraintDeparture2>dateTime</TimeConstraintDeparture2>
            <TimeEstimatedArrival>dateTime</TimeEstimatedArrival>
            <LocationType>Midway or Start or Finish or Delivery or MidwayDrop or Break</LocationType>
            <CanArriveEarly>boolean</CanArriveEarly>
            <Distance>double</Distance>
            <Time>int</Time>
            <Conditions>string</Conditions>
          </Location>
        </Locations>
      </specification>
    </Dispatch>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <DispatchResponse xmlns="http://TrackService.TrackRoad.com/">
      <DispatchResult>
        <Items>
          <VehicleItem>
            <Vehicle xsi:nil="true" />
            <Locations xsi:nil="true" />
          </VehicleItem>
          <VehicleItem>
            <Vehicle xsi:nil="true" />
            <Locations xsi:nil="true" />
          </VehicleItem>
        </Items>
      </DispatchResult>
    </DispatchResponse>
  </soap12:Body>
</soap12:Envelope>