RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

SoftSortBeltController

Controller Class for Soft Sort Belts

Constructor

new SoftSortBeltController()

Source

Methods

static

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

Create a Soft Sort Belt [POST /packhouse/sites/{siteId}/soft-sort-belts]

Parameters

  • siteId number

    The Site ID

  • createData SoftSortBeltController.CreateData

    The Soft Sort Belt Create Data

Returns

  • Promise.<SoftSortBeltModel>

Source

static

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

List all Soft Sort Belts [GET /packhouse/sites/{siteId}/soft-sort-belts]

Parameters

  • siteId number

    The Site ID

  • queryParameters SoftSortBeltController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<SoftSortBeltModel>>

Source

static

getAllEvents(siteId, queryParametersopt) → {Promise.<Array.<SoftSortBeltController.SoftSortEventItem>>}

Retrieve the Events of all Soft Sort Belts [GET /packhouse/sites/{siteId}/soft-sort-belts/events]

Retrieves Events for all Soft Sort Belts

Parameters

  • siteId number

    The Site ID

  • queryParameters SoftSortBeltController.GetAllEventsQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<SoftSortBeltController.SoftSortEventItem>>

Source

static

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

Retrieve a Soft Sort Belt [GET /packhouse/sites/{siteId}/soft-sort-belts/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Soft Sort Belt ID

Returns

  • Promise.<SoftSortBeltModel>

Source

static

getOneEvents(siteId, id, queryParametersopt) → {Promise.<Array.<SoftSortBeltController.SoftSortEventItem>>}

Retrieve the Events of a Soft Sort Belt [GET /packhouse/sites/{siteId}/soft-sort-belts/{id}/events]

Retrieves Events for a Single Soft Sort Belt

Parameters

  • siteId number

    The Site ID

  • id string

    The Soft Sort Belt ID

  • queryParameters SoftSortBeltController.GetOneEventsQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<SoftSortBeltController.SoftSortEventItem>>

Source

static

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

Update a Soft Sort Belt [PATCH /packhouse/sites/{siteId}/soft-sort-belts/{id}]

Parameters

  • siteId number

    The Site ID

  • id string

    The Soft Sort Belt ID

  • updateData SoftSortBeltController.UpdateData

    The Soft Sort Belt Update Data

Returns

  • Promise.<SoftSortBeltModel>

Source

Type Definitions

CreateData

The Create Data for a Soft Sort Belt

Type

  • Object

Properties

  • rtuId number <optional>
    <nullable>

    The RTU this Soft Sort Belt belongs to

  • name string

    The Name of this Soft Sort Belt

  • points Object

    The Points used by this Soft Sort Belt

  • packingLineId string

    The Packing Line that owns this Soft Sort Belt

Source

GetAllEventsQueryParameters

The Optional Query Parameters for the getAllEvents Function

Type

  • Object

Properties

  • beltIds Array.<string> <optional>

    A List of Soft-Sort Belt IDs to Filter by

  • timestampBegin Date <optional>

    The Beginning Timestamp of the Soft-Sort Event Results. Defaults to 24 Hours ago

  • timestampEnd Date <optional>

    The End Timestamp of the Soft-Sort Event Results. Defaults to Now

  • packrunId string <optional>

    A Packrun ID to Filter by. Forces timestampBegin and timestampEnd to be Ignored

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • rtuId number <optional>
    <nullable>

    The RTU this Soft Sort Belt belongs to

  • name string <optional>

    The Name of this Soft Sort Belt

  • packingLineId string <optional>

    The Packing Line that owns this Soft Sort Belt

Source

GetOneEventsQueryParameters

The Optional Query Parameters for the getOneEvents Function

Type

  • Object

Properties

  • timestampBegin Date <optional>

    The Beginning Timestamp of the Soft-Sort Event Results. Defaults to 24 Hours ago

  • timestampEnd Date <optional>

    The End Timestamp of the Soft-Sort Event Results. Defaults to Now

Source

SoftSortEventItem

A SoftSortEventItem Type

Type

  • Object

Properties

  • beltId string

    The Soft-Sort Belt ID

  • packrunId string

    The ID of the associated Packrun

  • packrunName string

    The Name of the associated Packrun

  • startTimestamp Date

    When the Event Started

  • endTimestamp Date

    When the Event Ended

  • duration number

    The Duration in Seconds of the Event

Source

UpdateData

The Update Data for a Soft Sort Belt

Type

  • Object

Properties

  • name string <optional>

    The Name of this Soft Sort Belt

  • points Object <optional>

    The Points used by this Soft Sort Belt

  • packingLineId string <optional>

    The Packing Line that owns this Soft Sort Belt

Source