v1

latestOpenAPI 3.0.32026-07-26134195287.9 KB
Access Door Exception Calendars

Add Exception to Door Exception Calendar

post/access/v1/door/exception_calendar/{calendar_id}/exception

Path parameters

calendar_idstring required

Request body

all_day_defaultboolean

Bool value specifying if Exception is an All Day Default. If <code>TRUE</code>, then:

  • <code>door_status</code> must be set to <code>access_controlled</code>
  • <code>start_time</code> and <code>end_time</code> will automatically be set to <code>00:00:00</code> and <code>23:59:59</code>, respectively. Different values should not be provided.
  • <code>first_person_in</code> and <code>double_badge</code> must be <code>FALSE</code>
datestring required

Date of the Door Exception formatted as <code>YYYY-MM-DD</code> (according to ISO 8601).

door_status'locked' | 'card_and_code' | 'access_controlled' | 'unlocked'

An enumeration.

double_badgeboolean

Bool value specifying if the Double Badge setting should be enabled for relevant doors. If <code>TRUE</code>, <code>door_status</code> must be set to <code>access_controlled</code>.

By default, all users with access to relevant doors will be allowed to double badge.

double_badge_group_idsstring[]

List of IDs for Access Groups that users must be a member of to be allowed to double badge on relevant doors.

<code>double_badge</code> must also be set to <code>TRUE</code> if value is provided.

end_timestring time required

End time of the Door Exception formatted as <code>hh:mm</code> (according to ISO 8601).

first_person_inboolean

Bool value specifying if the First Person In setting should be enabled for relevant doors. If <code>TRUE</code>, <code>door_status</code> must be set to <code>card_and_code</code>, <code>access_controlled</code>, or <code>unlocked</code>.

first_person_in_group_idsstring[]

List of IDs for Access Groups including supervisors used for First Person In mode.

<code>first_person_in</code> must also be set to <code>TRUE</code> if this value is provided.

start_timestring time required

Start time of the Door Exception formatted as <code>hh:mm</code> (according to ISO 8601).

Response

OK

all_day_defaultboolean

Bool value specifying if Exception is an All Day Default. If <code>TRUE</code>, then:

  • <code>door_status</code> must be set to <code>access_controlled</code>
  • <code>start_time</code> and <code>end_time</code> will automatically be set to <code>00:00:00</code> and <code>23:59:59</code>, respectively. Different values should not be provided.
  • <code>first_person_in</code> and <code>double_badge</code> must be <code>FALSE</code>
calendar_idstring

Unique ID of the Door Exception Calendar that this Exception belongs to.

datestring required

Date of the Door Exception formatted as <code>YYYY-MM-DD</code> (according to ISO 8601).

door_exception_idstring

The unique ID of the Door Exception.

door_status'locked' | 'card_and_code' | 'access_controlled' | 'unlocked'

An enumeration.

double_badgeboolean

Bool value specifying if the Double Badge setting should be enabled for relevant doors. If <code>TRUE</code>, <code>door_status</code> must be set to <code>access_controlled</code>.

By default, all users with access to relevant doors will be allowed to double badge.

double_badge_group_idsstring[]

List of IDs for Access Groups that users must be a member of to be allowed to double badge on relevant doors.

<code>double_badge</code> must also be set to <code>TRUE</code> if value is provided.

end_timestring time required

End time of the Door Exception formatted as <code>hh:mm</code> (according to ISO 8601).

first_person_inboolean

Bool value specifying if the First Person In setting should be enabled for relevant doors. If <code>TRUE</code>, <code>door_status</code> must be set to <code>card_and_code</code>, <code>access_controlled</code>, or <code>unlocked</code>.

first_person_in_group_idsstring[]

List of IDs for Access Groups including supervisors used for First Person In mode.

<code>first_person_in</code> must also be set to <code>TRUE</code> if this value is provided.

start_timestring time required

Start time of the Door Exception formatted as <code>hh:mm</code> (according to ISO 8601).