Type Alias AcsEntrance

Represents an entrance within an access control system.

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.

type AcsEntrance = {
    acs_entrance_id: string;
    acs_system_id: string;
    akiles_metadata?: {
        actions?: { id?: string; name?: string }[];
        gadget_id?: string;
        site_id?: string;
        site_name?: string;
    };
    assa_abloy_vostio_metadata?: {
        door_name?: string;
        door_number?: number;
        door_type?: "CommonDoor"
        | "EntranceDoor"
        | "GuestDoor"
        | "Elevator";
        pms_id?: string;
        stand_open?: boolean;
    };
    avigilon_alta_metadata?: {
        entry_name?: string;
        entry_relays_total_count?: number;
        org_name?: string;
        site_id?: number;
        site_name?: string;
        zone_id?: number;
        zone_name?: string;
    };
    brivo_metadata?: {
        access_point_id?: string;
        site_id?: number;
        site_name?: string;
    };
    can_belong_to_reservation?: boolean;
    can_unlock_with_card?: boolean;
    can_unlock_with_cloud_key?: boolean;
    can_unlock_with_code?: boolean;
    can_unlock_with_mobile_key?: boolean;
    connected_account_id: string;
    created_at: string;
    display_name: string;
    dormakaba_ambiance_metadata?: { access_point_name?: string };
    dormakaba_community_metadata?: { access_point_profile?: string };
    errors: { created_at: string; error_code: string; message: string }[];
    hotek_metadata?: {
        common_area_name?: string;
        common_area_number?: string;
        room_number?: string;
    };
    is_locked?: boolean;
    latch_metadata?: {
        accessibility_type?: string;
        door_name?: string;
        door_type?: string;
        is_connected?: boolean;
    };
    salto_ks_metadata?: {
        battery_level?: string;
        door_name?: string;
        intrusion_alarm?: boolean;
        left_open_alarm?: boolean;
        lock_type?: string;
        locked_state?: string;
        online?: boolean;
        privacy_mode?: boolean;
    };
    salto_space_metadata?: {
        audit_on_keys?: boolean;
        door_description?: string;
        door_id?: string;
        door_name?: string;
        room_description?: string;
        room_name?: string;
    };
    space_ids: string[];
    visionline_metadata?: {
        door_category?: | "entrance"
        | "guest"
        | "elevator reader"
        | "common"
        | "common (PMS)";
        door_name?: string;
        profiles?: {
            visionline_door_profile_id?: string;
            visionline_door_profile_type?: "BLE"
            | "commonDoor"
            | "touch";
        }[];
    };
    warnings: (
        | {
            created_at: string;
            message: string;
            warning_code: "salto_ks_entrance_access_code_support_removed";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "entrance_shares_zone";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "entrance_setup_required";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "salto_ks_privacy_mode";
        }
        | { created_at: string; message: string; warning_code: "privacy_mode" }
    )[];
}

Properties

acs_entrance_id

acs_entrance_id: string

ID of the entrance.

acs_system_id

acs_system_id: string

ID of the access control system that contains the entrance.

`Optional`akiles_metadata

akiles_metadata?: {
    actions?: { id?: string; name?: string }[];
    gadget_id?: string;
    site_id?: string;
    site_name?: string;
}

Akiles-specific metadata associated with the entrance.

Type Declaration

Optionalactions?: { id?: string; name?: string }[]

Actions the gadget exposes (for example, open).
Optionalgadget_id?: string

ID of the Akiles gadget.
Optionalsite_id?: string

ID of the Akiles site the gadget belongs to.
Optionalsite_name?: string

Name of the Akiles site the gadget belongs to.

`Optional`assa_abloy_vostio_metadata

assa_abloy_vostio_metadata?: {
    door_name?: string;
    door_number?: number;
    door_type?: "CommonDoor" | "EntranceDoor" | "GuestDoor" | "Elevator";
    pms_id?: string;
    stand_open?: boolean;
}

ASSA ABLOY Vostio-specific metadata associated with the entrance.

Type Declaration

Optionaldoor_name?: string

Name of the door in the Vostio access system.
Optionaldoor_number?: number

Number of the door in the Vostio access system.
Optionaldoor_type?: "CommonDoor" | "EntranceDoor" | "GuestDoor" | "Elevator"

Type of the door in the Vostio access system.
Optionalpms_id?: string

PMS ID of the door in the Vostio access system.
Optionalstand_open?: boolean

Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system.

`Optional`avigilon_alta_metadata

avigilon_alta_metadata?: {
    entry_name?: string;
    entry_relays_total_count?: number;
    org_name?: string;
    site_id?: number;
    site_name?: string;
    zone_id?: number;
    zone_name?: string;
}

Avigilon Alta-specific metadata associated with the entrance.

Type Declaration

Optionalentry_name?: string

Entry name for an Avigilon Alta system.
Optionalentry_relays_total_count?: number

Total count of entry relays for an Avigilon Alta system.
Optionalorg_name?: string

Organization name for an Avigilon Alta system.
Optionalsite_id?: number

Site ID for an Avigilon Alta system.
Optionalsite_name?: string

Site name for an Avigilon Alta system.
Optionalzone_id?: number

Zone ID for an Avigilon Alta system.
Optionalzone_name?: string

Zone name for an Avigilon Alta system.

`Optional`brivo_metadata

brivo_metadata?: {
    access_point_id?: string;
    site_id?: number;
    site_name?: string;
}

Brivo-specific metadata associated with the entrance.

Type Declaration

Optionalaccess_point_id?: string

ID of the access point in the Brivo access system.
Optionalsite_id?: number

ID of the site that the access point belongs to.
Optionalsite_name?: string

Name of the site that the access point belongs to.

`Optional`can_belong_to_reservation

can_belong_to_reservation?: boolean

Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.

`Optional`can_unlock_with_card

can_unlock_with_card?: boolean

Indicates whether the ACS entrance can be unlocked with card credentials.

`Optional`can_unlock_with_cloud_key

can_unlock_with_cloud_key?: boolean

Indicates whether the ACS entrance can be unlocked with cloud key credentials.

`Optional`can_unlock_with_code

can_unlock_with_code?: boolean

Indicates whether the ACS entrance can be unlocked with pin codes.

`Optional`can_unlock_with_mobile_key

can_unlock_with_mobile_key?: boolean

Indicates whether the ACS entrance can be unlocked with mobile key credentials.

connected_account_id

connected_account_id: string

ID of the connected account associated with the entrance.

created_at

created_at: string

Date and time at which the entrance was created.

display_name

display_name: string

Display name for the entrance.

`Optional`dormakaba_ambiance_metadata

dormakaba_ambiance_metadata?: { access_point_name?: string }

dormakaba Ambiance-specific metadata associated with the entrance.

Type Declaration

Optionalaccess_point_name?: string

Name of the access point in the dormakaba Ambiance access system.

`Optional`dormakaba_community_metadata

dormakaba_community_metadata?: { access_point_profile?: string }

dormakaba Community-specific metadata associated with the entrance.

Type Declaration

Optionalaccess_point_profile?: string

Type of access point profile in the dormakaba Community access system.

errors

errors: { created_at: string; error_code: string; message: string }[]

Errors associated with the entrance.

Type Declaration

created_at: string

Date and time at which Seam created the error.
error_code: string

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
message: string

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

`Optional`hotek_metadata

hotek_metadata?: {
    common_area_name?: string;
    common_area_number?: string;
    room_number?: string;
}

Hotek-specific metadata associated with the entrance.

Type Declaration

Optionalcommon_area_name?: string

Display name of the entrance.
Optionalcommon_area_number?: string

Display name of the entrance.
Optionalroom_number?: string

Room number of the entrance.

`Optional`is_locked

is_locked?: boolean

Indicates whether the entrance is currently locked.

`Optional`latch_metadata

latch_metadata?: {
    accessibility_type?: string;
    door_name?: string;
    door_type?: string;
    is_connected?: boolean;
}

Latch-specific metadata associated with the entrance.

Type Declaration

Optionalaccessibility_type?: string

Accessibility type in the Latch access system.
Optionaldoor_name?: string

Name of the door in the Latch access system.
Optionaldoor_type?: string

Type of the door in the Latch access system.
Optionalis_connected?: boolean

Indicates whether the entrance is connected.

`Optional`salto_ks_metadata

salto_ks_metadata?: {
    battery_level?: string;
    door_name?: string;
    intrusion_alarm?: boolean;
    left_open_alarm?: boolean;
    lock_type?: string;
    locked_state?: string;
    online?: boolean;
    privacy_mode?: boolean;
}

Salto KS-specific metadata associated with the entrance.

Type Declaration

Optionalbattery_level?: string

Battery level of the door access device.
Optionaldoor_name?: string

Name of the door in the Salto KS access system.
Optionalintrusion_alarm?: boolean

Indicates whether an intrusion alarm is active on the door.
Optionalleft_open_alarm?: boolean

Indicates whether the door is left open.
Optionallock_type?: string

Type of the lock in the Salto KS access system.
Optionallocked_state?: string

Locked state of the door in the Salto KS access system.
Optionalonline?: boolean

Indicates whether the door access device is online.
Optionalprivacy_mode?: boolean

Indicates whether privacy mode is enabled for the lock.

`Optional`salto_space_metadata

salto_space_metadata?: {
    audit_on_keys?: boolean;
    door_description?: string;
    door_id?: string;
    door_name?: string;
    room_description?: string;
    room_name?: string;
}

Salto Space-specific metadata associated with the entrance.

Type Declaration

Optionalaudit_on_keys?: boolean

Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system.
Optionaldoor_description?: string

Description of the door in the Salto Space access system.
Optionaldoor_id?: string

Door ID in the Salto Space access system.
Optionaldoor_name?: string

Name of the door in the Salto Space access system.
Optionalroom_description?: string

Description of the room in the Salto Space access system.
Optionalroom_name?: string

Name of the room in the Salto Space access system.

space_ids

space_ids: string[]

IDs of the spaces that the entrance is in.

`Optional`visionline_metadata

visionline_metadata?: {
    door_category?:
        | "entrance"
        | "guest"
        | "elevator reader"
        | "common"
        | "common (PMS)";
    door_name?: string;
    profiles?: {
        visionline_door_profile_id?: string;
        visionline_door_profile_type?: "BLE"
        | "commonDoor"
        | "touch";
    }[];
}

Visionline-specific metadata associated with the entrance.

Type Declaration

Optionaldoor_category?: "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)"

Category of the door in the Visionline access system.
Optionaldoor_name?: string

Name of the door in the Visionline access system.
Optionalprofiles?: {
visionline_door_profile_id?: string;
visionline_door_profile_type?: "BLE" | "commonDoor" | "touch";
}[]

Profile for the door in the Visionline access system.

warnings

warnings: (
    | {
        created_at: string;
        message: string;
        warning_code: "salto_ks_entrance_access_code_support_removed";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "entrance_shares_zone";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "entrance_setup_required";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "salto_ks_privacy_mode";
    }
    | { created_at: string; message: string; warning_code: "privacy_mode" }
)[]

Warnings associated with the entrance.

Type Declaration

{
    created_at: string;
    message: string;
    warning_code: "salto_ks_entrance_access_code_support_removed";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "salto_ks_entrance_access_code_support_removed"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{ created_at: string; message: string; warning_code: "entrance_shares_zone" }
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "entrance_shares_zone"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{ created_at: string; message: string; warning_code: "entrance_setup_required" }
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "entrance_setup_required"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{ created_at: string; message: string; warning_code: "salto_ks_privacy_mode" }
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "salto_ks_privacy_mode"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{ created_at: string; message: string; warning_code: "privacy_mode" }
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "privacy_mode"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Type Alias AcsEntrance

Index

Properties

Properties

acs_entrance_id

acs_system_id

Optionalakiles_metadata

Type Declaration

Optionalactions?: { id?: string; name?: string }[]

Optionalgadget_id?: string

Optionalsite_id?: string

Optionalsite_name?: string

Optionalassa_abloy_vostio_metadata

Type Declaration

Optionaldoor_name?: string

Optionaldoor_number?: number

Optionaldoor_type?: "CommonDoor" | "EntranceDoor" | "GuestDoor" | "Elevator"

Optionalpms_id?: string

Optionalstand_open?: boolean

Optionalavigilon_alta_metadata

Type Declaration

Optionalentry_name?: string

Optionalentry_relays_total_count?: number

Optionalorg_name?: string

Optionalsite_id?: number

Optionalsite_name?: string

Optionalzone_id?: number

Optionalzone_name?: string

Optionalbrivo_metadata

Type Declaration

Optionalaccess_point_id?: string

Optionalsite_id?: number

Optionalsite_name?: string

Optionalcan_belong_to_reservation

Optionalcan_unlock_with_card

Optionalcan_unlock_with_cloud_key

Optionalcan_unlock_with_code

Optionalcan_unlock_with_mobile_key

connected_account_id

created_at

display_name

Optionaldormakaba_ambiance_metadata

Type Declaration

Optionalaccess_point_name?: string

Optionaldormakaba_community_metadata

Type Declaration

Optionalaccess_point_profile?: string

errors

Type Declaration

created_at: string

error_code: string

message: string

Optionalhotek_metadata

Type Declaration

Optionalcommon_area_name?: string

Optionalcommon_area_number?: string

Optionalroom_number?: string

Optionalis_locked

Optionallatch_metadata

Type Declaration

Optionalaccessibility_type?: string

Optionaldoor_name?: string

Optionaldoor_type?: string

Optionalis_connected?: boolean

Optionalsalto_ks_metadata

Type Declaration

Optionalbattery_level?: string

Optionaldoor_name?: string

Optionalintrusion_alarm?: boolean

Optionalleft_open_alarm?: boolean

Optionallock_type?: string

Optionallocked_state?: string

Optionalonline?: boolean

Optionalprivacy_mode?: boolean

Optionalsalto_space_metadata

Type Declaration

Optionalaudit_on_keys?: boolean

Optionaldoor_description?: string

Optionaldoor_id?: string

Optionaldoor_name?: string

`Optional`akiles_metadata

`Optional`actions?: { id?: string; name?: string }[]

`Optional`gadget_id?: string

`Optional`site_id?: string

`Optional`site_name?: string

`Optional`assa_abloy_vostio_metadata

`Optional`door_name?: string

`Optional`door_number?: number

`Optional`door_type?: "CommonDoor" | "EntranceDoor" | "GuestDoor" | "Elevator"

`Optional`pms_id?: string

`Optional`stand_open?: boolean

`Optional`avigilon_alta_metadata

`Optional`entry_name?: string

`Optional`entry_relays_total_count?: number

`Optional`org_name?: string

`Optional`site_id?: number

`Optional`site_name?: string

`Optional`zone_id?: number

`Optional`zone_name?: string

`Optional`brivo_metadata

`Optional`access_point_id?: string

`Optional`site_id?: number

`Optional`site_name?: string

`Optional`can_belong_to_reservation

`Optional`can_unlock_with_card

`Optional`can_unlock_with_cloud_key

`Optional`can_unlock_with_code

`Optional`can_unlock_with_mobile_key

`Optional`dormakaba_ambiance_metadata

`Optional`access_point_name?: string

`Optional`dormakaba_community_metadata

`Optional`access_point_profile?: string

`Optional`hotek_metadata

`Optional`common_area_name?: string

`Optional`common_area_number?: string

`Optional`room_number?: string

`Optional`is_locked

`Optional`latch_metadata

`Optional`accessibility_type?: string

`Optional`door_name?: string

`Optional`door_type?: string

`Optional`is_connected?: boolean

`Optional`salto_ks_metadata

`Optional`battery_level?: string

`Optional`door_name?: string

`Optional`intrusion_alarm?: boolean

`Optional`left_open_alarm?: boolean

`Optional`lock_type?: string

`Optional`locked_state?: string

`Optional`online?: boolean

`Optional`privacy_mode?: boolean

`Optional`salto_space_metadata

`Optional`audit_on_keys?: boolean

`Optional`door_description?: string

`Optional`door_id?: string

`Optional`door_name?: string

`Optional`room_description?: string

`Optional`room_name?: string

`Optional`visionline_metadata

`Optional`door_category?: "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)"

`Optional`door_name?: string

`Optional`profiles?: {
visionline_door_profile_id?: string;
visionline_door_profile_type?: "BLE" | "commonDoor" | "touch";
}[]