api/v1/swagger/definitions/hold.json

   1 {
   2   "type": "object",
   3   "properties": {
   4     "hold_id": {
   5       "type": "integer",
   6       "description": "Internal hold identifier"
   7     },
   8     "patron_id": {
   9       "type": "integer",
  10       "description": "Internal patron identifier"
  11     },
  12     "hold_date": {
  13       "type": ["string", "null"],
  14       "format": "date",
  15       "description": "The date the hold was placed"
  16     },
  17     "biblio_id": {
  18       "type": "integer",
  19       "description": "Internal biblio identifier"
  20     },
  21     "pickup_library_id": {
  22       "type": ["string", "null"],
  23       "description": "Internal library identifier for the pickup library"
  24     },
  25     "cancelation_date": {
  26       "type": ["string", "null"],
  27       "format": "date",
  28       "description": "The date the hold was cancelled"
  29     },
  30     "notes": {
  31       "type": ["string", "null"],
  32       "description": "Notes related to this hold"
  33     },
  34     "priority": {
  35       "type": ["integer", "null"],
  36       "description": "Where in the queue the patron sits"
  37     },
  38     "status": {
  39       "type": ["string", "null"],
  40       "description": "A one letter code defining what the status of the hold is after it has been confirmed"
  41     },
  42     "timestamp": {
  43       "type": "string",
  44       "format": "date-time",
  45       "description": "Timestamp for the latest hold update"
  46     },
  47     "item_id": {
  48       "type": ["string", "null"],
  49       "description": "Internal item identifier"
  50     },
  51     "waiting_date": {
  52       "type": ["string", "null"],
  53       "format": "date",
  54       "description": "The date the item was marked as waiting for the patron at the library"
  55     },
  56     "expiration_date": {
  57       "type": ["string", "null"],
  58       "format": "date",
  59       "description": "The date the hold expires"
  60     },
  61     "lowest_priority": {
  62       "type": "boolean",
  63       "description": "Controls if the hold is given the lowest priority on the queue"
  64     },
  65     "suspended": {
  66       "type": "boolean",
  67       "description": "Controls if the hold is suspended"
  68     },
  69     "suspended_until": {
  70       "type": ["string", "null"],
  71       "format": "date-time",
  72       "description": "Date until which the hold has been suspended"
  73     },
  74     "item_type": {
  75       "type": ["string", "null"],
  76       "description": "If record level hold, the optional itemtype of the item the patron is requesting"
  77     }
  78   }
  79 }