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)
viewNoStringValid 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
$offsetNoIntegerPage offset (number of records to skip)
$limitNoIntegerPage 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".
addressStringAddress of the ASB premises, e.g. "300 Queen Street Auckland 1010".
longitudeDecimalLongitude part of the geo-coordinate, e.g. -36.851111.
latitudeDecimalLatitude part of the geo-coordinate, e.g. 174.764722.
branchNumberStringBranch 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".
postalAddressStringThe postal address for the branch.
emailAddressStringThe email address for the branch.
hasFastDepositBooleanIndicates whether Branch has Fast Deposit facility.
shortOpeningHoursStringAbbreviated version of the opening and closing times for branch.
openingHoursArray of Complex TypeOpening and closing times for branch.
ATM parameters
atmIDStringATM 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.
availabilityDescriptionStringIndicates when an ATM is available and where is is located. For example '24 Hour Branch', '24 Hour Non Branch', 'Inside Mall ATM'.
placementStringShows where the ATM is situated. Valid values:
In branch, In lobby, Branch, Offsite internal, Offsite
isCustomerFacingBooleanAvailability of the ATM to the public.
hasEnvelopeDispenserBooleanIndicates whether the ATM has an envelope dispenser or not.
hasBusinessDepositBoolean

Indicates whether the ATM has a business deposit facility or not.

hasBusinessDepositOnlyBooleanIndicates whether the ATM only has a business deposit facility.
hasPersonalDepositBooleanIndicates whether the ATM has a personal facility.
hasNoteAcceptorBoolean

Indicates whether the ATM has a mechanism for accepting banknotes for deposits.

hasChequeAcceptorBooleanIndicates whether the ATM has a mechanism for accepting cheques for deposits.
hasNoteAndChequeAcceptorBooleanIndicates whether the ATM has a mechanism for accepting both notes and cheques.
hasCoinAcceptorBooleanIndicates whether the ATM accepts coins for deposits.

openingHours is an array of Complex Type with the following fields: 

ParameterTypeDescription

Day

String

Day that these opening hours apply to.
Example values: "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday", "Public Holiday".

DayNumberInteger

Number representation for the day of the week where:
0 = "Monday"
1 = "Tuesday"
2 = "Wednesday"
3 = "Thursday"
4 = "Friday"
5 = "Saturday"
6 = "Sunday"
7 = "Public holiday"

OpeningStringTime that the branch opens in 24 hour format "HH:mm", e.g. "09:00".
ClosingStringTime that the branch closes in 24 hour format "HH:mm", e.g. "16:00".

Sample Response/s: 

GET https://api.asb.co.nz/public/v1/locations
{
    "value": [
        {
            "type": "atm",
            "name": "277 Broadway",
            "address": "277 Broadway, Newmarket, Auckland, 1023",
            "latitude": -36.870866,
            "longitude": 174.776532,
            "branchNumber": "3200",
            "atmID": "A3200218",
            "atmCount": 1,
            "hasAudio": false,
            "availabilityDescription": "24 Hour Non Branch",
            "placement": "In branch",
            "isCustomerFacing": true,
            "hasEnvelopeDispenser": false,
            "hasBusinessDeposit": false,
            "hasPersonalDeposit": false,
            "hasNoteAcceptor": false,
            "hasChequeAcceptor": false,
            "hasCoinAcceptor": false,
            "hasBusinessDepositOnly": false,
            "hasNoteAndChequeAcceptor": false
        },
        {
            "type": "atm",
            "name": "360 Dominion Road",
            "address": "360 Dominion Road, Mt Eden, Auckland, 1024",
            "latitude": -36.879998,
            "longitude": 174.749871,
            "branchNumber": "3200",
            "atmID": "A3200266",
            "atmCount": 1,
            "hasAudio": true,
            "availabilityDescription": "24 Hour Non Branch",
            "placement": "In branch",
            "isCustomerFacing": true,
            "hasEnvelopeDispenser": false,
            "hasBusinessDeposit": false,
            "hasPersonalDeposit": false,
            "hasNoteAcceptor": false,
            "hasChequeAcceptor": false,
            "hasCoinAcceptor": false,
            "hasBusinessDepositOnly": false,
            "hasNoteAndChequeAcceptor": false
        },
        ...
        "type": "branch",
            "name": "Albany",
            "address": "Westfield Centre 219 Don McKinnon Drive Albany Auckland 0632",
            "postalAddress": "PO Box 35, Auckland 1015",
            "emailAddress": "norma.clark@asb.co.nz",
            "latitude": -36.728611,
            "longitude": 174.710555,
            "branchNumber": "3136",
            "phoneNumber": "+64 (0)9 337-2135",
            "faxNumber": "+64 (0)9 415-5417",
                        "hasFastDeposit": true,
            "shortOpeningHours": "Mon - Wed 9:00 am - 4:30 pm|Thu 9:00 am - 7:00 pm|Fri - Sat 9:00 am - 4:30 pm|Sun 10:00 am - 4:00 pm|Public holiday 10:00 am - 4:00 pm",
            "openingHours": [
                {
                    "day": "Monday",
                    "dayNumber": 0,
                    "opening": "09:00",
                    "closing": "16:30"
                },
                {
                    "day": "Tuesday",
                    "dayNumber": 1,
                    "opening": "09:00",
                    "closing": "16:30"
                },
                {
                    "day": "Wednesday",
                    "dayNumber": 2,
                    "opening": "09:00",
                    "closing": "16:30"
                },
                {
                    "day": "Thursday",
                    "dayNumber": 3,
                    "opening": "09:00",
                    "closing": "19:00"
                },
                {
                    "day": "Friday",
                    "dayNumber": 4,
                    "opening": "09:00",
                    "closing": "16:30"
                },
                {
                    "day": "Saturday",
                    "dayNumber": 5,
                    "opening": "09:00",
                    "closing": "16:30"
                },
                {
                    "day": "Sunday",
                    "dayNumber": 6,
                    "opening": "10:00",
                    "closing": "16:00"
                },
                {
                    "day": "Public holiday",
                    "dayNumber": 7,
                    "opening": "10:00",
                    "closing": "16:00"
                }
            ]
        },
        {
            "type": "branch",
            "name": "Anglesea Clinic",
            "address": "Gate 1 3 Thackeray Street Hamilton Lake Hamilton 3204",
            "postalAddress": "PO Box 19007, Hamilton 2030",
            "emailAddress": "ITHelpDesk@asbbank.co.nz",
            "latitude": -37.7925,
            "longitude": 175.282222,
            "branchNumber": "3152",
            "phoneNumber": "+64 (0)7 834-0345",
            "faxNumber": "+64 (0)7 838-2083",
                        "hasFastDeposit": false,
            "shortOpeningHours": "Mon - Fri 9:00 am - 4:30 pm",
            "openingHours": [
                {
                    "day": "Monday",
                    "dayNumber": 0,
                    "opening": "09:00",
                    "closing": "16:30"
                },
                {
                    "day": "Tuesday",
                    "dayNumber": 1,
                    "opening": "09:00",
                    "closing": "16:30"
                },
                {
                    "day": "Wednesday",
                    "dayNumber": 2,
                    "opening": "09:00",
                    "closing": "16:30"
                },
                {
                    "day": "Thursday",
                    "dayNumber": 3,
                    "opening": "09:00",
                    "closing": "16:30"
                },
                {
                    "day": "Friday",
                    "dayNumber": 4,
                    "opening": "09:00",
                    "closing": "16:30"
                }
            ]
        }
        ....
    ]
}

Note: Depending on the location type (branch or atm) the object will have slightly different fields set (see section Fields).

Request with paging:
GET https://api.asb.co.nz/public/v1/locations?$offset=10&$limit=10
{
    "count": 562,
    "value": [
        {
            "type": "atm",
            "name": "277 Broadway",
            "address": "277 Broadway, Newmarket, Auckland, 1023",
            "latitude": -36.870866,
            "longitude": 174.776532,
            "branchNumber": "3200",
            "atmID": "A3200218",
            "atmCount": 1,
            "hasAudio": false,
            "availabilityDescription": "24 Hour Non Branch",
            "placement": "In branch",
            "isCustomerFacing": true,
            "hasEnvelopeDispenser": false,
            "hasBusinessDeposit": false,
            "hasPersonalDeposit": false,
            "hasNoteAcceptor": false,
            "hasChequeAcceptor": false,
            "hasCoinAcceptor": false,
            "hasBusinessDepositOnly": false,
            "hasNoteAndChequeAcceptor": false
        },
        {
            "type": "atm",
            "name": "360 Dominion Road",
            "address": "360 Dominion Road, Mt Eden, Auckland, 1024",
            "latitude": -36.879998,
            "longitude": 174.749871,
            "branchNumber": "3200",
            "atmID": "A3200266",
            "atmCount": 1,
            "hasAudio": true,
            "availabilityDescription": "24 Hour Non Branch",
            "placement": "In branch",
            "isCustomerFacing": true,
            "hasEnvelopeDispenser": false,
            "hasBusinessDeposit": false,
            "hasPersonalDeposit": false,
            "hasNoteAcceptor": false,
            "hasChequeAcceptor": false,
            "hasCoinAcceptor": false,
            "hasBusinessDepositOnly": false,
            "hasNoteAndChequeAcceptor": false
        },
        {
            "type": "atm",
            "name": "Air NZ Domestic Terminal",
            "address": "Domestic Terminal, Auckland Airport, Auckland, 2022",
            "latitude": -37.006357,
            "longitude": 174.791628,
            "branchNumber": "3200",
            "atmID": "A3200223",
            "atmCount": 1,
            "hasAudio": true,
            "availabilityDesdcription": "Inside Store ATM",
            "placement": "In branch",
            "isCustomerFacing": true,
            "hasEnvelopeDispenser": false,
            "hasBusinessDeposit": false,
            "hasPersonalDeposit": false,
            "hasNoteAcceptor": false,
            "hasChequeAcceptor": false,
            "hasCoinAcceptor": false,
            "hasBusinessDepositOnly": false,
            "hasNoteAndChequeAcceptor": false
        },
        ...
    ]
}

Security

This API is non-authenticated