Versions Compared

Key

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

Purpose

This Web Service Call allows a third party application to retrieve a list of possible locations that match a validated location / postcode / state / country code based on search terms. Depending on the granularity of the search term, the service may return multiple values that match the search term.


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 5) Creating Chained Requests

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

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

Headers: 

...

Code Block
languagexml
themeRDark
firstline1
titleSOAP Web Service Call Body Example
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>
      <FindLocation>
 
         <session>
     <cha:FindLocation>       <!-- Session Credentials Available By following the "Login Web Service Call"
  <AccountID>{{AccountID}}</AccountID>
            <DistributorID>{{DistributorID}}</DistributorID>
            <Expires>{{Expires}}</Expires>
            https://flipgroup.atlassian.net/wiki/spaces/FLIP/pages/703102977/2a+Example+Web+Service+Call+Login--<Key>{{Key}}</Key>
            <UserID>{{UserID}}</UserID>
         </session>
 
         <countryCode>AU</countryCode>
         <searchValue>Hallam</searchValue>
      </FindLocation>
 
   </soapenv:Body>
</soapenv:Envelope>


Code Block
languagexml
themeRDark
firstline1
titleSOAP Web Service Call Body Response
linenumberstrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
        <FindLocationResponse <cha:session>xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
             <cha:AccountID>115860</cha:AccountID><FindLocationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <Location>
  <!--Mandatory:-->             <cha:DistributorID>101605</cha:DistributorID>     <LocationID>8017</LocationID>
       <!--Mandatory:-->             <cha:Expires>2018-08-16T15:15:55.89</cha:Expires><Locality>HALLAM</Locality>
            <!--Mandatory:-->        <State>VIC</State>
    <cha:Key>E36D344D-DCA9-45B8-8FCD-2F049B1E73B3</cha:Key>             <!--Mandatory:-->   <Postcode>3803</Postcode>
         <cha:UserID>64796</cha:UserID>           <CountryCode>AU</CountryCode>
 <!--Mandatory:-->          </cha:session>         <SuburbStatePostcode>HALLAM VIC <cha:countryCode>AU</cha:countryCode>3803</SuburbStatePostcode>
         <!--Mandatory:-->       </Location>
  <cha:searchValue>3131</cha:searchValue>          <!--Mandatory:-->/FindLocationResult>
        </cha:FindLocation>FindLocationResponse>
    </soapenvs:Body>
</soapenvs:Envelope>

Image Modified

...


Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@20f86d
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel = "kb-how-to-article" and type = "page" and space = "FLIP"
labelskb-how-to-article

...