Access Level Object

An Access Level that grants access to users included in access_groups to doors during the time periods specified b access_schedule_events. Door Exception Calendar that applies exception states defined by Door Exceptions to the Door Schedules of all doors included in doors.

AttributeTypeDescription
nameStringName of the Access Level.
access_level_idString(Unique)Unique identifier for the Access Level.
access_groupsList(String)IDs of Access Groups granted door access via this Access Level.
access_schedule_eventsList(Access Schedule Event Object)List of Access Schedule Events associated with this Access Level.
sitesList(String)IDs of Sites containing the Doors this Access Level applies to.
doorsList(String)IDs of Doors accessible under this Access Level
last_updated_atIntegerThe last time the Access Level was updated. Formatted as a Unix timestamp in seconds.

Access Level Object

{
  "access_groups" : LIST(STR),
  "access_level_id" : STR(UNIQUE),
  "access_schedule_events" : LIST(Access Schedule Events),
  "doors" : LIST[STR],
  "last_updated_at" : INT,
  "name" : STR,
  "sites" : LIST(STR)
}

Example

{
	{
  	 "door_exception_calendar_id": "8838a312-7c6a-4b42-bdff-bf7a3871d8e0",
     "doors": [
     		"5fcfb028-2d9b-4994-a5c1-64e36d67d03f",
         "e66bca98-75aa-4a4b-b91f-cdd7e50161fc"
     ],
     "exceptions": [
     		{
       		 "all_day_default": false,
           "calendar_id": "8838a312-7c6a-4b42-bdff-bf7a3871d8e0",
           "date": "2024-11-03",
           "door_exception_id": "808ed282-d35a-400a-bb22-28507c57568e",
           "door_status": "unlocked",
           "double_badge": false,
           "double_badge_group_ids": [],
           "end_time": "13:00:00",
           "first_person_in": false,
           "first_person_in_group_ids": [],
           "recurrence_rule": {
           		"by_day": null,
              "by_month": null,
              "by_month_day": 3,
              "by_set_pos": null,
              "count": null,
              "excluded_dates": null,
              "frequency": "MONTHLY",
              "interval": 1,
              		"until": null
              },
              "start_time": "11:00:00"
           }
    ],
    "last_updated_at": 1736891796,
    "name": "Monthly Unlocks"
	}
}

{
  "access_groups": [
    "a9611b39-ef11-435a-838a-b446d16ecf0e"
  ],
  "access_level_id": "159c5ed3-0619-4250-a720-d5983484af7e",
  "access_schedule_events": [
    {
      "access_schedule_event_id": "611fc672-2dfa-4c0c-9fc8-5ebc6c59ba4e",
      "door_status": "access_granted",
      "end_time": "23:59",
      "start_time": "00:00",
      "weekday": "MO"
    },
    {
      "access_schedule_event_id": "d804170b-dbce-471c-9d81-c5fb6f7d608d",
      "door_status": "access_granted",
      "end_time": "23:59",
      "start_time": "00:00",
      "weekday": "TU"
    },
    {
      "access_schedule_event_id": "82598fc6-6fae-481f-975b-57855af74748",
      "door_status": "access_granted",
      "end_time": "23:59",
      "start_time": "00:00",
      "weekday": "WE"
    },
    {
      "access_schedule_event_id": "0e33b715-63ce-43a5-9f23-3cd89af0ca20",
      "door_status": "access_granted",
      "end_time": "23:59",
      "start_time": "00:00",
      "weekday": "TH"
    },
    {
      "access_schedule_event_id": "cbc5bb84-703c-4870-8bfd-8f6d434ed170",
      "door_status": "access_granted",
      "end_time": "23:59",
      "start_time": "00:00",
      "weekday": "FR"
    }
  ],
  "doors": [
    "2401b667-8c91-48ae-b61e-731f4774b112",
    "5a1e38dd-43ff-4991-8045-04fb9a02ec8b",
    "5fcfb028-2d9b-4994-a5c1-64e36d67d03f",
    "e66bca98-75aa-4a4b-b91f-cdd7e50161fc"
  ],
  "last_updated_at": 1741386167,
  "name": "24/7 Access Granted",
  "sites": [
    "a84aa1b7-1a8c-435b-bf72-9cf607e876c3",
    "42eb5b25-f69d-40d9-9c23-43dae34dc948"
  ]
}