n4.cuwo.messages.generic.StatusNotification

In the case that the CUWO container detects a state or state change for the system configuration, network or attached peripherals, it will send a StatusNotification message to the CUWO.

Since there are a multitude of different kinds of status values that need to be communicated, the enfore platform uses a three-level structure consisting of categories > groups > codes for organizing them. Additionally, each status may have some “data” object whose structure and content are specific to the status code. For example, a “Peripherals > Printers > ...” status has a DeviceReference identifying the relevant printer.

CategoryTypeCodes
ConnectivityGeneralINTERNET_DOWN
INTERNET_UP
PeripheralsPrintersOK
WARN_PAPER_NEAR_END
ERROR_MEMORY
ERROR_COVER
ERROR_NO_PAPER
ERROR_HEAD_TEMPERATURE
ERROR_HEAD
ERROR_VOLTAGE
ERROR_CUTTER
ERROR_PAPER_FEED
ERROR_UNKOWN
UNKOWN
PeripheralsPayment DevicesUNKNOWN
SUCCESS
DISCOVERY_FAILED
CONFIGURATION_FAILED
IN_PROGRESS
CANCELED
SIGNATURE_REQUIRED
INVALID_TRANSACION_ID
DEVICE_NOT_FOUND
TRANSACTION_CONFIRMATION_REQUIRED
ACTION_REQUIRED
CONCURRENT_OPERATION
REVERSAL_NOT_POSSIBLE
ALREADY_REVERSED

The message has the following structure:

{
  "@type": "n4.cuwo.messages.generic.StatusNotification",
  "id": "...",
  "status": {
    "@type": "n4.n4.apis.status.StatusInformation",
    "category": {...},
    "group": {...},
    "code": {...},
    "data": {...},
    "message": "..."
  }
}

Operation members:

  • id - The ID of the notification
  • status - Information about the status
    • category - The category of the status
    • group - The category-specific type of the status
    • code - The group-specific code of the status
    • data - The code-specific data of the status
    • message - An optional message for helping to debug the error.

Note that the n4.cuwo.messages.StatusInformation structure may also be part of an OperationFinished message if the operation failed due to a problem indicated by the status.