Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Warning
titleWarning

GetQuote5 returns the exact same information as GetQuote. This example includes significant Complexities, We only recommend undertaking the process of utilizing this functionality only under the requirement of calculating rates for delivery of complex dangerous goods

Info

In this instance I am making a call to GetChargeQuote in my uat environment through postman, Things I need to perform this call:

  1. My Session Credentials form my previous Login Call
    1. Note Session Credentials will expire If
      1. You Have generated a new "Key"
      2. You Have Passed the Expiry Date of the Session
      3. The User has been Deleted/made inactive
  2. Your package/quote information

Endpoint: https://bau-uat-ws.azurewebsites.net/Data/ChainIT/DataService.svc

...

Note
titleNot Required

Header declaration is not required for SoapUI. *SoapUI does this automatically

...

Code Block
languagexml
themeRDark
firstline1
titleWeb Service Call
linenumberstrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:GetChargeQuoteUsingXMLWithItems3>
   
  <!-- Session Credentials Available By following the "Login Web Service Call" 
							https://flipgroup.atlassian.net/wiki/spaces/FLIP/pages/703102977/2a+Example+Web+Service+Call+Login-->     ValidateLocation>
                 <cha:session>location>
            <cha:AccountID>115860</cha:AccountID>
            <!--Mandatory:-->
            <cha:DistributorID>101605<Locality>North Sydney</cha:DistributorID>Locality>
            <!--Mandatory:-->
            <cha:Expires>2018-08-14T09:27:17.78<State>NSW</cha:Expires>State>
            <!--Mandatory:-->
            <cha:Key>D1F83B85-4EEE-4AD1-BC53-99E57836C246<Postcode>2060</cha:Key>Postcode>
            <!--Mandatory:-->
            <cha:UserID>64796<CountryCode>AU</cha:UserID>CountryCode>
            <!--Mandatory:-->
         </cha:session>
 
         <cha:shipperID>115860</cha:shipperID>
         <!--Mandatory:-->
         <cha:effectiveDate>15/08/2018</cha:effectiveDate>
         <!--Mandatory:-->
Optional - Will Default to AU if not provided:-->
        <cha:senderLocation>Nunawading</cha:senderLocation>          <!--Mandatory:-->
        <cha:senderState>VIC</cha:senderState>
location>

      <!--Mandatory:-->
         <cha:senderPostcode>3131</cha:senderPostcode>ValidateLocation>
         <!--Mandatory:-->
         <cha:senderCountryCode>AU</cha:senderCountryCode>
         <!--Mandatory:-->
         <cha:senderIsResidential>0</cha:senderIsResidential>
          <!--Mandatory:Flags for whether the address is residential. Used to pre-empt residential pick up fees.-->
         <!--
             1 = Yes
             0 = No
         -->
         <cha:receiverAddress1>18 Sycamore Grove</cha:receiverAddress1>
         <!--Mandatory:-->
         <cha:receiverAddress2></cha:receiverAddress2>
         <!--Mandatory:-->
         <cha:receiverLocation>Narooma</cha:receiverLocation>
         <!--Mandatory:-->
        <cha:receiverState>NSW</cha:receiverState>
		<!--Mandatory:-->
         <cha:receiverPostcode>2546</cha:receiverPostcode>
         <!--Mandatory:-->
         <cha:receiverCountryCode>AU</cha:receiverCountryCode>
         <!--Mandatory:-->
         <cha:receiverIsResidential>0</cha:receiverIsResidential>
           <!--Mandatory:Flags for whether the address is residential. Used to pre-empt residential pick up fees.-->
         <!--
             1 = Yes
             0 = No
         -->
         <cha:items>4</cha:items>
         <!--Mandatory:-->
         <cha:weight>18</cha:weight>
         <!--Mandatory:-->
         <cha:volume>20</cha:volume>
         <!--Mandatory:-->
         <cha:time>0</cha:time>/soapenv:Body>
</soapenv:Envelope>


Code Block
languagexml
themeRDark
firstline1
titleSuccessful Web Service Call Response
linenumberstrue
collapsetrue
<!-- A valid response will contain a Location ID:-->
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
         <!--Optional:Estimated Travel Time. Recommended not to be used as inaccuracies in time calculation greatly vary quote results.-->
         <!--
			 1 = Yes
			 0 = No 
		 -->
         <cha:distance>0</cha:distance>
          <!--Optional: Estimated Distance between sender and receiver locations. Recommended not to be used as inaccuracies in route taken greatly vary quote results. -->
         <!--
			 1 = Yes
			 0 = No 
		 -->
         <cha:serviceList>0</cha:serviceList>
         <!--Optional:-->
         <cha:userID>64796</cha:userID>
         <!--Mandatory:-->

         <cha:itemsList>
            <!--Zero or more repetitions:-->

            <cha:ConsignmentItem>
               <!--Optional:-->
               <cha:Barcode>1</cha:Barcode>
               <!--Optional:--<ValidateLocationResponse xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
            <ValidateLocationResult   <cha:ConsignmentID>666666</cha:ConsignmentID>
               <!--Optional:-->

               <cha:ConsignmentProduct>
                  <!--Optional:-->
                  <cha:AccountID>115860</cha:AccountID>
                  <!--Optional:-->
                  <cha:Code>1</cha:Code>
                  <!--Optional:-->

                  <cha:DangerousGoods>
                     <!--Optional:-->
                     <cha:AggrigateQuantity>1</cha:AggrigateQuantity>
                     <!--Optional:-->
                     <cha:ConsignmentID>1</cha:ConsignmentID>
                     <!--Optional:--xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                     <cha:DangerousGoodsID>1</cha:DangerousGoodsID><LocationID>686</LocationID>
                     <!--Optional:-->
                     <cha:DgClass>1</cha:DgClass><Locality>NORTH SYDNEY</Locality>
                     <!--Optional:-->

                     <cha:Exception>
                        <!--Optional:-->
                        <cha:Message>Na</cha:Message><State>NSW</State>
                        <!--Optional:-->
                        <cha:ModuleName>Peter</cha:ModuleName><Postcode>2060</Postcode>
                        <!--Optional:-->
                        <cha:ProcedureName>Test</cha:ProcedureName><CountryCode>AU</CountryCode>
                <SuburbStatePostcode>NORTH SYDNEY NSW   </cha:Exception>
        2060</SuburbStatePostcode>
            <!--Optional:-->

                     <cha:Group>1</cha:Group>/ValidateLocationResult>
                     <!--Optional:-->
                     <cha:ID>1</cha:ID>
               /ValidateLocationResponse>
     <!--Optional:-->
                     <cha:ItemNo>1</cha:ItemNo>
                     <!--Optional:-->
                     <cha:LiquidVolume>1</cha:LiquidVolume>
                     <!--Optional:-->
                     <cha:Liquidweight>1</cha:Liquidweight>
                     <!--Optional:-->
                     <cha:Name>1</cha:Name>
                     <!--Optional:-->
                     <cha:PSN>1</cha:PSN>
                     <!--Optional:-->
                     <cha:Quantity>1</cha:Quantity>
                     <!--Optional:-->
                     <cha:Recepticle>1</cha:Recepticle>
                     <!--Optional:-->
                     <cha:SubRisk>1</cha:SubRisk>
                     <!--Optional:-->
                     <cha:UnCode>1</cha:UnCode>
                     <!--Optional:-->
                     <cha:Units>1</cha:Units>
                     <!--Optional:-->
                     <cha:Volume>1</cha:Volume>
                     <!--Optional:-->
                     <cha:Weight>1</cha:Weight>
                  </cha:DangerousGoods>

                     <!--Optional:-->
                  <cha:DangerousGoodsID>1</cha:DangerousGoodsID>
                  <!--Mandatory:-->

                  <cha:Error>
                     <!--Optional:-->
                     <cha:Message>1</cha:Message>
                     <!--Optional:-->
                     <cha:ModuleName>1</cha:ModuleName>
                     <!--Optional:-->
                     <cha:ProcedureName>1</cha:ProcedureName>
                  </cha:Error>

                  <!--Optional:-->
                  <cha:Height>1</cha:Height>
                  <!--Optional:-->
                  <cha:IsActive>1</cha:IsActive>
                  <!--Optional:-->
                  <cha:Length>1</cha:Length>
                  <!--Optional:-->
                  <cha:Name>1</cha:Name>
                  <!--Optional:-->
                  <cha:ProductID>1</cha:ProductID>
                  <!--Optional:-->
                  <cha:Volume>1</cha:Volume>
                  <!--Optional:-->
                  <cha:Weight>1</cha:Weight>
                  <!--Optional:-->
                  <cha:Width>1</cha:Width>
               </cha:ConsignmentProduct>
               <!--Optional:-->

               <cha:Description>Enter Description</cha:Description>
               <!--Optional:-->
               <cha:ExchangeReturnable>1</cha:ExchangeReturnable>
               <!--Optional:-->
               <cha:Height>1</cha:Height>
               <!--Optional:-->
               <cha:ItemNo>1</cha:ItemNo>
               <!--Optional:-->
               <cha:ItemType>1</cha:ItemType>
               <!--Optional:-->
               <cha:Length>1</cha:Length>
               <!--Optional:-->
               <cha:ModifiedBy>1</cha:ModifiedBy>
               <!--Optional:-->
               <cha:NoItems>1</cha:NoItems>
               <!--Optional:-->
               <cha:ProductID>1</cha:ProductID>
               <!--Optional:-->
               <cha:Reference>1</cha:Reference>
               <!--Optional:-->
               <cha:Returnable>1</cha:Returnable>
               <!--Optional:-->
               <cha:Volume>1</cha:Volume>
               <!--Optional:-->
               <cha:Weight>1</cha:Weight>
               <!--Optional:-->
               <cha:Width>1</cha:Width>
            </cha:ConsignmentItem>

         </cha:itemsList>
         <!--Optional:-->

         <cha:containsDGs>0</cha:containsDGs>             
         <!--Mandatory:Flags whether shipping items contain dangerous goods. Required for compliance and dangerous goods handling fee calculations.-->
         <!--
			 1 = Yes
			 0 = No 
		 -->
      </cha:GetChargeQuoteUsingXMLWithItems3>
   </soapenv:Body>
</soapenv:Envelope>
Code Block
languagexml
themeRDark
firstline1
titleSuccessful Web Service Call Response
linenumberstrue
collapsetrue
/s:Body>
</s:Envelope>


Code Block
languagexml
themeRDark
firstline1
titleFailed Web Service Call Response
linenumberstrue
collapsetrue
<!-- An Invalid response will  NOT contain a Location ID/ LocationID = 0:-->
<!-- This means your provided Location is not found within our system-->

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
        <GetChargeQuote5Response<ValidateLocationResponse xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
            <GetChargeQuote4Result<ValidateLocationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <ServicePricing>                <CalculatedSUType>UnDefined</CalculatedSUType><LocationID>0</LocationID>
               <CarrierID>101956</CarrierID>                <CarrierName>TOLL IPEC PTY LTD</CarrierName>
<Locality>North Sydney</Locality>
              <CarrierService>L</CarrierService>                <ETA>16/08/2018</ETA><State>NSW</State>
               <FeesCharge>237.1800</FeesCharge>
               <FreightCharge>1652.8100</FreightCharge> <Postcode>2050</Postcode>
               <ID>0</ID>
               <NetCharge>1889.9900</NetCharge> <CountryCode>AU</CountryCode>
               <RateID>9607039</RateID> <SuburbStatePostcode>North Sydney              <ServiceName>IPEC Local</ServiceName>
               <ShipperService>IPECL</ShipperService>
               <TaxCharge>189.0000</TaxCharge>
               <TotalCharge>2078.9900</TotalCharge>
               <WebDescription>Toll Ipec Local</WebDescription>
               <ZoneFrom>MEL1</ZoneFrom>
  NSW 2050</SuburbStatePostcode>
            <ZoneTo>IVIC</ZoneTo>
            </ServicePricing>
            <ServicePricing>
               <CalculatedSUType>UnDefined</CalculatedSUType>
               <CarrierID>101956</CarrierID>
               <CarrierName>TOLL IPEC PTY LTD</CarrierName>
               <CarrierService>X</CarrierService>
               <ETA>16/08/2018</ETA>
               <FeesCharge>261.2700</FeesCharge>
               <FreightCharge>1820.6700</FreightCharge>
               <ID>0</ID>
               <NetCharge>2081.9400</NetCharge>
               <RateID>9607176</RateID>
               <ServiceName>IPEC Road Express</ServiceName>
               <ShipperService>IPECX</ShipperService>
               <TaxCharge>208.2000</TaxCharge>
               <TotalCharge>2290.1400</TotalCharge>
               <WebDescription>Toll Ipec Road Express</WebDescription>
       </ValidateLocationResult>
       <ZoneFrom>MEL1</ZoneFrom>                <ZoneTo>IVIC</ZoneTo>
            </ServicePricing>
            <ServicePricing>
               <CalculatedSUType>UnDefined</CalculatedSUType>
               <CarrierID>102958</CarrierID>
               <CarrierName>Hi-Trans Express Pty Ltd</CarrierName>
               <CarrierService>G</CarrierService>
               <ETA/>
               <FeesCharge>327.8300</FeesCharge>
               <FreightCharge>1927.2900</FreightCharge>
               <ID>0</ID>
               <NetCharge>2255.1200</NetCharge>
               <RateID>10702459</RateID>
               <ServiceName>Hi Trans General Service</ServiceName>
               <ShipperService>HITRANG</ShipperService>
               <TaxCharge>225.5100</TaxCharge>
               <TotalCharge>2480.6300</TotalCharge>
               <WebDescription>Hi-Trans General</WebDescription>
               <ZoneFrom>MEL</ZoneFrom>
               <ZoneTo>VC1I</ZoneTo>
            </ServicePricing>
            <ServicePricing>
               <CalculatedSUType>UnDefined</CalculatedSUType>
               <CarrierID>102958</CarrierID>
               <CarrierName>Hi-Trans Express Pty Ltd</CarrierName>
               <CarrierService>X</CarrierService>
               <ETA/>
               <FeesCharge>392.8600</FeesCharge>
               <FreightCharge>2309.5900</FreightCharge>
               <ID>0</ID>
               <NetCharge>2702.4500</NetCharge>
               <RateID>10702460</RateID>
               <ServiceName>Hi-Trans Express Service</ServiceName>
               <ShipperService>HITRANX</ShipperService>
               <TaxCharge>270.2500</TaxCharge>
               <TotalCharge>2972.7000</TotalCharge>
               <WebDescription>Hi Trans Express</WebDescription>
               <ZoneFrom>MEL</ZoneFrom>
               <ZoneTo>VC1I</ZoneTo>
            </ServicePricing>
            <ServicePricing>
               <CalculatedSUType>UnDefined</CalculatedSUType>
               <CarrierID>101956</CarrierID>
               <CarrierName>TOLL IPEC PTY LTD</CarrierName>
               <CarrierService>H</CarrierService>
               <ETA>16/08/2018</ETA>
               <FeesCharge>766.2200</FeesCharge>
               <FreightCharge>4895.9800</FreightCharge>
               <ID>0</ID>
               <NetCharge>5662.2000</NetCharge>
               <RateID>9606992</RateID>
               <ServiceName>IPEC Priority</ServiceName>
               <ShipperService>IPECH</ShipperService>
               <TaxCharge>566.2200</TaxCharge>
               <TotalCharge>6228.4200</TotalCharge>
               <WebDescription>Toll Ipec Priority</WebDescription>
               <ZoneFrom>MEL1</ZoneFrom>
               <ZoneTo>IVIC</ZoneTo>
            </ServicePricing>
         </GetChargeQuote4Result>
      </GetChargeQuote5Response>
   </s:Body></ValidateLocationResponse>
    </s:Body>
</s:Envelope>
</s:Envelope>


Image RemovedImage AddedImage RemovedImage RemovedImage Added

...