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