ExchangeAtmService
Click here for a complete list of operations.
ReturnAtmSearchByAddress
Returns an XML/JSON document containing a list 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): Optional parameter(s):
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/ReturnAtmSearchByAddress"
<?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>
<ReturnAtmSearchByAddress xmlns="http://the-exchange.ca/atmService">
<strAtmServiceKey>
string</strAtmServiceKey>
<strAddress>
string</strAddress>
<strCity>
string</strCity>
<strProvince>
string</strProvince>
<strPostalCode>
string</strPostalCode>
<bytRadius>
unsignedByte</bytRadius>
</ReturnAtmSearchByAddress>
</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>
<ReturnAtmSearchByAddressResponse xmlns="http://the-exchange.ca/atmService">
<ReturnAtmSearchByAddressResult>
xml</ReturnAtmSearchByAddressResult>
</ReturnAtmSearchByAddressResponse>
</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>
<ReturnAtmSearchByAddress xmlns="http://the-exchange.ca/atmService">
<strAtmServiceKey>
string</strAtmServiceKey>
<strAddress>
string</strAddress>
<strCity>
string</strCity>
<strProvince>
string</strProvince>
<strPostalCode>
string</strPostalCode>
<bytRadius>
unsignedByte</bytRadius>
</ReturnAtmSearchByAddress>
</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>
<ReturnAtmSearchByAddressResponse xmlns="http://the-exchange.ca/atmService">
<ReturnAtmSearchByAddressResult>
xml</ReturnAtmSearchByAddressResult>
</ReturnAtmSearchByAddressResponse>
</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/ReturnAtmSearchByAddress?
strAtmServiceKey=
string&
strAddress=
string&
strCity=
string&
strProvince=
string&
strPostalCode=
string&
bytRadius=
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/ReturnAtmSearchByAddress 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
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length:
length
<?xml version="1.0"?>
xml
HTTP JSON GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /service-v2.asmx/ReturnAtmSearchByAddress HTTP/1.1
Host: api.ficanex.ca
Content-Type: application/json
Content-Length:
length
strAtmServiceKey=
string&
strAddress=
string&
strCity=
string&
strProvince=
string&
strPostalCode=
string&
bytRadius=
string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length:
length
{
"count": 1,
"coordinates": {
"latitude": 49.3380932,
"longitude": -123.0692896
},
"locations": [
{
"index": 0,
"id": 2021,
"atmIdentifier": "VSCU5972",
"institution": {
"id": 303,
"name": "Vancity Credit Union",
"url": "",
"isAtlanticCreditUnion": 0
},
"coordinates": {
"latitude": 49.3236,
"longitude": -123.072
},
"address": {
"streetAddress": "1620 Lonsdale Aveneu",
"city": "North Vancouver",
"province": "BC",
"postalCode": "V7M2J3",
"landmark": "Lonsdale & 17th Street"
},
"features": {
"deposits": 1,
"hours": 2,
"driveThru": 0,
"pinChange": 1,
"voiceGuidance": 1
},
"creditCards": {
"visa": 1,
"plus": 0,
"mastercard": 0,
"cirrus": 1
},
"languages": [
"en",
"fr"
]
}
]
}