RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

BinTipBarcodeScannerResultController

Controller Class for Bin Tip Barcode Scanner Results

Constructor

new BinTipBarcodeScannerResultController()

Source

Methods

static

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

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

Parameters

  • siteId number

    The Site ID

  • createData BinTipBarcodeScannerResultController.CreateData

    The Bin Tip Barcode Scanner Result Create Data

Returns

  • Promise.<BinTipBarcodeScannerResultModel>

Source

static

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

List all Bin Tip Barcode Scanner Results [GET /packhouse/sites/{siteId}/bin-tip-barcode-scanner-results]

Parameters

  • siteId number

    The Site ID

  • queryParameters BinTipBarcodeScannerResultController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<BinTipBarcodeScannerResultModel>>

Source

static

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

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

Parameters

  • siteId number

    The Site ID

  • id string

    The Bin Tip Barcode Scanner Result ID

Returns

  • Promise.<BinTipBarcodeScannerResultModel>

Source

static

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

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

Parameters

  • siteId number

    The Site ID

  • id string

    The Bin Tip Barcode Scanner Result ID

  • updateData BinTipBarcodeScannerResultController.UpdateData

    The Bin Tip Barcode Scanner Result Update Data

Returns

  • Promise.<BinTipBarcodeScannerResultModel>

Source

Type Definitions

CreateData

The Create Data for a Bin Tip Barcode Scanner Result

Type

  • Object

Properties

  • barcodeScannerId string

    The Bin Tip Barcode Scanner ID associated with this Result

  • binNumber string <optional>

    A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)

  • createdTimestamp Date <optional>

    When this Barcode Scanner Result was Created

  • scanMode string

    The Mode of the Barcode Scanner when creating this Barcode Scanner Result

  • packrunId string <optional>
    <nullable>

    The Packrun ID associated with this Barcode Scanner Result

  • result boolean

    Whether the Bin Number was Valid and could be matched with a Current or Scheduled Packrun

  • resultMessage string <nullable>

    An Optional Message to accompany the Result. Typically only present when the Result is false

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • barcodeScannerId string <optional>

    The Bin Tip Barcode Scanner ID associated with this Result

  • binNumber string <optional>

    A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)

  • scanMode string <optional>

    The Mode of the Barcode Scanner when creating this Barcode Scanner Result

  • packrunId string <optional>
    <nullable>

    The Packrun ID associated with this Barcode Scanner Result

  • createdTimestampBegin Date <optional>

    Filter by the Timestamp when this Barcode Scanner Result was Created. Results Greater than or Equal to Timestamp

  • createdTimestampEnd Date <optional>

    Filter by the Timestamp when this Barcode Scanner Result was Created. Results Less than or Equal to Timestamp

Source

UpdateData

The Update Data for a Bin Tip Barcode Scanner Result

Type

  • Object

Properties

  • barcodeScannerId string <optional>

    The Bin Tip Barcode Scanner ID associated with this Result

  • createdTimestamp Date <optional>

    When this Barcode Scanner Result was Created

  • scanMode string <optional>

    The Mode of the Barcode Scanner when creating this Barcode Scanner Result

  • packrunId string <optional>
    <nullable>

    The Packrun ID associated with this Barcode Scanner Result

  • result boolean <optional>

    Whether the Bin Number was Valid and could be matched with a Current or Scheduled Packrun

  • resultMessage string <optional>
    <nullable>

    An Optional Message to accompany the Result. Typically only present when the Result is false

Source