ExchangeAtmService


Click here for a complete list of operations.

ReturnAtmSearchByCoordinates

Returns an XML/JSON document containing a list of ATM locations based upon a latitude and longitude. 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/ReturnAtmSearchByCoordinates"

<?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>
    <ReturnAtmSearchByCoordinates xmlns="http://the-exchange.ca/atmService">
      <strAtmServiceKey>
                        string</strAtmServiceKey>
      <strPostalCode>
                        string</strPostalCode>
      <dblLatitude>
                        double</dblLatitude>
      <dblLongitude>
                        double</dblLongitude>
      <bytRadius>
                        unsignedByte</bytRadius>
    </ReturnAtmSearchByCoordinates>
  </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>
    <ReturnAtmSearchByCoordinatesResponse xmlns="http://the-exchange.ca/atmService">
      <ReturnAtmSearchByCoordinatesResult>
                        xml</ReturnAtmSearchByCoordinatesResult>
    </ReturnAtmSearchByCoordinatesResponse>
  </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>
    <ReturnAtmSearchByCoordinates xmlns="http://the-exchange.ca/atmService">
      <strAtmServiceKey>
                        string</strAtmServiceKey>
      <strPostalCode>
                        string</strPostalCode>
      <dblLatitude>
                        double</dblLatitude>
      <dblLongitude>
                        double</dblLongitude>
      <bytRadius>
                        unsignedByte</bytRadius>
    </ReturnAtmSearchByCoordinates>
  </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>
    <ReturnAtmSearchByCoordinatesResponse xmlns="http://the-exchange.ca/atmService">
      <ReturnAtmSearchByCoordinatesResult>
                        xml</ReturnAtmSearchByCoordinatesResult>
    </ReturnAtmSearchByCoordinatesResponse>
  </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/ReturnAtmSearchByCoordinates?
                        strAtmServiceKey=
                        string&
                        strPostalCode=
                        string&
                        dblLatitude=
                        string&
                        dblLongitude=
                        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/ReturnAtmSearchByCoordinates HTTP/1.1
Host: api.ficanex.ca
Content-Type: application/x-www-form-urlencoded
Content-Length: 
                        length
                        strAtmServiceKey=
                        string&
                        strPostalCode=
                        string&
                        dblLatitude=
                        string&
                        dblLongitude=
                        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/ReturnAtmSearchByCoordinates HTTP/1.1
Host: api.ficanex.ca
Content-Type: application/json
Content-Length: 
                            length
                            strAtmServiceKey=
                            string&
                            strPostalCode=
                            string&
                            dblLatitude=
                            string&
                            dblLongitude=
                            string&
                            bytRadius=
                            string
                
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 
                    length
                    {
                        "count": 1,
                        "coordinates": {
                            "latitude": 48.45886,
                            "longitude": -123.379264
                        },
                        "locations": [
                            {
                                "index": 0,
                                "id": 963,
                                "atmIdentifier": "CCSC3102",
                                "institution": {
                                    "id": 58,
                                    "name": "Coast Capital Savings Federal Credit Union",
                                    "url": "",
                                    "isAtlanticCreditUnion": 0
                                },
                                "coordinates": {
                                    "latitude": 48.4542,
                                    "longitude": -123.395
                                },
                                "address": {
                                    "streetAddress": "3170 Tillicum Rd, Unit 169",
                                    "city": "Victoria",
                                    "province": "BC",
                                    "postalCode": "V9A7C9",
                                    "landmark": "Tillicum Centre Mall"
                                },
                                "features": {
                                    "deposits": 1,
                                    "hours": 2,
                                    "driveThru": 0,
                                    "pinChange": 1,
                                    "voiceGuidance": 1
                                },
                                "creditCards": {
                                    "visa": 1,
                                    "plus": 1,
                                    "mastercard": 1,
                                    "cirrus": 1
                                },
                                "languages": [
                                    "en",
                                    "fr",
                                    "zh",
                                    "pa"
                                ]
                            }
                        ]
                    }