TruckService Web Service

TruckService

Click here for a complete list of operations.

GetRouteDataByText

Get route data and context truck and cargo information

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 /TruckService.asmx HTTP/1.1
Host: dev.cargogeo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://dev.cargogeo.com/GetRouteDataByText"

<?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>
    <GetRouteDataByText xmlns="http://dev.cargogeo.com/">
      <FromAddress>string</FromAddress>
      <ToAddress>string</ToAddress>
      <Stops>
        <string>string</string>
        <string>string</string>
      </Stops>
      <IsBestTime>boolean</IsBestTime>
      <NumTrucks>short</NumTrucks>
      <NumCargos>short</NumCargos>
      <compressRouteLevel>int</compressRouteLevel>
      <IdUser>guid</IdUser>
    </GetRouteDataByText>
  </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>
    <GetRouteDataByTextResponse xmlns="http://dev.cargogeo.com/">
      <GetRouteDataByTextResult>
        <Id>int</Id>
        <Points>
          <LatLonShort>
            <Lat>float</Lat>
            <Lon>float</Lon>
          </LatLonShort>
          <LatLonShort>
            <Lat>float</Lat>
            <Lon>float</Lon>
          </LatLonShort>
        </Points>
        <Legs>
          <LatLonDistance>
            <Distance>decimal</Distance>
            <TimeInSeconds>int</TimeInSeconds>
          </LatLonDistance>
          <LatLonDistance>
            <Distance>decimal</Distance>
            <TimeInSeconds>int</TimeInSeconds>
          </LatLonDistance>
        </Legs>
        <PolygonPoints>
          <LatLonShort>
            <Lat>float</Lat>
            <Lon>float</Lon>
          </LatLonShort>
          <LatLonShort>
            <Lat>float</Lat>
            <Lon>float</Lon>
          </LatLonShort>
        </PolygonPoints>
        <FromPoint>
          <Lat>float</Lat>
          <Lon>float</Lon>
          <Description>string</Description>
        </FromPoint>
        <FromRadius>float</FromRadius>
        <ToPoint>
          <Lat>float</Lat>
          <Lon>float</Lon>
          <Description>string</Description>
        </ToPoint>
        <ToRadius>float</ToRadius>
        <MaxRadius>float</MaxRadius>
        <CargoDirections>
          <CargoDirection>
            <Id>int</Id>
            <Name>string</Name>
            <Start xsi:nil="true" />
            <Finish xsi:nil="true" />
            <NumItems>int</NumItems>
            <Cargos xsi:nil="true" />
          </CargoDirection>
          <CargoDirection>
            <Id>int</Id>
            <Name>string</Name>
            <Start xsi:nil="true" />
            <Finish xsi:nil="true" />
            <NumItems>int</NumItems>
            <Cargos xsi:nil="true" />
          </CargoDirection>
        </CargoDirections>
        <MaxCargo>float</MaxCargo>
        <TotalCargoCount>int</TotalCargoCount>
        <TruckPoints>
          <TruckPoint>
            <Id>int</Id>
            <Trucks xsi:nil="true" />
          </TruckPoint>
          <TruckPoint>
            <Id>int</Id>
            <Trucks xsi:nil="true" />
          </TruckPoint>
        </TruckPoints>
        <TotalTrucksCount>int</TotalTrucksCount>
        <TimeInSeconds>int</TimeInSeconds>
        <Distance>float</Distance>
        <NorthEst>
          <Lat>float</Lat>
          <Lon>float</Lon>
        </NorthEst>
        <SouthWest>
          <Lat>float</Lat>
          <Lon>float</Lon>
        </SouthWest>
        <QueryTime>long</QueryTime>
        <Balance>decimal</Balance>
      </GetRouteDataByTextResult>
    </GetRouteDataByTextResponse>
  </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 /TruckService.asmx HTTP/1.1
Host: dev.cargogeo.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:Body>
    <GetRouteDataByText xmlns="http://dev.cargogeo.com/">
      <FromAddress>string</FromAddress>
      <ToAddress>string</ToAddress>
      <Stops>
        <string>string</string>
        <string>string</string>
      </Stops>
      <IsBestTime>boolean</IsBestTime>
      <NumTrucks>short</NumTrucks>
      <NumCargos>short</NumCargos>
      <compressRouteLevel>int</compressRouteLevel>
      <IdUser>guid</IdUser>
    </GetRouteDataByText>
  </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>
    <GetRouteDataByTextResponse xmlns="http://dev.cargogeo.com/">
      <GetRouteDataByTextResult>
        <Id>int</Id>
        <Points>
          <LatLonShort>
            <Lat>float</Lat>
            <Lon>float</Lon>
          </LatLonShort>
          <LatLonShort>
            <Lat>float</Lat>
            <Lon>float</Lon>
          </LatLonShort>
        </Points>
        <Legs>
          <LatLonDistance>
            <Distance>decimal</Distance>
            <TimeInSeconds>int</TimeInSeconds>
          </LatLonDistance>
          <LatLonDistance>
            <Distance>decimal</Distance>
            <TimeInSeconds>int</TimeInSeconds>
          </LatLonDistance>
        </Legs>
        <PolygonPoints>
          <LatLonShort>
            <Lat>float</Lat>
            <Lon>float</Lon>
          </LatLonShort>
          <LatLonShort>
            <Lat>float</Lat>
            <Lon>float</Lon>
          </LatLonShort>
        </PolygonPoints>
        <FromPoint>
          <Lat>float</Lat>
          <Lon>float</Lon>
          <Description>string</Description>
        </FromPoint>
        <FromRadius>float</FromRadius>
        <ToPoint>
          <Lat>float</Lat>
          <Lon>float</Lon>
          <Description>string</Description>
        </ToPoint>
        <ToRadius>float</ToRadius>
        <MaxRadius>float</MaxRadius>
        <CargoDirections>
          <CargoDirection>
            <Id>int</Id>
            <Name>string</Name>
            <Start xsi:nil="true" />
            <Finish xsi:nil="true" />
            <NumItems>int</NumItems>
            <Cargos xsi:nil="true" />
          </CargoDirection>
          <CargoDirection>
            <Id>int</Id>
            <Name>string</Name>
            <Start xsi:nil="true" />
            <Finish xsi:nil="true" />
            <NumItems>int</NumItems>
            <Cargos xsi:nil="true" />
          </CargoDirection>
        </CargoDirections>
        <MaxCargo>float</MaxCargo>
        <TotalCargoCount>int</TotalCargoCount>
        <TruckPoints>
          <TruckPoint>
            <Id>int</Id>
            <Trucks xsi:nil="true" />
          </TruckPoint>
          <TruckPoint>
            <Id>int</Id>
            <Trucks xsi:nil="true" />
          </TruckPoint>
        </TruckPoints>
        <TotalTrucksCount>int</TotalTrucksCount>
        <TimeInSeconds>int</TimeInSeconds>
        <Distance>float</Distance>
        <NorthEst>
          <Lat>float</Lat>
          <Lon>float</Lon>
        </NorthEst>
        <SouthWest>
          <Lat>float</Lat>
          <Lon>float</Lon>
        </SouthWest>
        <QueryTime>long</QueryTime>
        <Balance>decimal</Balance>
      </GetRouteDataByTextResult>
    </GetRouteDataByTextResponse>
  </soap12:Body>
</soap12:Envelope>