AcquisitionStatus

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/dentsply-sirona/main/json-schema/dentsply-sirona-acquisition-status-schema.json",
  "title": "AcquisitionStatus",
  "description": "Describes the state of the current exposure",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/dentsply-sirona-images-api-openapi.yml#/components/schemas/AcquisitionStatus",
  "type": "object",
  "properties": {
    "ready": {
      "description": "Indicates exposure readiness of the sensor. Use this property to update the user with information regarding exposure readiness.",
      "type": "boolean"
    },
    "state": {
      "description": "The state of the current exposure. For a typical exposure, the acquisition state property will start with `NoAcquisitionInfo`. Once the client has supplied AcquisitionInfo with `enable` set to true and the sensor is ready to acquire, the state will transition to `Ready`. When the user exposes the sensor, the state will automatically transition to `Reading`, followed by `Processing`, `Storing`, `NewImage` and finally return to `NoAcquisitionInfo` as it prepares for the next exposure. \n\n  The state property will contain one of the following values:\n  * `Error` - An error has occurred and acquisition is unavailable.\n  * `LowBattery` - A warning that the device does not have enough power to continue. The device must be recharged.\n  * `InsufficientStorage` - There is not enough space available to store the next exposure\n  * `NoHardware` - The device has been lost or is no longer connected\n  * `NoSensor` - There is no sensor connected to the device\n  * `Initializing` - The device is initializing the sensor and preparing for an exposure\n  * `NoAcquisitionInfo` - AcquisitionInfo has not been sent yet. The client must send AcquisitionInfo prior to each exposure.\n  * `Ready` - The device is ready for an exposure. Note that the device may be ready, but the client has disabled acquisition. In this case, the ready property above would be false.\n  * `Reading` - An exposure occurred and the sensor is being read.\n  * `Processing` - The device is processing image data received from the sensor\n  * `Storing` - The device is storing image data\n  * `NewImage` - Indicates that an exposure just completed and a new image is available.\n",
      "type": "string",
      "enum": [
        "Error",
        "LowBattery",
        "InsufficientStorage",
        "NoHardware",
        "NoSensor",
        "Initializing",
        "NoAcquisitionInfo",
        "Ready",
        "Reading",
        "Processing",
        "Storing",
        "NewImage"
      ]
    },
    "lastImageId": {
      "description": "The id of the most recent image acquired. This property will be updated when an image is acquired and the state transitions to `NewImage`.",
      "type": "string"
    },
    "totalImages": {
      "description": "The total number of images acquired so far in this session. This property will be updated when an image is acquired and the state transitions to `NewImage`.",
      "type": "number"
    }
  }
}