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
60 x-mojo-to: Biblios#list
61 operationId: listBiblio
66 - $ref: "../swagger.yaml#/parameters/page"
67 - $ref: "../swagger.yaml#/parameters/per_page"
68 - $ref: "../swagger.yaml#/parameters/match"
69 - $ref: "../swagger.yaml#/parameters/order_by"
70 - $ref: "../swagger.yaml#/parameters/q_param"
71 - $ref: "../swagger.yaml#/parameters/q_body"
72 - $ref: "../swagger.yaml#/parameters/q_header"
73 - $ref: "../swagger.yaml#/parameters/request_id_header"
76 - application/marcxml+xml
77 - application/marc-in-json
82 description: A list of biblios
84 description: Authentication required
86 $ref: "../swagger.yaml#/definitions/error"
88 description: Access forbidden
90 $ref: "../swagger.yaml#/definitions/error"
92 description: Biblio not found
94 $ref: "../swagger.yaml#/definitions/error"
96 description: Not acceptable
99 description: Accepted content-types
104 Internal server error. Possible `error_code` attribute values:
106 * `internal_server_error`
108 $ref: "../swagger.yaml#/definitions/error"
110 description: Under maintenance
112 $ref: "../swagger.yaml#/definitions/error"
113 x-koha-authorization:
116 "/biblios/{biblio_id}":
118 x-mojo-to: Biblios#get
119 operationId: getBiblio
124 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
127 - application/marcxml+xml
128 - application/marc-in-json
133 description: A biblio
135 description: Authentication required
137 $ref: "../swagger.yaml#/definitions/error"
139 description: Access forbidden
141 $ref: "../swagger.yaml#/definitions/error"
143 description: Biblio not found
145 $ref: "../swagger.yaml#/definitions/error"
147 description: Not acceptable
150 description: Accepted content-types
155 Internal server error. Possible `error_code` attribute values:
157 * `internal_server_error`
159 $ref: "../swagger.yaml#/definitions/error"
161 description: Under maintenance
163 $ref: "../swagger.yaml#/definitions/error"
164 x-koha-authorization:
168 x-mojo-to: Biblios#delete
169 operationId: deleteBiblio
172 summary: Delete biblio
174 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
179 description: Biblio deleted
183 description: Authentication required
185 $ref: "../swagger.yaml#/definitions/error"
187 description: Access forbidden
189 $ref: "../swagger.yaml#/definitions/error"
191 description: Biblio not found
193 $ref: "../swagger.yaml#/definitions/error"
195 description: Unable to perform action on biblio
197 $ref: "../swagger.yaml#/definitions/error"
199 description: Internal error
201 $ref: "../swagger.yaml#/definitions/error"
203 description: Under maintenance
205 $ref: "../swagger.yaml#/definitions/error"
206 x-koha-authorization:
208 editcatalogue: edit_catalogue
210 x-mojo-to: Biblios#update
211 operationId: updateBiblio
214 summary: Update biblio
216 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
219 description: A JSON object or the Marc string describing a biblio
225 - $ref: "../swagger.yaml#/parameters/framework_id_header"
226 - $ref: "../swagger.yaml#/parameters/marc_schema_header"
227 - $ref: "../swagger.yaml#/parameters/confirm_not_duplicate_header"
232 description: A biblio
234 description: Bad request
236 $ref: "../swagger.yaml#/definitions/error"
238 description: Authentication required
240 $ref: "../swagger.yaml#/definitions/error"
242 description: Access forbidden
244 $ref: "../swagger.yaml#/definitions/error"
246 description: Biblio not found
248 $ref: "../swagger.yaml#/definitions/error"
250 description: Not acceptable
253 description: Accepted content-types
258 Internal server error. Possible `error_code` attribute values:
260 * `internal_server_error`
262 $ref: "../swagger.yaml#/definitions/error"
264 description: Under maintenance
266 $ref: "../swagger.yaml#/definitions/error"
267 x-koha-authorization:
269 editcatalogue: edit_catalogue
270 "/biblios/{biblio_id}/checkouts":
272 x-mojo-to: Biblios#get_checkouts
273 operationId: listBiblioCheckouts
276 summary: List checkouts for a biblio
278 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
279 - $ref: "../swagger.yaml#/parameters/page"
280 - $ref: "../swagger.yaml#/parameters/per_page"
281 - $ref: "../swagger.yaml#/parameters/match"
282 - $ref: "../swagger.yaml#/parameters/order_by"
283 - $ref: "../swagger.yaml#/parameters/q_param"
284 - $ref: "../swagger.yaml#/parameters/q_body"
285 - $ref: "../swagger.yaml#/parameters/q_header"
286 - $ref: "../swagger.yaml#/parameters/request_id_header"
290 description: Embed list sent as a request header
299 collectionFormat: csv
302 description: By default, current checkouts are returned, when this is true then
303 checked in checkouts are returned as result.
309 description: A list of checkouts
311 $ref: "../swagger.yaml#/definitions/checkouts"
313 description: Access forbidden
315 $ref: "../swagger.yaml#/definitions/error"
317 description: Biblio not found
319 $ref: "../swagger.yaml#/definitions/error"
322 Internal server error. Possible `error_code` attribute values:
324 * `internal_server_error`
326 $ref: "../swagger.yaml#/definitions/error"
328 description: Under maintenance
330 $ref: "../swagger.yaml#/definitions/error"
331 x-koha-authorization:
333 circulate: circulate_remaining_permissions
334 "/biblios/{biblio_id}/items":
336 x-mojo-to: Biblios#get_items
337 operationId: getBiblioItems
340 summary: Get items for a biblio
342 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
343 - $ref: "../swagger.yaml#/parameters/match"
344 - $ref: "../swagger.yaml#/parameters/order_by"
345 - $ref: "../swagger.yaml#/parameters/page"
346 - $ref: "../swagger.yaml#/parameters/per_page"
347 - $ref: "../swagger.yaml#/parameters/q_param"
348 - $ref: "../swagger.yaml#/parameters/q_body"
349 - $ref: "../swagger.yaml#/parameters/q_header"
350 - $ref: "../swagger.yaml#/parameters/request_id_header"
357 description: A list of the items attached to the record
361 $ref: "../swagger.yaml#/definitions/item"
363 description: Authentication required
365 $ref: "../swagger.yaml#/definitions/error"
367 description: Access forbidden
369 $ref: "../swagger.yaml#/definitions/error"
371 description: Biblio not found
373 $ref: "../swagger.yaml#/definitions/error"
375 description: Not acceptable
378 description: Accepted content-types
383 Internal server error. Possible `error_code` attribute values:
385 * `internal_server_error`
387 $ref: "../swagger.yaml#/definitions/error"
389 description: Under maintenance
391 $ref: "../swagger.yaml#/definitions/error"
392 x-koha-authorization:
395 "/biblios/{biblio_id}/pickup_locations":
397 x-mojo-to: Biblios#pickup_locations
398 operationId: getBiblioPickupLocations
401 summary: Get valid pickup locations for a biblio
403 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
406 description: Internal patron identifier
409 - $ref: "../swagger.yaml#/parameters/match"
410 - $ref: "../swagger.yaml#/parameters/order_by"
411 - $ref: "../swagger.yaml#/parameters/page"
412 - $ref: "../swagger.yaml#/parameters/per_page"
413 - $ref: "../swagger.yaml#/parameters/q_param"
414 - $ref: "../swagger.yaml#/parameters/q_body"
415 - $ref: "../swagger.yaml#/parameters/q_header"
422 description: Biblio pickup locations
426 $ref: "../swagger.yaml#/definitions/library"
428 description: Missing or wrong parameters
430 $ref: "../swagger.yaml#/definitions/error"
432 description: Authentication required
434 $ref: "../swagger.yaml#/definitions/error"
436 description: Access forbidden
438 $ref: "../swagger.yaml#/definitions/error"
440 description: Biblio not found
442 $ref: "../swagger.yaml#/definitions/error"
445 Internal server error. Possible `error_code` attribute values:
447 * `internal_server_error`
449 $ref: "../swagger.yaml#/definitions/error"
451 description: Under maintenance
453 $ref: "../swagger.yaml#/definitions/error"
454 x-koha-authorization:
456 reserveforothers: place_holds
457 "/public/biblios/{biblio_id}":
459 x-mojo-to: Biblios#get_public
460 operationId: getBiblioPublic
463 summary: Get biblio (public)
465 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
467 - application/marcxml+xml
468 - application/marc-in-json
473 description: A biblio
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}/items":
506 x-mojo-to: Biblios#get_items_public
507 operationId: getBiblioItemsPublic
512 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
513 - $ref: "../swagger.yaml#/parameters/match"
514 - $ref: "../swagger.yaml#/parameters/order_by"
515 - $ref: "../swagger.yaml#/parameters/page"
516 - $ref: "../swagger.yaml#/parameters/per_page"
517 - $ref: "../swagger.yaml#/parameters/q_param"
518 - $ref: "../swagger.yaml#/parameters/q_body"
519 - $ref: "../swagger.yaml#/parameters/q_header"
526 description: A list of the items attached to the record
530 $ref: "../swagger.yaml#/definitions/item"
532 description: Authentication required
534 $ref: "../swagger.yaml#/definitions/error"
536 description: Access forbidden
538 $ref: "../swagger.yaml#/definitions/error"
540 description: Biblio not found
542 $ref: "../swagger.yaml#/definitions/error"
544 description: Not acceptable
547 description: Accepted content-types
552 Internal server error. Possible `error_code` attribute values:
554 * `internal_server_error`
556 $ref: "../swagger.yaml#/definitions/error"
558 description: Under maintenance
560 $ref: "../swagger.yaml#/definitions/error"
561 "/public/biblios/{biblio_id}/ratings":
563 x-mojo-to: Biblios#set_rating
564 operationId: setBiblioRating
567 summary: set biblio rating (public)
569 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
572 description: A JSON object containing rating information
577 description: the rating
583 additionalProperties: false
588 description: Rating set
593 description: user's rating
598 description: average rating
601 description: number of ratings
603 additionalProperties: false
605 description: Authentication required
607 $ref: "../swagger.yaml#/definitions/error"
609 description: Access forbidden
611 $ref: "../swagger.yaml#/definitions/error"
613 description: Biblio not found
615 $ref: "../swagger.yaml#/definitions/error"
618 Internal server error. Possible `error_code` attribute values:
620 * `internal_server_error`
622 $ref: "../swagger.yaml#/definitions/error"
624 description: Under maintenance
626 $ref: "../swagger.yaml#/definitions/error"