koha-dev.rot13.org Git - srvgit/blob - 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   damaged_status:
  64     type: integer
  65     description: Authorized value defining this item as damaged
  66   damaged_date:
  67     type:
  68       - string
  69       - "null"
  70     description: The date and time an item was last marked as damaged, NULL if not damaged
  71   lost_status:
  72     type: integer
  73     description: Authorized value defining this item as lost
  74   lost_date:
  75     type:
  76       - string
  77       - "null"
  78     format: date-time
  79     description: The date and time an item was last marked as lost, NULL if not lost
  80   withdrawn:
  81     type: integer
  82     description: Authorized value defining this item as withdrawn
  83   withdrawn_date:
  84     type:
  85       - string
  86       - "null"
  87     format: date-time
  88     description: The date and time an item was last marked as withdrawn, NULL if not
  89       withdrawn
  90   callnumber:
  91     type:
  92       - string
  93       - "null"
  94     description: Call number for this item
  95   coded_location_qualifier:
  96     type:
  97       - string
  98       - "null"
  99     description: Coded location qualifier
 100   checkouts_count:
 101     type:
 102       - integer
 103       - "null"
 104     description: Number of times this item has been checked out/issued
 105   renewals_count:
 106     type:
 107       - integer
 108       - "null"
 109     description: Number of times this item has been renewed
 110   holds_count:
 111     type:
 112       - integer
 113       - "null"
 114     description: Number of times this item has been placed on hold/reserved
 115   restricted_status:
 116     type:
 117       - integer
 118       - "null"
 119     description: Authorized value defining use restrictions for this item
 120   public_notes:
 121     type:
 122       - string
 123       - "null"
 124     description: Public notes on this item
 125   internal_notes:
 126     type:
 127       - string
 128       - "null"
 129     description: Non-public notes on this item
 130   holding_library_id:
 131     type:
 132       - string
 133       - "null"
 134     description: Library that is currently in possession item
 135   timestamp:
 136     type: string
 137     format: date-time
 138     description: Date and time this item was last altered
 139   location:
 140     type:
 141       - string
 142       - "null"
 143     description: Authorized value for the shelving location for this item
 144   permanent_location:
 145     type:
 146       - string
 147       - "null"
 148     description: Linked to the CART and PROC temporary locations feature, stores the
 149       permanent shelving location
 150   checked_out_date:
 151     type:
 152       - string
 153       - "null"
 154     format: date
 155     description: Defines if item is checked out (NULL for not checked out, and checkout
 156       date for checked out)
 157   call_number_source:
 158     type:
 159       - string
 160       - "null"
 161     description: Classification source used on this item
 162   call_number_sort:
 163     type:
 164       - string
 165       - "null"
 166     description: "?"
 167   collection_code:
 168     type:
 169       - string
 170       - "null"
 171     description: Authorized value for the collection code associated with this item
 172   materials_notes:
 173     type:
 174       - string
 175       - "null"
 176     description: Materials specified
 177   uri:
 178     type:
 179       - string
 180       - "null"
 181     description: URL for the item
 182   item_type_id:
 183     type:
 184       - string
 185       - "null"
 186     description: Itemtype defining the type for this item
 187   effective_item_type_id:
 188     type:
 189       - string
 190       - "null"
 191     description: Effective itemtype defining the type for this item_id
 192   extended_subfields:
 193     type:
 194       - string
 195       - "null"
 196     description: Additional 952 subfields in XML format
 197   serial_issue_number:
 198     type:
 199       - string
 200       - "null"
 201     description: serial enumeration/chronology for the item
 202   copy_number:
 203     type:
 204       - string
 205       - "null"
 206     description: Copy number
 207   inventory_number:
 208     type:
 209       - string
 210       - "null"
 211     description: Inventory number
 212   new_status:
 213     type:
 214       - string
 215       - "null"
 216     description: "'new' value, whatever free-text information."
 217   exclude_from_local_holds_priority:
 218     type: boolean
 219     description: Exclude this item from local holds priority.
 220   return_claims:
 221     type: array
 222     description: An array of all return claims associated with this item
 223   return_claim:
 224     type:
 225       - object
 226       - "null"
 227     description: A return claims object if one exists that's unresolved
 228 additionalProperties: false
 229 required:
 230   - item_id
 231   - biblio_id
 232   - not_for_loan_status
 233   - damaged_status
 234   - lost_status
 235   - withdrawn