Location API
This API is: | Public |
Business purpose: | Provide any user the ability to retrieve ASB branch & ATM information |
HTTP Methods: | GET |
Request URL: | https://api.asb.co.nz/public/v1/locations |
Requests
The following parameters are supported in JSON format
Parameter |
Mandatory | Type | Description |
---|---|---|---|
type |
No |
String |
Type of ASB premise (branch/atm) |
view | No | String | Valid values: GeoSummary.
Currently only supported for type=atm. This grouping will remove duplicate geo-locations by grouping ATMs according to latitude and longitude. When ATM locations are grouped, the features of the resulting ATM location will be the maximum of the features that were grouped. For example, if there are two ATMs with identical latitude and longitude and one ATM has an envelope dispenser capability and another ATM does not, the resulting grouped ATM will have an envelope dispenser capability (hasEnvelopeDispenser=true). |
$fields |
No |
String |
Specify the properties to include in the result set. E.g. $fields=name,address |
$orderby |
No |
String |
Specify the sort order, if not specified, by default the result is sorted firstly by name |
$offset | No | Integer | Page offset (number of records to skip) |
$limit | No | Integer | Page limit (maximum number of records to return) |
Sample Request/s:
https://api.asb.co.nz/public/v1/locations
https://api.asb.co.nz/public/v1/locations?type=atm
https://api.asb.co.nz/public/v1/locations?type=atm&view=geoSummary
Responses
Responses are in JSON format
Parameter | Type | Description |
---|---|---|
Common parameters | ||
type |
String | Type of ASB premises (branch/atm). |
name |
String | Name of the ASB premises, e.g. "Auckland". |
address | String | Address of the ASB premises, e.g. "300 Queen Street Auckland 1010". |
longitude | Decimal | Longitude part of the geo-coordinate, e.g. -36.851111. |
latitude | Decimal | Latitude part of the geo-coordinate, e.g. 174.764722. |
branchNumber | String | Branch number, e.g. "3119". |
Branch parameters | ||
phoneNumber |
String | Branch phone number, e.g. "+64 (0)9 377-8930". |
faxNumber |
String | Branch fax number, e.g. "+64 (0)9 623-8708". |
postalAddress | String | The postal address for the branch. |
emailAddress | String | The email address for the branch. |
hasFastDeposit | Boolean | Indicates whether Branch has Fast Deposit facility. |
shortOpeningHours | String | Abbreviated version of the opening and closing times for branch. |
openingHours | Array of Complex Type | Opening and closing times for branch. |
ATM parameters | ||
atmID | String | ATM ID, e.g. "A3200280". |
atmCount |
Integer | Number of ATMs at the same location.
For the default view, the atmCount is the number of ATMs with the same branchNumber and placement (excluding offsite ATMs). For the GeoSummary view, atmCount is the number of ATMs with the same latitude and longitude that have been grouped into a single ATM summary record. |
hasAudio |
Boolean | Whether the ATM has audio capability. |
availabilityDescription | String | Indicates when an ATM is available and where is is located. For example '24 Hour Branch', '24 Hour Non Branch', 'Inside Mall ATM'. |
placement | String | Shows where the ATM is situated. Valid values:
In branch, In lobby, Branch, Offsite internal, Offsite |
isCustomerFacing | Boolean | Availability of the ATM to the public. |
hasEnvelopeDispenser | Boolean | Indicates whether the ATM has an envelope dispenser or not. |
hasBusinessDeposit | Boolean |
Indicates whether the ATM has a business deposit facility or not. |
hasBusinessDepositOnly | Boolean | Indicates whether the ATM only has a business deposit facility. |
hasPersonalDeposit | Boolean | Indicates whether the ATM has a personal facility. |
hasNoteAcceptor | Boolean |
Indicates whether the ATM has a mechanism for accepting banknotes for deposits. |
hasChequeAcceptor | Boolean | Indicates whether the ATM has a mechanism for accepting cheques for deposits. |
hasNoteAndChequeAcceptor | Boolean | Indicates whether the ATM has a mechanism for accepting both notes and cheques. |
hasCoinAcceptor | Boolean | Indicates whether the ATM accepts coins for deposits. |
openingHours is an array of Complex Type with the following fields:
Parameter | Type | Description |
---|---|---|
Day |
String |
Day that these opening hours apply to.
|
DayNumber | Integer |
Number representation for the day of the week where:
|
Opening | String | Time that the branch opens in 24 hour format "HH:mm", e.g. "09:00". |
Closing | String | Time that the branch closes in 24 hour format "HH:mm", e.g. "16:00". |
Sample Response/s:
|
Note: Depending on the location type (branch or atm) the object will have slightly different fields set (see section Fields).
|
Security
This API is non-authenticated
-
API URL : https://api.asb.co.nz
-
-
-