api/v1/swagger/definitions/hold.json

   1 {
   2   "type": "object",
   3   "properties": {
   4     "reserve_id": {
   5       "$ref": "../x-primitives.json#/reserve_id"
   6     },
   7     "borrowernumber": {
   8       "$ref": "../x-primitives.json#/borrowernumber"
   9     },
  10     "reservedate": {
  11       "description": "the date the hold was placed"
  12     },
  13     "biblionumber": {
  14       "$ref": "../x-primitives.json#/biblionumber"
  15     },
  16     "branchcode": {
  17       "$ref": "../x-primitives.json#/branchcode"
  18     },
  19     "notificationdate": {
  20       "description": "currently unused"
  21     },
  22     "reminderdate": {
  23       "description": "currently unused"
  24     },
  25     "cancellationdate": {
  26       "description": "the date the hold was cancelled"
  27     },
  28     "reservenotes": {
  29       "description": "notes related to this hold"
  30     },
  31     "priority": {
  32       "description": "where in the queue the patron sits"
  33     },
  34     "found": {
  35       "description": "a one letter code defining what the status of the hold is after it has been confirmed"
  36     },
  37     "timestamp": {
  38       "description": "date and time the hold was last updated"
  39     },
  40     "itemnumber": {
  41       "$ref": "../x-primitives.json#/itemnumber"
  42     },
  43     "waitingdate": {
  44       "description": "the date the item was marked as waiting for the patron at the library"
  45     },
  46     "expirationdate": {
  47       "description": "the date the hold expires"
  48     },
  49     "lowestPriority": {
  50       "description": ""
  51     },
  52     "suspend": {
  53       "description": ""
  54     },
  55     "suspend_until": {
  56       "description": ""
  57     },
  58     "itemtype": {
  59       "type": ["string", "null"],
  60       "description": "If record level hold, the optional itemtype of the item the patron is requesting"
  61     }
  62   }
  63 }