REST API - BarcodeImageEvent (optional)

After a RaPTr Scanner has sent a BarcodeReadEvent message, it will upload the image in which the barcode was found to the REST Server.

Endpoint

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

---

Request

Headers

• Content-Type: multipart/form-data

Form Data

1. ImageFile (content-type: image/jpg)

   • Description: The barcode image file.
   • Content-Disposition: form-data; name=ImageFile; filename=image.jpg; filename*=utf-8''image.jpg
   • Content-Type: image/jpg
   • File Type: JPEG image (binary data)

2. json (content-type: application/json; charset=utf-8)

   • Description: JSON payload containing metadata about the barcode event.
   • Content-Disposition: form-data; name=json
   • Content-Type: application/json; charset=utf-8

   Example JSON Payload:

   {
     "WarehouseID": "string",  // Unique identifier of the warehouse (string)
     "LocationID": 1234,       // Identifier of the RaPTr unit (unsigned int)
     "MessageID": 56789,       // Identifier of the barcode read event (unsigned long)
     "CameraID": 1,            // Identifier of the camera which read the barcode (unsigned int)
     "BarcodeCoordinates": {
       "TopLeftX": 0.1,       // X coordinate of the top left corner (percentage of image width, double)
       "TopLeftY": 0.2,       // Y coordinate of the top left corner (percentage of image height, double)
       "TopRightX": 0.9,      // X coordinate of the top right corner (percentage of image width, double)
       "TopRightY": 0.2,      // Y coordinate of the top right corner (percentage of image height, double)
       "BotLeftX": 0.1,       // X coordinate of the bottom left corner (percentage of image width, double)
       "BotLeftY": 0.8,       // Y coordinate of the bottom left corner (percentage of image height, double)
       "BotRightX": 0.9,      // X coordinate of the bottom right corner (percentage of image width, double)
       "BotRightY": 0.8       // Y coordinate of the bottom right corner (percentage of image height, double)
     }
   }
   

   Parameter Types:

   • WarehouseID: string
   • LocationID: unsigned int
   • MessageID: unsigned long
   • CameraID: unsigned int
   • BarcodeCoordinates: Object containing:
     • TopLeftX, TopLeftY, TopRightX, TopRightY, BotLeftX, BotLeftY, BotRightX, BotRightY: double (coordinates expressed as percentages of image width/height)

---

Response

Success Response

HTTP Status: 200 OK

Body:

{
  "ResponseCode": 1,        // 1 for success (unsigned int)
  "ResponseString": "Success" // Optional message (string)
}

Failure Response

HTTP Status: 400 Bad Request (or other error codes)

Body:

{
  "ResponseCode": 0,        // 0 for failure (unsigned int)
  "ResponseString": "Error message" // Information about failure (string)
}

---

Notes

• The ImageFile and json parameters are sent as part of the multipart/form-data request, not in the request body.
• The ImageFile is uploaded as a JPEG image (image/jpg), while the json field contains the metadata about the image event in JSON format (application/json; charset=utf-8).
• Parameter types:
  • unsigned int: An integer that is guaranteed to be non-negative.
  • unsigned long: A larger integer that is also non-negative.
  • double: A floating-point number with double precision (for coordinates).
  • string: A sequence of characters (e.g., warehouse ID, response message).