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