RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

RejectBinScaleController

Controller Class for Reject Bin Scales

Constructor

new RejectBinScaleController()

Source

Methods

static

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

Create a Reject Bin Scale [POST /packhouse/sites/{siteId}/reject-bin-scales]

Parameters

  • siteId number

    The Site ID

  • createData RejectBinScaleController.CreateData

    The Reject Bin Scale Create Data

Returns

  • Promise.<RejectBinScaleModel>

Source

static

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

List all Reject Bin Scales [GET /packhouse/sites/{siteId}/reject-bin-scales]

Parameters

  • siteId number

    The Site ID

  • queryParameters RejectBinScaleController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<RejectBinScaleModel>>

Source

static

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

Retrieve a Reject Bin Scale [GET /packhouse/sites/{siteId}/reject-bin-scales/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Reject Bin Scale ID

Returns

  • Promise.<RejectBinScaleModel>

Source

static

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

Update a Reject Bin Scale [PATCH /packhouse/sites/{siteId}/reject-bin-scales/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Reject Bin Scale ID

  • updateData RejectBinScaleController.UpdateData

    The Reject Bin Scale Update Data

Returns

  • Promise.<RejectBinScaleModel>

Source

Type Definitions

BeltSource

A BeltSource Type

Type

  • Object

Properties

  • type string

    Type of this Reject Bin Scale Source

  • beltName string <nullable>

    Name of the Belt

  • classType string

    The Default Class Type of this Reject Bin Scale Source

  • varietyClassTypes Array.<{varietyId: string, classType: string}>

    An Array of Varieties and Class Types to override the Default Class Type

Source

CreateData

The Create Data for a Reject Bin Scale

Type

  • Object

Properties

  • rtuId number <optional>
    <nullable>

    The RTU this Reject Bin Scale belongs to

  • name string

    The Name of this Reject Bin Scale

  • points Object

    The Points used by this Reject Bin Scale

  • packingLineId string

    The Packing Line that owns this Reject Bin Scale

  • packrunSourceId string <optional>
    <nullable>

    The Permanent Object that provides the Next Packrun for this Reject Bin Scale

  • packrunGroup number <optional>
    <nullable>

    The Packrun Group this Reject Bin Scale is a part of

  • sources Array.<(RejectBinScaleController.SortingTableSource|RejectBinScaleController.BeltSource|RejectBinScaleController.SizerOutletSource)> <optional>

    An Array of Sources that deliver Fruit to this Reject Bin Scale

  • autoPackrunChange Object <optional>
    <nullable>

    The Auto Packrun Change Configuration for this Reject Bin Scale

  • supportsLiveWeighing boolean <optional>
    <nullable>

    Whether this Reject Bin Scale supports Live Weighing

  • autoWeighingStartThreshold number <optional>
    <nullable>

    The Minimum Weight Change Required to Automatically Start Live Weighing

  • autoWeighingStartDelay number <optional>
    <nullable>

    The Delay in Milliseconds before Auto Live Weighing would Start

  • autoWeighingFinishThreshold number <optional>
    <nullable>

    The Minimum Weight Change Required to Automatically Finish Live Weighing

  • autoWeighingFinishDelay number <optional>
    <nullable>

    The Delay in Milliseconds before Auto Live Weighing would Finish

  • autoWeighingFinishAtGrossTarget boolean <optional>
    <nullable>

    Whether Live Weighing should be Automatically Finished when the Target Gross Weight is Met

  • manualInterventionMaximumDuration number <optional>
    <nullable>

    The Maximum Duration in Milliseconds before a Manual Intervention would end

  • liveWeighingIncreaseTolerance number <optional>
    <nullable>

    The Maximum Weight Increase allowed within a single Live Weighing Update Interval

  • liveWeighingDecreaseTolerance number <optional>
    <nullable>

    The Maximum Weight Decrease allowed within a single Live Weighing Update Interval

  • liveWeighingUpdateInterval number <optional>
    <nullable>

    The Interval in Milliseconds between Live Weighing Updates

  • liveWeighingUsesStableStatus boolean <optional>
    <nullable>

    Whether the Loadcell Stable Status is used to ignore Changes during Live Weighing

  • incorrectOperationTolerance number <optional>
    <nullable>

    The Maximum Weight Change allowed while Live Weighing before an Incorrect Operation is Logged

  • freshPackIntegration RejectBinScaleController.FreshPackBinScaleIntegration <optional>
    <nullable>

    The FreshPack Integration Configuration for this Reject Bin Scale

Source

FreshPackBinScaleIntegration

A FreshPackBinScaleIntegration Type

Type

  • Object

Properties

  • points Object

    The Points used by this FreshPack Bin Scale Integration

  • enabled boolean

    Whether this FreshPack Bin Scale Integration is Enabled

  • materialGroupId number <nullable>

    The FreshPack Material Group ID to be used for Multi-Grower Bins from this Reject Bin Scale

  • binTypeId number

    The FreshPack Bin Type ID to be used for Multi-Grower Bins from this Reject Bin Scale

  • printerGroupId number <nullable>

    The FreshPack Printer Group ID to be used when Printing Multi-Grower Bin Cards for this Reject Bin Scale

  • binCardPrintingEnabled boolean

    Whether Bin Card Printing is Enabled

  • useWindowsDriverApi boolean <optional>

    Whether Bin Card Printing should use the Specialized FreshPack Windows Driver API

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • rtuId number <optional>
    <nullable>

    The RTU this Reject Bin Scale belongs to

  • name string <optional>

    The Name of this Reject Bin Scale

  • packingLineId string <optional>

    The Packing Line that owns this Reject Bin Scale

  • packrunSourceId string <optional>
    <nullable>

    The Permanent Object that provides the Next Packrun for this Reject Bin Scale

  • packrunGroup number <optional>
    <nullable>

    The Packrun Group this Reject Bin Scale is a part of

Source

SortingTableSource

A SortingTableSource Type

Type

  • Object

Properties

  • type string

    Type of this Reject Bin Scale Source

  • sortingTableId string

    ID of the Sorting Table Object

  • classType string

    The Default Class Type of this Reject Bin Scale Source

  • varietyClassTypes Array.<{varietyId: string, classType: string}>

    An Array of Varieties and Class Types to override the Default Class Type

Source

UpdateData

The Update Data for a Reject Bin Scale

Type

  • Object

Properties

  • name string <optional>

    The Name of this Reject Bin Scale

  • points Object <optional>

    The Points used by this Reject Bin Scale

  • packingLineId string <optional>

    The Packing Line that owns this Reject Bin Scale

  • packrunSourceId string <optional>
    <nullable>

    The Permanent Object that provides the Next Packrun for this Reject Bin Scale

  • packrunGroup number <optional>
    <nullable>

    The Packrun Group this Reject Bin Scale is a part of

  • sources Array.<(RejectBinScaleController.SortingTableSource|RejectBinScaleController.BeltSource|RejectBinScaleController.SizerOutletSource)> <optional>

    An Array of Sources that deliver Fruit to this Reject Bin Scale

  • autoPackrunChange Object <optional>
    <nullable>

    The Auto Packrun Change Configuration for this Reject Bin Scale

  • supportsLiveWeighing boolean <optional>
    <nullable>

    Whether this Reject Bin Scale supports Live Weighing

  • autoWeighingStartThreshold number <optional>
    <nullable>

    The Minimum Weight Change Required to Automatically Start Live Weighing

  • autoWeighingStartDelay number <optional>
    <nullable>

    The Delay in Milliseconds before Auto Live Weighing would Start

  • autoWeighingFinishThreshold number <optional>
    <nullable>

    The Minimum Weight Change Required to Automatically Finish Live Weighing

  • autoWeighingFinishDelay number <optional>
    <nullable>

    The Delay in Milliseconds before Auto Live Weighing would Finish

  • autoWeighingFinishAtGrossTarget boolean <optional>
    <nullable>

    Whether Live Weighing should be Automatically Finished when the Target Gross Weight is Met

  • manualInterventionMaximumDuration number <optional>
    <nullable>

    The Maximum Duration in Milliseconds before a Manual Intervention would end

  • liveWeighingIncreaseTolerance number <optional>
    <nullable>

    The Maximum Weight Increase allowed within a single Live Weighing Update Interval

  • liveWeighingDecreaseTolerance number <optional>
    <nullable>

    The Maximum Weight Decrease allowed within a single Live Weighing Update Interval

  • liveWeighingUpdateInterval number <optional>
    <nullable>

    The Interval in Milliseconds between Live Weighing Updates

  • liveWeighingUsesStableStatus boolean <optional>
    <nullable>

    Whether the Loadcell Stable Status is used to ignore Changes during Live Weighing

  • incorrectOperationTolerance number <optional>
    <nullable>

    The Maximum Weight Change allowed while Live Weighing before an Incorrect Operation is Logged

  • freshPackIntegration RejectBinScaleController.FreshPackBinScaleIntegration <optional>
    <nullable>

    The FreshPack Integration Configuration for this Reject Bin Scale

Source