Skip to content

API Specification v1.0

Hannah edited this page Aug 20, 2019 · 2 revisions
api paths:
- path: /api/printjobs/{pid}/status
  - type: PUT
    description: update a print job's status
    request body parameters (JSON):
    - employee ID
    - status
- path: /api/printjobs/{pid}
  - type: DELETE
    description: delete a print job
    request parameters:
    - employee ID
    - authentication????
  - type: PUT
    description: update a print job's fields
    request body parameters (JSON):
    - file
    - color
    - comments
  - type: GET
    description: get details for a single print job
    request parameters:
    - print job ID
    response parameters:
    - email
    - dropbox file link
    - color
    - comments
    - current status
    - time changed to current status
    - time job was initially requested
- path: /api/printjobs
  - type: GET
    description: get details for all print jobs (with optional filters)
    request parameters:
    - active (filter for active jobs)
    - deletable (filter for deletable jobs)
  - type: POST
    description: submit request for new print job
    request body parameters (JSON):
    - name
    - email
    - file
    - preferred color
    - time stamp
    - comments
Clone this wiki locally