diff --git a/docs/capability-guides/smart-locks/access-codes/creating-access-codes/README.md b/docs/capability-guides/smart-locks/access-codes/creating-access-codes/README.md index 1468d3a48..9c536a403 100644 --- a/docs/capability-guides/smart-locks/access-codes/creating-access-codes/README.md +++ b/docs/capability-guides/smart-locks/access-codes/creating-access-codes/README.md @@ -19,7 +19,7 @@ layout: ## Overview -This guide explains how to create online access codes on an online smart lock. With the [Access Codes](../../../../api/access_codes/) API, generate PIN codes on a door lock and share it with visitors, allowing them keyless access. +This guide explains how to create online access codes on an online smart lock. With the [Access Codes](../../../../api/access_codes/README.md) API, generate PIN codes on a door lock and share it with visitors, allowing them keyless access. Seam supports programming two types of online access codes for online door locks: @@ -550,7 +550,7 @@ There are two methods to verify that an ongoing access code has been set on the ### **Polling Method** -Use the `access_code` reference returned by the create function to call the [Get Access Code](../../../../api/access_codes/get/) function. A basic implementation would involve polling this endpoint until the `status` of the access code updates to `set`. +Use the `access_code` reference returned by the create function to call the [Get Access Code](../../../../api/access_codes/get.md) function. A basic implementation would involve polling this endpoint until the `status` of the access code updates to `set`. If the `status` remains `setting` for a very long time, or if the `access_code` object contains any `warnings` or `errors` properties, consult [the guide on "Troubleshooting Access Code Issues"](../../../../products/smart-locks/access-codes/troubleshooting-access-code-issues.md) for further guidance. @@ -936,7 +936,7 @@ There are two methods to verify that an time-bound access code has been set on t ### **Polling Method** -Use the `access_code` reference returned by the create function to call the [Get Access Code](../../../../api/access_codes/get/) function. In a basic implementation, you would poll this endpoint at the `starts_at` time to check if the access code's status is updated to `set`. +Use the `access_code` reference returned by the create function to call the [Get Access Code](../../../../api/access_codes/get.md) function. In a basic implementation, you would poll this endpoint at the `starts_at` time to check if the access code's status is updated to `set`. If the `status` remains `setting`, or if the `access_code` object displays any `warnings` or `errors`, refer to [the "Troubleshooting Access Code Issues" guide](../../../../products/smart-locks/access-codes/troubleshooting-access-code-issues.md) for assistance. diff --git a/docs/device-and-system-integration-guides/smartthings-hubs-+-smart-locks.md b/docs/device-and-system-integration-guides/smartthings-hubs-+-smart-locks.md index bd6c720e1..60d4736d6 100644 --- a/docs/device-and-system-integration-guides/smartthings-hubs-+-smart-locks.md +++ b/docs/device-and-system-integration-guides/smartthings-hubs-+-smart-locks.md @@ -49,7 +49,7 @@ Note the following SmartThings-specific features: ### Reporting Access Code Length Constraints -For SmartThings-connected devices, you can report the set of supported access code lengths or the minimum and maximum supported code lengths. For details, see [Report Device Access Code Constraints](../api/access_codes/report-device-access-code-constraints.md). +For SmartThings-connected devices, you can report the set of supported access code lengths or the minimum and maximum supported code lengths. For details, see [Report Device Access Code Constraints](../api/access_codes/report_device_constraints.md). *** diff --git a/docs/device-guides/implementing-robust-access-code-management-for-guests.md b/docs/device-guides/implementing-robust-access-code-management-for-guests.md index af2688065..75c0c052c 100644 --- a/docs/device-guides/implementing-robust-access-code-management-for-guests.md +++ b/docs/device-guides/implementing-robust-access-code-management-for-guests.md @@ -46,7 +46,7 @@ Seam's backup access code pool, we automatically make sure all backup access cod are healthy, ready for immediate usage, replaced after every use, and automatically removed when a reservation ends. -Seam's official backup access code pool can be enabled by adding `use_backup_access_code_pool: true` to any [`/access_codes/create` API request](https://docs.seam.co/latest/api/access_codes/create). You can then retrieve access codes using [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). +Seam's official backup access code pool can be enabled by adding `use_backup_access_code_pool: true` to any [`/access_codes/create` API request](https://docs.seam.co/latest/api/access_codes/create.md). You can then retrieve access codes using [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code.md). {% tabs %} diff --git a/docs/products/smart-locks/access-codes/backup-access-codes.md b/docs/products/smart-locks/access-codes/backup-access-codes.md index 730105bcc..2ea7d0878 100644 --- a/docs/products/smart-locks/access-codes/backup-access-codes.md +++ b/docs/products/smart-locks/access-codes/backup-access-codes.md @@ -516,7 +516,7 @@ You can retrieve a backup access code to use instead. ### 3. Confirm the availability of a backup access code -To confirm that a backup access code is available for retrieval, check the `is_backup_access_code_available` property on the access code by inspecting the response from [Get Access Code](../../../api/access_codes/get/) or [List Access Codes](../../../api/access_codes/list.md). If the backup code pool has been exhausted, this property returns `false`. +To confirm that a backup access code is available for retrieval, check the `is_backup_access_code_available` property on the access code by inspecting the response from [Get Access Code](../../../api/access_codes/get.md) or [List Access Codes](../../../api/access_codes/list.md). If the backup code pool has been exhausted, this property returns `false`. {% hint style="info" %} Note that we only support pulling backup codes for `time_bound` codes at this time. diff --git a/docs/products/smart-locks/access-codes/modifying-access-codes.md b/docs/products/smart-locks/access-codes/modifying-access-codes.md index 80d0a629b..d104540dc 100644 --- a/docs/products/smart-locks/access-codes/modifying-access-codes.md +++ b/docs/products/smart-locks/access-codes/modifying-access-codes.md @@ -200,7 +200,7 @@ There are two methods to verify that a permanent access code has been set on the **Polling Method** -Utilize the `access_code_id` returned in the response from the create endpoint to invoke the [Get Access Code](../../../api/access_codes/get/) endpoint. A basic implementation would involve polling this endpoint until the `status` of the access code updates to `set`. +Utilize the `access_code_id` returned in the response from the create endpoint to invoke the [Get Access Code](../../../api/access_codes/get.md) endpoint. A basic implementation would involve polling this endpoint until the `status` of the access code updates to `set`. If the `status` remains `setting` for a very long time, or if the `access_code` object contains any `warnings` or `errors` properties, consult [our guide on "Troubleshooting Access Code Issues"](troubleshooting-access-code-issues.md) for further guidance. @@ -216,7 +216,7 @@ There are two methods to verify that a time-bound access code has been set on th **Polling Method** -Use the `access_code_id` provided in the response from the create endpoint to call the [Get Access Code](../../../api/access_codes/get/) endpoint. In a basic implementation, you would poll this endpoint at the `starts_at` time to check if the access code's status is updated to `set`. +Use the `access_code_id` provided in the response from the create endpoint to call the [Get Access Code](../../../api/access_codes/get.md) endpoint. In a basic implementation, you would poll this endpoint at the `starts_at` time to check if the access code's status is updated to `set`. If the `status` remains `setting`, or if the `access_code` object displays any warnings or errors, refer to [our "Troubleshooting Access Code Issues" guide](troubleshooting-access-code-issues.md) for assistance. diff --git a/docs/products/smart-locks/access-codes/retrieving-access-codes.md b/docs/products/smart-locks/access-codes/retrieving-access-codes.md index 21826ba50..5e0a613a7 100644 --- a/docs/products/smart-locks/access-codes/retrieving-access-codes.md +++ b/docs/products/smart-locks/access-codes/retrieving-access-codes.md @@ -709,7 +709,7 @@ System.out.println(accessCodes); ## Retrieving Individual Access Codes -To retrieve a specific access code, include the desired `access_code_id` in the [Get Access Code](../../../api/access_codes/get/) request. +To retrieve a specific access code, include the desired `access_code_id` in the [Get Access Code](../../../api/access_codes/get.md) request. {% tabs %} {% tab title="Python" %} diff --git a/docs/products/smart-locks/access-codes/troubleshooting-access-code-issues.md b/docs/products/smart-locks/access-codes/troubleshooting-access-code-issues.md index 6c9ffb742..0424a9757 100644 --- a/docs/products/smart-locks/access-codes/troubleshooting-access-code-issues.md +++ b/docs/products/smart-locks/access-codes/troubleshooting-access-code-issues.md @@ -29,7 +29,7 @@ If the device or connected account associated with an access code has an error, ## Determining the Issue -The first step in troubleshooting an access code issue is to figure out what the issue is from Seam's point of view. Make a [Get Access Code](../../../api/access_codes/get/) or [List Access Codes](../../../api/access_codes/list.md) request and look at the `errors` and `warnings` payloads on the access code object. Look at the error and warning codes. Then, see the matching remedy in [Suggested Access Code Remedies](troubleshooting-access-code-issues.md#suggested-access-code-remedies) for next steps. +The first step in troubleshooting an access code issue is to figure out what the issue is from Seam's point of view. Make a [Get Access Code](../../../api/access_codes/get.md) or [List Access Codes](../../../api/access_codes/list.md) request and look at the `errors` and `warnings` payloads on the access code object. Look at the error and warning codes. Then, see the matching remedy in [Suggested Access Code Remedies](troubleshooting-access-code-issues.md#suggested-access-code-remedies) for next steps. {% tabs %} {% tab title="Python" %}