Door Exception Object

Attribute	Type	Description
calendar_id	String(Unique)	Unique ID of the Door Exception Calendar that this Exception belongs to.
door_exception_id	String(Unique)	The unique ID of the Door Exception.
door_status	String	The door status that this Exception should apply to all doors assigned to its Door Exception Calendar. Possible values are: - locked - card_and_code - access_controlled - unlocked
date	String	Date of the Door Exception formatted as YYYY-MM-DD (according to ISO 8601).
start_time	String	Start time of the Door Exception formatted as hh:mm (according to ISO 8601).
end_time	String	End time of the Door Exception formatted as hh:mm (according to ISO 8601).
all_day_default	Bool	Bool value specifying if Exception is an All Day Default. If TRUE, then: - door_status must be set to access_controlled - start_time and end_time will automatically be set to “00:00:00” and “23:59:59”, respectively. Different values should not be provided. - first_person_in_active and double_badge_active must be FALSE
recurrence_rule	Recurrence Rule Object	A recurrence rule object specifying when the exception should repeat.
first_person_in	Bool	Bool value specifying if the First Person In setting should be enabled for relevant doors. If TRUE, door_status must be set to card_and_code, access_controlled, or unlocked.
double_badge	Bool	Bool value specifying if the Double Badge setting should be enabled for relevant doors. If TRUE, door_status must be set to access_controlled. By default, all users with access to relevant doors will be allowed to double badge.
first_person_in_group_ids	List(String)	List of IDs for Access Groups including supervisors used for First Person In mode. first_person_in_active must also be set to TRUE if this value is provided.
double_badge_group_ids (optional)	List(String)	List of IDs for Access Groups that users must be a member of to be allowed to double badge on relevant doors. double_badge must also be set to TRUE if value is provided.

Door Exception Object TO UPDATE

{
  "all_day_default": BOOL,
  "calendar_id": STR(UNIQUE),
  "date": STR(UNIQUE),
  "door_exception_id": STR(UNIQUE),
  "door_status": STR,
  "double_badge": BOOL,
  "double_badge_group_ids": LIST[STR],
  "end_time": STR,
  "first_person_in": BOOL,
  "first_person_in_group_ids": LIST[STR],
  "recurrence_rule": [Recurrence Rule Object],
  "start_time": STR
}

Example

{
  "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"
}