api/v1/swagger/definitions/item.yaml

   1 ---
   2 type: object
   3 properties:
   4   item_id:
   5     type: integer
   6     description: Internal item identifier
   7   biblio_id:
   8     type: integer
   9     description: Internal identifier for the parent bibliographic record
  10   biblio: {}
  11   external_id:
  12     type:
  13       - string
  14       - "null"
  15     description: The item's barcode
  16   acquisition_date:
  17     type:
  18       - string
  19       - "null"
  20     format: date
  21     description: The date the item was acquired
  22   acquisition_source:
  23     type:
  24       - string
  25       - "null"
  26     description: Information about the acquisition source (it is not really a vendor id)
  27   home_library_id:
  28     type:
  29       - string
  30       - "null"
  31     description: Internal library id for the library the item belongs to
  32   purchase_price:
  33     type:
  34       - number
  35       - "null"
  36     description: Purchase price
  37   replacement_price:
  38     type:
  39       - number
  40       - "null"
  41     description: Cost the library charges to replace the item (e.g. if lost)
  42   replacement_price_date:
  43     type:
  44       - string
  45       - "null"
  46     format: date
  47     description: The date the replacement price is effective from
  48   last_checkout_date:
  49     type:
  50       - string
  51       - "null"
  52     format: date
  53     description: The date the item was last checked out
  54   last_seen_date:
  55     type:
  56       - string
  57       - "null"
  58     format: date
  59     description: The date the item barcode was last scanned
  60   not_for_loan_status:
  61     type: integer
  62     description: Authorized value defining why this item is not for loan
  63   effective_not_for_loan_status:
  64     type: integer
  65     description: Authorized value defining why this item is not for not_for_loan_status
  66   damaged_status:
  67     type: integer
  68     description: Authorized value defining this item as damaged
  69   damaged_date:
  70     type:
  71       - string
  72       - "null"
  73     description: The date and time an item was last marked as damaged, NULL if not damaged
  74   lost_status:
  75     type: integer
  76     description: Authorized value defining this item as lost
  77   lost_date:
  78     type:
  79       - string
  80       - "null"
  81     format: date-time
  82     description: The date and time an item was last marked as lost, NULL if not lost
  83   withdrawn:
  84     type: integer
  85     description: Authorized value defining this item as withdrawn
  86   withdrawn_date:
  87     type:
  88       - string
  89       - "null"
  90     format: date-time
  91     description: The date and time an item was last marked as withdrawn, NULL if not
  92       withdrawn
  93   callnumber:
  94     type:
  95       - string
  96       - "null"
  97     description: Call number for this item
  98   coded_location_qualifier:
  99     type:
 100       - string
 101       - "null"
 102     description: Coded location qualifier
 103   checkouts_count:
 104     type:
 105       - integer
 106       - "null"
 107     description: Number of times this item has been checked out/issued
 108   renewals_count:
 109     type:
 110       - integer
 111       - "null"
 112     description: Number of times this item has been renewed
 113   holds_count:
 114     type:
 115       - integer
 116       - "null"
 117     description: Number of times this item has been placed on hold/reserved
 118   restricted_status:
 119     type:
 120       - integer
 121       - "null"
 122     description: Authorized value defining use restrictions for this item
 123   public_notes:
 124     type:
 125       - string
 126       - "null"
 127     description: Public notes on this item
 128   internal_notes:
 129     type:
 130       - string
 131       - "null"
 132     description: Non-public notes on this item
 133   holding_library_id:
 134     type:
 135       - string
 136       - "null"
 137     description: Library that is currently in possession item
 138   timestamp:
 139     type: string
 140     format: date-time
 141     description: Date and time this item was last altered
 142   location:
 143     type:
 144       - string
 145       - "null"
 146     description: Authorized value for the shelving location for this item
 147   permanent_location:
 148     type:
 149       - string
 150       - "null"
 151     description: Linked to the CART and PROC temporary locations feature, stores the
 152       permanent shelving location
 153   checked_out_date:
 154     type:
 155       - string
 156       - "null"
 157     format: date
 158     description: Defines if item is checked out (NULL for not checked out, and checkout
 159       date for checked out)
 160   call_number_source:
 161     type:
 162       - string
 163       - "null"
 164     description: Classification source used on this item
 165   call_number_sort:
 166     type:
 167       - string
 168       - "null"
 169     description: "?"
 170   collection_code:
 171     type:
 172       - string
 173       - "null"
 174     description: Authorized value for the collection code associated with this item
 175   materials_notes:
 176     type:
 177       - string
 178       - "null"
 179     description: Materials specified
 180   uri:
 181     type:
 182       - string
 183       - "null"
 184     description: URL for the item
 185   item_type_id:
 186     type:
 187       - string
 188       - "null"
 189     description: Itemtype defining the type for this item
 190   effective_item_type_id:
 191     type:
 192       - string
 193       - "null"
 194     description: Effective itemtype defining the type for this item_id
 195   extended_subfields:
 196     type:
 197       - string
 198       - "null"
 199     description: Additional 952 subfields in XML format
 200   serial_issue_number:
 201     type:
 202       - string
 203       - "null"
 204     description: serial enumeration/chronology for the item
 205   copy_number:
 206     type:
 207       - string
 208       - "null"
 209     description: Copy number
 210   inventory_number:
 211     type:
 212       - string
 213       - "null"
 214     description: Inventory number
 215   new_status:
 216     type:
 217       - string
 218       - "null"
 219     description: "'new' value, whatever free-text information."
 220   exclude_from_local_holds_priority:
 221     type: boolean
 222     description: Exclude this item from local holds priority.
 223   return_claims:
 224     type: array
 225     description: An array of all return claims associated with this item
 226   return_claim:
 227     type:
 228       - object
 229       - "null"
 230   _strings:
 231     type:
 232       - object
 233       - "null"
 234     description: A return claims object if one exists that's unresolved
 235 additionalProperties: false
 236 required:
 237   - item_id
 238   - biblio_id
 239   - not_for_loan_status
 240   - damaged_status
 241   - lost_status
 242   - withdrawn