@seamapi/http - v2.1.0
    Preparing search index...

    Type Alias AcsEncoder

    Represents a hardware device that encodes credential data onto physical cards within an access control system.

    Some access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:

    1. Credential creation Configure the access parameters for the credential.
    2. Card encoding Write the credential data onto the card using a compatible card encoder.

    Separately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.

    See Working with Card Encoders and Scanners.

    To verify if your access control system requires a card encoder, see the corresponding system integration guide.

    type AcsEncoder = {
        acs_encoder_id: string;
        acs_system_id: string;
        connected_account_id: string;
        created_at: string;
        display_name: string;
        errors: {
            created_at: string;
            error_code: "acs_encoder_removed";
            message: string;
        }[];
        workspace_id: string;
    }
    Index
    acs_encoder_id acs_system_id connected_account_id created_at display_name errors workspace_id
    acs_encoder_id: string

    ID of the encoder.

    acs_system_id: string

    ID of the access control system that contains the encoder.

    connected_account_id: string

    ID of the connected account that contains the encoder.

    created_at: string

    Date and time at which the encoder was created.

    display_name: string

    Display name for the encoder.

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

    Errors associated with the encoder.

    Type Declaration

    • created_at: string

      Date and time at which Seam created the error.

    • error_code: "acs_encoder_removed"

      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.

    workspace_id: string

    ID of the workspace that contains the encoder.

    Settings
    Member Visibility

    On This Page
    Properties