diff --git a/docs/api-clients/access-codes/README.md b/docs/api-clients/access-codes/README.md index d4f7c4d6..2ca7c963 100644 --- a/docs/api-clients/access-codes/README.md +++ b/docs/api-clients/access-codes/README.md @@ -1,14 +1,14 @@ --- -description: Key Codes to be programmed on a door lock. +description: Key codes to be programmed on a door lock --- # Access Codes -## Access Codes +### `access_code` Properties -### The Access Code object +The `access_code` object has the following properties: -
access_code_id | String (UUID) | Unique identifier for the access code. |
device_id | String (UUID) | Unique identifier for the device associated with the access code. |
code | String | Code used for access. Typically, a numeric or alphanumeric string. |
name | String | Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. |
common_code_key | string | Unique identifier for a group of access codes that share the same code. |
appearance | Object | Name as it appears on the lock provider app or on the device. This is an object with a name property, and first_name and last_name properties if the provider breaks down names into components. |
status | String | Current status of the access code within the operational lifecycle. Values are:
|
is_scheduled_on_device | Boolean | Indicates whether the code is set on the device according to a preconfigured schedule. |
is_managed | Boolean | Indicates whether Seam manages the access code. |
type | Enum | Nature of the access code. Values are:
|
is_backup_access_code_available | Boolean | Indicates whether a backup access code is available for use if the primary access code is lost or compromised. |
is_backup | Boolean | Indicates whether the access code is a backup access code. |
pulled_backup_access_code_id | String (UUID) | Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. |
is_waiting_for_code_assignment | Boolean | Indicates whether the access code is waiting for a code assignment. |
is_external_modification_allowed | Boolean | Indicates whether changes to the access code from external sources are permitted. |
is_one_time_use | Boolean | Indicates whether the access code can only be used once. If true , the code becomes invalid after the first use. |
is_offline_access_code | Boolean | Indicates whether the access code is intended for use in offline scenarios. If true , this code can be created on a device without a network connection. |
starts_at | Datetime (ISO 8601) | Date and time at which the time-bound access code becomes active (only relevant for time_bound codes). |
ends_at | Datetime (ISO 8601) | Date and time after which the time-bound access code becomes inactive (only relevant for time_bound codes). |
created_at | Datetime (ISO 8601) | Date and time at which the access code was created. |
errors | See Access Code Error Types. | Collection of errors associated with the access code, structured in a dictionary format. A unique
This structure enables detailed tracking and timely response to critical issues. |
warnings | See Access Code Warning Types. | Collection of warnings associated with the access code, structured in a dictionary format. A unique
This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. |
Property | Type | Description |
---|---|---|
access_code_id | String (UUID) | Unique identifier for the access code. |
device_id | String (UUID) | Unique identifier for the device associated with the access code. |
code | String | Code used for access. Typically, a numeric or alphanumeric string. |
name | String | Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. |
common_code_key | String | Unique identifier for a group of access codes that share the same code. |
appearance | Object | Name as it appears on the lock provider app or on the device. This is an object with a name property, and first_name and last_name properties if the provider breaks down names into components. |
status | String | Current status of the access code within the operational lifecycle. Values are:
|
is_scheduled_on_device | Boolean | Indicates whether the code is set on the device according to a preconfigured schedule. |
is_managed | Boolean | Indicates whether Seam manages the access code. |
type | Enum | Nature of the access code. Values are:
|
is_backup_access_code_available | Boolean | Indicates whether a backup access code is available for use if the primary access code is lost or compromised. |
is_backup | Boolean | Indicates whether the access code is a backup access code. |
pulled_backup_access_code_id | String (UUID) | Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. |
is_waiting_for_code_assignment | Boolean | Indicates whether the access code is waiting for a code assignment. |
is_external_modification_allowed | Boolean | Indicates whether changes to the access code from external sources are permitted. |
is_one_time_use | Boolean | Indicates whether the access code can only be used once. If true , the code becomes invalid after the first use. |
is_offline_access_code | Boolean | Indicates whether the access code is intended for use in offline scenarios. If true , this code can be created on a device without a network connection. |
starts_at | Datetime (ISO 8601) | Date and time at which the time-bound access code becomes active (only relevant for time_bound codes). |
ends_at | Datetime (ISO 8601) | Date and time after which the time-bound access code becomes inactive (only relevant for time_bound codes). |
created_at | Datetime (ISO 8601) | Date and time at which the access code was created. |
errors | See Access Code Error Types. | Collection of errors associated with the access code, structured in a dictionary format. A unique
This structure enables detailed tracking and timely response to critical issues. |
warnings | See Access Code Warning Types. | Collection of warnings associated with the access code, structured in a dictionary format. A unique
This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. |
Create an Access Code | Create an Access Code |
Create many Access Codes | Create many Access Codes |
Update an Access Code | Update an Access Code |
Delete an Access Code | Delete an Access Code |
Retrieve an Access Code | Retrieve an Access Code |
Retrieve a list of Access Codes | Retrieve a list of Access Codes |