Line 0
Link Here
|
|
|
1 |
{ |
2 |
"swagger": "2.0", |
3 |
"info": { |
4 |
"title": "Koha REST API", |
5 |
"version": "1", |
6 |
"license": { |
7 |
"name": "GPL v3", |
8 |
"url": "http://www.gnu.org/licenses/gpl.txt" |
9 |
}, |
10 |
"contact": { |
11 |
"name": "Koha Team", |
12 |
"url": "http://koha-community.org/" |
13 |
} |
14 |
}, |
15 |
"basePath": "/api/v1", |
16 |
"paths": { |
17 |
"/patrons": { |
18 |
"get": { |
19 |
"operationId": "listPatrons", |
20 |
"tags": ["patrons"], |
21 |
"produces": [ |
22 |
"application/json" |
23 |
], |
24 |
"responses": { |
25 |
"200": { |
26 |
"description": "A list of patrons", |
27 |
"schema": { |
28 |
"type": "array", |
29 |
"items": { |
30 |
"$ref": "#/definitions/patron" |
31 |
} |
32 |
} |
33 |
}, |
34 |
"403": { |
35 |
"description": "Access forbidden", |
36 |
"schema": { |
37 |
"$ref": "#/definitions/error" |
38 |
} |
39 |
} |
40 |
} |
41 |
} |
42 |
}, |
43 |
"/patrons/{borrowernumber}": { |
44 |
"get": { |
45 |
"operationId": "getPatron", |
46 |
"tags": ["patrons"], |
47 |
"parameters": [ |
48 |
{ |
49 |
"$ref": "#/parameters/borrowernumberPathParam" |
50 |
} |
51 |
], |
52 |
"produces": [ |
53 |
"application/json" |
54 |
], |
55 |
"responses": { |
56 |
"200": { |
57 |
"description": "A patron", |
58 |
"schema": { |
59 |
"$ref": "#/definitions/patron" |
60 |
} |
61 |
}, |
62 |
"403": { |
63 |
"description": "Access forbidden", |
64 |
"schema": { |
65 |
"$ref": "#/definitions/error" |
66 |
} |
67 |
}, |
68 |
"404": { |
69 |
"description": "Patron not found", |
70 |
"schema": { |
71 |
"$ref": "#/definitions/error" |
72 |
} |
73 |
} |
74 |
} |
75 |
} |
76 |
}, |
77 |
"/patrons/{borrowernumber}/password": { |
78 |
"patch": { |
79 |
"operationId": "changepasswordPatron", |
80 |
"tags": ["patrons"], |
81 |
"parameters": [ |
82 |
{ "$ref": "#/parameters/borrowernumberPathParam" }, |
83 |
{ |
84 |
"name": "body", |
85 |
"in": "body", |
86 |
"description": "A JSON object containing informations about passwords", |
87 |
"required": true, |
88 |
"schema": { |
89 |
"type": "object", |
90 |
"properties": { |
91 |
"current_password": { |
92 |
"description": "Current password", |
93 |
"type": "string" |
94 |
}, |
95 |
"new_password": { |
96 |
"description": "New password", |
97 |
"type": "string" |
98 |
} |
99 |
} |
100 |
} |
101 |
} |
102 |
], |
103 |
"produces": [ |
104 |
"application/json" |
105 |
], |
106 |
"responses": { |
107 |
"200": { |
108 |
"description": "Password changed" |
109 |
}, |
110 |
"400": { |
111 |
"description": "Bad request", |
112 |
"schema": { |
113 |
"$ref": "#/definitions/error" |
114 |
} |
115 |
}, |
116 |
"403": { |
117 |
"description": "Access forbidden", |
118 |
"schema": { |
119 |
"$ref": "#/definitions/error" |
120 |
} |
121 |
}, |
122 |
"404": { |
123 |
"description": "Patron not found", |
124 |
"schema": { |
125 |
"$ref": "#/definitions/error" |
126 |
} |
127 |
} |
128 |
} |
129 |
} |
130 |
}, |
131 |
"/holds": { |
132 |
"get": { |
133 |
"operationId": "listHolds", |
134 |
"tags": ["borrowers", "holds"], |
135 |
"parameters": [ |
136 |
{ |
137 |
"name": "reserve_id", |
138 |
"in": "query", |
139 |
"description": "Internal reserve identifier", |
140 |
"type": "integer" |
141 |
}, |
142 |
{ |
143 |
"name": "borrowernumber", |
144 |
"in": "query", |
145 |
"description": "Internal borrower identifier", |
146 |
"type": "integer" |
147 |
}, |
148 |
{ |
149 |
"name": "reservedate", |
150 |
"in": "query", |
151 |
"description": "Reserve date", |
152 |
"type": "string" |
153 |
}, |
154 |
{ |
155 |
"name": "biblionumber", |
156 |
"in": "query", |
157 |
"description": "Internal biblio identifier", |
158 |
"type": "integer" |
159 |
}, |
160 |
{ |
161 |
"name": "branchcode", |
162 |
"in": "query", |
163 |
"description": "Branch code", |
164 |
"type": "string" |
165 |
}, |
166 |
{ |
167 |
"name": "notificationdate", |
168 |
"in": "query", |
169 |
"description": "Notification date", |
170 |
"type": "string" |
171 |
}, |
172 |
{ |
173 |
"name": "reminderdate", |
174 |
"in": "query", |
175 |
"description": "Reminder date", |
176 |
"type": "string" |
177 |
}, |
178 |
{ |
179 |
"name": "cancellationdate", |
180 |
"in": "query", |
181 |
"description": "Cancellation date", |
182 |
"type": "string" |
183 |
}, |
184 |
{ |
185 |
"name": "reservenotes", |
186 |
"in": "query", |
187 |
"description": "Reserve notes", |
188 |
"type": "string" |
189 |
}, |
190 |
{ |
191 |
"name": "priority", |
192 |
"in": "query", |
193 |
"description": "Priority", |
194 |
"type": "integer" |
195 |
}, |
196 |
{ |
197 |
"name": "found", |
198 |
"in": "query", |
199 |
"description": "Found status", |
200 |
"type": "string" |
201 |
}, |
202 |
{ |
203 |
"name": "timestamp", |
204 |
"in": "query", |
205 |
"description": "Time of latest update", |
206 |
"type": "string" |
207 |
}, |
208 |
{ |
209 |
"name": "itemnumber", |
210 |
"in": "query", |
211 |
"description": "Internal item identifier", |
212 |
"type": "integer" |
213 |
}, |
214 |
{ |
215 |
"name": "waitingdate", |
216 |
"in": "query", |
217 |
"description": "Date the item was marked as waiting for the patron", |
218 |
"type": "string" |
219 |
}, |
220 |
{ |
221 |
"name": "expirationdate", |
222 |
"in": "query", |
223 |
"description": "Date the hold expires", |
224 |
"type": "string" |
225 |
}, |
226 |
{ |
227 |
"name": "lowestPriority", |
228 |
"in": "query", |
229 |
"description": "Lowest priority", |
230 |
"type": "integer" |
231 |
}, |
232 |
{ |
233 |
"name": "suspend", |
234 |
"in": "query", |
235 |
"description": "Suspended", |
236 |
"type": "integer" |
237 |
}, |
238 |
{ |
239 |
"name": "suspend_until", |
240 |
"in": "query", |
241 |
"description": "Suspended until", |
242 |
"type": "string" |
243 |
} |
244 |
], |
245 |
"produces": ["application/json"], |
246 |
"responses": { |
247 |
"200": { |
248 |
"description": "A list of holds", |
249 |
"schema": { "$ref": "#/definitions/holds" } |
250 |
}, |
251 |
"404": { |
252 |
"description": "Borrower not found", |
253 |
"schema": { "$ref": "#/definitions/error" } |
254 |
} |
255 |
} |
256 |
}, |
257 |
"post": { |
258 |
"operationId": "addHold", |
259 |
"tags": ["borrowers", "holds"], |
260 |
"parameters": [ |
261 |
{ |
262 |
"name": "body", |
263 |
"in": "body", |
264 |
"description": "A JSON object containing informations about the new hold", |
265 |
"required": true, |
266 |
"schema": { |
267 |
"type": "object", |
268 |
"properties": { |
269 |
"borrowernumber": { |
270 |
"description": "Borrower internal identifier", |
271 |
"type": "integer" |
272 |
}, |
273 |
"biblionumber": { |
274 |
"description": "Biblio internal identifier", |
275 |
"type": "integer" |
276 |
}, |
277 |
"itemnumber": { |
278 |
"description": "Item internal identifier", |
279 |
"type": "integer" |
280 |
}, |
281 |
"branchcode": { |
282 |
"description": "Pickup location", |
283 |
"type": "string" |
284 |
}, |
285 |
"expirationdate": { |
286 |
"description": "Hold end date", |
287 |
"type": "string", |
288 |
"format": "date" |
289 |
} |
290 |
} |
291 |
} |
292 |
} |
293 |
], |
294 |
"consumes": ["application/json"], |
295 |
"produces": ["application/json"], |
296 |
"responses": { |
297 |
"201": { |
298 |
"description": "Created hold", |
299 |
"schema": { "$ref": "#/definitions/hold" } |
300 |
}, |
301 |
"400": { |
302 |
"description": "Missing or wrong parameters", |
303 |
"schema": { "$ref": "#/definitions/error" } |
304 |
}, |
305 |
"403": { |
306 |
"description": "Hold not allowed", |
307 |
"schema": { "$ref": "#/definitions/error" } |
308 |
}, |
309 |
"404": { |
310 |
"description": "Borrower not found", |
311 |
"schema": { "$ref": "#/definitions/error" } |
312 |
}, |
313 |
"500": { |
314 |
"description": "Internal error", |
315 |
"schema": { "$ref": "#/definitions/error" } |
316 |
} |
317 |
} |
318 |
} |
319 |
}, |
320 |
"/holds/{reserve_id}": { |
321 |
"put": { |
322 |
"operationId": "editHold", |
323 |
"tags": ["holds"], |
324 |
"parameters": [ |
325 |
{ "$ref": "#/parameters/holdIdPathParam" }, |
326 |
{ |
327 |
"name": "body", |
328 |
"in": "body", |
329 |
"description": "A JSON object containing fields to modify", |
330 |
"required": true, |
331 |
"schema": { |
332 |
"type": "object", |
333 |
"properties": { |
334 |
"priority": { |
335 |
"description": "Position in waiting queue", |
336 |
"type": "integer", |
337 |
"minimum": 1 |
338 |
}, |
339 |
"branchcode": { |
340 |
"description": "Pickup location", |
341 |
"type": "string" |
342 |
}, |
343 |
"suspend_until": { |
344 |
"description": "Suspend until", |
345 |
"type": "string", |
346 |
"format": "date" |
347 |
} |
348 |
} |
349 |
} |
350 |
} |
351 |
], |
352 |
"consumes": ["application/json"], |
353 |
"produces": ["application/json"], |
354 |
"responses": { |
355 |
"200": { |
356 |
"description": "Updated hold", |
357 |
"schema": { "$ref": "#/definitions/hold" } |
358 |
}, |
359 |
"400": { |
360 |
"description": "Missing or wrong parameters", |
361 |
"schema": { "$ref": "#/definitions/error" } |
362 |
}, |
363 |
"404": { |
364 |
"description": "Hold not found", |
365 |
"schema": { "$ref": "#/definitions/error" } |
366 |
} |
367 |
} |
368 |
}, |
369 |
"delete": { |
370 |
"operationId": "deleteHold", |
371 |
"tags": ["holds"], |
372 |
"parameters": [ |
373 |
{ "$ref": "#/parameters/holdIdPathParam" } |
374 |
], |
375 |
"produces": ["application/json"], |
376 |
"responses": { |
377 |
"200": { |
378 |
"description": "Successful deletion", |
379 |
"schema": { |
380 |
"type": "object" |
381 |
} |
382 |
}, |
383 |
"404": { |
384 |
"description": "Hold not found", |
385 |
"schema": { "$ref": "#/definitions/error" } |
386 |
} |
387 |
} |
388 |
} |
389 |
} |
390 |
}, |
391 |
"definitions": { |
392 |
"$ref": "./definitions/index.json" |
393 |
}, |
394 |
"parameters": { |
395 |
"borrowernumberPathParam": { |
396 |
"name": "borrowernumber", |
397 |
"in": "path", |
398 |
"description": "Internal patron identifier", |
399 |
"required": true, |
400 |
"type": "integer" |
401 |
}, |
402 |
"holdIdPathParam": { |
403 |
"name": "reserve_id", |
404 |
"in": "path", |
405 |
"description": "Internal hold identifier", |
406 |
"required": true, |
407 |
"type": "integer" |
408 |
} |
409 |
} |
410 |
} |