Skip to main content

Get ScannerTypes

GET 
/scanner/{type?}

Returns ScannerTypes of the requested Company. When there are no ScannerTypes an empty array will be returned.

Request​

Path Parameters

    type string

    Possible values: [normal, trashed, justtrashed]

    Default value: normal

    How to handle soft deleted ("archived") ScannerTypes.

    "normal"
    Returns all the ScannerTypes, except those which are soft deleted.
    "trashed"
    Returns all the ScannerTypes, including those which are soft deleted.
    "justtrashed"
    Returns only the ScannerTypes which are soft deleted.

Responses​

ScannerTypes found.

Schema

  • Array [

    • guid uuidrequired

    The guid of the ScannerType.

    company_id uuid

    The guid of the Company this ScannerType is associated with.

    event_id uuid

    The guid of the Event this ScannerType is associated with.

    name stringrequired

    Possible values: <= 255 characters

    The name of the ScannerType.

    description string

    Possible values: <= 65535 characters

    The human readable description of the ScannerType.

    username stringrequired

    Possible values: >= 6 characters and <= 255 characters

    The username to login into the Scanners.

    password stringrequired

    Possible values: >= 4 characters and <= 255 characters

    The password to login into the Scanners.

    visibility integer

    Possible values: <= 255

    Default value: 115

    The bitmap for visibility options in the Scanners of the ScannerType, e.g. hiding counters.

    scan_types integerrequired

    Default value: 68719476735

    The bitmap for which barcode types are scannable.

    expires_at ISO 8601required

    The expire date of the ScannerType, i.e. when all the Scanners of the ScannerType should expire.

    QR string

    The QR code contents for quick login.

    created_at ISO 8601

    The time it was created.

    updated_at ISO 8601

    The time it was last updated.

    deleted_at ISO 8601

    The time it was deleted.

  • ]

Loading...