Event Volume Sort

Description

volume-sort
Event Volume Sort

A collection of properties for the current Volume Sort job.

Properties

Property Description
created read-only
string
date-time

The creation date of the current Volume Sort job.
eventId read-only
integer

The numeric identifier for the event to which this volume sort belongs.
id read-only
integer

The identifier for the volume sort
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
numberOfAlbumsCreated
integer

Count of the number of albums created upon completion of the current Volume Sort job.
numberOfImages
integer

Count of the images that are expected in the current Volume Sort job.
numberOfImagesSorted
integer

Count of the images that have been sorted in the current Volume Sort job.
numberOfImagesToSort
integer

Count of the images to be sorted in the current Volume Sort job.
numberOfQrCodesDetected
integer

Count of the QR codes detected in the current Volume Sort job.
numberOfQrCodesGenerated
integer

Count of the QR codes generated for the current Volume Sort job.
type
string
enum
  • volume-sort

The type of object represented.
volumeSortStatus
string
enum
  • not-started
  • sorting
  • finished-sorting

The status of the volume sort job.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "A collection of properties for the current Volume Sort job.",
  "properties": {
    "created": {
      "description": "The creation date of the current Volume Sort job.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "eventId": {
      "description": "The numeric identifier for the event to which this volume sort belongs.",
      "readOnly": true,
      "type": "integer"
    },
    "id": {
      "description": "The identifier for the volume sort",
      "readOnly": true,
      "type": "integer"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "numberOfAlbumsCreated": {
      "description": "Count of the number of albums created upon completion of the current Volume Sort job.",
      "type": "integer"
    },
    "numberOfImages": {
      "description": "Count of the images that are expected in the current Volume Sort job.",
      "type": "integer"
    },
    "numberOfImagesSorted": {
      "description": "Count of the images that have been sorted in the current Volume Sort job.",
      "type": "integer"
    },
    "numberOfImagesToSort": {
      "description": "Count of the images to be sorted in the current Volume Sort job.",
      "type": "integer"
    },
    "numberOfQrCodesDetected": {
      "description": "Count of the QR codes detected in the current Volume Sort job.",
      "type": "integer"
    },
    "numberOfQrCodesGenerated": {
      "description": "Count of the QR codes generated for the current Volume Sort job.",
      "type": "integer"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "volume-sort"
      ],
      "type": "string"
    },
    "volumeSortStatus": {
      "description": "The status of the volume sort job.",
      "enum": [
        "not-started",
        "sorting",
        "finished-sorting"
      ],
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "title": "Event Volume Sort",
  "type": "object"
}
Event Volume Sort