TicketsImportJob

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/agendaforge-app/json-schema/agendaforge-app-tickets-import-job-schema.json",
  "title": "TicketsImportJob",
  "description": "Returned by POST /api/v1/imports/tickets and by GET /api/v1/jobs/{id} for a tickets_import job.",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/agendaforge-app-openapi.json#/components/schemas/TicketsImportJob",
  "type": "object",
  "required": [
    "jobId",
    "type",
    "status",
    "total",
    "statusUrl",
    "result"
  ],
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Opaque job id."
    },
    "type": {
      "type": "string",
      "enum": [
        "tickets_import"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "processing",
        "completed",
        "failed"
      ],
      "description": "completed in a 200 response; pending in a 202 response. Terminal states are completed and failed; keep polling until one is reached."
    },
    "total": {
      "type": "integer",
      "description": "Tickets in the request."
    },
    "statusUrl": {
      "type": "string",
      "format": "uri",
      "description": "Poll this URL (GET, a key with tickets:import) for progress."
    },
    "result": {
      "type": "object",
      "required": [
        "total",
        "processed",
        "created",
        "updated",
        "unchanged",
        "cancelled",
        "restored",
        "failed",
        "errors"
      ],
      "properties": {
        "total": {
          "type": "integer"
        },
        "processed": {
          "type": "integer",
          "description": "Rows handled so far, failed rows included; equals total when done."
        },
        "created": {
          "type": "integer",
          "description": "New tickets."
        },
        "updated": {
          "type": "integer",
          "description": "Existing tickets that changed."
        },
        "unchanged": {
          "type": "integer",
          "description": "Existing tickets with nothing to change."
        },
        "cancelled": {
          "type": "integer",
          "description": "Tickets cancelled or refunded."
        },
        "restored": {
          "type": "integer",
          "description": "Cancelled or refunded tickets made valid again."
        },
        "failed": {
          "type": "integer",
          "description": "Rows not applied."
        },
        "errors": {
          "type": "array",
          "description": "Row failures (first 50). code is one of missing_reference, reference_too_long, reference_mangled, reference_reserved, duplicate_reference, missing_name, invalid_email, missing_ticket_type, unknown_status, scan_key_reserved, scan_key_length, scan_key_taken, invalid_date, field_too_long, missing_fields, checked_in, event_full, type_catalogue_full. A job that stops early reports one CONFLICT entry and status failed.",
          "items": {
            "type": "object",
            "required": [
              "index",
              "reference",
              "code",
              "message"
            ],
            "properties": {
              "index": {
                "type": "integer",
                "description": "Zero-based position in the tickets array."
              },
              "reference": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The row's reference, or null when it is withheld."
              },
              "code": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}