openapi: 3.0.1
info:
  title: Vasion Output Management Reporter API
  version: v1.0.0
  description: This API is the one that the OM service client will call to report the status of a job. 
               The URI for it should be defined in the `statusURL` field of the print job request.
  contact:
    name: PrinterLogic Support
    url: https://vasion.com/technical-support/
    email: support@printerlogic.com
servers:
  - url: https://localhost:31990/
tags: []
components:
  securitySchemes:
    basicAuth:     
      type: http
      scheme: basic
paths:
  /print-job-status:
    post:
      security:
        - basicAuth: []
      summary: Print Job Status Update
      description: |
        The OM service client will call this endpoint to report the status of a job. <br><br>
        Status Responses:
          - success
          - fail 
      requestBody:
        content:
          application/json::
            schema:
              required:
                - jobID
                - status
              properties:
                jobID:
                  pattern: >-
                    ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
                  type: string
                  description: >-
                    Job UUID. 
                  example: 96e31686-daae-4820-9389-5a9d36496bad
                status:
                  type: string
                  description: >-
                    The status of the job.
                    Possible values:
                    - success
                    - fail
                  example: "success"
                message:
                  type: string
                  description: If more information is needed, it can be sent here.
                  example: "No response from printer."
        required: true
      responses:
        default:
          description: OK