ExchangeAtmService Web Service

ExchangeAtmService

Click here for a complete list of operations.

ReturnAllAtms

Returns an XML document containing a list of all ATM locations. Each location node contains:

index attribute - the unique ranking of the ATM location within the results set
id attribute - the unique identifier of the ATM location
institution attribute - the name of the institution associated with the ATM location
url attribute - the URL of the institution associated with the ATM location
atmCount attribute - the number of ATM machines installed at this location
latitude attribute - the latitude of the ATM location which can be used to map the ATM
longitude attribute - the longitude of the ATM location which can be used to map the ATM
atmIds node - contains 1 or more child nodes that represent the specific ATMs supported by this ATM location
address/streetAddress node - the address associated with the ATM location
address/city node - the city associated with the ATM location
address/province node - the province associated with the ATM location
address/postalCode node - the postal code associated with the ATM location
address/landmark node - the landmark associated with the ATM location
features/deposits node - information about the deposit-taking abilities of the ATM location; values include 'true' and 'false'
features/hours node - information about the hours associated with the ATM location; values include 'Business Hours Only', '24 Hours a Day' and 'Restricted Access Building'
features/driveThru node - information about whether the ATM location is a drive-thru location; values include 'Yes', 'No' and 'Blank'
features/pinChange node - information about whether the ATM location supports PIN changes; values include 'true' and 'false'
features/voiceGuidance node - information about whether the ATM location supports voice guidance; values include 'true' and 'false'
creditCards/visa node - information about whether the ATM location supports Visa; values include 'true' and 'false'
creditCards/mastercard node - information about whether the ATM location supports Mastercard; values include 'true' and 'false'
creditCards/cirrus node - information about whether the ATM location supports Cirrus; values include 'true' and 'false'
creditCards/plus node - information about whether the ATM location supports Plus; values include 'true' and 'false'
languages node - contains 1 or more child nodes that represent the languages supported by this ATM location; values include English, French, Chinese, Punjabi, Italian and Polish

This method requires the following parameter(s):

strAtmServiceKey - the unique key assigned to your 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/ReturnAllAtms"

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

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

<?xml version="1.0"?>
                        xml