SAP Gateway API - AdditionalImageEvent (optional) – Artemis Vision

Endpoint

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

Request

Headers
Content-Type: application/json

Request Body
The request must be a JSON object wrapped in a top-level "d" key. This event uploads an image from a secondary or auxiliary camera associated with a previously recorded barcode read event.

Example JSON Payload:

{
  "d": {
    "WarehouseID": "WAREHOUSE_42",     // Unique identifier of the warehouse (string)
    "LocationID": 7,                   // ID of the RaPTr unit capturing the image (unsigned int)
    "MessageID": 987654321,            // Must match the barcode read event ID (unsigned long)
    "CameraID": 4,                     // ID of the additional camera (unsigned int)
    "Image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD..."  // Base64-encoded image (string)
  }
}

Parameter Types:

WarehouseID: string – Identifies the warehouse where the scanner is located.
LocationID: unsigned int – Unique ID of the RaPTr scanner.
MessageID: unsigned long – Must be the same ID used in the related BarcodeReadEvent.
CameraID: unsigned int – ID of the auxiliary camera that captured this image.
Image: string – A JPEG image encoded in base64 format.

Response

Success Response
HTTP Status: 200 OK

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

{
  "d": {
    "ResponseCode": 1,                     // 1 for success, 0 for failure (unsigned int)
    "ResponseString": "Image received."    // Message or error description (string)
  }
}

Example Flow: Upload from Secondary Camera

Request:

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

Body:

{
  "d": {
    "WarehouseID": "WH001",
    "LocationID": 17,
    "MessageID": 1122334455,
    "CameraID": 5,
    "Image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD..."
  }
}

Response:

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

Notes

This endpoint is optional, but it enhances traceability and verification by providing multiple image perspectives for the same barcode event.
This should be called after the corresponding BarcodeReadEvent has been processed.
Each additional image must reference the correct MessageID to associate it with the proper event.

Related to