REST API - DisplayInformation (Optional)

The customer can display custom HTML in the upper section of a RaPTr Scanner UI. This is typically information about the current shipment being loaded.

Endpoint

POST

[http vs https]://[Supervisor Hostname]:[REST API Supervisor Port (if greater than 0)]/DisplayInformation

---

 

Request

Headers
Content-Type: application/json

Request Body
The body of the request should include the following fields in JSON format:

Example JSON Payload:

{
  "LocationID": 1,                      // Identifier of the RaPTr unit (unsigned int)
  "HTML": "<b>Loading Order ORD123</b>" // HTML content to display (string)
}

 

Parameter Types:

• LocationID: unsigned int – The identifier of the RaPTr unit.

• HTML: string – The HTML markup that will be rendered in the upper-left section of the RaPTr Scanner UI.

---

 

Response

Success Response
HTTP Status: 200 OK

Response Body:

{
  "ResponseCode": 1,                  // 1 for success, 0 for failure (unsigned int)
  "ResponseString": "Display updated" // Information about the result (string)
}

 

Parameter Types:

• ResponseCode: unsigned int – A value indicating the result (1 for success, 0 for failure).

• ResponseString: string – A message providing details about the result or any failure reason.

---

 

Example Flow of Successful Display Update

Request:

POST [http vs https]://[Supervisor Hostname]:[REST API Supervisor Port (if greater than 0)]/DisplayInformation 

Body:

{
  "LocationID": 1,
  "HTML": "<div style='color: green;'>Order #12345 - In Progress</div>"
}

Response:

{
  "ResponseCode": 1,
  "ResponseString": "Display updated"
}

---

 

Example Flow of Failed Display Update

Request:

POST [http vs https]://[Supervisor Hostname]:[REST API Supervisor Port (if greater than 0)]/DisplayInformation  

Body:

{
  "LocationID": 9999,
  "HTML": "<div>Order Info</div>"
}

Response:

{
  "ResponseCode": 0,
  "ResponseString": "LocationID not recognized"
}

---

 

Notes

• This endpoint allows dynamic updating of informational content shown on RaPTr Scanner UIs.

• The HTML content should be sanitized and styled appropriately to fit within the constraints of the RaPTr UI display area.

• If ResponseCode is 0, check that the LocationID is valid and the HTML content is properly formatted.