diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 398b959e3..729fd730e 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -17,36 +17,6 @@ Seam supports programming two types of access codes: [ongoing](https://docs.seam In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. -{% tabs %} -{% tab title="JSON" %} -```json -{ - access_code_id: [example value], - code: [example value], - common_code_key: [example value], - created_at: [example value], - device_id: [example value], - ends_at: [example value], - errors: [example value], - is_backup: [example value], - is_backup_access_code_available: [example value], - is_external_modification_allowed: [example value], - is_managed: [example value], - is_offline_access_code: [example value], - is_one_time_use: [example value], - is_scheduled_on_device: [example value], - is_waiting_for_code_assignment: [example value], - name: [example value], - pulled_backup_access_code_id: [example value], - starts_at: [example value], - status: [example value], - type: [example value], - warnings: [example value] -} -``` -{% endtab %} -{% endtabs %} - --- ## Properties diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index b9a38e2cd..0b7aaff05 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -21,27 +21,6 @@ Not all providers support unmanaged access codes. The following providers do not - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) -{% tabs %} -{% tab title="JSON" %} -```json -{ - access_code_id: [example value], - code: [example value], - created_at: [example value], - device_id: [example value], - ends_at: [example value], - errors: [example value], - is_managed: [example value], - name: [example value], - starts_at: [example value], - status: [example value], - type: [example value], - warnings: [example value] -} -``` -{% endtab %} -{% endtabs %} - --- ## Properties diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 16b639e54..0da3bf44f 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -15,27 +15,6 @@ Some access control systems use [access group](https://docs.seam.co/latest/capab To learn whether your access control system supports access groups, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems). -{% tabs %} -{% tab title="JSON" %} -```json -{ - access_group_type: [example value], - access_group_type_display_name: [example value], - acs_access_group_id: [example value], - acs_system_id: [example value], - created_at: [example value], - display_name: [example value], - external_type: [example value], - external_type_display_name: [example value], - is_managed: [example value], - name: [example value], - warnings: [example value], - workspace_id: [example value] -} -``` -{% endtab %} -{% endtabs %} - --- ## Properties diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index b78e82031..354b7d0e6 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -15,41 +15,6 @@ An access control system generally uses digital means of access to authorize a u For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. -{% tabs %} -{% tab title="JSON" %} -```json -{ - access_method: [example value], - acs_credential_id: [example value], - acs_credential_pool_id: [example value], - acs_system_id: [example value], - acs_user_id: [example value], - assa_abloy_vostio_metadata: [example value], - card_number: [example value], - code: [example value], - created_at: [example value], - display_name: [example value], - ends_at: [example value], - errors: [example value], - external_type: [example value], - external_type_display_name: [example value], - is_issued: [example value], - is_latest_desired_state_synced_with_provider: [example value], - is_managed: [example value], - is_multi_phone_sync_credential: [example value], - is_one_time_use: [example value], - issued_at: [example value], - latest_desired_state_synced_with_provider_at: [example value], - parent_acs_credential_id: [example value], - starts_at: [example value], - visionline_metadata: [example value], - warnings: [example value], - workspace_id: [example value] -} -``` -{% endtab %} -{% endtabs %} - --- ## Properties diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 1679cb871..3e34d445c 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -24,21 +24,6 @@ Separately, the Seam API also supports card scanning, which enables you to scan To verify if your access control system requires a card encoder, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems). -{% tabs %} -{% tab title="JSON" %} -```json -{ - acs_encoder_id: [example value], - acs_system_id: [example value], - created_at: [example value], - display_name: [example value], - errors: [example value], - workspace_id: [example value] -} -``` -{% endtab %} -{% endtabs %} - --- ## Properties diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index cac0d3cc5..92250226c 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -13,26 +13,6 @@ Represents an [entrance](../../../capability-guides/access-systems/retrieving-en In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance. -{% tabs %} -{% tab title="JSON" %} -```json -{ - acs_entrance_id: [example value], - acs_system_id: [example value], - assa_abloy_vostio_metadata: [example value], - created_at: [example value], - display_name: [example value], - dormakaba_community_metadata: [example value], - errors: [example value], - latch_metadata: [example value], - salto_ks_metadata: [example value], - salto_space_metadata: [example value], - visionline_metadata: [example value] -} -``` -{% endtab %} -{% endtabs %} - --- ## Properties diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 61100bdf8..1d33ff026 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -36,35 +36,6 @@ For details about the resources associated with an access control system, see th {% endtab %} {% endtabs %} -{% tabs %} -{% tab title="JSON" %} -```json -{ - acs_access_group_count: [example value], - acs_system_id: [example value], - acs_user_count: [example value], - connected_account_id: [example value], - connected_account_ids: [example value], - created_at: [example value], - default_credential_manager_acs_system_id: [example value], - errors: [example value], - external_type: [example value], - external_type_display_name: [example value], - image_alt_text: [example value], - image_url: [example value], - is_credential_manager: [example value], - location: [example value], - name: [example value], - system_type: [example value], - system_type_display_name: [example value], - visionline_metadata: [example value], - warnings: [example value], - workspace_id: [example value] -} -``` -{% endtab %} -{% endtabs %} - --- ## Properties diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 3a8838857..41367f2a1 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -15,38 +15,6 @@ An `acs_user` typically refers to an individual who requires access, like an emp For details about how to configure `acs_user`s in your access control system, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems). -{% tabs %} -{% tab title="JSON" %} -```json -{ - access_schedule: [example value], - acs_system_id: [example value], - acs_user_id: [example value], - connected_account_id: [example value], - created_at: [example value], - display_name: [example value], - email: [example value], - email_address: [example value], - errors: [example value], - external_type: [example value], - external_type_display_name: [example value], - full_name: [example value], - hid_acs_system_id: [example value], - is_managed: [example value], - is_suspended: [example value], - pending_mutations: [example value], - phone_number: [example value], - user_identity_email_address: [example value], - user_identity_full_name: [example value], - user_identity_id: [example value], - user_identity_phone_number: [example value], - warnings: [example value], - workspace_id: [example value] -} -``` -{% endtab %} -{% endtabs %} - --- ## Properties diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 09e938791..83d68963b 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -11,24 +11,6 @@ Represents an app user's mobile phone. -{% tabs %} -{% tab title="JSON" %} -```json -{ - created_at: [example value], - custom_metadata: [example value], - device_id: [example value], - device_type: [example value], - display_name: [example value], - errors: [example value], - nickname: [example value], - warnings: [example value], - workspace_id: [example value] -} -``` -{% endtab %} -{% endtabs %} - --- ## Properties diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index cb119d376..55d580462 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -11,26 +11,6 @@ Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. -{% tabs %} -{% tab title="JSON" %} -```json -{ - climate_preset_key: [example value], - created_at: [example value], - device_id: [example value], - ends_at: [example value], - errors: [example value], - is_override_allowed: [example value], - max_override_period_minutes: [example value], - name: [example value], - starts_at: [example value], - thermostat_schedule_id: [example value], - workspace_id: [example value] -} -``` -{% endtab %} -{% endtabs %} - --- ## Properties diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 35af09e84..24b48062a 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -11,23 +11,6 @@ Represents a [user identity](../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) associated with an application user account. -{% tabs %} -{% tab title="JSON" %} -```json -{ - created_at: [example value], - display_name: [example value], - email_address: [example value], - full_name: [example value], - phone_number: [example value], - user_identity_id: [example value], - user_identity_key: [example value], - workspace_id: [example value] -} -``` -{% endtab %} -{% endtabs %} - --- ## Properties diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index c199a05d2..d8a942ec4 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -11,20 +11,6 @@ Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). -{% tabs %} -{% tab title="JSON" %} -```json -{ - created_at: [example value], - credential_manager_acs_system_id: [example value], - enrollment_automation_id: [example value], - user_identity_id: [example value], - workspace_id: [example value] -} -``` -{% endtab %} -{% endtabs %} - --- ## Properties diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index cfe76b350..461c4576a 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -27,22 +27,6 @@ {% endtabs %} {{/if}} -{% tabs %} -{% tab title="JSON" %} -```json -{ -{{#each properties}} -{{#if @last}} - {{name}}: [example value] -{{else}} - {{name}}: [example value], -{{/if}} -{{/each}} -} -``` -{% endtab %} -{% endtabs %} - --- {{#if headingOffset}} ### Properties