Skip to content

encode_credential.md

Latest commit

 

History

History
351 lines (230 loc) · 10.6 KB

encode_credential.md

File metadata and controls

351 lines (230 loc) · 10.6 KB

Encode a Credential

POST /acs/encoders/encode_credential ⇒ { action_attempt }

Encodes an existing credential onto a plastic card placed on the specified encoder.

Authentication Methods

  • API key
  • Personal access token
    Must also include the seam-workspace header in the request.

Request Parameters

acs_credential_id

Format: UUID Required: Yes

ID of the acs_credential to encode onto a card.

acs_encoder_id

Format: UUID Required: Yes

ID of the acs_encoder to use to encode the acs_credential.

Return Type

action_attempt

ENCODE_CREDENTIAL

Action attempt to track encoding credential data from the physical encoder onto a card.

action_attempt_id

Format: UUID

ID of the action attempt.

action_type

Format: Enum

Type of action that the action attempt tracks.

Value: ENCODE_CREDENTIAL

error

Format: Object

message Format: String
type Format: Enum

Possible enum values:

  • uncategorized_error
  • action_attempt_expired
  • no_credential_on_encoder
  • incompatible_card_format
  • credential_cannot_be_reissued
---

result

Format: Object

If an encoding attempt was successful, includes the acs_credential data that was encoded onto the card.

access_method Format: Enum

Access method for the credential. Supported values: code, card, mobile_key.

Possible enum values:

  • code
  • card
  • mobile_key
acs_credential_id Format: UUID

ID of the credential.

acs_credential_pool_id Format: UUID
acs_system_id Format: UUID

ID of the access control system that contains the credential.

acs_user_id Format: UUID

ID of the ACS user to whom the credential belongs.

assa_abloy_vostio_metadata Format: Object

Vostio-specific metadata for the credential.

assa_abloy_vostio_metadata.door_names Format: List Item format: String
assa_abloy_vostio_metadata.endpoint_id Format: String
assa_abloy_vostio_metadata.key_id Format: String
assa_abloy_vostio_metadata.key_issuing_request_id Format: String
assa_abloy_vostio_metadata.override_guest_acs_entrance_ids Format: List Item format: String
card_number Format: String

Number of the card associated with the credential.

code Format: String

Access (PIN) code for the credential.

created_at Format: Datetime

Date and time at which the credential was created.

display_name Format: String

Display name that corresponds to the credential type.

ends_at Format: String

Date and time at which the credential validity ends, in ISO 8601 format. Must be a time in the future and after starts_at.

errors Format: List Item format: Object

Errors associated with the credential.

  • error_code Format: String

  • message Format: String

external_type Format: Enum

Brand-specific terminology for the credential type. Supported values: pti_card, brivo_credential, hid_credential, visionline_card.

Possible enum values:

  • pti_card
  • brivo_credential
  • hid_credential
  • visionline_card
  • salto_ks_credential
  • assa_abloy_vostio_key
  • salto_space_key
external_type_display_name Format: String

Display name that corresponds to the brand-specific terminology for the credential type.

is_issued Format: Boolean

Indicates whether the credential has been encoded onto a card.

is_latest_desired_state_synced_with_provider Format: Boolean

Indicates whether the latest state of the credential has been synced from Seam to the provider.

is_managed Format: Boolean
is_multi_phone_sync_credential Format: Boolean

Indicates whether the credential is a multi-phone sync credential.

is_one_time_use Format: Boolean

Indicates whether the credential can only be used once. If true, the code becomes invalid after the first use.

issued_at Format: Datetime

Date and time at which the credential was encoded onto a card.

latest_desired_state_synced_with_provider_at Format: Datetime

Date and time at which the state of the credential was most recently synced from Seam to the provider.

parent_acs_credential_id Format: UUID

ID of the parent credential.

starts_at Format: String

Date and time at which the credential validity starts, in ISO 8601 format.

visionline_metadata Format: Object

Visionline-specific metadata for the credential.

visionline_metadata.auto_join Format: Boolean
visionline_metadata.card_function_type Format: Enum

Possible enum values:

  • guest
  • staff
visionline_metadata.card_id Format: String
visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID
visionline_metadata.credential_id Format: String
visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID
visionline_metadata.is_valid Format: Boolean
visionline_metadata.joiner_acs_credential_ids Format: List Item format: UUID
warnings Format: List Item format: Object

Warnings associated with the credential.

  • created_at Format: Datetime

    Date and time at which Seam created the warning.

  • message Format: String

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

  • warning_code Format: Enum

    Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

    Possible enum values:

    • waiting_to_be_issued
    • schedule_externally_modified
    • schedule_modified
    • being_deleted
    • unknown_issue_with_acs_credential
    • needs_to_be_reissued
workspace_id Format: UUID

ID of the workspace that contains the credential.

---

status

Format: Enum

Possible enum values:

  • success
  • pending
  • error