10 Add a bibliographic record to Koha. An optional `x-framework-id`
11 may be passed to specify the cataloguing framework to be used (instead
14 The request body is expected to contain a MARC record in the format specified in
15 the `Content-type` header you pass. Possible values for this header and the corresponding
16 record formats expected are listed below:
18 * application/marcxml+xml: MARCXML
19 * application/marc-in-json: MARC-in-JSON
20 * application/marc: Raw USMARC binary data
22 - $ref: "../swagger.yaml#/parameters/framework_id_header"
23 - $ref: "../swagger.yaml#/parameters/marc_schema_header"
24 - $ref: "../swagger.yaml#/parameters/confirm_not_duplicate_header"
31 description: Bad request
33 $ref: "../swagger.yaml#/definitions/error"
35 description: Authentication required
37 $ref: "../swagger.yaml#/definitions/error"
39 description: Access forbidden
41 $ref: "../swagger.yaml#/definitions/error"
43 description: Not acceptable
46 description: Accepted content-types
51 Internal server error. Possible `error_code` attribute values:
53 * `internal_server_error`
55 $ref: "../swagger.yaml#/definitions/error"
57 description: Under maintenance
59 $ref: "../swagger.yaml#/definitions/error"
62 editcatalogue: edit_catalogue
64 x-mojo-to: Biblios#list
65 operationId: listBiblio
70 - $ref: "../swagger.yaml#/parameters/page"
71 - $ref: "../swagger.yaml#/parameters/per_page"
72 - $ref: "../swagger.yaml#/parameters/match"
73 - $ref: "../swagger.yaml#/parameters/order_by"
74 - $ref: "../swagger.yaml#/parameters/q_param"
75 - $ref: "../swagger.yaml#/parameters/q_body"
76 - $ref: "../swagger.yaml#/parameters/q_header"
77 - $ref: "../swagger.yaml#/parameters/request_id_header"
80 - application/marcxml+xml
81 - application/marc-in-json
86 description: A list of biblios
88 description: Authentication required
90 $ref: "../swagger.yaml#/definitions/error"
92 description: Access forbidden
94 $ref: "../swagger.yaml#/definitions/error"
96 description: Biblio not found
98 $ref: "../swagger.yaml#/definitions/error"
100 description: Not acceptable
103 description: Accepted content-types
108 Internal server error. Possible `error_code` attribute values:
110 * `internal_server_error`
112 $ref: "../swagger.yaml#/definitions/error"
114 description: Under maintenance
116 $ref: "../swagger.yaml#/definitions/error"
117 x-koha-authorization:
120 "/biblios/{biblio_id}":
122 x-mojo-to: Biblios#get
123 operationId: getBiblio
128 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
131 - application/marcxml+xml
132 - application/marc-in-json
137 description: A biblio
139 description: Authentication required
141 $ref: "../swagger.yaml#/definitions/error"
143 description: Access forbidden
145 $ref: "../swagger.yaml#/definitions/error"
147 description: Biblio not found
149 $ref: "../swagger.yaml#/definitions/error"
151 description: Not acceptable
154 description: Accepted content-types
159 Internal server error. Possible `error_code` attribute values:
161 * `internal_server_error`
163 $ref: "../swagger.yaml#/definitions/error"
165 description: Under maintenance
167 $ref: "../swagger.yaml#/definitions/error"
168 x-koha-authorization:
172 x-mojo-to: Biblios#delete
173 operationId: deleteBiblio
176 summary: Delete biblio
178 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
183 description: Biblio deleted
187 description: Authentication required
189 $ref: "../swagger.yaml#/definitions/error"
191 description: Access forbidden
193 $ref: "../swagger.yaml#/definitions/error"
195 description: Biblio not found
197 $ref: "../swagger.yaml#/definitions/error"
199 description: Unable to perform action on biblio
201 $ref: "../swagger.yaml#/definitions/error"
203 description: Internal 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
214 x-mojo-to: Biblios#update
215 operationId: updateBiblio
218 summary: Update biblio
220 Updates a bibliographic record to Koha. An optional `x-framework-id`
221 may be passed, to specify the cataloguing framework to be used (instead
224 The request body is expected to contain a MARC record in the format specified by
225 the `Content-type` header passed. Possible values for this headers and the corresponding
226 record formats expected are listed below:
228 * application/marcxml+xml: MARCXML
229 * application/marc-in-json: MARC-in-JSON
230 * application/marc: Raw USMARC binary data
232 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
233 - $ref: "../swagger.yaml#/parameters/framework_id_header"
234 - $ref: "../swagger.yaml#/parameters/marc_schema_header"
235 - $ref: "../swagger.yaml#/parameters/confirm_not_duplicate_header"
240 description: A biblio
242 description: Bad request
244 $ref: "../swagger.yaml#/definitions/error"
246 description: Authentication required
248 $ref: "../swagger.yaml#/definitions/error"
250 description: Access forbidden
252 $ref: "../swagger.yaml#/definitions/error"
254 description: Biblio not found
256 $ref: "../swagger.yaml#/definitions/error"
258 description: Not acceptable
261 description: Accepted content-types
266 Internal server error. Possible `error_code` attribute values:
268 * `internal_server_error`
270 $ref: "../swagger.yaml#/definitions/error"
272 description: Under maintenance
274 $ref: "../swagger.yaml#/definitions/error"
275 x-koha-authorization:
277 editcatalogue: edit_catalogue
278 "/biblios/{biblio_id}/checkouts":
280 x-mojo-to: Biblios#get_checkouts
281 operationId: listBiblioCheckouts
284 summary: List checkouts for a biblio
286 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
287 - $ref: "../swagger.yaml#/parameters/page"
288 - $ref: "../swagger.yaml#/parameters/per_page"
289 - $ref: "../swagger.yaml#/parameters/match"
290 - $ref: "../swagger.yaml#/parameters/order_by"
291 - $ref: "../swagger.yaml#/parameters/q_param"
292 - $ref: "../swagger.yaml#/parameters/q_body"
293 - $ref: "../swagger.yaml#/parameters/q_header"
294 - $ref: "../swagger.yaml#/parameters/request_id_header"
298 description: Embed list sent as a request header
307 collectionFormat: csv
310 description: By default, current checkouts are returned, when this is true then
311 checked in checkouts are returned as result.
317 description: A list of checkouts
319 $ref: "../swagger.yaml#/definitions/checkouts"
321 description: Access forbidden
323 $ref: "../swagger.yaml#/definitions/error"
325 description: Biblio not found
327 $ref: "../swagger.yaml#/definitions/error"
330 Internal server error. Possible `error_code` attribute values:
332 * `internal_server_error`
334 $ref: "../swagger.yaml#/definitions/error"
336 description: Under maintenance
338 $ref: "../swagger.yaml#/definitions/error"
339 x-koha-authorization:
341 circulate: circulate_remaining_permissions
342 "/biblios/{biblio_id}/items":
344 x-mojo-to: Biblios#get_items
345 operationId: getBiblioItems
348 summary: Get items for a biblio
350 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
351 - $ref: "../swagger.yaml#/parameters/match"
352 - $ref: "../swagger.yaml#/parameters/order_by"
353 - $ref: "../swagger.yaml#/parameters/page"
354 - $ref: "../swagger.yaml#/parameters/per_page"
355 - $ref: "../swagger.yaml#/parameters/q_param"
356 - $ref: "../swagger.yaml#/parameters/q_body"
357 - $ref: "../swagger.yaml#/parameters/q_header"
358 - $ref: "../swagger.yaml#/parameters/request_id_header"
365 description: A list of the items attached to the record
369 $ref: "../swagger.yaml#/definitions/item"
371 description: Authentication required
373 $ref: "../swagger.yaml#/definitions/error"
375 description: Access forbidden
377 $ref: "../swagger.yaml#/definitions/error"
379 description: Biblio not found
381 $ref: "../swagger.yaml#/definitions/error"
383 description: Not acceptable
386 description: Accepted content-types
391 Internal server error. Possible `error_code` attribute values:
393 * `internal_server_error`
395 $ref: "../swagger.yaml#/definitions/error"
397 description: Under maintenance
399 $ref: "../swagger.yaml#/definitions/error"
400 x-koha-authorization:
404 x-mojo-to: Biblios#add_item
405 operationId: addBiblioItem
408 summary: Add an item for a biblio
410 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
413 description: A JSON object containing information about the new item
416 $ref: "../swagger.yaml#/definitions/item"
421 description: Item added
423 $ref: "../swagger.yaml#/definitions/item"
425 description: Bad request
427 $ref: "../swagger.yaml#/definitions/error"
429 description: Authentication required
431 $ref: "../swagger.yaml#/definitions/error"
433 description: Access forbidden
435 $ref: "../swagger.yaml#/definitions/error"
437 description: Not found
439 $ref: "../swagger.yaml#/definitions/error"
442 Internal server error. Possible `error_code` attribute values:
444 * `internal_server_error`
446 $ref: "../swagger.yaml#/definitions/error"
448 description: Under maintenance
450 $ref: "../swagger.yaml#/definitions/error"
451 x-koha-authorization:
453 editcatalogue: edit_catalogue
454 "/biblios/{biblio_id}/pickup_locations":
456 x-mojo-to: Biblios#pickup_locations
457 operationId: getBiblioPickupLocations
460 summary: Get valid pickup locations for a biblio
462 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
465 description: Internal patron identifier
468 - $ref: "../swagger.yaml#/parameters/match"
469 - $ref: "../swagger.yaml#/parameters/order_by"
470 - $ref: "../swagger.yaml#/parameters/page"
471 - $ref: "../swagger.yaml#/parameters/per_page"
472 - $ref: "../swagger.yaml#/parameters/q_param"
473 - $ref: "../swagger.yaml#/parameters/q_body"
474 - $ref: "../swagger.yaml#/parameters/q_header"
481 description: Biblio pickup locations
485 $ref: "../swagger.yaml#/definitions/library"
487 description: Missing or wrong parameters
489 $ref: "../swagger.yaml#/definitions/error"
491 description: Authentication required
493 $ref: "../swagger.yaml#/definitions/error"
495 description: Access forbidden
497 $ref: "../swagger.yaml#/definitions/error"
499 description: Biblio not found
501 $ref: "../swagger.yaml#/definitions/error"
504 Internal server error. Possible `error_code` attribute values:
506 * `internal_server_error`
508 $ref: "../swagger.yaml#/definitions/error"
510 description: Under maintenance
512 $ref: "../swagger.yaml#/definitions/error"
513 x-koha-authorization:
515 reserveforothers: place_holds
516 "/public/biblios/{biblio_id}":
518 x-mojo-to: Biblios#get_public
519 operationId: getBiblioPublic
522 summary: Get biblio (public)
524 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
526 - application/marcxml+xml
527 - application/marc-in-json
532 description: A biblio
534 description: Authentication required
536 $ref: "../swagger.yaml#/definitions/error"
538 description: Access forbidden
540 $ref: "../swagger.yaml#/definitions/error"
542 description: Biblio not found
544 $ref: "../swagger.yaml#/definitions/error"
546 description: Not acceptable
549 description: Accepted content-types
554 Internal server error. Possible `error_code` attribute values:
556 * `internal_server_error`
558 $ref: "../swagger.yaml#/definitions/error"
560 description: Under maintenance
562 $ref: "../swagger.yaml#/definitions/error"
563 "/public/biblios/{biblio_id}/items":
565 x-mojo-to: Biblios#get_items_public
566 operationId: getBiblioItemsPublic
571 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
572 - $ref: "../swagger.yaml#/parameters/match"
573 - $ref: "../swagger.yaml#/parameters/order_by"
574 - $ref: "../swagger.yaml#/parameters/page"
575 - $ref: "../swagger.yaml#/parameters/per_page"
576 - $ref: "../swagger.yaml#/parameters/q_param"
577 - $ref: "../swagger.yaml#/parameters/q_body"
578 - $ref: "../swagger.yaml#/parameters/q_header"
582 description: Embed list sent as a request header
588 collectionFormat: csv
595 description: A list of the items attached to the record
599 $ref: "../swagger.yaml#/definitions/item"
601 description: Authentication required
603 $ref: "../swagger.yaml#/definitions/error"
605 description: Access forbidden
607 $ref: "../swagger.yaml#/definitions/error"
609 description: Biblio not found
611 $ref: "../swagger.yaml#/definitions/error"
613 description: Not acceptable
616 description: Accepted content-types
621 Internal server error. Possible `error_code` attribute values:
623 * `internal_server_error`
625 $ref: "../swagger.yaml#/definitions/error"
627 description: Under maintenance
629 $ref: "../swagger.yaml#/definitions/error"
630 "/public/biblios/{biblio_id}/ratings":
632 x-mojo-to: Biblios#set_rating
633 operationId: setBiblioRating
636 summary: set biblio rating (public)
638 - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
641 description: A JSON object containing rating information
646 description: the rating
652 additionalProperties: false
657 description: Rating set
662 description: user's rating
667 description: average rating
670 description: number of ratings
672 additionalProperties: false
674 description: Authentication required
676 $ref: "../swagger.yaml#/definitions/error"
678 description: Access forbidden
680 $ref: "../swagger.yaml#/definitions/error"
682 description: Biblio not found
684 $ref: "../swagger.yaml#/definitions/error"
687 Internal server error. Possible `error_code` attribute values:
689 * `internal_server_error`
691 $ref: "../swagger.yaml#/definitions/error"
693 description: Under maintenance
695 $ref: "../swagger.yaml#/definitions/error"