SAP Gateway API - BarcodeImageEvent (optional) – Artemis Vision

Endpoint

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

Request

Headers
Content-Type: application/json

Request Body
The request body must be a JSON object wrapped in a top-level key "d", containing all event details and barcode positioning metadata.

Example JSON Payload:

{
  "d": {
    "WarehouseID": "WAREHOUSE_42",     // Unique identifier of the warehouse (string)
    "LocationID": 5,                   // ID of the RaPTr unit that captured the image (unsigned int)
    "MessageID": 123456789,            // Identifier of the related barcode read event (unsigned long)
    "CameraID": 2,                     // ID of the camera that captured the image (unsigned int)
    "Image": "/images/capture123.jpg", // Base64-encoded image or path to stored image (string)
    "BarcodeCoordinates": {
      "TopLeftX": 0.12,   // X coordinate of top-left corner (as % of image width, float 0–1)
      "TopLeftY": 0.08,   // Y coordinate of top-left corner (as % of image height, float 0–1)
      "TopRightX": 0.42,
      "TopRightY": 0.08,
      "BotLeftX": 0.12,
      "BotLeftY": 0.18,
      "BotRightX": 0.42,
      "BotRightY": 0.18
    }
  }
}

Parameter Types:

WarehouseID: string – Unique warehouse identifier.
LocationID: unsigned int – ID of the RaPTr scanner that captured the barcode.
MessageID: unsigned long – Must match the ID used in the related BarcodeReadEvent.
CameraID: unsigned int – Identifies which camera on the scanner captured the image.
Image: string – A base64-encoded JPEG image or a relative path to the saved image.
BarcodeCoordinates: object – Specifies the corners of the detected barcode in the image. Each value is a double representing a percentage (0.0 to 1.0) of image width/height:
- TopLeftX, TopLeftY
- TopRightX, TopRightY
- BotLeftX, BotLeftY
- BotRightX, BotRightY

Response

Success Response
HTTP Status: 200 OK

Response Body: The response is also wrapped in a "d" key.

{
  "d": {
    "ResponseCode": 1,                    // 1 for success, 0 for failure (unsigned int)
    "ResponseString": "Upload complete."  // Message or error reason (string)
  }
}

Example Flow: Successful Upload

Request:

POST [http vs https]://[Supervisor Hostname]:[REST API Supervisor Port]/BarcodeImageEventURL

Body:

{
  "d": {
    "WarehouseID": "WH2",
    "LocationID": 12,
    "MessageID": 999888777,
    "CameraID": 3,
    "Image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...",
    "BarcodeCoordinates": {
      "TopLeftX": 0.10,
      "TopLeftY": 0.05,
      "TopRightX": 0.40,
      "TopRightY": 0.05,
      "BotLeftX": 0.10,
      "BotLeftY": 0.15,
      "BotRightX": 0.40,
      "BotRightY": 0.15
    }
  }
}

Response:

{
  "d": {
    "ResponseCode": 1,
    "ResponseString": "Barcode image saved successfully."
  }
}

Notes

This endpoint is optional, but it adds valuable visual context to barcode reads.
MessageID must match the barcode read event it supports for traceability.
Either a full base64-encoded image string or a relative file path to a pre-saved image is accepted for the Image field.
All barcode coordinates must be accurate percentages (0.0–1.0) to render correctly in RaPTr UI overlays.

Related to