12 description: A JSON object or the Marc string describing a biblio
18 - $ref: "../swagger.yaml#/parameters/framework_id_header"
19 - $ref: "../swagger.yaml#/parameters/marc_schema_header"
20 - $ref: "../swagger.yaml#/parameters/confirm_not_duplicate_header"
27 description: Bad request
29 $ref: "../swagger.yaml#/definitions/error"
31 description: Authentication required
33 $ref: "../swagger.yaml#/definitions/error"
35 description: Access forbidden
37 $ref: "../swagger.yaml#/definitions/error"
39 description: Not acceptable
42 description: Accepted content-types
47 Internal server error. Possible `error_code` attribute values:
49 * `internal_server_error`
51 $ref: "../swagger.yaml#/definitions/error"
53 description: Under maintenance
55 $ref: "../swagger.yaml#/definitions/error"
58 editcatalogue: edit_catalogue
59 "/biblios/{biblio_id}":
61 x-mojo-to: Biblios#get
62 operationId: getBiblio
67 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
70 - application/marcxml+xml
71 - application/marc-in-json
78 description: Authentication required
80 $ref: "../swagger.yaml#/definitions/error"
82 description: Access forbidden
84 $ref: "../swagger.yaml#/definitions/error"
86 description: Biblio not found
88 $ref: "../swagger.yaml#/definitions/error"
90 description: Not acceptable
93 description: Accepted content-types
98 Internal server error. Possible `error_code` attribute values:
100 * `internal_server_error`
102 $ref: "../swagger.yaml#/definitions/error"
104 description: Under maintenance
106 $ref: "../swagger.yaml#/definitions/error"
107 x-koha-authorization:
111 x-mojo-to: Biblios#delete
112 operationId: deleteBiblio
115 summary: Delete biblio
117 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
122 description: Biblio deleted
126 description: Authentication required
128 $ref: "../swagger.yaml#/definitions/error"
130 description: Access forbidden
132 $ref: "../swagger.yaml#/definitions/error"
134 description: Biblio not found
136 $ref: "../swagger.yaml#/definitions/error"
138 description: Unable to perform action on biblio
140 $ref: "../swagger.yaml#/definitions/error"
142 description: Internal error
144 $ref: "../swagger.yaml#/definitions/error"
146 description: Under maintenance
148 $ref: "../swagger.yaml#/definitions/error"
149 x-koha-authorization:
151 editcatalogue: edit_catalogue
153 x-mojo-to: Biblios#update
154 operationId: updateBiblio
157 summary: Update biblio
159 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
162 description: A JSON object or the Marc string describing a biblio
168 - $ref: "../swagger.yaml#/parameters/framework_id_header"
169 - $ref: "../swagger.yaml#/parameters/marc_schema_header"
170 - $ref: "../swagger.yaml#/parameters/confirm_not_duplicate_header"
175 description: A biblio
177 description: Bad request
179 $ref: "../swagger.yaml#/definitions/error"
181 description: Authentication required
183 $ref: "../swagger.yaml#/definitions/error"
185 description: Access forbidden
187 $ref: "../swagger.yaml#/definitions/error"
189 description: Biblio not found
191 $ref: "../swagger.yaml#/definitions/error"
193 description: Not acceptable
196 description: Accepted content-types
201 Internal server error. Possible `error_code` attribute values:
203 * `internal_server_error`
205 $ref: "../swagger.yaml#/definitions/error"
207 description: Under maintenance
209 $ref: "../swagger.yaml#/definitions/error"
210 x-koha-authorization:
212 editcatalogue: edit_catalogue
213 "/biblios/{biblio_id}/checkouts":
215 x-mojo-to: Biblios#get_checkouts
216 operationId: listBiblioCheckouts
219 summary: List checkouts for a biblio
221 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
222 - $ref: "../swagger.yaml#/parameters/page"
223 - $ref: "../swagger.yaml#/parameters/per_page"
224 - $ref: "../swagger.yaml#/parameters/match"
225 - $ref: "../swagger.yaml#/parameters/order_by"
226 - $ref: "../swagger.yaml#/parameters/q_param"
227 - $ref: "../swagger.yaml#/parameters/q_body"
228 - $ref: "../swagger.yaml#/parameters/q_header"
229 - $ref: "../swagger.yaml#/parameters/request_id_header"
233 description: Embed list sent as a request header
242 collectionFormat: csv
245 description: By default, current checkouts are returned, when this is true then
246 checked in checkouts are returned as result.
252 description: A list of checkouts
254 $ref: "../swagger.yaml#/definitions/checkouts"
256 description: Access forbidden
258 $ref: "../swagger.yaml#/definitions/error"
260 description: Biblio not found
262 $ref: "../swagger.yaml#/definitions/error"
265 Internal server error. Possible `error_code` attribute values:
267 * `internal_server_error`
269 $ref: "../swagger.yaml#/definitions/error"
271 description: Under maintenance
273 $ref: "../swagger.yaml#/definitions/error"
274 x-koha-authorization:
276 circulate: circulate_remaining_permissions
277 "/biblios/{biblio_id}/items":
279 x-mojo-to: Biblios#get_items
280 operationId: getBiblioItems
283 summary: Get items for a biblio
285 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
286 - $ref: "../swagger.yaml#/parameters/match"
287 - $ref: "../swagger.yaml#/parameters/order_by"
288 - $ref: "../swagger.yaml#/parameters/page"
289 - $ref: "../swagger.yaml#/parameters/per_page"
290 - $ref: "../swagger.yaml#/parameters/q_param"
291 - $ref: "../swagger.yaml#/parameters/q_body"
292 - $ref: "../swagger.yaml#/parameters/q_header"
293 - $ref: "../swagger.yaml#/parameters/request_id_header"
300 description: A list of the items attached to the record
304 $ref: "../swagger.yaml#/definitions/item"
306 description: Authentication required
308 $ref: "../swagger.yaml#/definitions/error"
310 description: Access forbidden
312 $ref: "../swagger.yaml#/definitions/error"
314 description: Biblio not found
316 $ref: "../swagger.yaml#/definitions/error"
318 description: Not acceptable
321 description: Accepted content-types
326 Internal server error. Possible `error_code` attribute values:
328 * `internal_server_error`
330 $ref: "../swagger.yaml#/definitions/error"
332 description: Under maintenance
334 $ref: "../swagger.yaml#/definitions/error"
335 x-koha-authorization:
338 "/biblios/{biblio_id}/pickup_locations":
340 x-mojo-to: Biblios#pickup_locations
341 operationId: getBiblioPickupLocations
344 summary: Get valid pickup locations for a biblio
346 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
349 description: Internal patron identifier
352 - $ref: "../swagger.yaml#/parameters/match"
353 - $ref: "../swagger.yaml#/parameters/order_by"
354 - $ref: "../swagger.yaml#/parameters/page"
355 - $ref: "../swagger.yaml#/parameters/per_page"
356 - $ref: "../swagger.yaml#/parameters/q_param"
357 - $ref: "../swagger.yaml#/parameters/q_body"
358 - $ref: "../swagger.yaml#/parameters/q_header"
365 description: Biblio pickup locations
369 $ref: "../swagger.yaml#/definitions/library"
371 description: Missing or wrong parameters
373 $ref: "../swagger.yaml#/definitions/error"
375 description: Authentication required
377 $ref: "../swagger.yaml#/definitions/error"
379 description: Access forbidden
381 $ref: "../swagger.yaml#/definitions/error"
383 description: Biblio not found
385 $ref: "../swagger.yaml#/definitions/error"
388 Internal server error. Possible `error_code` attribute values:
390 * `internal_server_error`
392 $ref: "../swagger.yaml#/definitions/error"
394 description: Under maintenance
396 $ref: "../swagger.yaml#/definitions/error"
397 x-koha-authorization:
399 reserveforothers: place_holds
400 "/public/biblios/{biblio_id}":
402 x-mojo-to: Biblios#get_public
403 operationId: getBiblioPublic
406 summary: Get biblio (public)
408 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
410 - application/marcxml+xml
411 - application/marc-in-json
416 description: A biblio
418 description: Authentication required
420 $ref: "../swagger.yaml#/definitions/error"
422 description: Access forbidden
424 $ref: "../swagger.yaml#/definitions/error"
426 description: Biblio not found
428 $ref: "../swagger.yaml#/definitions/error"
430 description: Not acceptable
433 description: Accepted content-types
438 Internal server error. Possible `error_code` attribute values:
440 * `internal_server_error`
442 $ref: "../swagger.yaml#/definitions/error"
444 description: Under maintenance
446 $ref: "../swagger.yaml#/definitions/error"
447 "/public/biblios/{biblio_id}/items":
449 x-mojo-to: Biblios#get_items_public
450 operationId: getBiblioItemsPublic
455 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
456 - $ref: "../swagger.yaml#/parameters/match"
457 - $ref: "../swagger.yaml#/parameters/order_by"
458 - $ref: "../swagger.yaml#/parameters/page"
459 - $ref: "../swagger.yaml#/parameters/per_page"
460 - $ref: "../swagger.yaml#/parameters/q_param"
461 - $ref: "../swagger.yaml#/parameters/q_body"
462 - $ref: "../swagger.yaml#/parameters/q_header"
469 description: A list of the items attached to the record
473 $ref: "../swagger.yaml#/definitions/item"
475 description: Authentication required
477 $ref: "../swagger.yaml#/definitions/error"
479 description: Access forbidden
481 $ref: "../swagger.yaml#/definitions/error"
483 description: Biblio not found
485 $ref: "../swagger.yaml#/definitions/error"
487 description: Not acceptable
490 description: Accepted content-types
495 Internal server error. Possible `error_code` attribute values:
497 * `internal_server_error`
499 $ref: "../swagger.yaml#/definitions/error"
501 description: Under maintenance
503 $ref: "../swagger.yaml#/definitions/error"
504 "/public/biblios/{biblio_id}/ratings":
506 x-mojo-to: Biblios#set_rating
507 operationId: setBiblioRating
510 summary: set biblio rating (public)
512 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
515 description: A JSON object containing rating information
520 description: the rating
526 additionalProperties: false
531 description: Rating set
536 description: user's rating
541 description: average rating
544 description: number of ratings
546 additionalProperties: false
548 description: Authentication required
550 $ref: "../swagger.yaml#/definitions/error"
552 description: Access forbidden
554 $ref: "../swagger.yaml#/definitions/error"
556 description: Biblio not found
558 $ref: "../swagger.yaml#/definitions/error"
561 Internal server error. Possible `error_code` attribute values:
563 * `internal_server_error`
565 $ref: "../swagger.yaml#/definitions/error"
567 description: Under maintenance
569 $ref: "../swagger.yaml#/definitions/error"