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