RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

BinTipBarcodeScannerController

Controller Class for Bin Tip Barcode Scanners

Constructor

new BinTipBarcodeScannerController()

Source

Methods

static

create(siteId, createData) → {Promise.<BinTipBarcodeScannerModel>}

Create a Bin Tip Barcode Scanner [POST /packhouse/sites/{siteId}/bin-tip-barcode-scanners]

Parameters

  • siteId number

    The Site ID

  • createData BinTipBarcodeScannerController.CreateData

    The Bin Tip Barcode Scanner Create Data

Returns

  • Promise.<BinTipBarcodeScannerModel>

Source

static

getAll(siteId, queryParametersopt) → {Promise.<Array.<BinTipBarcodeScannerModel>>}

List all Bin Tip Barcode Scanners [GET /packhouse/sites/{siteId}/bin-tip-barcode-scanners]

Parameters

  • siteId number

    The Site ID

  • queryParameters BinTipBarcodeScannerController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<BinTipBarcodeScannerModel>>

Source

static

getOne(siteId, id) → {Promise.<BinTipBarcodeScannerModel>}

Retrieve a Bin Tip Barcode Scanner [GET /packhouse/sites/{siteId}/bin-tip-barcode-scanners/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Bin Tip Barcode Scanner ID

Returns

  • Promise.<BinTipBarcodeScannerModel>

Source

static

update(siteId, id, updateData) → {Promise.<BinTipBarcodeScannerModel>}

Update a Bin Tip Barcode Scanner [PATCH /packhouse/sites/{siteId}/bin-tip-barcode-scanners/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Bin Tip Barcode Scanner ID

  • updateData BinTipBarcodeScannerController.UpdateData

    The Bin Tip Barcode Scanner Update Data

Returns

  • Promise.<BinTipBarcodeScannerModel>

Source

Type Definitions

CreateData

The Create Data for a Bin Tip Barcode Scanner

Type

  • Object

Properties

  • rtuId number <optional>
    <nullable>

    The RTU this Bin Tip Barcode Scanner Belt belongs to

  • name string

    The Name of this Bin Tip Barcode Scanner

  • binTipId string

    The Bin Tip that owns this Barcode Scanner

  • points Object

    The Points used by this Bin Tip Barcode Scanner

  • mode string

    The Mode for this Bin Tip Barcode Scanner

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • rtuId number <optional>
    <nullable>

    The RTU this Bin Tip Barcode Scanner Belt belongs to

  • name string <optional>

    The Name of this Bin Tip Barcode Scanner

  • binTipId string <optional>

    The Bin Tip that owns this Barcode Scanner

Source

UpdateData

The Update Data for a Bin Tip Barcode Scanner

Type

  • Object

Properties

  • name string <optional>

    The Name of this Bin Tip Barcode Scanner

  • binTipId string <optional>

    The Bin Tip that owns this Barcode Scanner

  • points Object <optional>

    The Points used by this Bin Tip Barcode Scanner

  • mode string <optional>

    The Mode for this Bin Tip Barcode Scanner

Source