SAP Gateway API - DisplayInformation (optional) – Artemis Vision

Endpoint

POST
http[s]://[RaPTrServerHostname]:[SAPGatewayLocalPort]/SAPDisplayInformation

Request

Headers
Content-Type: application/json

Purpose
This endpoint allows the customer to display custom HTML content in the upper-left section of a RaPTr Scanner UI. It is typically used to show information such as shipment or order details.

Request Body

The request body must be a JSON object wrapped in a "d" property.

Example JSON Payload:

{
  "d": {
    "LocationID": 12,                         // Identifier of the RaPTr unit (unsigned int)
    "HTML": "<strong>Order #1123</strong>"   // HTML to be rendered (string)
  }
}

Parameter Descriptions:

LocationID: unsigned int
Unique ID of the RaPTr unit where the content should be displayed.
HTML: string
A valid HTML string to be shown in the RaPTr UI’s upper-left section. Only safe and limited markup should be used to avoid rendering issues.

Response

Success Response
HTTP Status: 200 OK

Response Body
The response body is wrapped in a "d" property.

{
  "d": {
    "ResponseCode": 1,                           // 1 for success, 0 for failure (unsigned int)
    "ResponseString": ""       // Informational or error message (string)
  }
}

Example

Request:

POST http://raptr.local:8055/SAPDisplayInformation

Body:

{
  "d": {
    "LocationID": 22,
    "HTML": "<div style='color: green;'>Loading Order #4456</div>"
  }
}

Response:

{
  "d": {
    "ResponseCode": 1,
    "ResponseString": "Display updated successfully."
  }
}

Notes

This endpoint is optional but can significantly improve operator context and workflow visibility.
The scanner UI may impose restrictions on styling or HTML elements, so it is recommended to use simple, semantic HTML for best compatibility.

Related to