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.

GET

Endpoint

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

Header

XML

Desired response format:

Accept: application/xml (DEFAULT)

JSON

Desired response format:

Accept: application/json

POST

Endpoint

POSThttp://10.1.1.2:7100/

Header

XML

Desired response format:

Accept: application/xml (DEFAULT)

JSON

Desired response format:

Accept: application/json

Body

XML

<Requests>
    <ReportError>
        <Length>30.0</Length>
        <Width>20.0</Width>
        <Height>40</Height>
    </ReportError>
</Requests>

JSON

{
  "Requests":{
    "ReportError":{
      "Length": 30.0,
      "Width": 20.0,
      "Height": 40
    }
  }
}

Response

XML

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

JSON

{
  "Responses": {
    "ReportError": {
      "code": "0"
    }
  }
}

<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.

GET

Endpoint

GEThttp://10.1.1.2:7100/GetErrorStatus

Header

XML

Desired response format:

Accept: application/xml (DEFAULT)

JSON

Desired response format:

Accept: application/json

POST

Endpoint

POSThttp://10.1.1.2:7100/

Header

XML

Desired response format:

Accept: application/xml (DEFAULT)

JSON

Desired response format:

Accept: application/json

Body

XML

<Requests>
    <GetErrorStatus/>
</Requests>

JSON

JSON not currently supported

Response

XML

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

JSON

{
  "Responses": {
    "GetErrorStatus": {
      "code": "0"
    }
  }
}

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:

XML

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

JSON

{
  "Responses": {
    "Ping": {
      "code": "0",
      "value": ""
    },
    "Dimension": {
      "code": "DIM_NO_OBJECT",
      "description": "No object detected when scanning."
    }
  }
}

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 Code	Notes
LIC_NETWORK_ERROR	Couldn't connect to licensing server over the network.
LIC_NO_AVAILABLE_LICENSES	All licenses have been checked out.
LIC_UNKNOWN_ERROR	General issue with license checkout.
CAL_FILE_NOT_FOUND	Issue reading files from calibration.
CAL_REFS_NOT_FOUND	Couldn't find calibration objects.
CAL_GENERAL	Unknown calibration phase detected.
DIM_NULL	General issues with dimensioning.
DIM_UNCALIBRATED	Device is not calibrated - cannot scan.
DIM_CLIPPED_POINTS	Object is partially out of view when scanning.
DIM_NO_OBJECT	No object detected when scanning.
DIM_NO_CAMS	Issue with getting data from cameras when calibrating.
API_UNKNOWN	API command was not recognized.
API_BAD_PARAMETER	Error parsing an API parameter or its input.
WU_FAILED	Deals with failures to upload to the Cloud.
GENERAL	Other unknown errors are handled here.