Skip to main content

Dealing with Errors

This page is still under construction

<ReportError>​

If a piece has a questionable scan, it’s possible to report an error to us. This will upload the previous scan’s data to our cloud (including your calibration) where we can investigate what may have happened. Such cases can also be added to our regressions to better ensure accuracy in future versions. When using this reporting tool, we ask you to measure the cargo by an alternative method and then provide us with the measured: Length, Width, and Height (using the unit of measurement that your Cargo Spectre is set to).

Request​

Request report an error at a machine that has recently with local IP address 10.1.1.2 set to port 7100.

Endpoint​

GEThttp://10.1.1.2:7100/ReportError?Length=value&Width=value&Height=value


Desired response format:

Accept: application/xml (DEFAULT)

Response​

<Responses>
    <ReportError code="0"/>
</Responses>

<GetErrorStatus>​

This returns the last status code set by the Cargo Spectre server, whether error or success.

Request​

Receive last status code of machine with local IP address 10.1.1.2 set to port 7100.

Endpoint​

GEThttp://10.1.1.2:7100/GetErrorStatus


Header​

Desired response format:

Accept: application/xml (DEFAULT)

Response​

<Responses>
    <GetErrorStatus code="0"/>
</Responses>

Errors on API Commands​

The "code" parameter on each API responses signifies whether the command executed successfully or not. It is present on each and every command that was sent, even if they are combined into one request.

Example:

<Responses>
  <Ping code="0"/>
  <Dimension code="DIM_NO_OBJECT" description="No object detected when scanning."/>
</Responses>

Successful commands show a code of "0". If an error occurs, it will typically include a code that is not "0" and a description with a human-readable message.

Below are potential error codes and what they signify.

List of Error Codes​

Warning, this list may not be up to date.

Error CodeNotes
LIC_NETWORK_ERRORCouldn't connect to licensing server over the network.
LIC_NO_AVAILABLE_LICENSESAll licenses have been checked out.
LIC_UNKNOWN_ERRORGeneral issue with license checkout.
CAL_FILE_NOT_FOUNDIssue reading files from calibration.
CAL_REFS_NOT_FOUNDCouldn't find calibration objects.
CAL_GENERALUnknown calibration phase detected.
DIM_NULLGeneral issues with dimensioning.
DIM_UNCALIBRATEDDevice is not calibrated - cannot scan.
DIM_CLIPPED_POINTSObject is partially out of view when scanning.
DIM_NO_OBJECTNo object detected when scanning.
DIM_NO_CAMSIssue with getting data from cameras when calibrating.
API_UNKNOWNAPI command was not recognized.
API_BAD_PARAMETERError parsing an API parameter or its input.
WU_FAILEDDeals with failures to upload to the Cloud.
GENERALOther unknown errors are handled here.