Click here for a complete list of operations.

ReturnAtmSearchByAddressWithMaximum

Returns an XML document containing a specified number of ATM locations based upon an address, including street address, city, province and postal code. See ReturnAllAtms for details of the information included in a successful response.

This method requires the following parameter(s):

• strAtmServiceKey - the unique key assigned to your institution
• strAddress - the address with which to search
• strCity - the city with which to search
• strProvince - the province with which to search
• strPostalCode - the postal code with which to search
• bytRadius - a numeric value containing the radius of the area in which to search
• intMaximumAtms - a numeric value containing the maximum number of ATMs to return

Optional parameter(s):

• bShowDuplicateAddresses - returns additional ATMs present at the same location when value = 1

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 /service/service.asmx HTTP/1.1
Host: api.ficanex.ca
Content-Type: text/xml; charset=utf-8
Content-Length: 
                        length
SOAPAction: "http://the-exchange.ca/atmService/ReturnAtmSearchByAddressWithMaximum"

<?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>
    <ReturnAtmSearchByAddressWithMaximum xmlns="http://the-exchange.ca/atmService">
      <strAtmServiceKey>
                        string</strAtmServiceKey>
      <strAddress>
                        string</strAddress>
      <strCity>
                        string</strCity>
      <strProvince>
                        string</strProvince>
      <strPostalCode>
                        string</strPostalCode>
      <bytRadius>
                        unsignedByte</bytRadius>
      <intMaximumAtms>
                        int</intMaximumAtms>
    </ReturnAtmSearchByAddressWithMaximum>
  </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>
    <ReturnAtmSearchByAddressWithMaximumResponse xmlns="http://the-exchange.ca/atmService">
      <ReturnAtmSearchByAddressWithMaximumResult>
                        xml</ReturnAtmSearchByAddressWithMaximumResult>
    </ReturnAtmSearchByAddressWithMaximumResponse>
  </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 /service/service.asmx HTTP/1.1
Host: api.ficanex.ca
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>
    <ReturnAtmSearchByAddressWithMaximum xmlns="http://the-exchange.ca/atmService">
      <strAtmServiceKey>
                        string</strAtmServiceKey>
      <strAddress>
                        string</strAddress>
      <strCity>
                        string</strCity>
      <strProvince>
                        string</strProvince>
      <strPostalCode>
                        string</strPostalCode>
      <bytRadius>
                        unsignedByte</bytRadius>
      <intMaximumAtms>
                        int</intMaximumAtms>
    </ReturnAtmSearchByAddressWithMaximum>
  </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>
    <ReturnAtmSearchByAddressWithMaximumResponse xmlns="http://the-exchange.ca/atmService">
      <ReturnAtmSearchByAddressWithMaximumResult>
                        xml</ReturnAtmSearchByAddressWithMaximumResult>
    </ReturnAtmSearchByAddressWithMaximumResponse>
  </soap12:Body>
</soap12:Envelope>
                    

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /service/service.asmx/ReturnAtmSearchByAddressWithMaximum?
                        strAtmServiceKey=
                        string&
                        strAddress=
                        string&
                        strCity=
                        string&
                        strProvince=
                        string&
                        strPostalCode=
                        string&
                        bytRadius=
                        string&
                        intMaximumAtms=
                        string HTTP/1.1
Host: api.ficanex.ca
                    

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 
                        length

<?xml version="1.0"?>
                        xml
                    

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /service/service.asmx/ReturnAtmSearchByAddressWithMaximum HTTP/1.1
Host: api.ficanex.ca
Content-Type: application/x-www-form-urlencoded
Content-Length: 
                        length
                        strAtmServiceKey=
                        string&
                        strAddress=
                        string&
                        strCity=
                        string&
                        strProvince=
                        string&
                        strPostalCode=
                        string&
                        bytRadius=
                        string&
                        intMaximumAtms=
                        string
                    

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 
                        length

<?xml version="1.0"?>
                        xml