api/v1/swagger/definitions/hold.yaml

   1 ---
   2 type: object
   3 properties:
   4   hold_id:
   5     type: integer
   6     description: Internal hold identifier
   7   patron_id:
   8     type: integer
   9     description: Internal patron identifier
  10   hold_date:
  11     type:
  12       - string
  13       - "null"
  14     format: date
  15     description: The date the hold was placed
  16   biblio_id:
  17     type: integer
  18     description: Internal biblio identifier
  19   item_group_id:
  20     type:
  21       - string
  22       - "null"
  23     description: Internal item group identifier
  24   pickup_library_id:
  25     type:
  26       - string
  27       - "null"
  28     description: Internal library identifier for the pickup library
  29   desk_id:
  30     type:
  31       - integer
  32       - "null"
  33     description: The id of the desk
  34   cancellation_date:
  35     type:
  36       - string
  37       - "null"
  38     format: date
  39     description: The date the hold was cancelled
  40   cancellation_reason:
  41     type:
  42       - string
  43       - "null"
  44     description: The reason the hold was cancelled
  45   notes:
  46     type:
  47       - string
  48       - "null"
  49     description: Notes related to this hold
  50   priority:
  51     type:
  52       - integer
  53       - "null"
  54     description: Where in the queue the patron sits
  55   status:
  56     type:
  57       - string
  58       - "null"
  59     description: A one letter code defining what the status of the hold is after it has
  60       been confirmed
  61   timestamp:
  62     type: string
  63     format: date-time
  64     description: Timestamp for the latest hold update
  65   item_id:
  66     type:
  67       - string
  68       - "null"
  69     description: Internal item identifier
  70   waiting_date:
  71     type:
  72       - string
  73       - "null"
  74     format: date
  75     description: The date the item was marked as waiting for the patron at the library
  76   expiration_date:
  77     type:
  78       - string
  79       - "null"
  80     format: date
  81     description: The date the hold expires
  82   lowest_priority:
  83     type: boolean
  84     description: Controls if the hold is given the lowest priority on the queue
  85   suspended:
  86     type: boolean
  87     description: Controls if the hold is suspended
  88   suspended_until:
  89     type:
  90       - string
  91       - "null"
  92     format: date-time
  93     description: Date until which the hold has been suspended
  94   non_priority:
  95     description: Set this hold as non priority
  96     type: boolean
  97   item_type:
  98     type:
  99       - string
 100       - "null"
 101     description: If record level hold, the optional itemtype of the item the patron is
 102       requesting
 103   item_level:
 104     type: boolean
 105     description: If the hold is placed at item level
 106   cancellation_requested:
 107     type:
 108       - boolean
 109       - "null"
 110     description: Cancellation requests count for the hold (x-koha-embed)
 111   biblio:
 112     type:
 113       - object
 114       - "null"
 115     description: Bibliographic record
 116   item:
 117     type:
 118       - object
 119       - "null"
 120     description: The item
 121   pickup_library:
 122     type:
 123       - object
 124       - "null"
 125     description: Pickup library
 126
 127 additionalProperties: false