Click here for a complete list of operations.

ReturnAtmSearchByInstitution

Returns an XML document containing a list of ATM locations based upon an institution. 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
• intInstitutionID - an integer representing the unique identifier associated with an institution

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/ReturnAtmSearchByInstitution"

<?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>
    <ReturnAtmSearchByInstitution xmlns="http://the-exchange.ca/atmService">
      <strAtmServiceKey>
                        string</strAtmServiceKey>
      <intInstitutionID>
                        int</intInstitutionID>
    </ReturnAtmSearchByInstitution>
  </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>
    <ReturnAtmSearchByInstitutionResponse xmlns="http://the-exchange.ca/atmService">
      <ReturnAtmSearchByInstitutionResult>
                        xml</ReturnAtmSearchByInstitutionResult>
    </ReturnAtmSearchByInstitutionResponse>
  </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>
    <ReturnAtmSearchByInstitution xmlns="http://the-exchange.ca/atmService">
      <strAtmServiceKey>
                        string</strAtmServiceKey>
      <intInstitutionID>
                        int</intInstitutionID>
    </ReturnAtmSearchByInstitution>
  </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>
    <ReturnAtmSearchByInstitutionResponse xmlns="http://the-exchange.ca/atmService">
      <ReturnAtmSearchByInstitutionResult>
                        xml</ReturnAtmSearchByInstitutionResult>
    </ReturnAtmSearchByInstitutionResponse>
  </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/ReturnAtmSearchByInstitution?
                        strAtmServiceKey=
                        string&
                        intInstitutionID=
                        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/ReturnAtmSearchByInstitution HTTP/1.1
Host: api.ficanex.ca
Content-Type: application/x-www-form-urlencoded
Content-Length: 
                        length
                        strAtmServiceKey=
                        string&
                        intInstitutionID=
                        string
                    

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

<?xml version="1.0"?>
                        xml