CargoService Web Service

CargoService

Click here for a complete list of operations.

CargoSearchV1

Search cargos by using different criterias. To get all cargos, use null values for all parameters. Method return only one page of data. Max page size is 100 records.

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

<?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>
    <CargoSearchV1 xmlns="http://dev.cargogeo.com/">
      <DateFrom>dateTime</DateFrom>
      <DateTo>dateTime</DateTo>
      <FromAddress>
        <IdCity xmlns="http://geocode.cargogeo.com/">long</IdCity>
        <City xmlns="http://geocode.cargogeo.com/">string</City>
        <District xmlns="http://geocode.cargogeo.com/">string</District>
        <Region xmlns="http://geocode.cargogeo.com/">string</Region>
        <Country xmlns="http://geocode.cargogeo.com/">string</Country>
        <GeoPoint xmlns="http://geocode.cargogeo.com/">
          <Lat>float</Lat>
          <Lon>float</Lon>
        </GeoPoint>
      </FromAddress>
      <ToAddress>
        <IdCity xmlns="http://geocode.cargogeo.com/">long</IdCity>
        <City xmlns="http://geocode.cargogeo.com/">string</City>
        <District xmlns="http://geocode.cargogeo.com/">string</District>
        <Region xmlns="http://geocode.cargogeo.com/">string</Region>
        <Country xmlns="http://geocode.cargogeo.com/">string</Country>
        <GeoPoint xmlns="http://geocode.cargogeo.com/">
          <Lat>float</Lat>
          <Lon>float</Lon>
        </GeoPoint>
      </ToAddress>
      <FromRadius>float</FromRadius>
      <ToRadius>float</ToRadius>
      <MinDistance>float</MinDistance>
      <MinDistanceInPercents>boolean</MinDistanceInPercents>
      <MaxRadius>float</MaxRadius>
      <PassageWidth>float</PassageWidth>
      <Polygon>string</Polygon>
      <AddPeriod>short</AddPeriod>
      <MinQuantity>float</MinQuantity>
      <MaxQuantity>float</MaxQuantity>
      <MinVolume>float</MinVolume>
      <MaxVolume>float</MaxVolume>
      <IdTruckTypes>string</IdTruckTypes>
      <AllowBackLoading>boolean</AllowBackLoading>
      <AllowUpperLoading>boolean</AllowUpperLoading>
      <AllowSideLoading>boolean</AllowSideLoading>
      <CanAddLoading>unsignedByte</CanAddLoading>
      <TIR>boolean</TIR>
      <ADR>short</ADR>
      <MinRating>float</MinRating>
      <GoodReferences>boolean</GoodReferences>
      <IdUser>guid</IdUser>
      <Filter>string</Filter>
      <PartnerLevel>short</PartnerLevel>
      <BlackListLevel>short</BlackListLevel>
      <SortOrder>string</SortOrder>
      <RowsPerPage>int</RowsPerPage>
      <PageNumber>int</PageNumber>
      <Source>short</Source>
      <Random>double</Random>
      <IdTruck>int</IdTruck>
      <IdCompany>int</IdCompany>
    </CargoSearchV1>
  </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>
    <CargoSearchV1Response xmlns="http://dev.cargogeo.com/">
      <CargoSearchV1Result>
        <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>
      </CargoSearchV1Result>
    </CargoSearchV1Response>
  </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 /CargoService.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>
    <CargoSearchV1 xmlns="http://dev.cargogeo.com/">
      <DateFrom>dateTime</DateFrom>
      <DateTo>dateTime</DateTo>
      <FromAddress>
        <IdCity xmlns="http://geocode.cargogeo.com/">long</IdCity>
        <City xmlns="http://geocode.cargogeo.com/">string</City>
        <District xmlns="http://geocode.cargogeo.com/">string</District>
        <Region xmlns="http://geocode.cargogeo.com/">string</Region>
        <Country xmlns="http://geocode.cargogeo.com/">string</Country>
        <GeoPoint xmlns="http://geocode.cargogeo.com/">
          <Lat>float</Lat>
          <Lon>float</Lon>
        </GeoPoint>
      </FromAddress>
      <ToAddress>
        <IdCity xmlns="http://geocode.cargogeo.com/">long</IdCity>
        <City xmlns="http://geocode.cargogeo.com/">string</City>
        <District xmlns="http://geocode.cargogeo.com/">string</District>
        <Region xmlns="http://geocode.cargogeo.com/">string</Region>
        <Country xmlns="http://geocode.cargogeo.com/">string</Country>
        <GeoPoint xmlns="http://geocode.cargogeo.com/">
          <Lat>float</Lat>
          <Lon>float</Lon>
        </GeoPoint>
      </ToAddress>
      <FromRadius>float</FromRadius>
      <ToRadius>float</ToRadius>
      <MinDistance>float</MinDistance>
      <MinDistanceInPercents>boolean</MinDistanceInPercents>
      <MaxRadius>float</MaxRadius>
      <PassageWidth>float</PassageWidth>
      <Polygon>string</Polygon>
      <AddPeriod>short</AddPeriod>
      <MinQuantity>float</MinQuantity>
      <MaxQuantity>float</MaxQuantity>
      <MinVolume>float</MinVolume>
      <MaxVolume>float</MaxVolume>
      <IdTruckTypes>string</IdTruckTypes>
      <AllowBackLoading>boolean</AllowBackLoading>
      <AllowUpperLoading>boolean</AllowUpperLoading>
      <AllowSideLoading>boolean</AllowSideLoading>
      <CanAddLoading>unsignedByte</CanAddLoading>
      <TIR>boolean</TIR>
      <ADR>short</ADR>
      <MinRating>float</MinRating>
      <GoodReferences>boolean</GoodReferences>
      <IdUser>guid</IdUser>
      <Filter>string</Filter>
      <PartnerLevel>short</PartnerLevel>
      <BlackListLevel>short</BlackListLevel>
      <SortOrder>string</SortOrder>
      <RowsPerPage>int</RowsPerPage>
      <PageNumber>int</PageNumber>
      <Source>short</Source>
      <Random>double</Random>
      <IdTruck>int</IdTruck>
      <IdCompany>int</IdCompany>
    </CargoSearchV1>
  </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>
    <CargoSearchV1Response xmlns="http://dev.cargogeo.com/">
      <CargoSearchV1Result>
        <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>
      </CargoSearchV1Result>
    </CargoSearchV1Response>
  </soap12:Body>
</soap12:Envelope>