Page Comparison

Purpose

Required/Useful to validate locations used in a Third Party System. Invalid locations used in the "SaveConsignment" call will fail if an invalid location is used. If Suburb and Postcode Validation is not performed in the source system, It is highly recommended that this call is used.

https://auspost.com.au/postcode/suburb- is used as a point of authority for existing/valid Australian suburbs and Postcodes

*This call is not required if sufficiant validation is performed in the source system/

Making a Call:

Info

In this instance I am making a call to Find All locations in my uat environment through postman, I require my Session credentials from my previous example to continue.

*Learn how to chain this call in Creating Chained Requests

Endpoint: https://bau-uat-wsthirdpartywcf.flipgroup.azurewebsites.net/Data/ChainITcom.au/DataService.svc

This is not the production endpoint. The production endpoint will be provided once all requests have been validated to work correctly.

Headers:

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

...

title	Not Required

...

Body:

Code Block

language	xml
theme	RDark
firstline	1
title	SOAP Web Service Call Body Example
linenumbers	true

<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>
      <FindLocation>
<cha:FindLocation> 
         <cha:session><session>
            <cha:AccountID>115860</cha:AccountID><AccountID>{{AccountID}}</AccountID>
            <DistributorID>{{DistributorID}}</DistributorID>
            <!--Mandatory:--><Expires>{{Expires}}</Expires>
            <cha:DistributorID>101605</cha:DistributorID>
  <Key>{{Key}}</Key>
            <UserID>{{UserID}}</UserID>
         <!--Mandatory:-->/session>
 
         <countryCode>AU</countryCode>
         <searchValue>Hallam</searchValue>
      </FindLocation>
 
    <cha:Expires>2018-08-09T15:26:57.87</cha:Expires></soapenv:Body>
</soapenv:Envelope>

Code Block

language	xml
theme	RDark
firstline	1
title	SOAP Web Service Call Body Response
linenumbers	true

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
        <FindLocationResponse xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
            <!--Mandatory:--<FindLocationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <cha:Key>5158851E-1D9C-47D7-A384-55690F4A0B1E</cha:Key>    <Location>
                    <LocationID>8017</LocationID>
                    <Locality>HALLAM</Locality>
      <!--Mandatory:-->              <cha:UserID>64796</cha:UserID><State>VIC</State>
                    </cha:session><Postcode>3803</Postcode>
                    <cha:countryCode>AU</cha:countryCode><CountryCode>AU</CountryCode>
            <!--Mandatory:-->        <SuburbStatePostcode>HALLAM VIC <cha:searchValue>3131</cha:searchValue>3803</SuburbStatePostcode>
                <!--Mandatory:-->/Location>
            </cha:FindLocation>FindLocationResult>
        </soapenv:Body>FindLocationResponse>
    </soapenvs:Envelope>Body>
</soapenvs:Envelope>

...

Versions Compared

Old Version 5

New Version Current

Key

Related articles