CargoService Web Service

CargoService

Click here for a complete list of operations.

UpdateCargos

Update array of cargo's and return array of strings, representing Id's of inserted or updated cargo's or error message text if error occurs

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/UpdateCargos"

<?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>
    <UpdateCargos xmlns="http://dev.cargogeo.com/">
      <cargos>
        <CargoData>
          <Id>int</Id>
          <DateFrom>dateTime</DateFrom>
          <DateTo>dateTime</DateTo>
          <CargoName>string</CargoName>
          <PackageDefinition>string</PackageDefinition>
          <AllowUpperLoad>boolean</AllowUpperLoad>
          <AllowSideLoad>boolean</AllowSideLoad>
          <AllowBackLoad>boolean</AllowBackLoad>
          <CanAddLoading>boolean</CanAddLoading>
          <AllowUpperUpLoad>boolean</AllowUpperUpLoad>
          <AllowSideUpLoad>boolean</AllowSideUpLoad>
          <AllowBackUpLoad>boolean</AllowBackUpLoad>
          <Quantity>float</Quantity>
          <Volume>float</Volume>
          <NumberOfTrucks>int</NumberOfTrucks>
          <CargoSizes>string</CargoSizes>
          <Price>decimal</Price>
          <IsPricePerKm>boolean</IsPricePerKm>
          <IsPriceWithVAT>boolean</IsPriceWithVAT>
          <IdCurrency>string</IdCurrency>
          <FromAddress>string</FromAddress>
          <IdFromCountry>string</IdFromCountry>
          <IdFromCity>int</IdFromCity>
          <FromGeoPoint>
            <Lat>float</Lat>
            <Lon>float</Lon>
            <Description>string</Description>
          </FromGeoPoint>
          <ToAddress>string</ToAddress>
          <IdToCountry>string</IdToCountry>
          <IdToCity>int</IdToCity>
          <ToGeoPoint>
            <Lat>float</Lat>
            <Lon>float</Lon>
            <Description>string</Description>
          </ToGeoPoint>
          <IsRoundtrip>boolean</IsRoundtrip>
          <TIR>boolean</TIR>
          <T1>boolean</T1>
          <ADR>unsignedByte</ADR>
          <IdSourceSystem>short</IdSourceSystem>
          <Company>string</Company>
          <Contact>string</Contact>
          <Phone>string</Phone>
          <MobilePhone>string</MobilePhone>
          <ICQ>long</ICQ>
          <Skype>string</Skype>
          <EMail>string</EMail>
          <Rating>decimal</Rating>
          <GoodRefsCount>int</GoodRefsCount>
          <BadRefsCount>int</BadRefsCount>
          <ContextPrice>decimal</ContextPrice>
          <IsAnonymous>boolean</IsAnonymous>
          <AnonymousID>guid</AnonymousID>
          <CreateDate>dateTime</CreateDate>
          <ChangeDate>dateTime</ChangeDate>
          <ExternalId>long</ExternalId>
          <ExternalFirmId>long</ExternalFirmId>
          <ExternalFirmAddId>long</ExternalFirmAddId>
          <Distance>decimal</Distance>
          <Description>string</Description>
          <Route>
            <LatLon xsi:nil="true" />
            <LatLon xsi:nil="true" />
          </Route>
          <AddPoints>
            <CargoAddPointData xsi:nil="true" />
            <CargoAddPointData xsi:nil="true" />
          </AddPoints>
          <CargoTruckTypes>
            <short>short</short>
            <short>short</short>
          </CargoTruckTypes>
          <InformICQ>boolean</InformICQ>
          <InformSMS>boolean</InformSMS>
          <InformSkype>boolean</InformSkype>
          <InformEMail>boolean</InformEMail>
          <IdParentCargo>int</IdParentCargo>
          <ParentCargoAsString>string</ParentCargoAsString>
          <IsCargoOwner>boolean</IsCargoOwner>
          <SourceKeys>
            <SourceKey xsi:nil="true" />
            <SourceKey xsi:nil="true" />
          </SourceKeys>
          <ExternalRequests>
            <ExternalRequest xsi:nil="true" />
            <ExternalRequest xsi:nil="true" />
          </ExternalRequests>
          <IsPremium>boolean</IsPremium>
        </CargoData>
        <CargoData>
          <Id>int</Id>
          <DateFrom>dateTime</DateFrom>
          <DateTo>dateTime</DateTo>
          <CargoName>string</CargoName>
          <PackageDefinition>string</PackageDefinition>
          <AllowUpperLoad>boolean</AllowUpperLoad>
          <AllowSideLoad>boolean</AllowSideLoad>
          <AllowBackLoad>boolean</AllowBackLoad>
          <CanAddLoading>boolean</CanAddLoading>
          <AllowUpperUpLoad>boolean</AllowUpperUpLoad>
          <AllowSideUpLoad>boolean</AllowSideUpLoad>
          <AllowBackUpLoad>boolean</AllowBackUpLoad>
          <Quantity>float</Quantity>
          <Volume>float</Volume>
          <NumberOfTrucks>int</NumberOfTrucks>
          <CargoSizes>string</CargoSizes>
          <Price>decimal</Price>
          <IsPricePerKm>boolean</IsPricePerKm>
          <IsPriceWithVAT>boolean</IsPriceWithVAT>
          <IdCurrency>string</IdCurrency>
          <FromAddress>string</FromAddress>
          <IdFromCountry>string</IdFromCountry>
          <IdFromCity>int</IdFromCity>
          <FromGeoPoint>
            <Lat>float</Lat>
            <Lon>float</Lon>
            <Description>string</Description>
          </FromGeoPoint>
          <ToAddress>string</ToAddress>
          <IdToCountry>string</IdToCountry>
          <IdToCity>int</IdToCity>
          <ToGeoPoint>
            <Lat>float</Lat>
            <Lon>float</Lon>
            <Description>string</Description>
          </ToGeoPoint>
          <IsRoundtrip>boolean</IsRoundtrip>
          <TIR>boolean</TIR>
          <T1>boolean</T1>
          <ADR>unsignedByte</ADR>
          <IdSourceSystem>short</IdSourceSystem>
          <Company>string</Company>
          <Contact>string</Contact>
          <Phone>string</Phone>
          <MobilePhone>string</MobilePhone>
          <ICQ>long</ICQ>
          <Skype>string</Skype>
          <EMail>string</EMail>
          <Rating>decimal</Rating>
          <GoodRefsCount>int</GoodRefsCount>
          <BadRefsCount>int</BadRefsCount>
          <ContextPrice>decimal</ContextPrice>
          <IsAnonymous>boolean</IsAnonymous>
          <AnonymousID>guid</AnonymousID>
          <CreateDate>dateTime</CreateDate>
          <ChangeDate>dateTime</ChangeDate>
          <ExternalId>long</ExternalId>
          <ExternalFirmId>long</ExternalFirmId>
          <ExternalFirmAddId>long</ExternalFirmAddId>
          <Distance>decimal</Distance>
          <Description>string</Description>
          <Route>
            <LatLon xsi:nil="true" />
            <LatLon xsi:nil="true" />
          </Route>
          <AddPoints>
            <CargoAddPointData xsi:nil="true" />
            <CargoAddPointData xsi:nil="true" />
          </AddPoints>
          <CargoTruckTypes>
            <short>short</short>
            <short>short</short>
          </CargoTruckTypes>
          <InformICQ>boolean</InformICQ>
          <InformSMS>boolean</InformSMS>
          <InformSkype>boolean</InformSkype>
          <InformEMail>boolean</InformEMail>
          <IdParentCargo>int</IdParentCargo>
          <ParentCargoAsString>string</ParentCargoAsString>
          <IsCargoOwner>boolean</IsCargoOwner>
          <SourceKeys>
            <SourceKey xsi:nil="true" />
            <SourceKey xsi:nil="true" />
          </SourceKeys>
          <ExternalRequests>
            <ExternalRequest xsi:nil="true" />
            <ExternalRequest xsi:nil="true" />
          </ExternalRequests>
          <IsPremium>boolean</IsPremium>
        </CargoData>
      </cargos>
    </UpdateCargos>
  </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>
    <UpdateCargosResponse xmlns="http://dev.cargogeo.com/">
      <UpdateCargosResult>
        <string>string</string>
        <string>string</string>
      </UpdateCargosResult>
    </UpdateCargosResponse>
  </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>
    <UpdateCargos xmlns="http://dev.cargogeo.com/">
      <cargos>
        <CargoData>
          <Id>int</Id>
          <DateFrom>dateTime</DateFrom>
          <DateTo>dateTime</DateTo>
          <CargoName>string</CargoName>
          <PackageDefinition>string</PackageDefinition>
          <AllowUpperLoad>boolean</AllowUpperLoad>
          <AllowSideLoad>boolean</AllowSideLoad>
          <AllowBackLoad>boolean</AllowBackLoad>
          <CanAddLoading>boolean</CanAddLoading>
          <AllowUpperUpLoad>boolean</AllowUpperUpLoad>
          <AllowSideUpLoad>boolean</AllowSideUpLoad>
          <AllowBackUpLoad>boolean</AllowBackUpLoad>
          <Quantity>float</Quantity>
          <Volume>float</Volume>
          <NumberOfTrucks>int</NumberOfTrucks>
          <CargoSizes>string</CargoSizes>
          <Price>decimal</Price>
          <IsPricePerKm>boolean</IsPricePerKm>
          <IsPriceWithVAT>boolean</IsPriceWithVAT>
          <IdCurrency>string</IdCurrency>
          <FromAddress>string</FromAddress>
          <IdFromCountry>string</IdFromCountry>
          <IdFromCity>int</IdFromCity>
          <FromGeoPoint>
            <Lat>float</Lat>
            <Lon>float</Lon>
            <Description>string</Description>
          </FromGeoPoint>
          <ToAddress>string</ToAddress>
          <IdToCountry>string</IdToCountry>
          <IdToCity>int</IdToCity>
          <ToGeoPoint>
            <Lat>float</Lat>
            <Lon>float</Lon>
            <Description>string</Description>
          </ToGeoPoint>
          <IsRoundtrip>boolean</IsRoundtrip>
          <TIR>boolean</TIR>
          <T1>boolean</T1>
          <ADR>unsignedByte</ADR>
          <IdSourceSystem>short</IdSourceSystem>
          <Company>string</Company>
          <Contact>string</Contact>
          <Phone>string</Phone>
          <MobilePhone>string</MobilePhone>
          <ICQ>long</ICQ>
          <Skype>string</Skype>
          <EMail>string</EMail>
          <Rating>decimal</Rating>
          <GoodRefsCount>int</GoodRefsCount>
          <BadRefsCount>int</BadRefsCount>
          <ContextPrice>decimal</ContextPrice>
          <IsAnonymous>boolean</IsAnonymous>
          <AnonymousID>guid</AnonymousID>
          <CreateDate>dateTime</CreateDate>
          <ChangeDate>dateTime</ChangeDate>
          <ExternalId>long</ExternalId>
          <ExternalFirmId>long</ExternalFirmId>
          <ExternalFirmAddId>long</ExternalFirmAddId>
          <Distance>decimal</Distance>
          <Description>string</Description>
          <Route>
            <LatLon xsi:nil="true" />
            <LatLon xsi:nil="true" />
          </Route>
          <AddPoints>
            <CargoAddPointData xsi:nil="true" />
            <CargoAddPointData xsi:nil="true" />
          </AddPoints>
          <CargoTruckTypes>
            <short>short</short>
            <short>short</short>
          </CargoTruckTypes>
          <InformICQ>boolean</InformICQ>
          <InformSMS>boolean</InformSMS>
          <InformSkype>boolean</InformSkype>
          <InformEMail>boolean</InformEMail>
          <IdParentCargo>int</IdParentCargo>
          <ParentCargoAsString>string</ParentCargoAsString>
          <IsCargoOwner>boolean</IsCargoOwner>
          <SourceKeys>
            <SourceKey xsi:nil="true" />
            <SourceKey xsi:nil="true" />
          </SourceKeys>
          <ExternalRequests>
            <ExternalRequest xsi:nil="true" />
            <ExternalRequest xsi:nil="true" />
          </ExternalRequests>
          <IsPremium>boolean</IsPremium>
        </CargoData>
        <CargoData>
          <Id>int</Id>
          <DateFrom>dateTime</DateFrom>
          <DateTo>dateTime</DateTo>
          <CargoName>string</CargoName>
          <PackageDefinition>string</PackageDefinition>
          <AllowUpperLoad>boolean</AllowUpperLoad>
          <AllowSideLoad>boolean</AllowSideLoad>
          <AllowBackLoad>boolean</AllowBackLoad>
          <CanAddLoading>boolean</CanAddLoading>
          <AllowUpperUpLoad>boolean</AllowUpperUpLoad>
          <AllowSideUpLoad>boolean</AllowSideUpLoad>
          <AllowBackUpLoad>boolean</AllowBackUpLoad>
          <Quantity>float</Quantity>
          <Volume>float</Volume>
          <NumberOfTrucks>int</NumberOfTrucks>
          <CargoSizes>string</CargoSizes>
          <Price>decimal</Price>
          <IsPricePerKm>boolean</IsPricePerKm>
          <IsPriceWithVAT>boolean</IsPriceWithVAT>
          <IdCurrency>string</IdCurrency>
          <FromAddress>string</FromAddress>
          <IdFromCountry>string</IdFromCountry>
          <IdFromCity>int</IdFromCity>
          <FromGeoPoint>
            <Lat>float</Lat>
            <Lon>float</Lon>
            <Description>string</Description>
          </FromGeoPoint>
          <ToAddress>string</ToAddress>
          <IdToCountry>string</IdToCountry>
          <IdToCity>int</IdToCity>
          <ToGeoPoint>
            <Lat>float</Lat>
            <Lon>float</Lon>
            <Description>string</Description>
          </ToGeoPoint>
          <IsRoundtrip>boolean</IsRoundtrip>
          <TIR>boolean</TIR>
          <T1>boolean</T1>
          <ADR>unsignedByte</ADR>
          <IdSourceSystem>short</IdSourceSystem>
          <Company>string</Company>
          <Contact>string</Contact>
          <Phone>string</Phone>
          <MobilePhone>string</MobilePhone>
          <ICQ>long</ICQ>
          <Skype>string</Skype>
          <EMail>string</EMail>
          <Rating>decimal</Rating>
          <GoodRefsCount>int</GoodRefsCount>
          <BadRefsCount>int</BadRefsCount>
          <ContextPrice>decimal</ContextPrice>
          <IsAnonymous>boolean</IsAnonymous>
          <AnonymousID>guid</AnonymousID>
          <CreateDate>dateTime</CreateDate>
          <ChangeDate>dateTime</ChangeDate>
          <ExternalId>long</ExternalId>
          <ExternalFirmId>long</ExternalFirmId>
          <ExternalFirmAddId>long</ExternalFirmAddId>
          <Distance>decimal</Distance>
          <Description>string</Description>
          <Route>
            <LatLon xsi:nil="true" />
            <LatLon xsi:nil="true" />
          </Route>
          <AddPoints>
            <CargoAddPointData xsi:nil="true" />
            <CargoAddPointData xsi:nil="true" />
          </AddPoints>
          <CargoTruckTypes>
            <short>short</short>
            <short>short</short>
          </CargoTruckTypes>
          <InformICQ>boolean</InformICQ>
          <InformSMS>boolean</InformSMS>
          <InformSkype>boolean</InformSkype>
          <InformEMail>boolean</InformEMail>
          <IdParentCargo>int</IdParentCargo>
          <ParentCargoAsString>string</ParentCargoAsString>
          <IsCargoOwner>boolean</IsCargoOwner>
          <SourceKeys>
            <SourceKey xsi:nil="true" />
            <SourceKey xsi:nil="true" />
          </SourceKeys>
          <ExternalRequests>
            <ExternalRequest xsi:nil="true" />
            <ExternalRequest xsi:nil="true" />
          </ExternalRequests>
          <IsPremium>boolean</IsPremium>
        </CargoData>
      </cargos>
    </UpdateCargos>
  </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>
    <UpdateCargosResponse xmlns="http://dev.cargogeo.com/">
      <UpdateCargosResult>
        <string>string</string>
        <string>string</string>
      </UpdateCargosResult>
    </UpdateCargosResponse>
  </soap12:Body>
</soap12:Envelope>