PutApiVersionnumberProjectnameSessionSessionuidScenesSceneui2

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/trax/main/json-schema/trax-put-api-versionnumber-projectname-session-sessionuid-scenes-sceneui2-schema.json",
  "title": "PutApiVersionnumberProjectnameSessionSessionuidScenesSceneui2",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_ae-authored/trax-openapi-generated.yml#/components/schemas/PutApiVersionnumberProjectnameSessionSessionuidScenesSceneui2",
  "type": "object",
  "properties": {
    "file": {
      "type": "string",
      "description": "The image being uploaded, must be JPEG format. The recommended resolution of an image is 8 mega-pixel, with aspect ratio 4:3 or 16:9. The maximum size of an image is 50 MB."
    },
    "store_number": {
      "type": "string",
      "description": "Client's Store unique identifier, as provided in Stores"
    },
    "visit_date": {
      "type": "string",
      "description": "The date of the visit by local time zone (YYYY-MM-DD)"
    },
    "captured_by": {
      "type": "string",
      "description": "Client identifier for the entity taking the image. (e.g. if fixed cameras are used, this should identify the specific camera)"
    },
    "capture_time": {
      "type": "number",
      "description": "The Unix Epoch timestamp of the session end time in the client application"
    },
    "local_tz_offset": {
      "type": "number",
      "description": "The local timezone offset for UTC in minutes (e.g. for PST will be -420)"
    },
    "task_code": {
      "type": "string",
      "description": "Task Code - Scene types that have been configured in coordination with Trax implementation team"
    },
    "email_address": {
      "type": "string",
      "description": "The email of the user conduction the session. If this value is provided, it must correlate to an email address of a user as sent in Users ( V4 or V5 )"
    },
    "image_properties": {
      "type": "object",
      "description": "Trax Image Recognition algorithms are at optimal performance when the image properties are available. While the following section is not mandatory as part of the Image route, it is highly recommended to send this data."
    },
    "latitude": {
      "type": "number",
      "description": "GPS latitude coordinate (in degrees)"
    },
    "longitude": {
      "type": "number",
      "description": "GPS longitude coordinate (in degrees)"
    },
    "camera_orientation": {
      "type": "number",
      "description": "A quaternion representing the device's attitude ordered (w,x,y,z)"
    },
    "automatic_screen_rotation": {
      "type": "boolean",
      "description": "The setting of the screen rotation. True if enabled."
    },
    "camera_position": {
      "type": "number",
      "description": "The in-store location coordinates. The value is an ordered x,y,z of the pose of the current frame"
    },
    "device_name": {
      "type": "string",
      "description": "The name of the device."
    },
    "camera_maker": {
      "type": "string",
      "description": "The camera maker."
    },
    "exposure_time": {
      "type": "string",
      "description": "the number of seconds of exposure time/shutter speed."
    },
    "iso": {
      "type": "string",
      "description": "The ISO used."
    },
    "f_stop": {
      "type": "string",
      "description": "The f-stop value represents the aperture setting used when capturing the image."
    },
    "exposure_bias": {
      "type": "number",
      "description": "The exposure bias steps used for exposure compensation."
    },
    "35mm_focal_length": {
      "type": "number",
      "description": "The 35mm focal length equivalent."
    },
    "flash_mode": {
      "type": "string",
      "description": "The camera flash mode when the image has been captured."
    },
    "flash_energy": {
      "type": "number",
      "description": "Indicates the strobe energy at the time the image is captured (BCPS)."
    },
    "aperture": {
      "type": "number",
      "description": "Aperture value."
    },
    "compression": {
      "type": "number",
      "description": "Indicates the compression level applied to the image. Range: 0-100"
    },
    "white_balance": {
      "type": "string",
      "description": "The image's white balance."
    },
    "metering_mode": {
      "type": "string",
      "description": "The camera's metering mode."
    },
    "subject_distance": {
      "type": "number",
      "description": "The subject distance in meters."
    },
    "resolution": {
      "type": "number",
      "description": "Indicates the captured image resolution in megapixels."
    },
    "os": {
      "type": "string",
      "description": "The operating system and its version."
    },
    "calibration_matrix": {
      "type": "number",
      "description": "Intrinsic camera calibration matrix - (fx, fy, cx, cy)"
    },
    "lens_distortion": {
      "type": "number",
      "description": "Radial and tangential lens distortion values - (k1, k2, k3, p1, p2)"
    },
    "angular_velocity": {
      "type": "number",
      "description": "The rate of rotation in rad/s around a device's x, y, and z axes (wx, wy, wz)."
    },
    "puzzle_mode": {
      "type": "object",
      "description": "Overlap position data of captured photo, used by the stitching machine."
    },
    "column": {
      "type": "number",
      "description": "Index of the column on the grid."
    },
    "row": {
      "type": "number",
      "description": "Index of the row on the grid."
    },
    "overlap_percent_h": {
      "type": "number",
      "description": "Percentage of horizontal overlap with perviously taken photo"
    },
    "overlap_percent_v": {
      "type": "number",
      "description": "Percentage of vertical overlap with perviously taken photo"
    }
  },
  "required": [
    "file",
    "store_number",
    "visit_date",
    "capture_time",
    "local_tz_offset",
    "task_code"
  ]
}