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       "type": "integer",
   9       "description": "Internal patron identifier"
  10     },
  11     "reservedate": {
  12       "type": ["string", "null"],
  13       "description": "the date the hold was placed"
  14     },
  15     "biblionumber": {
  16       "$ref": "../x-primitives.json#/biblionumber"
  17     },
  18     "branchcode": {
  19       "type": ["string", "null"],
  20       "description": "code of patron's home branch"
  21     },
  22     "notificationdate": {
  23       "type": ["string", "null"],
  24       "description": "currently unused"
  25     },
  26     "reminderdate": {
  27       "type": ["string", "null"],
  28       "description": "currently unused"
  29     },
  30     "cancellationdate": {
  31       "type": ["string", "null"],
  32       "description": "the date the hold was cancelled"
  33     },
  34     "reservenotes": {
  35       "type": ["string", "null"],
  36       "description": "notes related to this hold"
  37     },
  38     "priority": {
  39       "type": ["integer", "null"],
  40       "description": "where in the queue the patron sits"
  41     },
  42     "found": {
  43       "type": ["string", "null"],
  44       "description": "a one letter code defining what the status of the hold is after it has been confirmed"
  45     },
  46     "timestamp": {
  47       "type": ["string", "null"],
  48       "description": "date and time the hold was last updated"
  49     },
  50     "itemnumber": {
  51       "$ref": "../x-primitives.json#/itemnumber"
  52     },
  53     "waitingdate": {
  54       "type": ["string", "null"],
  55       "description": "the date the item was marked as waiting for the patron at the library"
  56     },
  57     "expirationdate": {
  58       "type": ["string", "null"],
  59       "description": "the date the hold expires"
  60     },
  61     "lowestPriority": {
  62       "type": "boolean",
  63       "description": "Controls if the hold is given the lowest priority on the queue"
  64     },
  65     "suspend": {
  66       "type": "boolean",
  67       "description": "Controls if the hold is suspended"
  68     },
  69     "suspend_until": {
  70       "type": ["string", "null"],
  71       "description": "Date until which the hold has been suspended"
  72     },
  73     "itemtype": {
  74       "type": ["string", "null"],
  75       "description": "If record level hold, the optional itemtype of the item the patron is requesting"
  76     }
  77   }
  78 }