Lines 1-376
Link Here
|
1 |
{ |
|
|
2 |
"/transfer_limits": { |
3 |
"get": { |
4 |
"x-mojo-to": "TransferLimits#list", |
5 |
"operationId": "listTransferLimits", |
6 |
"tags": [ |
7 |
"transfer" |
8 |
], |
9 |
"parameters": [ |
10 |
{ |
11 |
"name": "to_library_id", |
12 |
"in": "query", |
13 |
"description": "Search on to_library_id", |
14 |
"required": false, |
15 |
"type": "string" |
16 |
}, |
17 |
{ |
18 |
"name": "from_library_id", |
19 |
"in": "query", |
20 |
"description": "Search on from_library_id", |
21 |
"required": false, |
22 |
"type": "string" |
23 |
}, |
24 |
{ |
25 |
"name": "item_type", |
26 |
"in": "query", |
27 |
"description": "Search on item_type", |
28 |
"required": false, |
29 |
"type": "string" |
30 |
}, |
31 |
{ |
32 |
"name": "collection_code", |
33 |
"in": "query", |
34 |
"description": "Search on collection_code", |
35 |
"required": false, |
36 |
"type": "string" |
37 |
}, |
38 |
{ |
39 |
"$ref": "../parameters.json#/match" |
40 |
}, |
41 |
{ |
42 |
"$ref": "../parameters.json#/order_by" |
43 |
}, |
44 |
{ |
45 |
"$ref": "../parameters.json#/page" |
46 |
}, |
47 |
{ |
48 |
"$ref": "../parameters.json#/per_page" |
49 |
}, |
50 |
{ |
51 |
"$ref": "../parameters.json#/q_param" |
52 |
}, |
53 |
{ |
54 |
"$ref": "../parameters.json#/q_body" |
55 |
}, |
56 |
{ |
57 |
"$ref": "../parameters.json#/q_header" |
58 |
} |
59 |
], |
60 |
"produces": [ |
61 |
"application/json" |
62 |
], |
63 |
"responses": { |
64 |
"200": { |
65 |
"description": "A list of transfer limits", |
66 |
"schema": { |
67 |
"type": "array", |
68 |
"items": { |
69 |
"$ref": "../definitions.json#/transfer_limit" |
70 |
} |
71 |
} |
72 |
}, |
73 |
"500": { |
74 |
"description": "Internal error", |
75 |
"schema": { |
76 |
"$ref": "../definitions.json#/error" |
77 |
} |
78 |
}, |
79 |
"503": { |
80 |
"description": "Under maintenance", |
81 |
"schema": { |
82 |
"$ref": "../definitions.json#/error" |
83 |
} |
84 |
} |
85 |
}, |
86 |
"x-koha-authorization": { |
87 |
"permissions": { |
88 |
"parameters": "manage_transfers" |
89 |
} |
90 |
} |
91 |
}, |
92 |
"post": { |
93 |
"x-mojo-to": "TransferLimits#add", |
94 |
"operationId": "addTransferLimit", |
95 |
"tags": [ |
96 |
"transfer" |
97 |
], |
98 |
"parameters": [ |
99 |
{ |
100 |
"name": "body", |
101 |
"in": "body", |
102 |
"description": "A JSON object containing information about a new transfer limit", |
103 |
"required": true, |
104 |
"schema": { |
105 |
"$ref": "../definitions.json#/transfer_limit" |
106 |
} |
107 |
} |
108 |
], |
109 |
"produces": [ |
110 |
"application/json" |
111 |
], |
112 |
"responses": { |
113 |
"201": { |
114 |
"description": "Transfer limit added", |
115 |
"schema": { |
116 |
"$ref": "../definitions.json#/transfer_limit" |
117 |
} |
118 |
}, |
119 |
"400": { |
120 |
"description": "Bad request", |
121 |
"schema": { |
122 |
"$ref": "../definitions.json#/error" |
123 |
} |
124 |
}, |
125 |
"401": { |
126 |
"description": "Authentication required", |
127 |
"schema": { |
128 |
"$ref": "../definitions.json#/error" |
129 |
} |
130 |
}, |
131 |
"403": { |
132 |
"description": "Access forbidden", |
133 |
"schema": { |
134 |
"$ref": "../definitions.json#/error" |
135 |
} |
136 |
}, |
137 |
"409": { |
138 |
"description": "Conflict in creating resource", |
139 |
"schema": { |
140 |
"$ref": "../definitions.json#/error" |
141 |
} |
142 |
}, |
143 |
"500": { |
144 |
"description": "Internal error", |
145 |
"schema": { |
146 |
"$ref": "../definitions.json#/error" |
147 |
} |
148 |
}, |
149 |
"503": { |
150 |
"description": "Under maintenance", |
151 |
"schema": { |
152 |
"$ref": "../definitions.json#/error" |
153 |
} |
154 |
} |
155 |
}, |
156 |
"x-koha-authorization": { |
157 |
"permissions": { |
158 |
"parameters": "manage_transfers" |
159 |
} |
160 |
} |
161 |
} |
162 |
}, |
163 |
"/transfer_limits/{limit_id}": { |
164 |
"delete": { |
165 |
"x-mojo-to": "TransferLimits#delete", |
166 |
"operationId": "deleteTransferLimit", |
167 |
"tags": [ |
168 |
"transfer" |
169 |
], |
170 |
"parameters": [ |
171 |
{ |
172 |
"$ref": "../parameters.json#/transfer_limit_id_pp" |
173 |
} |
174 |
], |
175 |
"produces": [ |
176 |
"application/json" |
177 |
], |
178 |
"responses": { |
179 |
"204": { |
180 |
"description": "Transfer limit deleted", |
181 |
"schema": { |
182 |
"type": "string" |
183 |
} |
184 |
}, |
185 |
"401": { |
186 |
"description": "Authentication required", |
187 |
"schema": { |
188 |
"$ref": "../definitions.json#/error" |
189 |
} |
190 |
}, |
191 |
"403": { |
192 |
"description": "Access forbidden", |
193 |
"schema": { |
194 |
"$ref": "../definitions.json#/error" |
195 |
} |
196 |
}, |
197 |
"404": { |
198 |
"description": "Library not found", |
199 |
"schema": { |
200 |
"$ref": "../definitions.json#/error" |
201 |
} |
202 |
}, |
203 |
"500": { |
204 |
"description": "Internal error", |
205 |
"schema": { |
206 |
"$ref": "../definitions.json#/error" |
207 |
} |
208 |
}, |
209 |
"503": { |
210 |
"description": "Under maintenance", |
211 |
"schema": { |
212 |
"$ref": "../definitions.json#/error" |
213 |
} |
214 |
} |
215 |
}, |
216 |
"x-koha-authorization": { |
217 |
"permissions": { |
218 |
"parameters": "manage_transfers" |
219 |
} |
220 |
} |
221 |
} |
222 |
}, |
223 |
"/transfer_limits/batch": { |
224 |
"post": { |
225 |
"x-mojo-to": "TransferLimits#batch_add", |
226 |
"operationId": "batchAddTransferLimits", |
227 |
"tags": [ |
228 |
"transfer" |
229 |
], |
230 |
"parameters": [ |
231 |
{ |
232 |
"name": "body", |
233 |
"in": "body", |
234 |
"description": "A JSON object containing information about new transfer limits.", |
235 |
"required": true, |
236 |
"schema": { |
237 |
"type": "object", |
238 |
"properties": { |
239 |
"to_library_id": { |
240 |
"type": "string", |
241 |
"description": "Internal library id for which library the item is going to" |
242 |
}, |
243 |
"from_library_id": { |
244 |
"type": "string", |
245 |
"description": "Internal library id for which library the item is coming from" |
246 |
}, |
247 |
"item_type": { |
248 |
"type": ["string", "null"], |
249 |
"description": "Itemtype defining the type for this limi" |
250 |
}, |
251 |
"collection_code": { |
252 |
"type": ["string", "null"], |
253 |
"description": "Authorized value for the collection code associated with this limit" |
254 |
} |
255 |
}, |
256 |
"additionalProperties": false |
257 |
} |
258 |
} |
259 |
], |
260 |
"produces": [ |
261 |
"application/json" |
262 |
], |
263 |
"responses": { |
264 |
"201": { |
265 |
"description": "A list of transfer limits", |
266 |
"schema": { |
267 |
"type": "array", |
268 |
"items": { |
269 |
"$ref": "../definitions.json#/transfer_limit" |
270 |
} |
271 |
} |
272 |
}, |
273 |
"500": { |
274 |
"description": "Internal error", |
275 |
"schema": { |
276 |
"$ref": "../definitions.json#/error" |
277 |
} |
278 |
}, |
279 |
"503": { |
280 |
"description": "Under maintenance", |
281 |
"schema": { |
282 |
"$ref": "../definitions.json#/error" |
283 |
} |
284 |
} |
285 |
}, |
286 |
"x-koha-authorization": { |
287 |
"permissions": { |
288 |
"parameters": "manage_transfers" |
289 |
} |
290 |
} |
291 |
}, |
292 |
"delete": { |
293 |
"x-mojo-to": "TransferLimits#batch_delete", |
294 |
"operationId": "batchDeleteTransferLimits", |
295 |
"tags": [ |
296 |
"transfer" |
297 |
], |
298 |
"parameters": [ |
299 |
{ |
300 |
"name": "body", |
301 |
"in": "body", |
302 |
"description": "A JSON object containing information about new transfer limits.", |
303 |
"required": true, |
304 |
"schema": { |
305 |
"type": "object", |
306 |
"properties": { |
307 |
"to_library_id": { |
308 |
"type": "string", |
309 |
"description": "Internal library id for which library the item is going to" |
310 |
}, |
311 |
"from_library_id": { |
312 |
"type": "string", |
313 |
"description": "Internal library id for which library the item is coming from" |
314 |
}, |
315 |
"item_type": { |
316 |
"type": ["string", "null"], |
317 |
"description": "Itemtype defining the type for this limi" |
318 |
}, |
319 |
"collection_code": { |
320 |
"type": ["string", "null"], |
321 |
"description": "Authorized value for the collection code associated with this limit" |
322 |
} |
323 |
}, |
324 |
"additionalProperties": false |
325 |
} |
326 |
} |
327 |
], |
328 |
"produces": [ |
329 |
"application/json" |
330 |
], |
331 |
"responses": { |
332 |
"204": { |
333 |
"description": "Transfer limits deleted", |
334 |
"schema": { |
335 |
"type": "string" |
336 |
} |
337 |
}, |
338 |
"401": { |
339 |
"description": "Authentication required", |
340 |
"schema": { |
341 |
"$ref": "../definitions.json#/error" |
342 |
} |
343 |
}, |
344 |
"403": { |
345 |
"description": "Access forbidden", |
346 |
"schema": { |
347 |
"$ref": "../definitions.json#/error" |
348 |
} |
349 |
}, |
350 |
"404": { |
351 |
"description": "Library not found", |
352 |
"schema": { |
353 |
"$ref": "../definitions.json#/error" |
354 |
} |
355 |
}, |
356 |
"500": { |
357 |
"description": "Internal error", |
358 |
"schema": { |
359 |
"$ref": "../definitions.json#/error" |
360 |
} |
361 |
}, |
362 |
"503": { |
363 |
"description": "Under maintenance", |
364 |
"schema": { |
365 |
"$ref": "../definitions.json#/error" |
366 |
} |
367 |
} |
368 |
}, |
369 |
"x-koha-authorization": { |
370 |
"permissions": { |
371 |
"parameters": "manage_transfers" |
372 |
} |
373 |
} |
374 |
} |
375 |
} |
376 |
} |