Skip to main content

Create a ScannerType

POST 
/scanner

Creates a new ScannerType and attaches it to the requested Company.

Request​

Body

Input data

    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.

    products uuid[]

    The guids of the Product Types that needs to be attached to the ScannerType. This only accept guids of Product Types of the requested Company, except for Admins.

Responses​

ScannerType created.

Schema

    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...