n4.cuwo.messages.imagecapture.CaptureImageOperation

The CaptureImageOperation message is used to trigger the capture of an image.

The message has the following structure:

{
  "@type": "n4.cuwo.messages.imagecapture.CaptureImageOperation",
  "id": "...",
}

The various member provide the information necessary for the operation:

  • id - The ID of the operation. Will be used as part of the acknowledgement and result messages

If the operation is successful, an instance of CaptureImageResult is returned as part of the OperationFinished message.

CaptureImageResult has the following structure:

{
  "@type": "n4.cuwo.messages.imagecapture.CaptureImageResult",
  "image": "...",
  "mimetype": "..."
}

The various member provide the result information for the operation:

  • image - The image data value as a base64 encoded string. The string must use the “base64” encoding defined in RFC 4648 Section 4.
  • mimetype - The Mime-Type of the image as a string