api/v1/swagger/definitions/recall.yaml

   1 ---
   2 type: object
   3 properties:
   4   recall_id:
   5     type: integer
   6     description: Internal recall identifier
   7   patron_id:
   8     type: integer
   9     description: Internal patron identifier
  10   created_date:
  11     type:
  12       - string
  13       - "null"
  14     format: date-time
  15     description: The date the recall was requested
  16   biblio_id:
  17     type: integer
  18     description: Internal biblio identifier
  19   pickup_library_id:
  20     type:
  21       - string
  22       - "null"
  23     description: Internal library identifier for the pickup library
  24   completed_date:
  25     type:
  26       - string
  27       - "null"
  28     format: date-time
  29     description: The date the recall was fulfilled
  30   notes:
  31     type:
  32       - string
  33       - "null"
  34     description: Notes related to this recall
  35   priority:
  36     type:
  37       - integer
  38       - "null"
  39     description: Where in the queue the patron sits (not yet implemented)
  40   status:
  41     type: string
  42     description: Status of the recall
  43     enum:
  44       - requested
  45       - overdue
  46       - waiting
  47       - in_transit
  48       - cancelled
  49       - expired
  50       - fulfilled
  51   timestamp:
  52     type: string
  53     format: date-time
  54     description: Timestamp for the latest recall update
  55   item_id:
  56     type:
  57       - integer
  58       - "null"
  59     description: Internal item identifier
  60   waiting_date:
  61     type:
  62       - string
  63       - "null"
  64     format: date-time
  65     description: The date the item was marked as waiting for the patron at the library
  66   expiration_date:
  67     type:
  68       - string
  69       - "null"
  70     format: date-time
  71     description: The date the recall expires
  72   completed:
  73     type: boolean
  74     description: Controls if the recall is fulfilled
  75   item_level:
  76     type: boolean
  77     description: If the recall is requested at item level
  78
  79 additionalProperties: false