Status
Interface: Status
Section titled “Interface: Status”A booking status.
There are two categories of status - flow statuses and exception statuses. Flow statuses are statuses that may be visited in an ordinary booking flow. They generally have following statuses, and represent ordinary progression of a booking. Exception statuses represent a non-standard completion of a booking, such as a booking being cancelled.
Several core statuses exist. The Submitted and Approved statuses are the start of the booking, following into the user flow statuses. Completed is the ending of normal flow statuses. The Cancelled status is the only custom Exception status.
The On Hold status exists as a sort of ‘holding ground’ for bookings that need to be held and not progressed through the flow, but should not be cancelled.
Fields
Section titled “Fields”| Field | Type | Description |
|---|---|---|
id* | UUID! | The ID of the status. |
key* | EntityKey! | A user-defined, stable identifier for the status. |
name* | String! | The name of the status. Status names are unique. |
description | String | The description of the status. |
type* | StatusType! | The type of the status. Core statuses have special rules on modification, and can never be deleted. The Submitted status can have entry fields, but no exit fields. The Completed status can have entry fields, but no exit fields. The Approved status can have exit fields, but no entry fields. |
carrierProgressable* | Boolean! | Whether this status is available to the carrier. If true, the carrier or the location can move from any status to this status. If false, only the location can move to this status. |
capturePoints* | [FieldCapturePoint!]! | Fields that should be captured on transition into/out of the status. |
colour* | Colour! | The colour of the status to be displayed as. |
highlighted* | Boolean! | Flag indicating if value should be highlighted in display. |
linkedYardAssetStatusFlows* | [BookingYardAssetLinkedStatusFlows!]! | Linked status flows for yard assets. |