2-33) Example Web Service Call (ValidateLocation)

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

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
Your package/quote information

*Learn how to chain this call in 5) Creating Chained Requests

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

Headers:

Key: Content-Type Value: text/xml
Key: SoapAction Value: http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices/IChainITService/ValidateLocation

Not Required

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

Body:

Web Service Call

<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:ValidateLocation>
         <cha:location>
            <cha:Locality>North Sydney</cha:Locality>
            <!--Mandatory:-->
            <cha:State>NSW</cha:State>
            <!--Mandatory:-->
            <cha:Postcode>2060</cha:Postcode>
            <!--Mandatory:-->
            <cha:CountryCode>AU</cha:CountryCode>
            <!--Optional - Will Default to AU if not provided:-->
         </cha:location>

      </cha:ValidateLocation>
   </soapenv:Body>
</soapenv:Envelope>

Successful Web Service Call Response

<!-- A valid response will contain a Location ID:-->
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
        <ValidateLocationResponse xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
            <ValidateLocationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <LocationID>686</LocationID>
                <Locality>NORTH SYDNEY</Locality>
                <State>NSW</State>
                <Postcode>2060</Postcode>
                <CountryCode>AU</CountryCode>
                <SuburbStatePostcode>NORTH SYDNEY NSW 2060</SuburbStatePostcode>
            </ValidateLocationResult>
        </ValidateLocationResponse>
    </s:Body>
</s:Envelope>

Failed Web Service Call Response

<!-- 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>
        <ValidateLocationResponse xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
            <ValidateLocationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <LocationID>0</LocationID>
                <Locality>North Sydney</Locality>
                <State>NSW</State>
                <Postcode>2050</Postcode>
                <CountryCode>AU</CountryCode>
                <SuburbStatePostcode>North Sydney NSW 2050</SuburbStatePostcode>
            </ValidateLocationResult>
        </ValidateLocationResponse>
    </s:Body>
</s:Envelope>
</s:Envelope>

Related articles

Filter by label