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   bookable:
  28     type: boolean
  29     description: Allow bookings on this item.
  30   home_library_id:
  31     type:
  32       - string
  33       - "null"
  34     description: Internal library id for the library the item belongs to
  35   purchase_price:
  36     type:
  37       - number
  38       - "null"
  39     description: Purchase price
  40   replacement_price:
  41     type:
  42       - number
  43       - "null"
  44     description: Cost the library charges to replace the item (e.g. if lost)
  45   replacement_price_date:
  46     type:
  47       - string
  48       - "null"
  49     format: date
  50     description: The date the replacement price is effective from
  51   last_checkout_date:
  52     type:
  53       - string
  54       - "null"
  55     format: date
  56     description: The date the item was last checked out
  57   last_seen_date:
  58     type:
  59       - string
  60       - "null"
  61     format: date-time
  62     description: The date the item barcode was last scanned
  63   not_for_loan_status:
  64     type: integer
  65     description: Authorized value defining why this item is not for loan
  66   effective_not_for_loan_status:
  67     type: integer
  68     description: Authorized value defining why this item is not for not_for_loan_status
  69   damaged_status:
  70     type: integer
  71     description: Authorized value defining this item as damaged
  72   damaged_date:
  73     type:
  74       - string
  75       - "null"
  76     description: The date and time an item was last marked as damaged, NULL if not damaged
  77   lost_status:
  78     type: integer
  79     description: Authorized value defining this item as lost
  80   lost_date:
  81     type:
  82       - string
  83       - "null"
  84     format: date-time
  85     description: The date and time an item was last marked as lost, NULL if not lost
  86   withdrawn:
  87     type: integer
  88     description: Authorized value defining this item as withdrawn
  89   withdrawn_date:
  90     type:
  91       - string
  92       - "null"
  93     format: date-time
  94     description: The date and time an item was last marked as withdrawn, NULL if not
  95       withdrawn
  96   callnumber:
  97     type:
  98       - string
  99       - "null"
 100     description: Call number for this item
 101   coded_location_qualifier:
 102     type:
 103       - string
 104       - "null"
 105     description: Coded location qualifier
 106   checkouts_count:
 107     type:
 108       - integer
 109       - "null"
 110     description: Number of times this item has been checked out/issued
 111   renewals_count:
 112     type:
 113       - integer
 114       - "null"
 115     description: Number of times this item has been renewed
 116   holds_count:
 117     type:
 118       - integer
 119       - "null"
 120     description: Number of times this item has been placed on hold/reserved
 121   restricted_status:
 122     type:
 123       - integer
 124       - "null"
 125     description: Authorized value defining use restrictions for this item
 126   public_notes:
 127     type:
 128       - string
 129       - "null"
 130     description: Public notes on this item
 131   internal_notes:
 132     type:
 133       - string
 134       - "null"
 135     description: Non-public notes on this item
 136   holding_library_id:
 137     type:
 138       - string
 139       - "null"
 140     description: Library that is currently in possession item
 141   timestamp:
 142     type: string
 143     format: date-time
 144     description: Date and time this item was last altered
 145   location:
 146     type:
 147       - string
 148       - "null"
 149     description: Authorized value for the shelving location for this item
 150   permanent_location:
 151     type:
 152       - string
 153       - "null"
 154     description: Linked to the CART and PROC temporary locations feature, stores the
 155       permanent shelving location
 156   checked_out_date:
 157     type:
 158       - string
 159       - "null"
 160     format: date
 161     description: Defines if item is checked out (NULL for not checked out, and checkout
 162       date for checked out)
 163   call_number_source:
 164     type:
 165       - string
 166       - "null"
 167     description: Classification source used on this item
 168   call_number_sort:
 169     type:
 170       - string
 171       - "null"
 172     description: "?"
 173   collection_code:
 174     type:
 175       - string
 176       - "null"
 177     description: Authorized value for the collection code associated with this item
 178   materials_notes:
 179     type:
 180       - string
 181       - "null"
 182     description: Materials specified
 183   uri:
 184     type:
 185       - string
 186       - "null"
 187     description: URL for the item
 188   item_type_id:
 189     type:
 190       - string
 191       - "null"
 192     description: Itemtype defining the type for this item
 193   effective_item_type_id:
 194     type:
 195       - string
 196       - "null"
 197     description: Effective itemtype defining the type for this item_id
 198   extended_subfields:
 199     type:
 200       - string
 201       - "null"
 202     description: Additional 952 subfields in XML format
 203   serial_issue_number:
 204     type:
 205       - string
 206       - "null"
 207     description: serial enumeration/chronology for the item
 208   copy_number:
 209     type:
 210       - string
 211       - "null"
 212     description: Copy number
 213   inventory_number:
 214     type:
 215       - string
 216       - "null"
 217     description: Inventory number
 218   new_status:
 219     type:
 220       - string
 221       - "null"
 222     description: "'new' value, whatever free-text information."
 223   exclude_from_local_holds_priority:
 224     type: boolean
 225     description: Exclude this item from local holds priority.
 226   return_claims:
 227     type: array
 228     description: An array of all return claims associated with this item
 229   return_claim:
 230     type:
 231       - object
 232       - "null"
 233   cover_image_ids:
 234     type:
 235       - array
 236       - "null"
 237   item_group_item:
 238     type:
 239       - object
 240       - "null"
 241   serialitem:
 242     type:
 243       - object
 244       - "null"
 245   checkout:
 246     type:
 247       - object
 248       - "null"
 249   transfer:
 250     type:
 251       - object
 252       - "null"
 253   first_hold:
 254     type:
 255       - object
 256       - "null"
 257   recall:
 258     type:
 259       - object
 260       - "null"
 261   item_type:
 262     type:
 263       - object
 264       - "null"
 265   in_bundle:
 266     type:
 267       - boolean
 268       - "null"
 269   bundle_host:
 270     type:
 271       - object
 272       - "null"
 273   _strings:
 274     type:
 275       - object
 276       - "null"
 277     description: A return claims object if one exists that's unresolved
 278 additionalProperties: false