diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 770495f8..09f904af 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -212,30 +212,62 @@ Format: `Object` Visionline-specific metadata for the credential.
-auto_join boolean + +auto_join Format: boolean + +
+
-card_function_type enum + +card_function_type Format: enum + +
+
-card_id string + +card_id Format: string + +
+
-common_acs_entrance_ids list + +common_acs_entrance_ids Format: list + +
+
-credential_id string + +credential_id Format: string + +
+
-guest_acs_entrance_ids list + +guest_acs_entrance_ids Format: list + +
+
-is_valid boolean + +is_valid Format: boolean + +
+
-joiner_acs_credential_ids list + +joiner_acs_credential_ids Format: list + +
+ --- ### `warnings` diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 3f725f6e..cda2c24a 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -27,21 +27,41 @@ ID of the access control system that contains the entrance. Format: `Object`
-door_name string + +door_name Format: string + +
+
-door_number number + +door_number Format: number + +
+
-door_type enum + +door_type Format: enum + +
+
-pms_id string + +pms_id Format: string + +
+
-stand_open boolean + +stand_open Format: boolean + +
+ --- ### `created_at` @@ -67,15 +87,27 @@ Display name for the entrance. Format: `Object`
-access_point_name string + +access_point_name Format: string + +
+
-common_area_number number + +common_area_number Format: number + +
+
-inner_access_points_names list + +inner_access_points_names Format: list + +
+ --- ### `errors` @@ -90,18 +122,34 @@ Format: `List` Format: `Object`
-accessibility_type string + +accessibility_type Format: string + +
+
-door_name string + +door_name Format: string + +
+
-door_type string + +door_type Format: string + +
+
-is_connected boolean + +is_connected Format: boolean + +
+ --- ### `salto_ks_metadata` @@ -109,30 +157,62 @@ Format: `Object` Format: `Object`
-battery_level string + +battery_level Format: string + +
+
-door_name string + +door_name Format: string + +
+
-intrusion_alarm boolean + +intrusion_alarm Format: boolean + +
+
-left_open_alarm boolean + +left_open_alarm Format: boolean + +
+
-lock_type string + +lock_type Format: string + +
+
-locked_state string + +locked_state Format: string + +
+
-online boolean + +online Format: boolean + +
+
-privacy_mode boolean + +privacy_mode Format: boolean + +
+ --- ### `salto_space_metadata` @@ -140,15 +220,27 @@ Format: `Object` Format: `Object`
-door_description string + +door_description Format: string + +
+
-door_name string + +door_name Format: string + +
+
-ext_door_id string + +ext_door_id Format: string + +
+ --- ### `visionline_metadata` @@ -156,15 +248,27 @@ Format: `Object` Format: `Object`
-door_category enum + +door_category Format: enum + +
+
-door_name string + +door_name Format: string + +
+
-profiles list + +profiles Format: list + +
+ --- ## Endpoints diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 6236e416..07fd2444 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -162,10 +162,14 @@ Indicates if the `acs_system` is a credential manager. Format: `Object`
-time_zone string + +time_zone Format: string + Time zone in which the `acs_system` is located. +
+ --- ### `name` @@ -219,18 +223,30 @@ Format: `String` Format: `Object`
-lan_address string + +lan_address Format: string + IP address or hostname of the main Visionline server relative to the Seam Bridge on the local network. +
+
-mobile_access_uuid string + +mobile_access_uuid Format: string + Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. +
+
-system_id string + +system_id Format: string + Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. +
+ --- ### `warnings` diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 6812cf6c..390a84da 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -11,14 +11,22 @@ Format: `Object` `starts_at` and `ends_at` timestamps for the `acs_user`'s access.
-ends_at datetime + +ends_at Format: datetime + Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. +
+
-starts_at datetime + +starts_at Format: datetime + Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. +
+ --- ### `acs_system_id` diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs index 7805e3a9..43342f3a 100644 --- a/src/layouts/api-route.hbs +++ b/src/layouts/api-route.hbs @@ -32,11 +32,15 @@ Possible enum values: {{#if objectProperties}} {{#each objectProperties}}
-{{this.name}} {{this.format}} + +{{this.name}} Format: {{this.format}} + {{#if this.description}} {{this.description}} {{/if}} +
+ {{/each}} {{/if}}