Get Access Control Units (v1)

1 Description
2 HTTP Request
- 2.1 Unit level
- 2.2 Facility level
3 Request parameters
4 Request example
5 Response parameters
6 Response example

Description

Use this endpoint to retrieve a list of all rented units and associated customer information for use with your integrated access control system. The response will always be an array of units, even if only one unit is requested.

Important! This API has a rate limit, you are only allowed to call this a maximum of 4 times within a 24 hour period.

HTTP Request

Unit level

GET YOUR_STORMAN_CLOUD_URL/api/v1/facility/YOUR_FACILITY_CODE/access-control/id

Facility level

GET YOUR_STORMAN_CLOUD_URL/api/v1/facility/YOUR_FACILITY_CODE/access-control

Request parameters

n/a

Request example

n/a

Response parameters

Parameter	Type	Description

Parameter	Type	Description
unit_id	number	The id of the unit. This is the primary key.
unit_number	text	The unit number.
facility_code	text	The facility code, of the facility this unit belongs to.
customer_name	text	The primary customer's name.
mobile_number	text	The primary customer's mobile phone number.
agreement_number	text	The agreement number for the primary customer.
unit_location	text	The unit's location.
access_timezone	number	The primary customer’s time zone; see Lookup values for TZ
access_status	text	Either "ACCESS_ALLOWED" or "ACCESS_DENIED".
access_pin_code	text	The PIN code in text form.
customer_email	text	The customer’s email address.
access_notes	text	Any notes regarding the access.
additional_access_users	array	Array of additional users related to the primary customer.
additional_id	integer	The ID of the additional user.
additional_name	text	The additional user’s name.
additional_pin_code	text	The additional user’s PIN code.
additional_timezone	integer	The additional user’s time zone; see Lookup values for TZ
additional_vehicle_reg	text	The additional user’s vehicle registration/number plate.
additional_vehicle_colour	text	The additional user’s vehicle colour.
additional_timezone_name	text	The additional user’s timezone name.
additional_units_allowed	text	The unit numbers that the additional access user can access.

Response example

[
  {
    "id": -4257,
    "unit_no": 10,
    "facility_code": "STORE",
    "customer_code": "STOREBARB1",
    "customer_name": "Barbara Smith",
    "mobile_number": "0730109010",
    "agreement_number": "000000001",
    "unit_location": "Outside / Car Park",
    "access_timezone": 1,
    "access_timezone_name": "1 - Standard Access 5am - 10pm",
    "access_status": "ACCESS_ALLOWED",
    "email_address": "john.smith@storman.com",
    "access_notes": "Sample notes",
    "access_pin_code": "151860"
    "additional_access_users": [
      {
        "additional_id": 11000053,
        "additional_name": "John Smith",
        "additional_pin_code": "1234",
        "additional_timezone": 1,
        "additional_timezone_name": "Greenwich Meantime",
        "additional_units_allowed": "A003, G009",
        "additional_vehicle_reg": "ABCD 123",
        "additional_vehicle_colour": "Green"
      },
      {
        "additional_id": 11000054,
        "additional_name": "Philip Nicklin",
        "additional_pin_code": "5678",
        "additional_timezone": 1,
        "additional_timezone_name": "Greenwich Meantime",
        "additional_units_allowed": "",
        "additional_vehicle_reg": "D429 POC",
        "additional_vehicle_colour": "White"
      }
    ]
  }
]