{"basePath":"\/api\/v1","definitions":{"DefaultResponse":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"},"path":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"}},"required":["errors"],"type":"object"},"account_line":{"additionalProperties":false,"properties":{"account_line_id":{"description":"Internal account line identifier","readOnly":true,"type":["integer","null"]},"amount":{"description":"Account line amount","type":"number"},"amount_outstanding":{"description":"Outstanding amount","readOnly":true,"type":"number"},"cash_register_id":{"description":"Internal identifier for the cash register used for the payment (if any)","type":["integer","null"]},"checkout_id":{"description":"Internal identifier for the checkout the account line is related to","type":["integer","null"]},"credit_number":{"description":"Internally generated identifier for credits","readOnly":true,"type":["string","null"]},"credit_type":{"description":"Account line credit type","type":["string","null"]},"date":{"description":"Date the account line was created","format":"date-time","readOnly":true,"type":"string"},"debit_type":{"description":"Account line debit type","type":["string","null"]},"description":{"description":"Account line description","readOnly":true,"type":["string","null"]},"interface":{"description":"Interface in which the account line was generated (values can be: api, cron, commandline, intranet, opac and sip)","readOnly":true,"type":["string","null"]},"internal_note":{"description":"Internal note","type":["string","null"]},"item_id":{"description":"Internal identifier for the item the account line is related to","type":["integer","null"]},"library_id":{"description":"Internal identifier for the library in which the transaction took place","type":["string","null"]},"old_checkout_id":{"description":"Internal identifier for the old checkout the account line is related to","type":["integer","null"]},"patron_id":{"description":"Internal identifier for the patron the account line belongs to","readOnly":true,"type":"integer"},"payment_type":{"description":"Payment type","type":["string","null"]},"payout_type":{"description":"Payout type","type":["string","null"]},"status":{"description":"The credit\/debit status","readOnly":true,"type":["string","null"]},"timestamp":{"description":"Timestamp for the latest line update","format":"date-time","readOnly":true,"type":"string"},"user_id":{"description":"Internal patron identifier for the staff member that introduced the account line","type":["integer","null"]}},"required":["amount"],"type":"object"},"additional_content":{"additionalProperties":false,"properties":{"additional_content_id":{"description":"Internal identifier for the additional content","type":"integer"},"category":{"description":"Category of the additional content","type":"string"},"code":{"description":"Code of the additional content","type":"string"},"expirationdate":{"description":"Expiration date of the additional content","type":"string"},"library_id":{"description":"Library id of the additional content","type":["string","null"]},"location":{"description":"Location of the additional content","type":"string"},"number":{"description":"The order in which this additional content appears in that specific location","type":"integer"},"patron_id":{"description":"The author of the additional content","type":["string","null"]},"published_on":{"description":"Publication date of the additional content","type":"string"},"translated_contents":{"description":"Related additional contents translations","type":["array","null"]},"updated_on":{"description":"Last modification date of the additional content","type":"string"}},"required":["additional_content_id","category","code","location"],"type":"object"},"advancededitormacro":{"additionalProperties":false,"properties":{"macro_id":{"description":"Internal advanced editor macro identifier","readOnly":true,"type":"integer"},"macro_text":{"description":"macro text","type":["string","null"]},"name":{"description":"macro name","type":"string"},"patron_id":{"description":"borrower number","type":["integer","null"]},"shared":{"description":"is macro shared","type":["boolean","null"]}},"required":["name","macro_text","patron_id","shared"],"type":"object"},"allows_renewal":{"additionalProperties":false,"properties":{"allows_renewal":{"description":"Renewability status; true = renewable, false = not renewable","type":"boolean"},"current_renewals":{"description":"Current used renewals","type":"integer"},"error":{"description":"Description on false allows_renewal.","type":["string","null"]},"max_renewals":{"description":"Maximum number of possible renewals","type":"integer"},"unseen_renewals":{"description":"Number of consecutive times the item was renewed without being seen","type":"integer"}},"type":"object"},"authorised_value":{"additionalProperties":false,"properties":{"authorised_value_id":{"description":"internally assigned authorised value identifier","readOnly":true,"type":"integer"},"category_name":{"description":"the category of this authorised value","type":"string"},"description":{"description":"The staff interface description for this authorised value","type":"string"},"image_url":{"description":"The url of the image associated with this authorised value, if any","type":["string","null"]},"opac_description":{"description":"The public interface description of this authorised value, if set\"","type":["string","null"]},"value":{"description":"The code for this authorised value","type":"string"}},"required":["category_name","value","description"],"type":"object"},"authorised_value_category":{"additionalProperties":false,"properties":{"authorised_values":{"description":"This category's authorised values","items":{"$ref":"#\/definitions\/authorised_value"},"type":"array"},"category_name":{"description":"Unique category name primary key","readOnly":true,"type":"string"},"is_integer_only":{"description":"Is this category integer only or not","readOnly":true},"is_system":{"description":"Is this category system or not","readOnly":true,"type":"boolean"}},"required":["category_name"],"type":"object"},"basket":{"additionalProperties":false,"properties":{"basket_group_id":{"description":"links this basket to its group (aqbasketgroups.id)","type":["integer","null"]},"basket_id":{"description":"Internal identifier for the basket","type":"integer"},"billing_library_id":{"description":"basket billing place","type":["string","null"]},"close_date":{"description":"The date the basket was closed","format":"date","type":["string","null"]},"closed":{"description":"Is the basket closed","type":"boolean"},"contract_id":{"description":"Internal identifier of the linked contract","type":["integer","null"]},"create_items":{"description":"When items should be created for orders in this basket (Options: 'ordering', 'receiving', 'cataloguing'. Null means system wide config)","enum":["ordering","receiving","cataloguing",null],"type":["string","null"]},"creation_date":{"description":"The date the basket was created","format":"date","type":["string","null"]},"creator_id":{"description":"Internal patron identifier of the basket creator","type":["integer","null"]},"days_late":{"description":"The number of days the basket is late (x-koha-embed)","type":["integer","null"]},"delivery_library_id":{"description":"basket delivery place","type":["string","null"]},"internal_note":{"description":"Internal note","type":["string","null"]},"library_id":{"description":"Library the basket belongs to","type":["integer","null"]},"name":{"description":"Basket name","type":["string","null"]},"standing":{"description":"If the orders in this basket are standing","type":"boolean"},"vendor_id":{"description":"Internal identifier for the vendor","type":"integer"},"vendor_note":{"description":"Vendor note","type":["string","null"]}},"required":["vendor_id"],"type":"object"},"booking":{"additionalProperties":false,"properties":{"biblio":{"description":"Embedable biblio representation","type":"object"},"biblio_id":{"description":"Internal identifier for the parent bibliographic record","type":"integer"},"booking_id":{"description":"Internal booking identifier","type":"integer"},"cancellation_reason":{"description":"Booking cancellation reason","type":["string","null"]},"creation_date":{"description":"Creation date and time of this booking","format":"date-time","readOnly":true,"type":"string"},"end_date":{"description":"Start date and time of this booking","format":"date-time","type":"string"},"item":{"description":"Embedable item representation","type":["object","null"]},"item_id":{"description":"Internal item identifier","type":["integer","null"]},"modification_date":{"description":"Modification date and time of this booking","format":"date-time","readOnly":true,"type":"string"},"patron":{"description":"Embedable patron representation","type":["object","null"]},"patron_id":{"description":"Internal patron identifier","type":"integer"},"pickup_library":{"description":"Embedable pickup_library representation","type":["object","null"]},"pickup_library_id":{"description":"Internal pickup_library identifier","type":"string"},"start_date":{"description":"Start date and time of this booking","format":"date-time","type":"string"},"status":{"description":"Status of the booking","type":["string","null"]}},"required":["biblio_id","item_id","patron_id","pickup_library_id","start_date","end_date"],"type":"object"},"booking_patch":{"additionalProperties":false,"properties":{"biblio_id":{"description":"Internal identifier for the parent bibliographic record","type":"integer"},"booking_id":{"description":"Internal booking identifier","readOnly":true,"type":"integer"},"cancellation_reason":{"description":"Booking cancellation reason","type":["string","null"]},"creation_date":{"description":"Creation date and time of this booking","format":"date-time","readOnly":true,"type":"string"},"end_date":{"description":"Start date and time of this booking","format":"date-time","type":"string"},"item_id":{"description":"Internal item identifier","type":["integer","null"]},"modification_date":{"description":"Modification date and time of this booking","format":"date-time","readOnly":true,"type":"string"},"patron_id":{"description":"Internal patron identifier","type":"integer"},"pickup_library_id":{"description":"Internal pickup_library identifier","type":"string"},"start_date":{"description":"Start date and time of this booking","format":"date-time","type":"string"},"status":{"description":"Status of the booking","type":["string","null"]}},"type":"object"},"bundle_link":{"additionalProperties":false,"properties":{"external_id":{"description":"Item barcode","type":["string","null"]},"force_checkin":{"type":["boolean","null"]},"ignore_holds":{"type":["boolean","null"]},"item_id":{"description":"Internal item identifier","type":["integer","null"]},"marc_link":{"description":"Is there a MARC link for this item","type":"boolean"}},"type":"object"},"cash_register":{"additionalProperties":false,"properties":{"archived":{"description":"If this till is archived","type":"boolean"},"cash_register_id":{"description":"Internal cash register identifier","type":"integer"},"description":{"description":"A description","type":"string"},"library_default":{"description":"If this till is the library default","type":"boolean"},"library_id":{"description":"Internally assigned library identifier","maxLength":10,"minLength":1,"type":"string"},"name":{"description":"The cash register display name","type":"string"},"starting_float":{"description":"The starting float this account register should be assigned","type":["number","null"]}},"required":["cash_register_id","name","library_id"],"type":"object"},"cashup":{"additionalProperties":false,"properties":{"amount":{"description":"Account line amount","type":"number"},"cash_register_id":{"description":"Internal identifier for the register the cashup belongs to","type":"integer"},"cashup_id":{"description":"Internal cashup identifier","type":"integer"},"manager":{"description":"The object representing the manager the cashup was performed by","type":["object","null"]},"manager_id":{"description":"Internal identifier for the manager the cashup was performed by","type":"integer"},"summary":{"description":"A summary of the cashup action","type":"object"},"timestamp":{"description":"Timestamp for the latest line update","format":"date-time","type":"string"}},"type":"object"},"checkout":{"additionalProperties":false,"properties":{"auto_renew":{"description":"Auto renewal","type":"boolean"},"auto_renew_error":{"description":"Auto renewal error","type":["string","null"]},"booking":{"description":"The object representing the linked booking","type":["object","null"]},"booking_id":{"description":"Internal booking identifier that this checkout fulfills","type":["integer","null"]},"checkin_date":{"description":"Date the item was returned","format":"date-time","type":["string","null"]},"checkin_library_id":{"description":"Internal library identifier for the library at which the item was returned","type":["string","null"]},"checkout_date":{"description":"Date the item was issued","format":"date-time","type":"string"},"checkout_id":{"description":"internally assigned checkout identifier","type":"integer"},"due_date":{"description":"Due date","format":"date-time","type":"string"},"external_id":{"description":"other identifier of checked out item f.e. barcode","type":["string","null"]},"issuer":{"description":"The object representing the checkout issuer","type":["object","null"]},"issuer_id":{"description":"internally assigned for the user that processed the checkout","type":["integer","null"]},"item":{"description":"The object representing the checked out item","type":["object","null"]},"item_id":{"type":["integer","null"]},"last_renewed_date":{"description":"Date the item was last renewed","format":"date-time","type":["string","null"]},"library":{"description":"The object representing the checkout library","type":["object","null"]},"library_id":{"description":"code of the library the item was checked out","type":["string","null"]},"note":{"description":"Issue note text","type":["string","null"]},"note_date":{"description":"Datetime of the issue note","format":"date","type":["string","null"]},"note_seen":{"description":"has the note been seen already","type":["boolean","null"]},"onsite_checkout":{"description":"On site checkout","type":"boolean"},"patron":{"description":"The object representing the checkout patron","type":["object","null"]},"patron_id":{"description":"Internal patron identifier","type":"integer"},"renewals_count":{"description":"Number of renewals","type":["integer","null"]},"timestamp":{"description":"Last update time","type":"string"},"unseen_renewals":{"description":"Number of consecutive unseen renewals","type":["integer","null"]}},"type":"object"},"checkout_availability":{"additionalProperties":false,"properties":{"blockers":{"description":"blocking issues","type":"object"},"confirmation_token":{"description":"token for confirmation","type":["string","null"]},"confirms":{"description":"issues requireing confirmation","type":"object"},"warnings":{"description":"informational issues","type":"object"}},"type":"object"},"checkouts":{"additionalProperties":false,"items":{"$ref":"#\/definitions\/checkout"},"type":"array"},"circ-rule-kind":{"additionalProperties":true,"properties":{"scope":{"description":"levels that this rule kind can be set for","items":{"enum":["branchcode","categorycode","itemtype"],"type":"string"},"type":"array"}},"required":["scope"],"type":"object"},"circulation_rules":{"additionalProperties":true,"properties":{"context":{"description":"Context of the ruleset","properties":{"item_type_id":{"description":"Item type id","type":"string"},"library_id":{"description":"Library branch id","type":"string"},"patron_category_id":{"description":"Patron category id","type":"string"}},"type":"object"}},"required":["context"],"type":"object"},"city":{"additionalProperties":false,"properties":{"city_id":{"description":"internally assigned city identifier","readOnly":true,"type":"integer"},"country":{"description":"city country","type":["string","null"]},"name":{"description":"city name","type":"string"},"postal_code":{"description":"city postal code","type":["string","null"]},"state":{"description":"city state","type":["string","null"]}},"required":["name","state","postal_code","country"],"type":"object"},"club_hold":{"additionalProperties":false,"properties":{"biblio_id":{"description":"Internal biblio identifier","type":"integer"},"club_hold_id":{"description":"Internal club hold identifier","type":"integer"},"club_id":{"description":"Internal club identifier","type":"integer"},"date_created":{"description":"Date and time the hold was created","format":"date-time","type":"string"},"item_id":{"description":"Internal item identifier","type":["string","null"]}},"type":"object"},"credit":{"additionalProperties":false,"properties":{"account_line_id":{"description":"Internal account line identifier","readOnly":true,"type":["integer","null"]},"amount":{"description":"Credit amount","type":"number"},"amount_outstanding":{"description":"Outstanding amount","readOnly":true,"type":"number"},"cash_register_id":{"description":"Internal identifier for the cash register used for the payment (if any)","type":["integer","null"]},"credit_number":{"description":"Internally generated identifier for credits","readOnly":true,"type":["string","null"]},"date":{"description":"Date the account line was created","format":"date-time","readOnly":true,"type":"string"},"description":{"description":"Account line description","readOnly":true,"type":["string","null"]},"interface":{"description":"Interface in which the account line was generated (values can be: api, cron, commandline, intranet, opac and sip)","readOnly":true,"type":["string","null"]},"internal_note":{"description":"Internal note","type":["string","null"]},"library_id":{"description":"Internal identifier for the library in which the transaction took place","type":["string","null"]},"patron_id":{"description":"Internal identifier for the patron the account line belongs to","readOnly":true,"type":"integer"},"payment_type":{"description":"Payment type","type":["string","null"]},"status":{"description":"The credit status","readOnly":true,"type":["string","null"]},"timestamp":{"description":"Timestamp for the latest line update","format":"date-time","readOnly":true,"type":"string"},"type":{"description":"Account credit type","type":["string","null"]},"user_id":{"description":"Internal patron identifier for the staff member that introduced the account line","type":["integer","null"]}},"required":["amount"],"type":"object"},"debit":{"additionalProperties":false,"properties":{"account_line_id":{"description":"Internal account line identifier","readOnly":true,"type":["integer","null"]},"amount":{"description":"Debit amount","minimum":0,"type":"number"},"amount_outstanding":{"description":"Outstanding amount","type":"number"},"cash_register_id":{"description":"Internal identifier for the cash register used for the payout (if any)","type":["integer","null"]},"checkout_id":{"description":"Internal identifier for the checkout the account line is related to","type":["integer","null"]},"date":{"description":"Date the account line was created","format":"date-time","type":"string"},"description":{"description":"Account line description","type":["string","null"]},"interface":{"description":"Interface in which the account line was generated (values can be: api, cron, commandline, intranet, opac and sip)","type":["string","null"]},"internal_note":{"description":"Internal note","type":["string","null"]},"item_id":{"description":"Internal identifier for the item the account line is related to","type":["integer","null"]},"library_id":{"description":"Internal identifier for the library in which the transaction took place","type":["string","null"]},"old_checkout_id":{"description":"Internal identifier for the old checkout the account line is related to","type":["integer","null"]},"patron_id":{"description":"Internal identifier for the patron the account line belongs to","type":"integer"},"payout_type":{"description":"Payout type","type":["string","null"]},"status":{"description":"The debit status","type":["string","null"]},"timestamp":{"description":"Timestamp for the latest line update","format":"date-time","type":"string"},"type":{"description":"Account debit type","type":["string","null"]},"user_id":{"description":"Internal patron identifier for the staff member that introduced the account line","type":["integer","null"]}},"required":["amount"],"type":"object"},"desk":{"additionalProperties":false,"properties":{"desk_id":{"description":"Internal desk identifier","type":"integer"},"library_id":{"description":"Internally assigned library identifier","maxLength":10,"minLength":1,"type":"string"},"name":{"description":"The desk display name","type":"string"}},"required":["desk_id","name","library_id"],"type":"object"},"edifact_file":{"additionalProperties":false,"properties":{"basket":{"description":"Koha basket","type":["object","null"]},"basket_id":{"description":"Koha basket ID","type":["string","null"]},"edi_acct":{"description":"EDIFACT account","type":["string","null"]},"errors":{"type":"array"},"filename":{"description":"EDIFACT file name","type":["string","null"]},"id":{"description":"internally assigned EDIFACT file identifier","readOnly":true,"type":"integer"},"raw_msg":{"description":"EDIFACT message","type":["string","null"]},"status":{"description":"EDIFACT file status","type":["string","null"]},"transfer_date":{"description":"EDIFACT file transfer date","format":"date","type":["string","null"]},"type":{"description":"EDIFACT file type","type":["string"]},"vendor":{"description":"Koha vendor","type":["object","null"]},"vendor_id":{"description":"Koha vendor ID","type":["string","null"]}},"type":"object"},"erm_agreement":{"additionalProperties":false,"properties":{"_strings":{"type":["object","null"]},"agreement_id":{"description":"internally assigned agreement identifier","readOnly":true,"type":"integer"},"agreement_licenses":{"description":"agreement licenses","items":{"$ref":"#\/definitions\/erm_agreement_license"},"type":"array"},"agreement_relationships":{"description":"agreement relationships","items":{"$ref":"#\/definitions\/erm_agreement_relationship"},"type":"array"},"closure_reason":{"description":"reason of the closure","maxLength":80,"type":["string","null"]},"description":{"description":"description of the agreement","type":["string","null"]},"documents":{"description":"documents","items":{"$ref":"#\/definitions\/erm_document"},"type":"array"},"extended_attributes":{"description":"Related additional field values","items":{"$ref":"#\/definitions\/extended_attribute_value"},"type":["array"]},"is_perpetual":{"description":"is the agreement perpetual","type":"boolean"},"license_info":{"description":"info about the license","type":["string","null"]},"name":{"description":"name of the agreement","maxLength":255,"type":"string"},"periods":{"description":"periods defined for this agreement","items":{"$ref":"#\/definitions\/erm_agreement_period"},"type":"array"},"renewal_priority":{"description":"priority of the renewal","maxLength":80,"type":["string","null"]},"status":{"description":"current status of the agreement","maxLength":80,"type":"string"},"user_roles":{"description":"role for users","items":{"$ref":"#\/definitions\/erm_user_role"},"type":"array"},"vendor":{"description":"Information about the vendor","type":["object","null"]},"vendor_id":{"description":"foreign key to aqbooksellers","type":["integer","null"]}},"required":["agreement_id","name","status","is_perpetual"],"type":"object"},"erm_agreement_license":{"additionalProperties":false,"properties":{"agreement_id":{"description":"Internal agreement identifier","type":"integer"},"agreement_license_id":{"description":"Internal agreement license identifier","type":"integer"},"license_id":{"description":"Internal license identifier","type":"integer"},"notes":{"type":["string","null"]},"physical_location":{"type":["string","null"]},"status":{"type":"string"},"uri":{"type":["string","null"]}},"required":["license_id","status"],"type":"object"},"erm_agreement_period":{"additionalProperties":false,"properties":{"agreement_id":{"description":"Internal agreement identifier","type":"integer"},"agreement_period_id":{"description":"internally assigned identifier","readOnly":true,"type":"integer"},"cancellation_deadline":{"description":"Deadline for the cancellation","format":"date","type":["string","null"]},"ended_on":{"description":"End of the agreemnent period","format":"date","type":["string","null"]},"notes":{"type":["string","null"]},"started_on":{"description":"Start of the agreement period","format":"date","type":"string"}},"required":["started_on"],"type":"object"},"erm_agreement_relationship":{"additionalProperties":false,"properties":{"agreement_id":{"description":"Internal agreement identifier","type":"integer"},"notes":{"type":["string","null"]},"related_agreement_id":{"description":"Internal related agreement identifier","type":"integer"},"relationship":{"description":"relationship between the agreements","enum":["supersedes","is-superseded-by","provides_post-cancellation_access_for","has-post-cancellation-access-in","tracks_demand-driven_acquisitions_for","has-demand-driven-acquisitions-in","has_backfile_in","has_frontfile_in","related_to"],"type":"string"}},"required":["related_agreement_id","relationship"],"type":"object"},"erm_config":{"additionalProperties":false,"properties":{"settings":{"description":"List of sysprefs used for the ERM module","type":"object"}},"type":"object"},"erm_counter_file":{"additionalProperties":false,"properties":{"counter_logs":{"description":"counter logs","items":{"$ref":"#\/definitions\/erm_counter_log"},"type":"array"},"date_uploaded":{"description":"Timestamp for the date of upload","format":"date-time","type":"string"},"erm_counter_files_id":{"description":"internally assigned counter_files identifier","readOnly":true,"type":"integer"},"file_content":{"description":"file_content","type":"string"},"filename":{"description":"filename","type":"string"},"type":{"description":"type of the counter_files","type":["string","null"]},"usage_data_provider_id":{"description":"usage_data_provider_id of the counter_files","type":"integer"}},"required":["usage_data_provider_id","filename","file_content"],"type":"object"},"erm_counter_log":{"additionalProperties":false,"properties":{"counter_files_id":{"description":"counter_files_id of the counter_log","type":["integer","null"]},"erm_counter_log_id":{"description":"internally assigned counter_log identifier","readOnly":true,"type":"integer"},"filename":{"description":"filename of the counter_file","type":["string","null"]},"importdate":{"description":"Timestamp for the date of upload","format":"date-time","type":"string"},"logdetails":{"description":"logdetails of the counter_log","type":["string","null"]},"patron":{"description":"patron object for the importer","type":["object","null"]},"patron_id":{"description":"patron_id of the counter log","type":["integer","null"]},"usage_data_provider_id":{"description":"logdetails of the counter_log","type":["integer","null"]}},"required":["filename","patron_id","counter_files_id"],"type":"object"},"erm_counter_registry":{"additionalProperties":false,"properties":{"abbrev":{"description":"abbrev of the platform","type":["string","null"]},"address":{"description":"current address of the platform","type":["string","null"]},"address_country":{"description":"current address country of the platform","type":["object","string"]},"audited":{"description":"has the record been audited?","type":"boolean"},"contact":{"description":"current contact of the platform","type":["object","null"]},"content_provider_name":{"description":"current content_provider_name of the platform","type":["string","null"]},"host_types":{"description":"host_types for the platform","items":{"type":"object"},"type":"array"},"id":{"description":"internally assigned identifier","type":"string"},"name":{"description":"name of the platform","type":"string"},"reports":{"description":"reports for the platform","items":{"type":"object"},"type":"array"},"sushi_services":{"description":"sushi_services for the platform","items":{"type":"object"},"type":"array"},"website":{"description":"current website of the platform","type":["string","null"]}},"type":"object"},"erm_custom_report":{"properties":{"erm_usage_muses":{"description":"usage mus","items":{"$ref":"#\/definitions\/erm_usage_mus"},"type":"array"},"erm_usage_yuses":{"description":"usage yus","items":{"$ref":"#\/definitions\/erm_usage_yus"},"type":"array"},"metric_type":{"description":"metric_type of the title data","type":["string","null"]},"online_issn":{"description":"online_issn number of the title","type":["string","null"]},"print_issn":{"description":"print_issn number of the title","type":["string","null"]},"provider_name":{"description":"provider_name of the title","type":["string","null"]},"publisher":{"description":"publisher of the title data","type":["string","null"]},"publisher_id":{"description":"publisher_id of the title data","type":["string","null"]},"title":{"description":"title of the title","type":["string","null"]},"title_doi":{"description":"doi number of the title","type":["string","null"]},"title_id":{"description":"internally assigned title identifier","readOnly":true,"type":"integer"},"title_uri":{"description":"title_uri number of the title","type":["string","null"]},"usage_data_provider_id":{"description":"usage_data_provider the title is harvested by","type":"integer"}},"type":"object"},"erm_default_usage_report":{"additionalProperties":false,"properties":{"erm_default_usage_report_id":{"description":"internally assigned default_usage_report identifier","readOnly":true,"type":"integer"},"report_name":{"description":"report_name","type":"string"},"report_url_params":{"description":"report_url_params","type":"string"}},"required":["report_name","report_url_params"],"type":"object"},"erm_document":{"additionalProperties":false,"properties":{"agreement_id":{"description":"Internal agreement identifier","type":["integer","null"]},"document_id":{"description":"internally assigned identifier","type":"integer"},"file_content":{"description":"Content of the file","type":["string","null"]},"file_description":{"description":"Description of the file","type":["string","null"]},"file_name":{"description":"Name of the file","type":["string","null"]},"file_type":{"description":"Type of the file","readOnly":true,"type":["string","null"]},"license_id":{"description":"Internal license identifier","type":["integer","null"]},"notes":{"type":["string","null"]},"physical_location":{"description":"Physical location of the document","type":["string","null"]},"uploaded_on":{"description":"Datetime of the upload","format":"date-time","readOnly":true,"type":["string","null"]},"uri":{"description":"URI of the document","type":["string","null"]}},"type":"object"},"erm_eholdings_package":{"additionalProperties":false,"properties":{"_strings":{"type":["object","null"]},"content_type":{"description":"content type of the package","type":["string","null"]},"created_on":{"description":"date of creation","type":["string","null"]},"extended_attributes":{"description":"Related additional field values","items":{"$ref":"#\/definitions\/extended_attribute_value"},"type":["array"]},"external_id":{"description":"external id of the package","type":["string","null"]},"is_selected":{"type":["boolean","null"]},"koha_internal_id":{"description":"internal id of the package","type":["integer","null"]},"name":{"description":"name of the package","type":"string"},"notes":{"description":"notes about the package","type":["string","null"]},"package_agreements":{"description":"agreements","items":{"$ref":"#\/definitions\/erm_eholdings_package_agreement"},"type":"array"},"package_id":{"description":"internally assigned package identifier","readOnly":true,"type":"string"},"package_type":{"description":"type of the package","type":["string","null"]},"provider":{"description":"external id of the package","type":["string","null"]},"resources":{"description":"resources","items":{"$ref":"#\/definitions\/erm_eholdings_resource"},"type":"array"},"resources_count":{"type":["integer","null"]},"vendor":{"type":["object","null"]},"vendor_id":{"description":"foreign key to aqbooksellers","type":["integer","null"]}},"required":["name"],"type":"object"},"erm_eholdings_package_agreement":{"additionalProperties":false,"properties":{"agreement_id":{"description":"foreign key to agreement","type":"integer"},"package_id":{"description":"foreign key to package","readOnly":true,"type":"integer"}},"required":["agreement_id"],"type":"object"},"erm_eholdings_resource":{"additionalProperties":false,"properties":{"ended_on":{"description":"End date","type":["string","null"]},"is_selected":{"type":["boolean","null"]},"package":{"description":"Information about the package","type":["object","null"]},"package_id":{"description":"foreign key to the package","type":["string","null"]},"proxy":{"description":"Proxy to access this resource","type":["string","null"]},"resource_id":{"description":"internally assigned identifier","readOnly":true,"type":"string"},"started_on":{"description":"Start date","type":["string","null"]},"title":{"description":"Information about the title","type":["object","null"]},"title_id":{"description":"foreign key to the title","type":["integer","null"]},"vendor":{"description":"Information about the vendor","type":["object","null"]},"vendor_id":{"description":"foreign key to aqbooksellers","type":["integer","null"]}},"required":["package_id"],"type":"object"},"erm_eholdings_title":{"additionalProperties":false,"properties":{"access_type":{"description":"access_type of the title","maxLength":255,"type":["string","null"]},"biblio_id":{"description":"internally assigned identifier for the linked biblio","readOnly":true,"type":["integer","null"]},"coverage_depth":{"description":"coverage_depth of the title","maxLength":255,"type":["string","null"]},"create_linked_biblio":{"description":"should a linked biblio be created","type":["boolean","null"]},"date_first_issue_online":{"description":"date_first_issue_online of the title","maxLength":255,"type":["string","null"]},"date_last_issue_online":{"description":"date_last_issue_online of the title","maxLength":255,"type":["string","null"]},"date_monograph_published_online":{"description":"date_monograph_published_online of the title","maxLength":255,"type":["string","null"]},"date_monograph_published_print":{"description":"date_monograph_published_print of the title","maxLength":255,"type":["string","null"]},"embargo_info":{"description":"embargo_info of the title","maxLength":255,"type":["string","null"]},"external_id":{"description":"External id of the title","maxLength":255,"type":["string","null"]},"first_author":{"description":"first_author of the title","maxLength":255,"type":["string","null"]},"first_editor":{"description":"first_editor of the title","maxLength":255,"type":["string","null"]},"is_selected":{"description":"if the title is selected in the KB","type":["boolean","null"]},"monograph_edition":{"description":"monograph_edition of the title","maxLength":255,"type":["string","null"]},"monograph_volume":{"description":"monograph_volume of the title","maxLength":255,"type":["string","null"]},"notes":{"description":"notes of the title","type":["string","null"]},"num_first_issue_online":{"description":"num_first_issue_online of the title","maxLength":255,"type":["string","null"]},"num_first_vol_online":{"description":"num_first_vol_online of the title","maxLength":255,"type":["string","null"]},"num_last_issue_online":{"description":"num_last_issue_online of the title","maxLength":255,"type":["string","null"]},"num_last_vol_online":{"description":"num_last_vol_online of the title","maxLength":255,"type":["string","null"]},"online_identifier":{"description":"online_identifier of the title","maxLength":255,"type":["string","null"]},"parent_publication_title_id":{"description":"parent_publication_title_id of the title","maxLength":255,"type":["string","null"]},"preceding_publication_title_id":{"description":"preceding_publication_title_id of the title","maxLength":255,"type":["string","null"]},"print_identifier":{"description":"print_identifier of the title","maxLength":255,"type":["string","null"]},"publication_title":{"description":"publication_title of the title","maxLength":255,"type":"string"},"publication_type":{"description":"publication_type of the title","maxLength":80,"type":["string","null"]},"publisher_name":{"description":"publisher_name of the title","maxLength":255,"type":["string","null"]},"resources":{"description":"Resource containing this title","items":{"$ref":"#\/definitions\/erm_eholdings_resource"},"type":"array"},"title_id":{"description":"internally assigned identifier","readOnly":true,"type":"integer"},"title_url":{"description":"title_url of the title","maxLength":255,"type":["string","null"]}},"required":["publication_title"],"type":"object"},"erm_license":{"additionalProperties":false,"properties":{"_strings":{"type":["object","null"]},"description":{"description":"description of the license","type":["string","null"]},"documents":{"description":"documents","items":{"$ref":"#\/definitions\/erm_document"},"type":"array"},"ended_on":{"description":"End of the license","format":"date","type":["string","null"]},"extended_attributes":{"description":"Related additional field values","items":{"$ref":"#\/definitions\/extended_attribute_value"},"type":["array"]},"license_id":{"description":"internally assigned license identifier","readOnly":true,"type":"integer"},"name":{"description":"name of the license","type":"string"},"started_on":{"description":"Start of the license","format":"date","type":["string","null"]},"status":{"description":"status of the license","type":"string"},"type":{"description":"description of the license","type":"string"},"user_roles":{"description":"role for users","items":{"$ref":"#\/definitions\/erm_user_role"},"type":"array"},"vendor":{"description":"Information about the vendor","type":["object","null"]},"vendor_id":{"description":"foreign key to aqbooksellers","type":["integer","null"]}},"required":["license_id","name","status","type"],"type":"object"},"erm_sushi_service":{"additionalProperties":false,"properties":{"api_key_info":{"description":"api_key_info of the sushi service","type":["string","null"]},"api_key_required":{"description":"is api_key required","type":["boolean","null"]},"contact":{"description":"contact for the sushi service","items":{"type":"object"},"type":"array"},"counter_release":{"description":"counter_release of the sushi service","type":["string","null"]},"credentials_auto_expire":{"description":"do the credentials expire","type":["boolean","null"]},"credentials_auto_expire_info":{"description":"credentials_auto_expire_info of the sushi service","type":["string","null"]},"customer_id_info":{"description":"customer_id_info of the sushi service","type":["string","null"]},"customizations_in_place":{"description":"are any customizations in place","type":["boolean","null"]},"customizations_info":{"description":"customizations_info of the sushi service","type":["string","null"]},"data_host":{"description":"data_host of the sushi service","type":["string","null"]},"id":{"description":"internally assigned identifier","type":"string"},"ip_address_authorization":{"description":"is ip address auth required","type":["boolean","null"]},"ip_address_authorization_info":{"description":"ip_address_authorization_info of the sushi service","type":["string","null"]},"last_audit":{"description":"the last time the service was audited","type":"object"},"migrations":{"description":"migrations for the sushi service","items":{"type":"object"},"type":"array"},"notification_count":{"description":"notification count","type":["integer","null"]},"notifications_url":{"description":"notifications_url of the sushi service","type":["string","null"]},"platform_attr_required":{"description":"is platform_attr required","type":["boolean","null"]},"platform_specific_info":{"description":"platform_specific_info of the sushi service","type":["string","null"]},"request_volume_limits_applied":{"description":"are limits applied","type":["boolean","null"]},"request_volume_limits_info":{"description":"request_volume_limits_info of the sushi service","type":["string","null"]},"requestor_id_info":{"description":"requestor_id_info of the sushi service","type":["string","null"]},"requestor_id_required":{"description":"is requestor_id required","type":["boolean","null"]},"url":{"description":"url of the sushi service","type":["string","null"]}},"type":"object"},"erm_usage_data_provider":{"additionalProperties":false,"properties":{"active":{"description":"status of the harvester","type":["integer","null"]},"aggregator":{"description":"aggregator of the harvester","type":["string","null"]},"api_key":{"description":"api_key of the harvester","type":["string","null"]},"counter_files":{"description":"counter files","items":{"$ref":"#\/definitions\/erm_counter_file"},"type":"array"},"customer_id":{"description":"customer_id of the harvester","type":["string","null"]},"description":{"description":"description of the data provider","type":["string","null"]},"earliest_database":{"description":"time period of data harvested","type":["string","null"]},"earliest_item":{"description":"time period of data harvested","type":["string","null"]},"earliest_platform":{"description":"time period of data harvested","type":["string","null"]},"earliest_title":{"description":"time period of data harvested","type":["string","null"]},"erm_usage_data_provider_id":{"description":"internally assigned data provider identifier","readOnly":true,"type":"integer"},"erm_usage_databases":{"description":"usage databases","items":{"$ref":"#\/definitions\/erm_usage_database"},"type":"array"},"erm_usage_items":{"description":"usage items","items":{"$ref":"#\/definitions\/erm_usage_item"},"type":"array"},"erm_usage_platforms":{"description":"usage platforms","items":{"$ref":"#\/definitions\/erm_usage_platform"},"type":"array"},"erm_usage_titles":{"description":"usage titles","items":{"$ref":"#\/definitions\/erm_usage_title"},"type":"array"},"last_run":{"description":"last time the harvester was run","type":["string","null"]},"latest_database":{"description":"time period of data harvested","type":["string","null"]},"latest_item":{"description":"time period of data harvested","type":["string","null"]},"latest_platform":{"description":"time period of data harvested","type":["string","null"]},"latest_title":{"description":"time period of data harvested","type":["string","null"]},"method":{"description":"method of the harvester","type":["string","null"]},"metric_type":{"description":"metric type of the harvester when reporting","type":["string","null"]},"name":{"description":"name of the data provider","type":"string"},"report_release":{"description":"report_release of the harvester","type":["string","null"]},"report_types":{"description":"report types of the harvester","type":["string","null"]},"requestor_email":{"description":"requestor_email of the harvester","type":["string","null"]},"requestor_id":{"description":"requestor_id of the harvester","type":["string","null"]},"requestor_name":{"description":"requestor_name of the harvester","type":["string","null"]},"service_platform":{"description":"service platform of the harvester","type":["string","null"]},"service_type":{"description":"service_type of the harvester","type":["string","null"]},"service_url":{"description":"service_url of the harvester","type":["string","null"]}},"required":["name","customer_id","requestor_id","service_url","report_release"],"type":"object"},"erm_usage_database":{"additionalProperties":false,"properties":{"database":{"description":"name of the database","type":["string","null"]},"database_id":{"description":"internally assigned database identifier","readOnly":true,"type":"integer"},"erm_usage_muses":{"description":"usage mus","items":{"$ref":"#\/definitions\/erm_usage_mus"},"type":"array"},"erm_usage_yuses":{"description":"usage yus","items":{"$ref":"#\/definitions\/erm_usage_yus"},"type":"array"},"platform":{"description":"name of the platform","type":["string","null"]},"publisher":{"description":"publisher of the database data","type":["string","null"]},"publisher_id":{"description":"publisher_id of the database data","type":["string","null"]},"usage_data_provider_id":{"description":"usage_data_provider the database is harvested by","type":"integer"}},"required":["database","usage_data_provider_id"],"type":"object"},"erm_usage_item":{"additionalProperties":false,"properties":{"erm_usage_muses":{"description":"usage mus","items":{"$ref":"#\/definitions\/erm_usage_mus"},"type":"array"},"erm_usage_yuses":{"description":"usage yus","items":{"$ref":"#\/definitions\/erm_usage_yus"},"type":"array"},"item":{"description":"item of the item","type":["string","null"]},"item_id":{"description":"internally assigned item identifier","readOnly":true,"type":"integer"},"platform":{"description":"name of the platform","type":["string","null"]},"publisher":{"description":"publisher of the item data","type":["string","null"]},"usage_data_provider_id":{"description":"usage_data_provider the item is harvested by","type":"integer"}},"required":["item","usage_data_provider_id"],"type":"object"},"erm_usage_mus":{"additionalProperties":false,"properties":{"access_type":{"description":"access type of the monthly usage summary","type":["string","null"]},"database_id":{"description":"database_id of the monthly usage summary","type":["integer","null"]},"item_id":{"description":"item_id of the monthly usage summary","type":["integer","null"]},"metric_type":{"description":"metric type of the monthly usage summary","type":["string","null"]},"month":{"description":"month of the monthly usage summary","type":["integer","null"]},"monthly_usage_summary_id":{"description":"internally assigned monthly usage summary identifier","readOnly":true,"type":"integer"},"platform_id":{"description":"platform_id of the monthly usage summary","type":["integer","null"]},"report_type":{"description":"report type of the monthly usage summary","type":["string","null"]},"title_id":{"description":"title_id of the monthly usage summary","type":["integer","null"]},"usage_count":{"description":"total count of the monthly usage summary","type":["integer","null"]},"usage_data_provider_id":{"description":"usage_data_provider_id of the monthly usage summary","type":["integer","null"]},"year":{"description":"year of the monthly usage summary","type":["integer","null"]},"yop":{"description":"year of publication of the monthly usage summary","type":["string","null"]}},"required":["title_id","usage_data_provider_id"],"type":"object"},"erm_usage_platform":{"additionalProperties":false,"properties":{"erm_usage_muses":{"description":"usage mus","items":{"$ref":"#\/definitions\/erm_usage_mus"},"type":"array"},"erm_usage_yuses":{"description":"usage yus","items":{"$ref":"#\/definitions\/erm_usage_yus"},"type":"array"},"platform":{"description":"title of the platform","type":["string","null"]},"platform_id":{"description":"internally assigned platform identifier","readOnly":true,"type":"integer"},"usage_data_provider_id":{"description":"usage_data_provider the platform is harvested by","type":"integer"}},"required":["platform","usage_data_provider_id"],"type":"object"},"erm_usage_title":{"additionalProperties":false,"properties":{"erm_usage_muses":{"description":"usage mus","items":{"$ref":"#\/definitions\/erm_usage_mus"},"type":"array"},"erm_usage_yuses":{"description":"usage yus","items":{"$ref":"#\/definitions\/erm_usage_yus"},"type":"array"},"isbn":{"description":"isbn of the title","type":["string","null"]},"metric_type":{"description":"metric_type of the title data","type":["string","null"]},"online_issn":{"description":"online_issn number of the title","type":["string","null"]},"platform":{"description":"platform of the title","type":["string","null"]},"print_issn":{"description":"print_issn number of the title","type":["string","null"]},"proprietary_id":{"description":"proprietary_id of the title","type":["string","null"]},"provider_name":{"description":"provider_name of the title","type":["string","null"]},"publisher":{"description":"publisher of the title data","type":["string","null"]},"publisher_id":{"description":"publisher_id of the title data","type":["string","null"]},"title":{"description":"title of the title","type":["string","null"]},"title_doi":{"description":"doi number of the title","type":["string","null"]},"title_id":{"description":"internally assigned title identifier","readOnly":true,"type":"integer"},"title_uri":{"description":"title_uri number of the title","type":["string","null"]},"usage_data_provider_id":{"description":"usage_data_provider the title is harvested by","type":"integer"}},"required":["title","usage_data_provider_id"],"type":"object"},"erm_usage_yus":{"additionalProperties":false,"properties":{"access_type":{"description":"access type of the yearly usage summary","type":["string","null"]},"database_id":{"description":"database_id of the yearly usage summary","type":["integer","null"]},"item_id":{"description":"item_id of the yearly usage summary","type":["integer","null"]},"metric_type":{"description":"metric type of the yearly usage summary","type":["string","null"]},"platform_id":{"description":"platform_id of the yearly usage summary","type":["integer","null"]},"report_type":{"description":"report type of the yearly usage summary","type":["string","null"]},"title_id":{"description":"title_id of the yearly usage summary","type":["integer","null"]},"totalcount":{"description":"total count of the yearly usage summary","type":["integer","null"]},"usage_data_provider_id":{"description":"usage_data_provider_id of the yearly usage summary","type":["integer","null"]},"year":{"description":"year of the yearly usage summary","type":["integer","null"]},"yearly_usage_summary_id":{"description":"internally assigned yearly usage summary identifier","readOnly":true,"type":"integer"},"yop":{"description":"year of publication of the yearly usage summary","type":["string","null"]}},"required":["title_id","usage_data_provider_id"],"type":"object"},"erm_user_role":{"additionalProperties":false,"properties":{"agreement_id":{"description":"Internal agreement identifier","type":["integer","null"]},"license_id":{"description":"Internal license identifier","type":["integer","null"]},"patron":{"type":["object","null"]},"role":{"description":"role of the user","type":["string"]},"user_id":{"description":"Internal patron identifier","type":"integer"},"user_role_id":{"description":"Internal user_role identifier","type":"integer"}},"required":["user_id","role"],"type":"object"},"error":{"additionalProperties":true,"properties":{"error":{"description":"Error message","type":"string"},"error_code":{"description":"Error code","type":"string"}},"type":"object"},"extended_attribute_type":{"additionalProperties":false,"properties":{"authorised_value_category_name":{"description":"authorised value category of the extended attribute type values","type":["string","null"]},"extended_attribute_type_id":{"description":"internally assigned extended attribute type identifier","readOnly":true,"type":"integer"},"marc_field":{"description":"marc field of the extended attribute type","type":"string"},"marc_field_mode":{"description":"marc field mode of the extended attribute type","enum":["get","set"],"type":"string"},"name":{"description":"name of the extended attribute type","type":"string"},"repeatable":{"description":"is the extended attribute type repetable","type":"boolean"},"resource_type":{"description":"name of the resource type this extended attribute type corresponds to","type":"string"},"searchable":{"description":"is the extended attribute type searchable","type":"boolean"}},"required":["extended_attribute_type_id","resource_type"],"type":"object"},"extended_attribute_value":{"additionalProperties":false,"properties":{"field_id":{"description":"FK in corresponding to id in additional_fields table","type":"integer"},"id":{"description":"id of the field","readOnly":true,"type":"string"},"record_id":{"description":"ID corresponding to the object ID this additional field relates to","type":"string"},"value":{"description":"value of the additional field","type":"string"}},"type":"object"},"file_transport":{"additionalProperties":false,"properties":{"auth_mode":{"description":"Authentication mode to use (optional)","enum":["password","key_file","noauth"],"type":"string"},"debug":{"description":"If the SMTP connection is set to debug mode (optional)","type":"boolean"},"download_directory":{"description":"Path on the remote server we download from (optional)","type":["string","null"]},"file_transport_id":{"description":"Internal File transport identifier","readOnly":true,"type":"integer"},"host":{"description":"FTP\/SFTP host name (optional)","type":"string"},"key_file":{"description":"The key file to use for authentication (optional)","type":["string","null"]},"name":{"description":"Name of the File transport","type":"string"},"passive":{"description":"Whether or not to use passive mode (optional)","type":"boolean"},"password":{"description":"The password to use for authentication (optional)","type":["string","null"]},"port":{"description":"TCP port number (optional)","type":"integer"},"status":{"description":"Most recent status of the File transport (optional)","type":["object","null"]},"transport":{"description":"Transport of File transport (optional)","enum":["ftp","sftp","file"],"type":"string"},"upload_directory":{"description":"Path on the remote server we upload to (optional)","type":["string","null"]},"user_name":{"description":"The user name to use for authentication (optional)","type":["string","null"]}},"required":["name"],"type":"object"},"fund":{"additionalProperties":false,"properties":{"budget_id":{"description":"Internal identifier for the budget","type":["number","null"]},"code":{"description":"Code assigned to the fund by the user","type":["string","null"]},"fund_access":{"description":"Level of permission for this fund (1: owner, 2: owner, users and library, 3: owner and users)","type":["number","null"]},"fund_id":{"description":"internally assigned fund identifier","readOnly":true,"type":"integer"},"fund_owner_id":{"description":"Internal identifier for the fund owner","type":["number","null"]},"library_id":{"description":"Internal identifier for the library that this fund belongs to","type":["string","null"]},"name":{"description":"Name assigned to the fund by the user","type":["string","null"]},"notes":{"description":"Notes related to this fund","type":["string","null"]},"parent_fund_id":{"description":"Internal identifier for parent fund","type":["integer","null"]},"statistic1_auth_value_category":{"description":"Statistical category for this fund","type":["string","null"]},"statistic2_auth_value_category":{"description":"Second statistical category for this fund","type":["string","null"]},"timestamp":{"description":"Timestamp","format":"date-time","type":["string"]},"total_amount":{"description":"Total amount for this fund","type":["number","null"]},"warn_at_amount":{"description":"Warning at amount","type":["number","null"]},"warn_at_percentage":{"description":"Warning at percentage","type":["number","null"]}},"required":["name"],"type":"object"},"hold":{"additionalProperties":false,"properties":{"_strings":{"description":"A list of stringified coded values","type":["object","null"]},"biblio":{"description":"Bibliographic record","type":["object","null"]},"biblio_id":{"description":"Internal biblio identifier","type":["integer","null"]},"cancellation_date":{"description":"The date the hold was cancelled","format":"date","type":["string","null"]},"cancellation_reason":{"description":"The reason the hold was cancelled","type":["string","null"]},"cancellation_requested":{"description":"Cancellation requests count for the hold (x-koha-embed)","type":["boolean","null"]},"deleted_biblio":{"description":"Deleted bibliographic record","type":["object","null"]},"deleted_biblio_id":{"description":"Internal deleted biblio identifier","type":["integer","null"]},"desk_id":{"description":"The id of the desk","type":["integer","null"]},"expiration_date":{"description":"The date the hold expires","format":"date","type":["string","null"]},"hold_date":{"description":"The date the hold was placed","format":"date","type":["string","null"]},"hold_group_id":{"type":["integer","null"]},"hold_id":{"description":"Internal hold identifier","type":"integer"},"item":{"description":"The item","type":["object","null"]},"item_group_id":{"description":"Internal item group identifier","type":["string","null"]},"item_id":{"description":"Internal item identifier","type":["integer","null"]},"item_level":{"description":"If the hold is placed at item level","type":"boolean"},"item_type_id":{"description":"If record level hold, the optional itemtype of the item the patron is requesting","type":["string","null"]},"lowest_priority":{"description":"Controls if the hold is given the lowest priority on the queue","type":"boolean"},"non_priority":{"description":"Set this hold as non priority","type":"boolean"},"notes":{"description":"Notes related to this hold","type":["string","null"]},"patron":{"description":"Patron for hold","type":["object","null"]},"patron_id":{"description":"Internal patron identifier","type":"integer"},"pickup_library":{"description":"Pickup library","type":["object","null"]},"pickup_library_id":{"description":"Internal library identifier for the pickup library","type":["string","null"]},"priority":{"description":"Where in the queue the patron sits","type":["integer","null"]},"status":{"description":"A one letter code defining what the status of the hold is after it has been confirmed","type":["string","null"]},"suspended":{"description":"Controls if the hold is suspended","type":"boolean"},"suspended_until":{"description":"Date until which the hold has been suspended","format":"date-time","type":["string","null"]},"timestamp":{"description":"Timestamp for the latest hold update","format":"date-time","type":"string"},"waiting_date":{"description":"The date the item was marked as waiting for the patron at the library","format":"date","type":["string","null"]}},"type":"object"},"hold_group":{"additionalProperties":false,"properties":{"borrowernumber":{"description":"Patron this hold group belongs to","type":"integer"},"hold_group_id":{"description":"Internal hold group identifier","type":"integer"},"holds":{"description":"The holds in this hold group (x-koha-embed)","type":["array","null"]},"target_hold_id":{"description":"Target hold ID of this hold group","type":"integer"},"visual_hold_group_id":{"description":"Visual ID for this hold group, in the context of the related patron","type":"integer"}},"type":"object"},"holds":{"additionalProperties":false,"items":{"$ref":"#\/definitions\/hold"},"type":"array"},"identity_provider":{"additionalProperties":false,"properties":{"code":{"description":"Identity provider code","type":"string"},"config":{"description":"Configuration","type":"object"},"description":{"description":"User-oriented description for the provider","type":"string"},"domains":{"description":"Configured domains for the identity provider","type":["array","null"]},"icon_url":{"description":"Icon url","type":["string","null"]},"identity_provider_id":{"description":"Internally assigned identity provider identifier","readOnly":true,"type":"integer"},"mapping":{"description":"Attribute mapping","type":["object","null"]},"matchpoint":{"description":"Patron attribute that will be used to match","enum":["email","userid","cardnumber"],"type":"string"},"protocol":{"description":"Authentication protocol","enum":["OAuth","OIDC","CAS (not implemented)","LDAP (not implemented)"],"type":"string"}},"required":["config","code","protocol"],"type":"object"},"identity_provider_domain":{"additionalProperties":false,"properties":{"allow_opac":{"description":"If this domain can be used for OPAC login","type":"boolean"},"allow_staff":{"description":"If this domain can be used for staff login","type":"boolean"},"auto_register_opac":{"description":"If patrons will be generated on login if required (OPAC)","type":"boolean"},"auto_register_staff":{"description":"If patrons will be generated on login if required (Staff interface)","type":"boolean"},"default_category_id":{"description":"Internal identifier for the default patron's category","type":["string","null"]},"default_library_id":{"description":"Internal identifier for the default library to be assigned to the new patrons","type":["string","null"]},"domain":{"description":"Matching domain ('*' used as wildcard)","type":["string","null"]},"identity_provider_domain_id":{"description":"Internally assigned identity provider domain identifier","readOnly":true,"type":"integer"},"identity_provider_id":{"description":"Internally assigned identity provider identifier","type":"integer"},"update_on_auth":{"description":"If patron data is updated on login","type":"boolean"}},"required":["identity_provider_domain_id","domain","auto_register_opac","auto_register_staff","update_on_auth","default_library_id","default_category_id","allow_opac","allow_staff"],"type":"object"},"ill_backend":{"additionalProperties":false,"properties":{"capabilities":{"description":"List of capabilities","type":"object"},"ill_backend_id":{"description":"Internal ILL backend identifier","type":"string"},"statuses":{"description":"existing statuses","items":{"$ref":"#\/definitions\/ill_status"},"type":"array"}},"type":"object"},"ill_backends":{"additionalProperties":false,"items":{"$ref":"#\/definitions\/ill_backend"},"type":"array"},"ill_batch":{"additionalProperties":false,"properties":{"_strings":{"description":"Expanded coded fields (x-koha-embed)","type":["object","null"]},"backend":{"description":"Backend name","type":"string"},"cardnumber":{"description":"Library assigned user identifier of the ILL batch","type":"string"},"ill_batch_id":{"description":"Internal ILL batch identifier","type":"integer"},"library":{"description":"The library associated with the batch","type":["object","null"]},"library_id":{"description":"Internal identifier for the ILL batch's library","type":"string"},"name":{"description":"Name of the ILL batch","type":"string"},"patron":{"description":"The patron associated with the batch","type":["object","null"]},"patron_id":{"description":"Internal identifier the patron of the ILL batch","type":"string"},"requests":{"description":"The requests in this batch (x-koha-embed)","type":["array","null"]},"requests_count":{"description":"The number of requests in this batch (x-koha-embed)","type":["integer","null"]},"status":{"description":"The status associated with the batch (x-koha-embed)","type":["object","null"]},"status_code":{"description":"Code of the status of the ILL batch","type":"string"}},"required":["name","backend","library_id","status_code"],"type":"object"},"ill_batches":{"additionalProperties":false,"items":{"$ref":"#\/definitions\/ill_batch"},"type":"array"},"ill_batchstatus":{"additionalProperties":false,"properties":{"code":{"description":"Unique, immutable status code","type":"string"},"id":{"description":"Internal ILL batch status identifier","type":"string"},"is_system":{"description":"Is this status required for system operation","type":"boolean"},"name":{"description":"Status name","type":"string"}},"required":["name","code","is_system"],"type":"object"},"ill_batchstatuses":{"additionalProperties":false,"items":{"$ref":"#\/definitions\/ill_batchstatus"},"type":"array"},"ill_request":{"additionalProperties":false,"properties":{"_strings":{"description":"Expanded coded fiels (x-koha-embed)","type":["object","null"]},"access_url":{"description":"A URL for accessing the item","type":["string","null"]},"biblio":{"description":"The linked biblio object (x-koha-embed)","type":["object","null"]},"biblio_id":{"description":"Internal bibliographic record identifier","type":["integer","null"]},"comments":{"description":"The linked comment objects (x-koha-embed)","type":["array","null"]},"comments_count":{"description":"The linked comment objects count (x-koha-embed)","type":["integer","null"]},"completed_date":{"description":"Date the request was marked as completed","format":"date","type":["string","null"]},"cost":{"description":"Default request cost","type":["string","null"]},"due_date":{"description":"Date and time the request item should be due when checked out","format":"date-time","type":["string","null"]},"extended_attributes":{"description":"The linked extended ill request attributes (x-koha-embed)","type":["array","null"]},"id_prefix":{"description":"The id_prefix of the request (x-koha-embed)","type":["string","null"]},"ill_backend_id":{"description":"The ILL backend identifier string","type":"string"},"ill_backend_request_id":{"description":"Backend-specific request id","type":["string","null"]},"ill_batch":{"description":"The linked ill batch object (x-koha-embed)","type":["object","null"]},"ill_batch_id":{"description":"Batch id this requests belongs to","type":["integer","null"]},"ill_request_id":{"description":"Internal ILL request identifier","type":"integer"},"library":{"description":"The linked library object (x-koha-embed)","type":["object","null"]},"library_id":{"description":"Internal library identifier","type":"string"},"medium":{"description":"Description of the ILL item medium","type":["string","null"]},"opac_notes":{"description":"Note that is visible to the patron","type":["string","null"]},"paid_price":{"description":"Effective request cost","type":["string","null"]},"patron":{"description":"The linked patron object (x-koha-embed)","type":["object","null"]},"patron_id":{"description":"Internal patron id","type":["integer","null"]},"replied_date":{"description":"FIXME","format":"date","type":["string","null"]},"requested_date":{"description":"Date the request was placed by the patron","format":"date","type":["string","null"]},"staff_notes":{"description":"Interal staff note about the request","type":["string","null"]},"status":{"description":"The status the request is at.\n\nNote: This is defined by each backend. Please refer to the specific backend's\ndocumentation or code to understand the possible values.\n","type":"string"},"status_av":{"description":"The authorised value category the field is linked to","type":["string","null"]},"timestamp":{"description":"Date and time of last object update","format":"date-time","type":"string"}},"type":"object"},"ill_status":{"additionalProperties":false,"properties":{"backend":{"description":"The backend in which this status is used","type":"string"},"category":{"description":"The AV category in which the status aliases exists in","type":"string"},"code":{"description":"Internal ILL status code or av code","type":"string"},"str":{"description":"Internal ILL status display string","type":"string"},"type":{"description":"This is 'ill_status' or 'av' depending on if coming from backend or authorised values i.e. alias","type":"string"}},"type":"object"},"import_batch_profile":{"additionalProperties":false,"properties":{"comments":{"description":"any comments added when the file was uploaded","type":["string","null"]},"encoding":{"description":"file encoding","type":["string","null"]},"format":{"description":"marc format","type":["string","null"]},"item_action":{"description":"what to do with item records","type":["string","null"]},"matcher_id":{"description":"the id of the match rule used (matchpoints.matcher_id)","type":["integer","null"]},"name":{"description":"name of this profile","type":"string"},"nomatch_action":{"description":"how to handle records where no match is found","type":["string","null"]},"overlay_action":{"description":"how to handle duplicate records","type":["string","null"]},"parse_items":{"description":"should items be parsed","type":["boolean","null"]},"profile_id":{"description":"Internal profile identifier","type":"integer"},"record_type":{"description":"type of record in the batch","type":["string","null"]},"template_id":{"description":"the id of the marc modification template","type":["integer","null"]}},"type":"object"},"import_batch_profiles":{"additionalProperties":false,"items":{"$ref":"#\/definitions\/import_batch_profile"},"type":"array"},"import_record_match":{"additionalProperties":false,"properties":{"candidate_match_id":{"description":"Internal import record match candidate identifier","type":"integer"},"chosen":{"description":"Whether match has been chosen for overlay","type":"boolean"},"import_record_id":{"description":"Internal import record identifier","type":"integer"},"score":{"description":"Ranking value for this match calculated by the matching rules","type":"integer"}},"type":"object"},"invoice":{"additionalProperties":false,"properties":{"close_date":{"description":"Invoice close date (only when the invoice is closed)","format":"date","type":"string"},"closed":{"description":"If the invoice is closed","type":"boolean"},"invoice_date":{"description":"Date of billing","format":"date","type":["string","null"]},"invoice_id":{"description":"Internal identifier for the incoide. Generated on POST","type":"integer"},"invoice_number":{"description":"Invoice number assigned by the vendor","type":"string"},"shipping_cost":{"description":"Shipping cost","type":["integer","null"]},"shipping_cost_budget_id":{"description":"Shipping cost linking to budget","type":["integer","null"]},"shipping_date":{"description":"Date of shipping","format":"date","type":["string","null"]},"vendor_id":{"description":"Internal identifier for the vendor","type":"integer"}},"type":"object"},"item":{"additionalProperties":false,"properties":{"_status":{"description":"The status of the item","type":["array","null"]},"_strings":{"description":"A return claims object if one exists that's unresolved","type":["object","null"]},"acquisition_date":{"description":"The date the item was acquired","format":"date","type":["string","null"]},"acquisition_source":{"description":"Information about the acquisition source (it is not really a vendor id)","type":["string","null"]},"analytics_count":{"type":["integer","null"]},"biblio":{"type":["object","null"]},"biblio_id":{"description":"Internal identifier for the parent bibliographic record","type":"integer"},"bookable":{"description":"Item level bookability override.","type":["boolean","null"]},"bundle_host":{"type":["object","null"]},"bundle_items_lost_count":{"description":"Number of lost items in the bundle","type":["integer","null"]},"bundle_items_not_lost_count":{"description":"Number of items not lost in the bundle","type":["integer","null"]},"call_number_sort":{"description":"?","maxLength":255,"type":["string","null"]},"call_number_source":{"description":"Classification source used on this item","maxLength":10,"type":["string","null"]},"callnumber":{"description":"Call number for this item","maxLength":255,"type":["string","null"]},"checked_out_date":{"description":"Defines if item is checked out (NULL for not checked out, and checkout date for checked out)","format":"date","type":["string","null"]},"checkout":{"type":["object","null"]},"checkouts_count":{"description":"Number of times this item has been checked out\/issued","type":["integer","null"]},"coded_location_qualifier":{"description":"Coded location qualifier","maxLength":10,"type":["string","null"]},"collection_code":{"description":"Authorized value for the collection code associated with this item","maxLength":80,"type":["string","null"]},"copy_number":{"description":"Copy number","maxLength":32,"type":["string","null"]},"course_item":{"type":["object","null"]},"cover_image_ids":{"type":["array","null"]},"damaged_date":{"description":"The date and time an item was last marked as damaged, NULL if not damaged","type":["string","null"]},"damaged_status":{"description":"Authorized value defining this item as damaged","type":"integer"},"effective_bookable":{"description":"Allow bookings on this item.","type":"boolean"},"effective_item_type_id":{"description":"Effective itemtype defining the type for this item_id","type":["string","null"]},"effective_not_for_loan_status":{"description":"Authorized value defining why this item is not for not_for_loan_status","type":"integer"},"exclude_from_local_holds_priority":{"description":"Exclude this item from local holds priority.","type":"boolean"},"extended_subfields":{"description":"Additional 952 subfields in XML format","type":["string","null"]},"external_id":{"description":"The item's barcode","maxLength":20,"type":["string","null"]},"first_hold":{"type":["object","null"]},"holding_library":{"type":["object","null"]},"holding_library_id":{"description":"Library that is currently in possession item","maxLength":10,"type":["string","null"]},"holds_count":{"description":"Number of times this item has been placed on hold\/reserved","type":["integer","null"]},"home_library":{"type":["object","null"]},"home_library_id":{"description":"Internal library id for the library the item belongs to","maxLength":10,"type":["string","null"]},"in_bundle":{"type":["boolean","null"]},"internal_notes":{"description":"Non-public notes on this item","type":["string","null"]},"inventory_number":{"description":"Inventory number","maxLength":80,"type":["string","null"]},"item_group_item":{"type":["object","null"]},"item_id":{"description":"Internal item identifier","type":"integer"},"item_type":{"type":["object","null"]},"item_type_id":{"description":"Itemtype defining the type for this item","maxLength":10,"type":["string","null"]},"last_checkout_date":{"description":"The date the item was last checked out","format":"date","type":["string","null"]},"last_seen_date":{"description":"The date the item barcode was last scanned","format":"date-time","type":["string","null"]},"localuse":{"description":"Number of times this item has been recorded for localuse","type":["integer","null"]},"location":{"description":"Authorized value for the shelving location for this item","maxLength":80,"type":["string","null"]},"lost_date":{"description":"The date and time an item was last marked as lost, NULL if not lost","format":"date-time","type":["string","null"]},"lost_status":{"description":"Authorized value defining this item as lost","type":"integer"},"materials_notes":{"description":"Materials specified","type":["string","null"]},"new_status":{"description":"'new' value, whatever free-text information.","maxLength":32,"type":["string","null"]},"not_for_loan_status":{"description":"Authorized value defining why this item is not for loan","type":"integer"},"permanent_location":{"description":"Linked to the CART and PROC temporary locations feature, stores the permanent shelving location","maxLength":80,"type":["string","null"]},"public_notes":{"description":"Public notes on this item","type":["string","null"]},"purchase_price":{"description":"Purchase price","type":["number","null"]},"recall":{"type":["object","null"]},"renewals_count":{"description":"Number of times this item has been renewed","type":["integer","null"]},"replacement_price":{"description":"Cost the library charges to replace the item (e.g. if lost)","type":["number","null"]},"replacement_price_date":{"description":"The date the replacement price is effective from","format":"date","type":["string","null"]},"restricted_status":{"description":"Authorized value defining use restrictions for this item","type":["integer","null"]},"return_claim":{"type":["object","null"]},"return_claims":{"description":"An array of all return claims associated with this item","type":"array"},"serial_issue_number":{"description":"serial enumeration\/chronology for the item","type":["string","null"]},"serial_item":{"type":["object","null"]},"shelving_control_number":{"description":"Shelving control number","type":["number","null"]},"timestamp":{"description":"Date and time this item was last altered","format":"date-time","type":"string"},"transfer":{"type":["object","null"]},"uri":{"description":"URL for the item","type":["string","null"]},"withdrawn":{"description":"Authorized value defining this item as withdrawn","type":"integer"},"withdrawn_date":{"description":"The date and time an item was last marked as withdrawn, NULL if not withdrawn","format":"date-time","type":["string","null"]}},"type":"object"},"item_group":{"additionalProperties":false,"properties":{"biblio_id":{"description":"Internal identifier for the parent bibliographic record","readOnly":true,"type":"integer"},"creation_date":{"description":"Date and time the item group was created","format":"date-time","readOnly":true,"type":"string"},"description":{"description":"Item group description","type":"string"},"display_order":{"description":"Item group description","type":"integer"},"item_group_id":{"description":"Internal identifier for the item group","readOnly":true,"type":"integer"},"items":{"description":"A list of items that belong to the volume (x-koha-embed)","readOnly":true,"type":["array","null"]},"modification_date":{"description":"Date and time the item group was last modified","format":"date-time","readOnly":true,"type":"string"}},"required":["item_group_id","biblio_id"],"type":"object"},"item_type":{"additionalProperties":false,"properties":{"automatic_checkin":{"description":"Controls if automatic checkin is enabled for items of this type","type":"boolean"},"bookable":{"description":"Boolean denoting whether this item type is normally bookable","type":"boolean"},"checkin_message":{"description":"Message that is displayed when an item with the given item type is checked in","type":["string","null"]},"checkin_message_type":{"description":"Type (CSS class) for the checkin_message, can be 'alert' or 'message'","type":["string","null"]},"checkprevcheckout":{"description":"Produce a warning for this item type if this item has previously been checked out to this patron if ''yes'', not if ''no'', defer to patron setting if ''inherit''","enum":["yes","no","inherit"],"type":"string"},"daily_rental_charge":{"description":"The amount charged for each day between checkout date and due date","type":["number","null"]},"daily_rental_charge_calendar":{"description":"Controls if the daily rental fee is calculated directly or using finesCalendar","type":"boolean"},"default_replacement_cost":{"description":"Default replacement cost","type":["number","null"]},"description":{"description":"A plain text explanation of the item type","type":"string"},"hide_in_opac":{"description":"Hide the item type from the search options in OPAC","type":"boolean"},"hourly_rental_charge":{"description":"The amount charged for each hour between checkout date and due date","type":["number","null"]},"hourly_rental_charge_calendar":{"description":"Controls if the hourly rental fee is calculated directly or using finesCalendar","type":"boolean"},"image_url":{"description":"URL for the item type icon","type":["string","null"]},"item_type_id":{"description":"Unique key, a code associated with the item type","maxLength":10,"minLength":1,"readOnly":true,"type":"string"},"not_for_loan_status":{"description":"If items of this type are not for loan","type":"boolean"},"parent_type":{"description":"Unique key, a code associated with the parent item type","type":["string","null"]},"process_fee":{"description":"Default text be recorded in the column note when the processing fee is applied","type":["number","null"]},"rentalcharge":{"description":"The amount charged when this item is checked out\/issued","type":["number","null"]},"searchcategory":{"description":"Group this item type with others with the same value on OPAC search options","type":["string","null"]},"sip_media_type":{"description":"SIP2 protocol media type for this item type","type":["string","null"]},"summary":{"description":"Information from the summary field, may include HTML","type":["string","null"]},"translated_descriptions":{"description":"Translations of description plain text (x-koha-embed)","items":{"$ref":"#\/definitions\/item_type_translated_description"},"type":"array"}},"required":["item_type_id"],"type":"object"},"item_type_translated_description":{"additionalProperties":false,"properties":{"lang":{"description":"Language identifier","type":"string"},"translation":{"description":"Translated plain text","type":"string"}},"required":["lang","translation"],"type":"object"},"job":{"additionalProperties":false,"properties":{"context":{"description":"job context","type":"object"},"data":{"description":"job data","type":["object","null"]},"ended_date":{"description":"job end date","format":"date-time","type":["string","null"]},"enqueued_date":{"description":"job enqueue date","format":"date-time","type":"string"},"job_id":{"description":"internally assigned job identifier","readOnly":true,"type":"integer"},"patron_id":{"description":"job enqueuer","type":["string","null"]},"progress":{"description":"job progress","type":["string","null"]},"queue":{"description":"job queue","type":"string"},"size":{"description":"job size","type":["string","null"]},"started_date":{"description":"job start date","format":"date-time","type":["string","null"]},"status":{"description":"job status","type":"string"},"type":{"description":"job type","type":"string"}},"type":"object"},"library":{"additionalProperties":false,"properties":{"address1":{"description":"the first address line of the library","type":["string","null"]},"address2":{"description":"the second address line of the library","type":["string","null"]},"address3":{"description":"the third address line of the library","type":["string","null"]},"cash_registers":{"description":"The library's defined cash registers (x-koha-embed)","type":["array","null"]},"city":{"description":"the city or province of the library","type":["string","null"]},"country":{"description":"the county of the library","type":["string","null"]},"desks":{"description":"The library's defined desks (x-koha-embed)","type":["array","null"]},"email":{"description":"the primary email address of the library","type":["string","null"]},"fax":{"description":"the fax number of the library","type":["string","null"]},"geolocation":{"description":"geolocation of your library","maxLength":255,"type":["string","null"]},"ill_email":{"description":"the ILL staff email address of the library","type":["string","null"]},"ip":{"description":"the IP address for your library or branch","maxLength":15,"type":["string","null"]},"library_hours":{"description":"The open and close times for a library on any given day","type":["array","null"]},"library_id":{"description":"internally assigned library identifier","maxLength":10,"minLength":1,"type":"string"},"marc_org_code":{"description":"MARC Organization Code, see http:\/\/www.loc.gov\/marc\/organizations\/orgshome.html, when empty defaults to syspref MARCOrgCode","maxLength":16,"type":["string","null"]},"name":{"description":"Printable name of library","type":"string"},"needs_override":{"description":"If the library needs an override to act as pickup location for a hold","type":"boolean"},"notes":{"description":"notes related to your library or branch","type":["string","null"]},"phone":{"description":"the primary phone of the library","type":["string","null"]},"pickup_items":{"description":"Array of items available for pickup at this library if the library is marked as a pickup location","items":{"type":"integer"},"type":["array","null"]},"pickup_location":{"description":"If the library can act as a pickup location","type":"boolean"},"postal_code":{"description":"the postal code of the library","maxLength":25,"type":["string","null"]},"public":{"description":"If the library is visible to the public","type":"boolean"},"reply_to_email":{"description":"the email to be used as a Reply-To","type":["string","null"]},"return_path_email":{"description":"the email to be used as Return-Path","type":["string","null"]},"smtp_server":{"description":"The library effective SMTP server","type":["object","null"]},"state":{"description":"the reqional state of the library","type":["string","null"]},"url":{"description":"the URL for your library or branch's website","type":["string","null"]}},"required":["library_id","name"],"type":"object"},"list":{"additionalProperties":false,"properties":{"allow_change_from_others":{"description":"If others can change the contents","type":"boolean"},"allow_change_from_owner":{"description":"If the owner can change the contents","type":"boolean"},"creation_date":{"description":"Date the list was created","format":"date-time","type":"string"},"default_sort_field":{"description":"The field this list is sorted on by default","type":"string"},"list_id":{"description":"Interal identifier for the list","type":"integer"},"name":{"description":"List name","type":"string"},"owner_id":{"description":"Internal identifier for the owning patron","type":"integer"},"public":{"description":"If the list is public","type":"boolean"},"updated_on_date":{"description":"Date the list was last updated","format":"date-time","type":"string"}},"required":["list_id","name","creation_date","updated_on_date","allow_change_from_owner","allow_change_from_others","public"],"type":"object"},"merge_biblios":{"additionalProperties":false,"properties":{"biblio_id_to_merge":{"description":"Biblionumber from which to merge","type":"integer"},"datarecord":{"description":"Bibliographic record used as result of the merge. It uses the format MARC-in-JSON","type":["object","null"]},"framework_to_use":{"description":"Framework code, you can use it only with a value in datarecord field. With null value it uses the framework code of record to be merged into.","type":["string","null"]},"rules":{"description":"Internally identifier of a merge algoritm. Now two identifier are supported, 'override' and 'override_ext'. 'override' is to use when you the bibliographic data of biblio_id as resulting bibliographic data. The null value is equivalent of 'override'. 'override_ext' is to use only with a value in datarecord field. In fact is mandatory to use if you insert a record inside datarecord field.","type":["string","null"]}},"required":["biblio_id_to_merge"],"type":"object"},"order":{"additionalProperties":false,"properties":{"basket":{"type":["object","null"]},"basket_id":{"description":"Basket this order is linked to","type":["integer","null"]},"biblio":{"type":["object","null"]},"biblio_id":{"description":"Identifier for the linked bibliographic record","type":["integer","null"]},"cancellation_date":{"description":"Date the line item was deleted","format":"date","type":["string","null"]},"cancellation_reason":{"description":"Reason of cancellation","type":["string","null"]},"claims_count":{"description":"Generated claim letters count","type":"integer"},"created_by":{"description":"Interal patron identifier of the order line creator","type":["integer","null"]},"creator":{"description":"Patron that created the order","type":["object","null"]},"currency":{"description":"Currency used for the purchase","type":["string","null"]},"current_item_level_holds_count":{"description":"Current holds count for associated items","type":"integer"},"date_received":{"description":"Date the order was received","format":"date","type":["string","null"]},"deleted_biblio_id":{"description":"Identifier for the linked deleted bibliographic record","type":["integer","null"]},"discount_rate":{"description":"Discount rate","type":["number","null"]},"ecost":{"description":"Effective cost","type":["number","null"]},"ecost_tax_excluded":{"description":"Effective cost (tax excluded)","type":["number","null"]},"ecost_tax_included":{"description":"Effective cost (tax included)","type":["number","null"]},"entry_date":{"description":"Date the bib was added to the basket","format":"date","type":["string","null"]},"estimated_delivery_date":{"description":"Estimated delivery date","format":"date","type":["string","null"]},"fund":{"type":["object","null"]},"fund_id":{"description":"Internal identifier for the fund this order goes against","type":"integer"},"internal_note":{"description":"Notes related to this order line, made for staff","type":["string","null"]},"invoice":{"type":["object","null"]},"invoice_currency":{"description":"Currency of the actual cost used when receiving","type":["string","null"]},"invoice_id":{"description":"Id of the order invoice","type":["integer","null"]},"invoice_unit_price":{"description":"The actual cost in the foreign currency used in the invoice","type":["number","null"]},"items":{"type":"array"},"last_claim_date":{"description":"Last date a claim letter was generated","format":"date","type":["string","null"]},"list_price":{"description":"Vendor price for the line item","type":["number","null"]},"order_id":{"description":"Internally assigned order identifier","type":"integer"},"parent_order_id":{"description":"Order ID of parent order line if exists","type":["integer","null"]},"quantity":{"description":"Ordered quantity","type":["integer","null"]},"quantity_received":{"description":"Quantity received so far","type":"integer"},"replacement_price":{"description":"Replacement cost for this item","type":["number","null"]},"rrp":{"description":"Retail cost for this item","type":["number","null"]},"rrp_tax_excluded":{"description":"Replacement cost for this item (tax excluded)","type":["number","null"]},"rrp_tax_included":{"description":"Replacement cost for this item (tax included)","type":["number","null"]},"shipping_cost":{"description":"Shipping cost","type":["number","null"]},"statistics_1":{"description":"Statistical field","type":["string","null"]},"statistics_1_authcat":{"description":"Statistical category for this order","type":["string","null"]},"statistics_2":{"description":"Statistical field (2)","type":["string","null"]},"statistics_2_authcat":{"description":"Statistical category for this order (2)","type":["string","null"]},"status":{"description":"The current order status","enum":["new","ordered","partial","complete","cancelled"],"type":"string"},"subscription":{"type":["object","null"]},"subscription_id":{"description":"Subscription ID linking the order to a subscription","type":["integer","null"]},"tax_rate_on_ordering":{"description":"Tax rate on ordering (%)","type":["number","null"]},"tax_rate_on_receiving":{"description":"Tax rate on receiving (%)","type":["number","null"]},"tax_value_on_ordering":{"description":"Tax value on ordering","type":["number","null"]},"tax_value_on_receiving":{"description":"Tax value on receiving","type":["number","null"]},"timestamp":{"description":"Date and time this order line was last modified","format":"date-time","type":"string"},"uncertain_price":{"description":"If this price was uncertain","type":"boolean"},"unit_price":{"description":"The actual cost entered when receiving this line item","type":["number","null"]},"unit_price_tax_excluded":{"description":"Unit price excluding tax (on receiving)","type":["number","null"]},"unit_price_tax_included":{"description":"Unit price including tax (on receiving)","type":["number","null"]},"vendor_note":{"description":"Notes related to this order line, made for vendor","type":["string","null"]}},"type":"object"},"order_claim":{"additionalProperties":false,"properties":{"date_claimed":{"description":"Date the claim was recorded","format":"date","type":"string"},"order_claim_id":{"description":"Internally assigned order claim identifier","type":"integer"},"order_id":{"description":"Internally assigned order identifier","type":"integer"}},"type":"object"},"patron":{"additionalProperties":false,"properties":{"_strings":{"description":"A list of stringified coded values","type":["object","null"]},"account_balance":{"description":"Balance of the patron's account","type":["number","null"]},"address":{"description":"first address line of patron's primary address","type":["string","null"]},"address2":{"description":"second address line of patron's primary address","type":["string","null"]},"altaddress_address":{"description":"first address line of patron's alternate address","type":["string","null"]},"altaddress_address2":{"description":"second address line of patron's alternate address","type":["string","null"]},"altaddress_city":{"description":"city or town of patron's alternate address","type":["string","null"]},"altaddress_country":{"description":"country of patron's alternate address","type":["string","null"]},"altaddress_email":{"description":"email address for patron's alternate address","type":["string","null"]},"altaddress_notes":{"description":"a note related to patron's alternate address","maxLength":255,"type":["string","null"]},"altaddress_phone":{"description":"phone number for patron's alternate address","type":["string","null"]},"altaddress_postal_code":{"description":"zip or postal code of patron's alternate address","type":["string","null"]},"altaddress_state":{"description":"state or province of patron's alternate address","type":["string","null"]},"altaddress_street_number":{"description":"street number of patron's alternate address","type":["string","null"]},"altaddress_street_type":{"description":"street type of patron's alternate address","type":["string","null"]},"altcontact_address":{"description":"the first address line for the alternate contact for the patron","type":["string","null"]},"altcontact_address2":{"description":"the second address line for the alternate contact for the patron","type":["string","null"]},"altcontact_city":{"description":"the city for the alternate contact for the patron","type":["string","null"]},"altcontact_country":{"description":"the country for the alternate contact for the patron","type":["string","null"]},"altcontact_firstname":{"description":"first name of alternate contact for the patron","type":["string","null"]},"altcontact_phone":{"description":"the phone number for the alternate contact for the patron","type":["string","null"]},"altcontact_postal_code":{"description":"the zipcode for the alternate contact for the patron","type":["string","null"]},"altcontact_state":{"description":"the state for the alternate contact for the patron","type":["string","null"]},"altcontact_surname":{"description":"surname or last name of the alternate contact for the patron","type":["string","null"]},"anonymized":{"description":"If the patron has been anonymized","readOnly":true,"type":"boolean"},"autorenew_checkouts":{"description":"indicate whether auto-renewal is allowed for patron","type":"boolean"},"cardnumber":{"description":"library assigned user identifier","maxLength":32,"type":["string","null"]},"category_id":{"description":"Internal identifier for the patron's category","maxLength":10,"type":"string"},"check_previous_checkout":{"description":"produce a warning for this patron if this item has previously been checked out to this patron if 'yes', not if 'no', defer to category setting if 'inherit'","enum":["yes","no","inherit"],"type":"string"},"checkouts_count":{"description":"Number of checkouts","type":["integer","null"]},"city":{"description":"city or town of patron's primary address","type":["string","null"]},"country":{"description":"country of patron's primary address","type":["string","null"]},"date_enrolled":{"description":"date the patron was added to Koha","format":"date","type":["string","null"]},"date_of_birth":{"description":"patron's date of birth","format":"date","type":["string","null"]},"date_renewed":{"description":"date the patron's card was last renewed","format":"date","type":["string","null"]},"email":{"description":"primary email address for patron's primary address","type":["string","null"]},"expired":{"description":"If patron is expired","readOnly":true,"type":"boolean"},"expiry_date":{"description":"date the patron's card is set to expire","format":"date","type":["string","null"]},"extended_attributes":{"description":"patron's extended attributes","items":{"$ref":"#\/definitions\/patron_extended_attribute"},"type":"array"},"fax":{"description":"fax number for patron's primary address","type":["string","null"]},"firstname":{"description":"patron's first name","type":["string","null"]},"gender":{"description":"patron's gender","maxLength":1,"type":["string","null"]},"incorrect_address":{"description":"set to 1 if library marked this patron as having an unconfirmed address","type":["boolean","null"]},"initials":{"description":"initials of the patron","type":["string","null"]},"lang":{"description":"lang to use to send notices to this patron","maxLength":25,"type":"string"},"last_seen":{"description":"last time a patron has been seen (connected at the OPAC or staff interface)","format":"date-time","type":["string","null"]},"library":{"description":"Library of the patron","type":["object","null"]},"library_id":{"description":"Internal identifier for the patron's home library","maxLength":10,"type":"string"},"login_attempts":{"description":"number of failed login attemps","type":["integer","null"]},"middle_name":{"description":"patron's middle name","type":["string","null"]},"mobile":{"description":"the other phone number for patron's primary address","type":["string","null"]},"opac_notes":{"description":"a note on the patron's account visible in OPAC and staff interface","type":["string","null"]},"other_name":{"description":"any other names associated with the patron","type":["string","null"]},"overdrive_auth_token":{"description":"persist OverDrive auth token","type":["string","null"]},"overdues_count":{"description":"Number of overdued checkouts","type":["integer","null"]},"patron_card_lost":{"description":"set to 1 if library marked this patron as having lost his card","type":["boolean","null"]},"patron_id":{"description":"Internal patron identifier","type":"integer"},"phone":{"description":"primary phone number for patron's primary address","type":["string","null"]},"postal_code":{"description":"zip or postal code of patron's primary address","type":["string","null"]},"preferred_name":{"description":"patron's preferred name","type":["string","null"]},"primary_contact_method":{"description":"patron's primary contact method","maxLength":45,"type":["string","null"]},"privacy":{"description":"patron's privacy settings related to their checkout history","type":"integer"},"privacy_guarantor_checkouts":{"description":"controls if relatives can see this patron's checkouts","type":"boolean"},"privacy_guarantor_fines":{"description":"controls if relatives can see this patron's fines","type":"boolean"},"pronouns":{"description":"pronouns of the patron","type":["string","null"]},"protected":{"description":"Protected status of the patron","type":["boolean"]},"relationship_type":{"description":"used for children to include the relationship to their guarantor","maxLength":100,"type":["string","null"]},"restricted":{"description":"If any restriction applies to the patron","readOnly":true,"type":"boolean"},"secondary_email":{"description":"secondary email address for patron's primary address","type":["string","null"]},"secondary_phone":{"description":"secondary phone number for patron's primary address","type":["string","null"]},"sms_number":{"description":"the mobile phone number where the patron would like to receive notices (if SMS turned on)","maxLength":50,"type":["string","null"]},"sms_provider_id":{"description":"the provider of the mobile phone number defined in smsalertnumber","type":["integer","null"]},"staff_notes":{"description":"a note on the patron's account","type":["string","null"]},"state":{"description":"state or province of patron's primary address","type":["string","null"]},"statistics_1":{"description":"a field that can be used for any information unique to the library","maxLength":80,"type":["string","null"]},"statistics_2":{"description":"a field that can be used for any information unique to the library","maxLength":80,"type":["string","null"]},"street_number":{"description":"street number of patron's primary address","type":["string","null"]},"street_type":{"description":"street type of patron's primary address","type":["string","null"]},"surname":{"description":"patron's last name","type":["string","null"]},"title":{"description":"patron's title","type":["string","null"]},"updated_on":{"description":"time of last change could be useful for synchronization with external systems (among others)","format":"date-time","type":"string"},"userid":{"description":"patron's login","maxLength":75,"type":["string","null"]}},"required":["surname","library_id","category_id"],"type":"object"},"patron_account_credit":{"additionalProperties":false,"properties":{"account_lines_ids":{"description":"List of account line ids the credit goes against (optional)","items":{"type":"integer"},"type":"array"},"amount":{"description":"Credit amount","minimum":0,"type":"number"},"credit_type":{"description":"Type of credit ('CREDIT', 'FORGIVEN', 'LOST_FOUND', 'PAYMENT', 'WRITEOFF', 'PROCESSING_FOUND' )","type":"string"},"date":{"description":"Date the credit was recorded (optional)","format":"date","type":"string"},"description":{"description":"Description","type":"string"},"library_id":{"description":"Internal identifier for the library in which the transaction took place","type":["string","null"]},"note":{"description":"Internal note","type":"string"},"payment_type":{"description":"Payment type (only applies when credit_type=payment)","type":"string"}},"required":["amount"],"type":"object"},"patron_balance":{"additionalProperties":false,"properties":{"balance":{"description":"Signed decimal number","type":"number"},"outstanding_credits":{"properties":{"lines":{"items":{"$ref":"#\/definitions\/account_line"},"type":"array"},"total":{"type":"number"}}},"outstanding_debits":{"properties":{"lines":{"items":{"$ref":"#\/definitions\/account_line"},"type":"array"},"total":{"type":"number"}},"type":"object"}},"required":["balance"],"type":"object"},"patron_category":{"additionalProperties":false,"properties":{"block_expired_patron_opac_actions":{"description":"Specific actions expired patrons of this category are blocked from performing. OPAC actions blocked based on the patron category take priority over this preference","maxLength":128,"type":"string"},"can_be_guarantee":{"description":"If patrons of this category can be guarantees","type":"boolean"},"can_place_ill_in_opac":{"description":"Can this patron category place interlibrary loan requests","type":"boolean"},"category_type":{"description":"Type of Koha patron (Adult, Child, Professional, Organizational, Statistical, Staff)","maxLength":1,"type":"string"},"change_password":{"description":"If patrons of this category can change their passwords in the OPAC","type":["boolean","null"]},"check_prev_checkout":{"description":"Produce a warning for this patron category if this item has previously been checked out to this patron if ''yes'', not if ''no'', defer to syspref setting if ''inherit''.'","enum":["yes","no","inherit"],"type":"string"},"default_privacy":{"description":"Default privacy setting for this patron category","enum":["default","never","forever"],"type":"string"},"enforce_expiry_notice":{"description":"Set threshold of debt allowed before issues are blocked","type":["boolean"]},"enrolment_fee":{"description":"Enrollment fee for the patron","type":["number","null"]},"enrolment_period":{"description":"Number of months the patron is enrolled for","type":["number","null"]},"enrolment_period_date":{"description":"Date the patron is enrolled until","format":"date","type":["string","null"]},"exclude_from_local_holds_priority":{"description":"Exclude patrons of this category from local holds priority","type":["boolean","null"]},"force_password_reset_when_set_by_staff":{"description":"If patrons of this category are required to reset password after being created by a staff member","type":"boolean"},"hide_lost_items":{"description":"Are lost items shown to this category (1 for yes, 0 for no)","type":"boolean"},"lower_age_limit":{"description":"The minimum age required for the patron category","type":["boolean","null"]},"min_password_length":{"description":"Set minimum password length for patrons in this category","type":["number","null"]},"name":{"description":"Name of the patron category","type":["string","null"]},"no_issues_charge":{"description":"Set threshold of debt allowed before issues are blocked","type":["number","null"]},"no_issues_charge_guarantees":{"description":"Set threshold of debt allowed, inclusive of guarantees debts, before issues are blocked","type":["number","null"]},"no_issues_charge_guarantors_with_guarantees":{"description":"Set threshold of debt allowed, inclused of relations debts, before issues are blocked","type":["number","null"]},"overdue_notice_required":{"description":"Are overdue notices sent to this patron category (1 for yes, 0 for no)","type":["boolean","null"]},"password_expiry_days":{"description":"Number of days after which the patron must reset their password","type":["number","null"]},"patron_category_id":{"description":"Internal patron category identifier","maxLength":10,"type":"string"},"require_strong_password":{"description":"Set required password strength for patrons in this category","type":["boolean","null"]},"reserve_fee":{"description":"Cost to place holds","type":["number","null"]},"reset_password":{"description":"If patrons of this category can do the password reset flow","type":["boolean","null"]},"upper_age_limit":{"description":"Age limit for the patron","type":["number","null"]}},"required":["patron_category_id"],"type":"object"},"patron_extended_attribute":{"additionalProperties":false,"properties":{"extended_attribute_id":{"description":"Internal ID for the extended attribute","type":"integer"},"type":{"description":"Extended attribute type","type":"string"},"value":{"description":"Extended attribute value","type":["string","null"]}},"required":["type","value"],"type":"object"},"preservation_config":{"additionalProperties":false,"properties":{"permissions":{"description":"List of permissions of the logged in user used for the Preservation module","type":"object"},"settings":{"description":"List of sysprefs used for the Preservation module","type":"object"}},"type":"object"},"preservation_processing":{"additionalProperties":false,"properties":{"attributes":{"description":"attributes of the processing","items":{"$ref":"#\/definitions\/preservation_processing_attribute"}},"letter_code":{"description":"Letter code of the letter to use for printing slips","type":["string","null"]},"name":{"description":"name of the processing","type":"string"},"processing_id":{"description":"internally assigned agreement identifier","readOnly":true,"type":"integer"}},"required":["processing_id","name"],"type":"object"},"preservation_processing_attribute":{"additionalProperties":false,"properties":{"name":{"type":"string"},"option_source":{"type":["string","null"]},"processing_attribute_id":{"description":"Internal processing attribute identifier","type":"integer"},"processing_id":{"description":"Internal processing identifier","type":"integer"},"type":{"type":["string"]}},"required":["name","type"],"type":"object"},"preservation_train":{"additionalProperties":false,"properties":{"closed_on":{"description":"closing date","type":["string","null"]},"created_on":{"description":"creation date","type":["string","null"]},"default_processing":{"description":"the default processing","type":["object","null"]},"default_processing_id":{"description":"foreign key to preservation_processings","type":["integer","null"]},"description":{"description":"description of the train","type":["string","null"]},"name":{"description":"name of the train","type":"string"},"not_for_loan":{"description":"NOT_LOAN authorised value to apply to item added to this train","type":["string","null"]},"received_on":{"description":"receiving date","type":["string","null"]},"sent_on":{"description":"sending date","type":["string","null"]},"train_id":{"description":"internally assigned train identifier","readOnly":true,"type":"integer"}},"required":["train_id","name"],"type":"object"},"preservation_train_item":{"additionalProperties":false,"properties":{"added_on":{"description":"add date","type":["string","null"]},"attributes":{"description":"attribute list","type":["array","null"]},"catalogue_item":{"description":"catalogue item","type":["object","null"]},"item_id":{"description":"internally item identifier","type":"integer"},"processing_id":{"description":"internally processing identifier","type":"integer"},"train_id":{"description":"internally train identifier","type":"integer"},"train_item_id":{"description":"internally assigned train item identifier","readOnly":true,"type":"integer"},"user_train_item_id":{"description":"internally user train item identifier","type":"integer"}},"type":"object"},"quote":{"additionalProperties":false,"properties":{"displayed_on":{"description":"Last display date","type":["string","null"]},"quote_id":{"description":"internally assigned quote identifier","type":"integer"},"source":{"description":"source of the quote","type":"string"},"text":{"description":"text","type":["string","null"]}},"required":["source","text"],"type":"object"},"recall":{"additionalProperties":false,"properties":{"biblio_id":{"description":"Internal biblio identifier","type":"integer"},"completed":{"description":"Controls if the recall is fulfilled","type":"boolean"},"completed_date":{"description":"The date the recall was fulfilled","format":"date-time","type":["string","null"]},"created_date":{"description":"The date the recall was requested","format":"date-time","type":["string","null"]},"expiration_date":{"description":"The date the recall expires","format":"date-time","type":["string","null"]},"item_id":{"description":"Internal item identifier","type":["integer","null"]},"item_level":{"description":"If the recall is requested at item level","type":"boolean"},"notes":{"description":"Notes related to this recall","type":["string","null"]},"patron_id":{"description":"Internal patron identifier","type":"integer"},"pickup_library_id":{"description":"Internal library identifier for the pickup library","type":["string","null"]},"priority":{"description":"Where in the queue the patron sits (not yet implemented)","type":["integer","null"]},"recall_id":{"description":"Internal recall identifier","type":"integer"},"status":{"description":"Status of the recall","enum":["requested","overdue","waiting","in_transit","cancelled","expired","fulfilled"],"type":"string"},"timestamp":{"description":"Timestamp for the latest recall update","format":"date-time","type":"string"},"waiting_date":{"description":"The date the item was marked as waiting for the patron at the library","format":"date-time","type":["string","null"]}},"type":"object"},"recalls":{"additionalProperties":false,"items":{"$ref":"#\/definitions\/recall"},"type":"array"},"record_source":{"additionalProperties":false,"properties":{"can_be_edited":{"description":"If records from this source can be edited","type":"boolean"},"name":{"description":"Record source name","type":"string"},"record_source_id":{"description":"Internally assigned record source identifier","readOnly":true,"type":"integer"},"usage_count":{"description":"Record source usage count (x-koha-embed)","type":"integer"}},"required":["name"],"type":"object"},"renewal":{"additionalProperties":false,"properties":{"checkout_id":{"description":"internally assigned checkout identifier","type":"integer"},"interface":{"description":"Interface from which the renewal took place (values can be: api, cron, commandline, intranet, opac and sip)","type":["string","null"]},"renewal_date":{"description":"Date the renewal took place","format":"date-time","type":"string"},"renewal_id":{"description":"internally assigned renewal identifier","type":"integer"},"renewal_type":{"enum":["Automatic","Manual"],"type":["string","null"]},"renewer":{"description":"The object representing the renewal issuer","type":["object","null"]},"renewer_id":{"description":"internally assigned for the user that processed the renewal","type":["integer","null"]},"seen":{"description":"Seen\/Unseen renewal","type":["boolean"]},"timestamp":{"description":"Last update time","type":"string"}},"type":"object"},"renewals":{"additionalProperties":false,"items":{"$ref":"#\/definitions\/renewal"},"type":"array"},"return_claim":{"additionalProperties":false,"properties":{"claim_id":{"description":"internally assigned return claim identifier","type":["integer"]},"created_by":{"description":"patron id of librarian who made the claim","type":["integer","null"]},"created_on":{"description":"date of claim creation","format":"date-time","type":["string","null"]},"issue_id":{"description":"internal identifier of the claimed checkout if still checked out","type":["integer","null"]},"item_id":{"description":"internal identifier of the claimed item","type":["integer"]},"notes":{"description":"notes about this claim","type":["string","null"]},"old_issue_id":{"description":"internal identifier of the claimed checkout if not longer checked out","type":["integer","null"]},"patron_id":{"description":"Internal patron identifier","type":"integer"},"resolution":{"description":"code of resolution type for this claim","type":["string","null"]},"resolved_by":{"description":"patron id of librarian who resolved this claim","type":["integer","null"]},"resolved_on":{"description":"date the claim was resolved","format":"date-time","type":["string","null"]},"updated_by":{"description":"patron id of librarian who last updated the claim","type":["integer","null"]},"updated_on":{"description":"date the claim was last updated","format":"date-time","type":["string","null"]}},"type":"object"},"rota":{"additionalProperties":false,"properties":{"active":{"description":"rota is active","type":"boolean"},"cyclical":{"description":"rota is cyclical","type":"boolean"},"description":{"description":"rota description","type":["string","null"]},"rota_id":{"description":"internally assigned rota identifier","readOnly":true,"type":"integer"},"title":{"description":"rota title","type":"string"}},"required":["title","description","cyclical","active"],"type":"object"},"search_filter":{"additionalProperties":false,"properties":{"limits":{"description":"filter limits part","type":["string","null"]},"name":{"description":"filter name","type":"string"},"opac":{"description":"visible on opac","type":["boolean","null"]},"query":{"description":"filter query part","type":["string","null"]},"search_filter_id":{"description":"internally assigned search filter identifier","readOnly":true,"type":"integer"},"staff_client":{"description":"visible in staff client","type":["boolean","null"]}},"required":["name"],"type":"object"},"sip2_account":{"additionalProperties":false,"properties":{"ae_field_template":{"description":"ae field template","type":["string","null"]},"allow_additional_materials_checkout":{"description":"allow additional materials checkout","type":["boolean","null"]},"allow_empty_passwords":{"description":"allow empty passwords","type":["boolean","null"]},"allow_fields":{"description":"allow fields","type":["string","null"]},"av_field_template":{"description":"av field template","type":["string","null"]},"blocked_item_types":{"description":"blocked item types","type":["string","null"]},"checked_in_ok":{"description":"checked in ok","type":["boolean","null"]},"convert_nonprinting_characters":{"description":"convert nonprinting characters","type":["string","null"]},"cr_item_field":{"description":"cr item field","type":["string","null"]},"ct_always_send":{"description":"ct always send","type":["boolean","null"]},"custom_item_fields":{"description":"Related custom_item_fields embed","type":["array","null"]},"custom_patron_fields":{"description":"Related custom_patron_fields embed","type":["array","null"]},"cv_send_00_on_success":{"description":"cv send 00 on success","type":["boolean","null"]},"cv_triggers_alert":{"description":"cv triggers alert","type":["boolean","null"]},"da_field_template":{"description":"da field template","type":["string","null"]},"delimiter":{"description":"delimiter","type":["string","null"]},"disallow_overpayment":{"description":"disallow overpayment","type":["boolean","null"]},"encoding":{"description":"encoding","type":["string","null"]},"error_detect":{"description":"error detect","type":["boolean","null"]},"format_due_date":{"description":"format due date","type":["boolean","null"]},"hide_fields":{"description":"hide fields","type":["string","null"]},"holds_block_checkin":{"description":"holds block checkin","type":["boolean","null"]},"holds_get_captured":{"description":"holds get captured","type":["boolean","null"]},"inhouse_item_types":{"description":"inhouse item types","type":["string","null"]},"inhouse_patron_categories":{"description":"inhouse patron categories","type":["string","null"]},"institution":{"description":"Related institution embed","type":["object","null"]},"item_fields":{"description":"Related item_fields embed","type":["array","null"]},"login_id":{"description":"Staff userid for SIP2 authentication","type":"string"},"lost_block_checkout":{"description":"lost status for missing","type":["integer","null"]},"lost_block_checkout_value":{"description":"lost status for missing","type":["integer","null"]},"lost_status_for_missing":{"description":"lost status for missing","type":["integer","null"]},"overdues_block_checkout":{"description":"overdues block checkout","type":["boolean","null"]},"patron_attributes":{"description":"Related patron_attributes embed","type":["array","null"]},"payment_type_writeoff":{"description":"payment type writeoff","type":["string","null"]},"prevcheckout_block_checkout":{"description":"prevcheckout block checkout","type":["boolean","null"]},"register_id":{"description":"register id","type":["integer","null"]},"screen_msg_regexs":{"description":"Related screen_msg_regexs embed","type":["array","null"]},"seen_on_item_information":{"description":"seen on item information","type":["string","null"]},"send_patron_home_library_in_af":{"description":"send patron home library in af","type":["boolean","null"]},"show_checkin_message":{"description":"show checkin message","type":["boolean","null"]},"show_outstanding_amount":{"description":"show outstanding amount","type":["boolean","null"]},"sip_account_id":{"description":"unique account identifier","readOnly":true,"type":"integer"},"sip_institution_id":{"description":"unique institution identifier","type":"integer"},"sort_bin_mappings":{"description":"Related sort_bin_mappings embed","type":["array","null"]},"system_preference_overrides":{"description":"Related system_preference_overrides embed","type":["array","null"]},"terminator":{"description":"terminator","enum":["CR","CRLF",null],"type":["string","null"]}},"required":["sip_account_id","login_id"],"type":"object"},"sip2_institution":{"additionalProperties":false,"properties":{"checkin":{"description":"institution's policy for checkin","type":"boolean"},"checkout":{"description":"institution's policy for checkout","type":"boolean"},"implementation":{"description":"institution's implementation, defaults to 'ILS'","type":"string"},"name":{"description":"unique string institution's name","type":"string"},"offline":{"description":"institution's policy for offline","type":"boolean"},"renewal":{"description":"institution's policy for renewal","type":"boolean"},"retries":{"description":"institution's policy for retries","type":"integer"},"sip_institution_id":{"description":"unique identifier","readOnly":true,"type":"integer"},"status_update":{"description":"institution's policy for status_update","type":"boolean"},"timeout":{"description":"institution's policy for timeout","type":"integer"}},"required":["sip_institution_id","name"],"type":"object"},"sip2_system_preference_override":{"additionalProperties":false,"properties":{"sip_system_preference_override_id":{"description":"unique identifier","readOnly":true,"type":"integer"},"value":{"description":"value","type":"string"},"variable":{"description":"variable","type":"string"}},"required":["sip_system_preference_override_id","variable","value"],"type":"object"},"smtp_server":{"additionalProperties":false,"properties":{"debug":{"description":"If the SMTP connection is set to debug mode","type":"boolean"},"host":{"description":"SMTP host name","type":"string"},"is_default":{"description":"Is this the default SMTP server","type":"boolean"},"name":{"description":"Name of the SMTP server","type":"string"},"password":{"description":"The password to use for authentication (optional)","type":["string","null"]},"port":{"description":"TCP port number","type":"integer"},"smtp_server_id":{"description":"Internal SMTP server identifier","readOnly":true,"type":"integer"},"ssl_mode":{"description":"If SSL\/TLS will be used","enum":["disabled","ssl","starttls"],"type":"string"},"timeout":{"description":"Maximum time in seconds to wait for server","type":"integer"},"user_name":{"description":"The user name to use for authentication (optional)","type":["string","null"]}},"required":["name"],"type":"object"},"suggestion":{"additionalProperties":false,"properties":{"_strings":{"type":["object","null"]},"accepted_by":{"description":"patron_id for the librarian who accepted the suggestion, foreign key linking to the borrowers table","type":["integer","null"]},"accepted_date":{"description":"date the suggestion was marked as accepted","format":"date","type":["string","null"]},"archived":{"description":"archived (processed) suggestion","type":["boolean","null"]},"author":{"description":"author of the suggested item","type":["string","null"]},"biblio_id":{"description":"foreign key linking the suggestion to the biblio table after the suggestion has been ordered","type":["integer","null"]},"budget_id":{"description":"foreign key linking the suggested budget to the aqbudgets table","type":["integer","null"]},"collection_title":{"description":"collection name for the suggested item","type":["string","null"]},"copyright_date":{"description":"copyright date of the suggested item","type":["integer","null"]},"currency":{"description":"suggested currency for the suggested price","type":["string","null"]},"fund":{"description":"fund the suggestion would be spent against","type":["object","null"]},"isbn":{"description":"isbn of the suggested item","type":["string","null"]},"item_price":{"description":"suggested price","type":["number","null"]},"item_type":{"description":"suggested item type","type":["string","null"]},"last_modifier":{"description":"last patron to modify the suggestion","type":["object","null"]},"last_status_change_by":{"description":"patron the suggestion was last modified by","type":["integer","null"]},"last_status_change_date":{"description":"date the suggestion was last modified","format":"date","type":["string","null"]},"library":{"description":"library the suggestion belongs to","type":["object","null"]},"library_id":{"description":"foreign key linking the suggested branch to the branches table","type":["string","null"]},"managed_by":{"description":"patron_id for the librarian managing the suggestion, foreign key linking to the borrowers table","type":["integer","null"]},"managed_date":{"description":"date the suggestion was updated","format":"date","type":["string","null"]},"manager":{"description":"suggestion manager details","type":["object","null"]},"note":{"description":"note entered on the suggestion","type":["string","null"]},"patron_reason":{"description":"reason for making the suggestion","type":["string","null"]},"publication_place":{"description":"publication place of the suggested item","type":["string","null"]},"publication_year":{"description":"year of publication","type":["string","null"]},"publisher_code":{"description":"publisher of the suggested item","type":["string","null"]},"quantity":{"description":"suggested quantity to be purchased","type":["string","null"]},"reason":{"description":"reason for accepting or rejecting the suggestion","type":["string","null"]},"rejected_by":{"description":"patron_id for the librarian who rejected the suggestion, foreign key linking to the borrowers table","type":["integer","null"]},"rejected_date":{"description":"date the suggestion was marked as rejected","format":"date","type":["string","null"]},"staff_note":{"description":"non-public note entered on the suggestion","type":["string","null"]},"status":{"description":"Suggestion status. Possible values are:\n\n* `ASKED`\n* `CHECKED`\n* `ACCEPTED`\n* `REJECTED`\n* `ORDERED`\n* `AVAILABLE`\n* Values from the `SUGGEST_STATUS` av category\n","type":"string"},"suggested_by":{"description":"patron_id for the person making the suggestion, foreign key linking to the borrowers table","type":["integer","null"]},"suggester":{"description":"suggester details","type":["object","null"]},"suggestion_date":{"description":"the suggestion was submitted","format":"date","type":"string"},"suggestion_id":{"description":"unique identifier assigned automatically by Koha","readOnly":true,"type":"integer"},"timestamp":{"description":"timestamp of date created","format":"date-time","type":["string","null"]},"title":{"description":"title of the suggested item","type":["string","null"]},"total_price":{"description":"suggested total cost (price*quantity updated for currency)","type":["string","null"]},"volume_desc":{"description":"volume description","type":["string","null"]}},"type":"object"},"ticket":{"additionalProperties":false,"properties":{"_strings":{"description":"A list of stringified coded values","type":["object","null"]},"assignee":{"type":["object","null"]},"assignee_id":{"type":["integer","null"]},"biblio":{"description":"The object representing the biblio the ticket is related to","readOnly":true,"type":["object","null"]},"biblio_id":{"description":"Internal identifier for the biblio the ticket is related to","type":"integer"},"body":{"description":"Ticket details","type":"string"},"reported_date":{"description":"Date the ticket was reported","format":"date-time","readOnly":true,"type":["string","null"]},"reporter":{"description":"The object representing the patron who reported the ticket","readOnly":true,"type":["object","null"]},"reporter_id":{"description":"Internal identifier for the patron who reported the ticket","type":"integer"},"resolved_date":{"description":"Date the ticket was resolved_date","format":"date-time","type":["string","null"]},"resolver":{"description":"The object representing the user who resolved the ticket","readOnly":true,"type":["object","null"]},"resolver_id":{"description":"Internal identifier for the user who resolved the ticket","type":["integer","null"]},"source":{"enum":["catalog"],"type":"string"},"status":{"description":"Current status of the ticket","readOnly":true,"type":["string","null"]},"ticket_id":{"description":"Internal ticket identifier","readOnly":true,"type":"integer"},"title":{"description":"Ticket title","type":"string"},"updates_count":{"description":"Number of updates","type":["integer","null"]}},"required":["source","title","body"],"type":"object"},"ticket_update":{"additionalProperties":true,"properties":{"assignee":{"type":["object","null"]},"assignee_id":{"type":["integer","null"]},"date":{"description":"Date the ticket update was reported","format":"date-time","readOnly":true,"type":["string","null"]},"message":{"description":"Ticket update details","type":"string"},"public":{"description":"Is this update intended to be sent to the patron","type":"boolean"},"status":{"description":"Status of the ticket after this update","type":["string","null"]},"ticket_id":{"description":"Internal ticket identifier","readOnly":true,"type":"integer"},"update_id":{"description":"Internal ticket update identifier","readOnly":true,"type":"integer"},"user":{"description":"The object representing the patron who added the update","readOnly":true,"type":["object","null"]},"user_id":{"description":"Internal identifier for the patron who added the update","type":"integer"}},"required":["message","public"],"type":"object"},"transfer_limit":{"additionalProperties":false,"properties":{"collection_code":{"description":"Authorized value for the collection code associated with this limit","type":["string","null"]},"from_library_id":{"description":"Internal library id for which library the item is coming from","type":"string"},"item_type":{"description":"Itemtype defining the type for this limi","type":["string","null"]},"limit_id":{"description":"Internal transfer limit identifier","type":"integer"},"to_library_id":{"description":"Internal library id for which library the item is going to","type":"string"}},"required":["to_library_id","from_library_id"],"type":"object"},"vendor":{"additionalProperties":false,"properties":{"accountnumber":{"description":"Vendor account number","type":["string","null"]},"active":{"description":"Is this vendor active","type":["boolean","null"]},"address1":{"description":"Vendor physical address (line 1)","type":["string","null"]},"address2":{"description":"Vendor physical address (line 2)","type":["string","null"]},"address3":{"description":"Vendor physical address (line 3)","type":["string","null"]},"address4":{"description":"Vendor physical address (line 4)","type":["string","null"]},"aliases":{"description":"List of aliases","items":{"$ref":"#\/definitions\/vendor_alias"},"type":"array"},"baskets":{"description":"List of baskets","type":"array"},"baskets_count":{"description":"Number of linked baskets","type":["integer","null"]},"contacts":{"description":"List of contacts","type":"array"},"contracts":{"description":"List of contracts","type":"array"},"deliverytime":{"description":"Expected delivery time (in days)","type":["integer","null"]},"discount":{"description":"Default discount rate for items ordered from this vendor","type":["number","null"]},"external_id":{"description":"External id","maxLength":255,"type":["string","null"]},"fax":{"description":"Vendor fax number","maxLength":50,"type":["string","null"]},"gst":{"description":"Is the library taxed when buying from this vendor","type":["boolean","null"]},"id":{"description":"internally assigned vendor identifier","readOnly":true,"type":"integer"},"interfaces":{"description":"List of interfaces","type":"array"},"invoice_currency":{"description":"Invoice prices currency","maxLength":10,"type":["string","null"]},"invoice_includes_gst":{"description":"Invoice prices include taxes","type":["boolean","null"]},"invoices":{"description":"List of invoices","type":"array"},"invoices_count":{"description":"Number of linked invoices","type":["integer","null"]},"list_currency":{"description":"List prices currency","maxLength":10,"type":["string","null"]},"list_includes_gst":{"description":"List prices include taxes","type":["boolean","null"]},"name":{"description":"Vendor name","type":["string"]},"notes":{"description":"Vendor notes","type":["string","null"]},"phone":{"description":"Vendor phone number","maxLength":30,"type":["string","null"]},"postal":{"description":"Vendor postal address","type":["string","null"]},"subscriptions_count":{"description":"Number of linked subscriptions","type":["integer","null"]},"tax_rate":{"description":"Default tax rate for items ordered from this vendor","type":["number","null"]},"type":{"description":"Type of vendor","maxLength":255,"type":["string","null"]},"url":{"description":"Vendor web address","maxLength":255,"type":["string","null"]}},"required":["name"],"type":"object"},"vendor_alias":{"additionalProperties":false,"properties":{"alias":{"description":"The alias","type":"string"},"vendor_alias_id":{"description":"Internally assigned vendor alias identifier","type":"integer"},"vendor_id":{"description":"Internally assigned vendor alias identifier","type":"integer"}},"required":["alias"],"type":"object"},"vendor_interface":{"additionalProperties":false,"properties":{"account_email":{"description":"Account email","type":"string"},"login":{"description":"Login to be used for the interface","type":"string"},"name":{"description":"Name of the interface","type":"string"},"notes":{"description":"Interface notes","type":"string"},"password":{"description":"Hashed password","type":"string"},"type":{"description":"Type of the interface, authorised value VENDOR_INTERFACE_TYPE","type":"string"},"uri":{"description":"URI of the interface","type":"string"},"vendor_id":{"description":"Internally assigned vendor identifier","type":"integer"},"vendor_interface_id":{"description":"Internally assigned vendor interface identifier","type":"integer"}},"type":"object"},"vendor_issue":{"additionalProperties":false,"properties":{"_strings":{"description":"A list of stringified coded values","type":["object","null"]},"ended_on":{"description":"End date","format":"date","type":["string","null"]},"issue_id":{"description":"internally assigned vendor identifier","readOnly":true,"type":"integer"},"notes":{"description":"Notes","type":["string","null"]},"started_on":{"description":"Start date","format":"date","type":["string","null"]},"type":{"description":"Type of the issue","type":["string","null"]},"vendor_id":{"description":"ID of the vendor","type":"integer"}},"type":"object"},"vendors_config":{"additionalProperties":false,"properties":{"currencies":{"description":"List of currencies","type":"array"},"edifact":{"description":"EDIFACT system preference value","type":"boolean"},"erm_module":{"description":"ERMModule system preference value","type":"boolean"},"gst_values":{"description":"List of tax rates","type":"array"},"marc_orders":{"description":"MarcOrderingAutomation system preference value","type":"boolean"},"permissions":{"description":"List of permissions for the user","type":"object"}},"type":"object"}},"host":"librarycatalogue.taylors.edu.my","info":{"contact":{"name":"Koha Development Team","url":"https:\/\/koha-community.org\/"},"description":"## Background\n\nThe API supports two sets of endpoints, one targetted at library staff and the other at at library users.\n\nThose endpoints under the `\/public` path are aimed at delivering functionality tailored to library users and offer\na more restricted set of functions, overrides and data in thier responses for data privacy and library policy\nreasons. Many of these endpoints do not require authentication for fetching public data, though an authenticated\nsession will expose additional options and allow users to see more data where it is part of their own record.\n\nAll other endpoints are targetted at the staff interface level and allow for additional functionality and a more\nunrestricted view of data.  These endpoints, however, have a level of redaction built in for resources that the\napi consumer should not have access to.  For example, user data for users who do not belong to the same library\nor library group of your api user will be reduced to just minimum neccesary for a valid response. Object keys will\nbe consistent for all responses, but their values may be removed depending on access.\n\n## Authentication\n\nThe API supports the following authentication mechanisms\n\n* HTTP Basic authentication\n* OAuth2 (client credentials grant)\n* Cookie-based\n\nBoth _Basic authentication_ and the _OAuth2_ flow, need to be enabled\nby system preferences.\n\n## Authorization\n\nThe API uses existing user profiles to restrict access to resources based on user permissions and the library the\nAPI user is assigned to.  This may result, at times, in resources being returned in a redacted form with all keys\npresent but sensative values nulled.\n\nWe do not yet support OAuth Scopes or the Authorization Code grant flow.\n\n## Errors\n\nThe API uses standard HTTP status codes to indicate the success or failure\nof the API call. The body of the response will be JSON in the following format:\n\n```\n{\n  \"error\": \"Current settings prevent the passed due date to be applied\",\n  \"error_code\": \"invalid_due_date\"\n}\n```\n\nNote: Some routes might offer additional attributes in their error responses but that\"s\nsubject to change and thus not documented.\n\n## Filtering responses\n\nThe API allows for some advanced response filtering using a JSON based query syntax. The\nquery can be added to the requests:\n\n* as a query parameter `q=`\n* in the request body\n\nFor simple field equality matches we can use `{ \"fieldname\": \"value\" }` where the fieldname\nmatches one of the fields as described in the particular endpoints response object.\n\nWe can refine that with more complex matching clauses by nesting a the clause into the\nobject; `{ \"fieldname\": { \"clause\": \"value\" } }`.\n\nAvailable matching clauses include `=`, `!=`, `<`, `>`, `<=`, `>=` and `-not`. We also support `-like`\nand `-not_like` string comparisons with `%` used to denote wildcards, thus you can pass\n`{ \"fieldname\": { \"-like\": \"value%\" } }` to do a 'starts with' string match for example.\n\nWe can filter on multiple fields by adding them to the JSON respresentation. Adding at `HASH`\nlevel will result in an \"AND\" query, whilst combinding them in an `ARRAY` will result in an\n\"OR\" query: `{ \"field1\": \"value2\", \"field2\": \"value2\" }` will filter the response to only those\nresults with both field1 containing value2 AND field2 containing value2 for example.\n\nThere is a collection of special operators also available to you, including:\n\n* `-in` - Expects an array of values to perform an OR match against\n* `-not_in` - Expects an array of values to perform a NOR match against\n* `-between` - Expects two values which the value of the field is expected to fall between\n* `-not_between` - Expects two values which the value of the field is expected to fall outside of\n* `-ident` - Expects a second field name to match the two field values against\n* `-regexp` - Expects a perl compatible regular expression for which the value should match\n\nLogic and nesting is also supported and you may use `-and` and `-or` to change the logic of an ARRAY\nor HASH as described above.\n\nAdditionally, if you are requesting related data be embedded into the response one can query\non the related data using dot notation in the field names.\n\n### Examples\n\nThe following request would return any patron with firstname \"Henry\" and lastname \"Acevedo\";\n\n`curl -u koha:koha --request GET \"http:\/\/127.0.0.1:8081\/api\/v1\/patrons\/\" --data-raw '{ \"surname\": \"Acevedo\", \"firstname\": \"Henry\" }'`\n\nThe following request would return any patron whose lastname begins with \"Ace\";\n\n`curl -u koha:koha --request GET \"http:\/\/127.0.0.1:8081\/api\/v1\/patrons\/\" --data-raw '{ \"surname\": { \"-like\": \"Ace%\" }'`\n\nThe following request would return any patron whose lastname is \"Acevedo\" OR \"Bernardo\"\n\n`curl -u koha:koha --request GET \"http:\/\/127.0.0.1:8081\/api\/v1\/patrons\/\" --data-raw '{ \"surname\": [ \"Acevedo\", \"Bernardo\" ] }'`\n\nThe following request embeds the related patron extended attributes data and filters on it.\n\n`curl -u koha:koha =--request GET 'http:\/\/127.0.0.1:8081\/api\/v1\/patrons\/' --header 'x-koha-embed: extended_attributes' --data-raw '{ \"extended_attributes.code\": \"internet\", \"extended_attributes.attribute\": \"1\" }'`\n\n## Special headers\n\n### x-koha-embed\n\nThis optional header allows the api consumer to request additional related data\nto be returned in the api response.  It also allows for cross referencing in the\nqueries as described above. It accepts a comma delimited list of relation names.\n\nRelations may on occasion also support dot delimited nesting to allow traversal.\n\n### x-koha-library\n\nThis optional header should be passed to give your api request a library\ncontext; If it is not included in the request, then the request context\nwill default to using your api comsumer\"s assigned home library.\n","license":{"name":"GPL v3,","url":"https:\/\/www.gnu.org\/licenses\/gpl.txt"},"title":"Koha REST API","version":"1"},"parameters":{"advancededitormacro_id_pp":{"description":"Advanced editor macro internal identifier","in":"path","name":"advancededitormacro_id","required":true,"type":"integer"},"agreement_id_pp":{"description":"Agreement internal identifier","in":"path","name":"agreement_id","required":true,"type":"integer"},"agreement_period_id_pp":{"description":"Agreement period internal identifier","in":"path","name":"agreement_period_id","required":true,"type":"integer"},"authorised_value_id_pp":{"description":"Authorised value internal identifier","in":"path","name":"authorised_value_id","required":true,"type":"integer"},"authority_id_pp":{"description":"Authority identifier","in":"path","name":"authority_id","required":true,"type":"integer"},"authority_type_header":{"description":"Authority type code. Use when content type is not application\/json","in":"header","name":"x-authority-type","required":false,"type":"string"},"biblio_id_pp":{"description":"Record internal identifier","in":"path","name":"biblio_id","required":true,"type":"integer"},"booking_id_pp":{"description":"Booking identifier","in":"path","name":"booking_id","required":true,"type":"integer"},"candidate_match_id_pp":{"description":"Internal import record match identifier","in":"path","name":"candidate_match_id","required":true,"type":"integer"},"cash_register_id_pp":{"description":"Cash register internal identifier","in":"path","name":"cash_register_id","required":true,"type":"integer"},"cashup_id_pp":{"description":"Cashup internal identifier","in":"path","name":"cashup_id","required":true,"type":"integer"},"checkout_id_pp":{"description":"Internal checkout identifier","in":"path","name":"checkout_id","required":true,"type":"integer"},"city_id_pp":{"description":"City internal identifier","in":"path","name":"city_id","required":true,"type":"integer"},"club_id_pp":{"description":"Internal club identifier","in":"path","name":"club_id","required":true,"type":"integer"},"confirm_not_duplicate_header":{"description":"Confirm the posted element is not a duplicate","in":"header","name":"x-confirm-not-duplicate","required":false,"type":"integer"},"credit_id_pp":{"description":"Internal credit identifier","in":"path","name":"credit_id","required":true,"type":"integer"},"data_type_pp":{"description":"ERM custom report data type","in":"path","name":"data_type","required":true,"type":"string"},"debit_id_pp":{"description":"Internal debit identifier","in":"path","name":"debit_id","required":true,"type":"integer"},"eholdings_package_id_pp":{"description":"Package internal identifier","in":"path","name":"package_id","required":true,"type":"string"},"eholdings_resource_id_pp":{"description":"Resource internal identifier","in":"path","name":"resource_id","required":true,"type":"string"},"eholdings_title_id_pp":{"description":"Title internal identifier","in":"path","name":"title_id","required":true,"type":"integer"},"erm_counter_files_id_pp":{"description":"ERM counter_files internal identifier","in":"path","name":"erm_counter_files_id","required":true,"type":"integer"},"erm_counter_log_id_pp":{"description":"ERM counter_log internal identifier","in":"path","name":"erm_counter_log_id","required":true,"type":"integer"},"erm_default_usage_report_id_pp":{"description":"ERM default_usage_report internal identifier","in":"path","name":"erm_default_usage_report_id","required":true,"type":"integer"},"erm_usage_data_provider_id_pp":{"description":"ERM usage_data_provider internal identifier","in":"path","name":"erm_usage_data_provider_id","required":true,"type":"integer"},"file_transport_id_pp":{"description":"File transport internal identifier","in":"path","name":"file_transport_id","required":true,"type":"integer"},"framework_id_header":{"description":"Framework id. Use when content type is not application\/json","in":"header","name":"x-framework-id","required":false,"type":"string"},"fund_id_pp":{"description":"Fund id","in":"path","name":"fund_id","required":true,"type":"integer"},"hold_id_pp":{"description":"Internal hold identifier","in":"path","name":"hold_id","required":true,"type":"integer"},"identity_provider_domain_id_pp":{"description":"Identity provider domain internal identifier","in":"path","name":"identity_provider_domain_id","required":true,"type":"integer"},"identity_provider_id_pp":{"description":"Identity provider internal identifier","in":"path","name":"identity_provider_id","required":true,"type":"integer"},"ill_batch_id_pp":{"description":"Internal ILL batch identifier","in":"path","name":"ill_batch_id","required":true,"type":"integer"},"ill_batchstatus_code_pp":{"description":"Internal ILL batch status identifier","in":"path","name":"ill_batchstatus_code","required":true,"type":"string"},"import_batch_profile_id_pp":{"description":"Internal profile identifier","in":"path","name":"import_batch_profile_id","required":true,"type":"integer"},"import_record_id_pp":{"description":"Internal import record identifier","in":"path","name":"import_record_id","required":true,"type":"integer"},"item_id_pp":{"description":"Internal item identifier","in":"path","name":"item_id","required":true,"type":"integer"},"item_id_qp":{"description":"Internal item identifier","in":"query","name":"item_id","type":"integer"},"job_id_pp":{"description":"Job internal identifier","in":"path","name":"job_id","required":true,"type":"integer"},"library_id_pp":{"description":"Internal library identifier","in":"path","name":"library_id","required":true,"type":"string"},"license_id_pp":{"description":"License internal identifier","in":"path","name":"license_id","required":true,"type":"integer"},"marc_schema_header":{"description":"March schema. One of MARC21 or UNIMARC","enum":["MARC21","UNIMARC"],"in":"header","name":"x-record-schema","required":false,"type":"string"},"match":{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},"order_by":{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},"order_id_pp":{"description":"Internal order identifier","in":"path","name":"order_id","required":true,"type":"integer"},"page":{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},"parameters_advancededitormacro_id_pp":{"description":"Advanced editor macro internal identifier","in":"path","name":"advancededitormacro_id","required":true,"type":"integer"},"parameters_agreement_id_pp":{"description":"Agreement internal identifier","in":"path","name":"agreement_id","required":true,"type":"integer"},"parameters_authority_id_pp":{"description":"Authority identifier","in":"path","name":"authority_id","required":true,"type":"integer"},"parameters_authority_type_header":{"description":"Authority type code. Use when content type is not application\/json","in":"header","name":"x-authority-type","required":false,"type":"string"},"parameters_biblio_id_pp":{"description":"Record internal identifier","in":"path","name":"biblio_id","required":true,"type":"integer"},"parameters_booking_id_pp":{"description":"Booking identifier","in":"path","name":"booking_id","required":true,"type":"integer"},"parameters_cash_register_id_pp":{"description":"Cash register internal identifier","in":"path","name":"cash_register_id","required":true,"type":"integer"},"parameters_cashup_id_pp":{"description":"Cashup internal identifier","in":"path","name":"cashup_id","required":true,"type":"integer"},"parameters_checkout_id_pp":{"description":"Internal checkout identifier","in":"path","name":"checkout_id","required":true,"type":"integer"},"parameters_city_id_pp":{"description":"City internal identifier","in":"path","name":"city_id","required":true,"type":"integer"},"parameters_club_id_pp":{"description":"Internal club identifier","in":"path","name":"club_id","required":true,"type":"integer"},"parameters_confirm_not_duplicate_header":{"description":"Confirm the posted element is not a duplicate","in":"header","name":"x-confirm-not-duplicate","required":false,"type":"integer"},"parameters_credit_id_pp":{"description":"Internal credit identifier","in":"path","name":"credit_id","required":true,"type":"integer"},"parameters_data_type_pp":{"description":"ERM custom report data type","in":"path","name":"data_type","required":true,"type":"string"},"parameters_debit_id_pp":{"description":"Internal debit identifier","in":"path","name":"debit_id","required":true,"type":"integer"},"parameters_eholdings_package_id_pp":{"description":"Package internal identifier","in":"path","name":"package_id","required":true,"type":"string"},"parameters_eholdings_resource_id_pp":{"description":"Resource internal identifier","in":"path","name":"resource_id","required":true,"type":"string"},"parameters_eholdings_title_id_pp":{"description":"Title internal identifier","in":"path","name":"title_id","required":true,"type":"integer"},"parameters_erm_counter_files_id_pp":{"description":"ERM counter_files internal identifier","in":"path","name":"erm_counter_files_id","required":true,"type":"integer"},"parameters_erm_default_usage_report_id_pp":{"description":"ERM default_usage_report internal identifier","in":"path","name":"erm_default_usage_report_id","required":true,"type":"integer"},"parameters_erm_usage_data_provider_id_pp":{"description":"ERM usage_data_provider internal identifier","in":"path","name":"erm_usage_data_provider_id","required":true,"type":"integer"},"parameters_file_transport_id_pp":{"description":"File transport internal identifier","in":"path","name":"file_transport_id","required":true,"type":"integer"},"parameters_framework_id_header":{"description":"Framework id. Use when content type is not application\/json","in":"header","name":"x-framework-id","required":false,"type":"string"},"parameters_hold_id_pp":{"description":"Internal hold identifier","in":"path","name":"hold_id","required":true,"type":"integer"},"parameters_identity_provider_domain_id_pp":{"description":"Identity provider domain internal identifier","in":"path","name":"identity_provider_domain_id","required":true,"type":"integer"},"parameters_identity_provider_id_pp":{"description":"Identity provider internal identifier","in":"path","name":"identity_provider_id","required":true,"type":"integer"},"parameters_ill_batch_id_pp":{"description":"Internal ILL batch identifier","in":"path","name":"ill_batch_id","required":true,"type":"integer"},"parameters_ill_batchstatus_code_pp":{"description":"Internal ILL batch status identifier","in":"path","name":"ill_batchstatus_code","required":true,"type":"string"},"parameters_import_batch_profile_id_pp":{"description":"Internal profile identifier","in":"path","name":"import_batch_profile_id","required":true,"type":"integer"},"parameters_item_id_pp":{"description":"Internal item identifier","in":"path","name":"item_id","required":true,"type":"integer"},"parameters_item_id_qp":{"description":"Internal item identifier","in":"query","name":"item_id","type":"integer"},"parameters_job_id_pp":{"description":"Job internal identifier","in":"path","name":"job_id","required":true,"type":"integer"},"parameters_library_id_pp":{"description":"Internal library identifier","in":"path","name":"library_id","required":true,"type":"string"},"parameters_license_id_pp":{"description":"License internal identifier","in":"path","name":"license_id","required":true,"type":"integer"},"parameters_marc_schema_header":{"description":"March schema. One of MARC21 or UNIMARC","enum":["MARC21","UNIMARC"],"in":"header","name":"x-record-schema","required":false,"type":"string"},"parameters_match":{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},"parameters_order_by":{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},"parameters_order_id_pp":{"description":"Internal order identifier","in":"path","name":"order_id","required":true,"type":"integer"},"parameters_page":{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},"parameters_patron_id_pp":{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},"parameters_patron_id_qp":{"description":"Internal patron identifier","in":"query","name":"patron_id","type":"integer"},"parameters_per_page":{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},"parameters_preservation_processing_id_pp":{"description":"processing internal identifier","in":"path","name":"processing_id","required":true,"type":"integer"},"parameters_preservation_train_id_pp":{"description":"train internal identifier","in":"path","name":"train_id","required":true,"type":"integer"},"parameters_preservation_train_item_id_pp":{"description":"train item internal identifier","in":"path","name":"train_item_id","required":true,"type":"integer"},"parameters_q_body":{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},"parameters_q_param":{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},"parameters_quote_id_pp":{"description":"Quote internal identifier","in":"path","name":"quote_id","required":true,"type":"integer"},"parameters_record_source_id_header":{"description":"Internal record source identifier.","in":"header","name":"x-record-source-id","required":false,"type":"string"},"parameters_record_source_id_pp":{"description":"Internal record source identifier","in":"path","name":"record_source_id","required":true,"type":"integer"},"parameters_request_id_header":{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},"parameters_rota_id_pp":{"description":"Rota internal identifier","in":"path","name":"rota_id","required":true,"type":"integer"},"parameters_search_filter_id_pp":{"description":"Search filter internal identifier","in":"path","name":"search_filter_id","required":true,"type":"integer"},"parameters_seen_pp":{"description":"Item was seen flag","in":"query","name":"seen","required":false,"type":"integer"},"parameters_sip_account_id_pp":{"description":"SIP2 account internal identifier","in":"path","name":"sip_account_id","required":true,"type":"integer"},"parameters_sip_institution_id_pp":{"description":"SIP2 institution internal identifier","in":"path","name":"sip_institution_id","required":true,"type":"integer"},"parameters_sip_system_preference_override_id_pp":{"description":"SIP2 system preference override internal identifier","in":"path","name":"sip_system_preference_override_id","required":true,"type":"integer"},"parameters_smtp_server_id_pp":{"description":"SMTP server internal identifier","in":"path","name":"smtp_server_id","required":true,"type":"integer"},"parameters_suggestion_id_pp":{"description":"Internal suggestion identifier","in":"path","name":"suggestion_id","required":true,"type":"integer"},"parameters_ticket_id_pp":{"description":"Internal ticket identifier","in":"path","name":"ticket_id","required":true,"type":"integer"},"parameters_transfer_limit_id_pp":{"description":"Internal transfer limit identifier","in":"path","name":"limit_id","required":true,"type":"string"},"parameters_vendor_id_pp":{"description":"Vendor id","in":"path","name":"vendor_id","required":true,"type":"integer"},"patron_id_pp":{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},"patron_id_qp":{"description":"Internal patron identifier","in":"query","name":"patron_id","type":"integer"},"per_page":{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},"preservation_processing_id_pp":{"description":"processing internal identifier","in":"path","name":"processing_id","required":true,"type":"integer"},"preservation_train_id_pp":{"description":"train internal identifier","in":"path","name":"train_id","required":true,"type":"integer"},"preservation_train_item_id_pp":{"description":"train item internal identifier","in":"path","name":"train_item_id","required":true,"type":"integer"},"q_body":{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},"q_param":{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},"quote_id_pp":{"description":"Quote internal identifier","in":"path","name":"quote_id","required":true,"type":"integer"},"record_source_id_header":{"description":"Internal record source identifier.","in":"header","name":"x-record-source-id","required":false,"type":"string"},"record_source_id_pp":{"description":"Internal record source identifier","in":"path","name":"record_source_id","required":true,"type":"integer"},"request_id_header":{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},"rota_id_pp":{"description":"Rota internal identifier","in":"path","name":"rota_id","required":true,"type":"integer"},"search_filter_id_pp":{"description":"Search filter internal identifier","in":"path","name":"search_filter_id","required":true,"type":"integer"},"seen_pp":{"description":"Item was seen flag","in":"query","name":"seen","required":false,"type":"integer"},"sip_account_id_pp":{"description":"SIP2 account internal identifier","in":"path","name":"sip_account_id","required":true,"type":"integer"},"sip_institution_id_pp":{"description":"SIP2 institution internal identifier","in":"path","name":"sip_institution_id","required":true,"type":"integer"},"sip_listener_id_pp":{"description":"SIP2 listener internal identifier","in":"path","name":"sip_listener_id","required":true,"type":"integer"},"sip_system_preference_override_id_pp":{"description":"SIP2 system preference override internal identifier","in":"path","name":"sip_system_preference_override_id","required":true,"type":"integer"},"smtp_server_id_pp":{"description":"SMTP server internal identifier","in":"path","name":"smtp_server_id","required":true,"type":"integer"},"suggestion_id_pp":{"description":"Internal suggestion identifier","in":"path","name":"suggestion_id","required":true,"type":"integer"},"ticket_id_pp":{"description":"Internal ticket identifier","in":"path","name":"ticket_id","required":true,"type":"integer"},"transfer_limit_id_pp":{"description":"Internal transfer limit identifier","in":"path","name":"limit_id","required":true,"type":"string"},"vendor_id_pp":{"description":"Vendor id","in":"path","name":"vendor_id","required":true,"type":"integer"}},"paths":{"\/acquisitions\/baskets":{"get":{"description":"This resource returns a list of baskets","operationId":"listBaskets","parameters":[{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["basket_group","creator","days_late"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of baskets","schema":{"items":{"$ref":"#\/definitions\/basket"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List of baskets","tags":["baskets"],"x-koha-authorization":{"permissions":{"acquisition":"order_manage"}},"x-mojo-to":"Acquisitions::Baskets#list"},"post":{"consumes":["application\/json"],"operationId":"addBasket","parameters":[{"description":"A basket","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/basket"}}],"produces":["application\/json"],"responses":{"201":{"description":"A successfully created basket","schema":{"items":{"$ref":"#\/definitions\/basket"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Resource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add basket","tags":["baskets"],"x-koha-authorization":{"permissions":{"acquisition":["order_manage"]}},"x-mojo-to":"Acquisitions::Baskets#add"}},"\/acquisitions\/baskets\/managers":{"get":{"description":"This resource returns a list of patron allowed to be a manager for baskets","operationId":"listBasketsManagers","parameters":[{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["extended_attributes","library"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of orders' managers","schema":{"items":{"$ref":"#\/definitions\/patron"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List possible managers for baskets","tags":["baskets"],"x-koha-authorization":{"permissions":{"acquisition":"order_manage"}},"x-mojo-to":"Acquisitions::Baskets#list_managers"}},"\/acquisitions\/edifiles":{"get":{"operationId":"listEdifactFiles","parameters":[{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["vendor","basket","errors"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of EDIFACT files","schema":{"items":{"$ref":"#\/definitions\/edifact_file"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"EDIFACT file not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List EDIFACT files","tags":["edi_files"],"x-koha-authorization":{"permissions":{"acquisition":"edi_manage"}},"x-mojo-to":"Acquisitions::Vendor::Edifact::Files#list"}},"\/acquisitions\/funds":{"get":{"operationId":"listFunds","parameters":[{"description":"Case insensitive search on fund name","in":"query","name":"name","required":false,"type":"string"},{"description":"Display only the funds that belongs to the given patron ID","in":"query","name":"fund_owner_id","required":false,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of funds","schema":{"items":{"$ref":"#\/definitions\/fund"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Fund not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List funds","tags":["funds"],"x-koha-authorization":{"permissions":{"acquisition":"budget_manage_all"}},"x-mojo-to":"Acquisitions::Funds#list"}},"\/acquisitions\/funds\/owners":{"get":{"description":"This resource returns a list of patron allowed to be owner of funds","operationId":"listFundsOwners","parameters":[{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["extended_attributes","library"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of funds' owners","schema":{"items":{"$ref":"#\/definitions\/patron"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List possibe owners for funds","tags":["funds"],"x-koha-authorization":{"permissions":{"acquisition":"budget_modify"}},"x-mojo-to":"Acquisitions::Funds#list_owners"}},"\/acquisitions\/funds\/users":{"get":{"description":"This resource returns a list of patron allowed to be owner of funds","operationId":"listFundsUsers","parameters":[{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["extended_attributes","library"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of funds' users","schema":{"items":{"$ref":"#\/definitions\/patron"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List possibe users for funds","tags":["funds"],"x-koha-authorization":{"permissions":{"acquisition":"budget_modify"}},"x-mojo-to":"Acquisitions::Funds#list_users"}},"\/acquisitions\/orders":{"get":{"operationId":"listOrders","parameters":[{"description":"Identifier for a linked bibliographic record","in":"query","name":"biblio_id","required":false,"type":"integer"},{"description":"Identifier for a linked acquisition basket","in":"query","name":"basket_id","required":false,"type":"integer"},{"description":"Identifier for the fund the order goes against","in":"query","name":"fund_id","required":false,"type":"integer"},{"description":"Current status for the order. Can be 'new', 'ordered', 'partial', 'complete' or 'cancelled'","in":"query","name":"status","required":false,"type":"string"},{"description":"If only active orders should be listed","in":"query","name":"only_active","required":false,"type":"boolean"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["basket","basket.basket_group","basket.creator","basket.days_late","biblio","biblio.uncancelled_orders+count","biblio.holds+count","biblio.items+count","biblio.suggestions.suggester","creator","fund","fund.budget","current_item_level_holds+count","invoice","items","items+strings","subscription"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of orders","schema":{"items":{"$ref":"#\/definitions\/order"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Order not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List orders","tags":["orders"],"x-koha-authorization":{"permissions":{"acquisition":["order_manage","order_manage_all","order_receive"]}},"x-mojo-to":"Acquisitions::Orders#list"},"post":{"operationId":"addOrder","parameters":[{"description":"A JSON object representing an order","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/order"}}],"produces":["application\/json"],"responses":{"201":{"description":"Order added","schema":{"$ref":"#\/definitions\/order"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"409":{"description":"Conflict in creating the resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add order","tags":["orders"],"x-koha-authorization":{"permissions":{"acquisition":"order_manage"}},"x-mojo-to":"Acquisitions::Orders#add"}},"\/acquisitions\/orders\/{order_id}":{"delete":{"operationId":"deleteOrder","parameters":[{"description":"Internal order identifier","in":"path","name":"order_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Order deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Order not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete order","tags":["orders"],"x-koha-authorization":{"permissions":{"acquisition":"order_manage"}},"x-mojo-to":"Acquisitions::Orders#delete"},"get":{"operationId":"getOrder","parameters":[{"description":"Internal order identifier","in":"path","name":"order_id","required":true,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["basket","basket.basket_group","basket.creator","basket.days_late","biblio","biblio.uncancelled_orders+count","biblio.holds+count","biblio.items+count","biblio.suggestions.suggester","fund","current_item_level_holds+count","invoice","items","subscription"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"An order","schema":{"$ref":"#\/definitions\/order"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Order not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get order","tags":["orders"],"x-koha-authorization":{"permissions":{"acquisition":"order_manage"}},"x-mojo-to":"Acquisitions::Orders#get"},"put":{"operationId":"updateOrder","parameters":[{"description":"Internal order identifier","in":"path","name":"order_id","required":true,"type":"integer"},{"description":"A JSON object representing an order","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/order"}}],"produces":["application\/json"],"responses":{"200":{"description":"An order","schema":{"$ref":"#\/definitions\/order"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Order not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update order","tags":["orders"],"x-koha-authorization":{"permissions":{"acquisition":"order_manage"}},"x-mojo-to":"Acquisitions::Orders#update"}},"\/acquisitions\/vendors":{"get":{"operationId":"listVendors","parameters":[{"description":"Case insensitive search on vendor name","in":"query","name":"name","required":false,"type":"string"},{"description":"Case insensitive search on vendor's account number","in":"query","name":"accountnumber","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["aliases","baskets+count","subscriptions+count","invoices+count"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of vendors","schema":{"items":{"$ref":"#\/definitions\/vendor"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Vendor not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List vendors","tags":["vendors"],"x-koha-authorization":{"permissions":[{"acquisition":["vendors_manage","marc_order_manage"]},{"erm":1}]},"x-mojo-to":"Acquisitions::Vendors#list"},"post":{"operationId":"addVendor","parameters":[{"description":"A JSON object representing a vendor","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/vendor"}}],"produces":["application\/json"],"responses":{"201":{"description":"Vendor added","schema":{"$ref":"#\/definitions\/vendor"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Vendor not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add vendor","tags":["vendors"],"x-koha-authorization":{"permissions":{"acquisition":"vendors_manage"}},"x-mojo-to":"Acquisitions::Vendors#add"}},"\/acquisitions\/vendors\/config":{"get":{"description":"This resource returns a list of options needed for the Vendors Vue app","operationId":"getVendorsconfig","produces":["application\/json"],"responses":{"200":{"description":"The Vendors config","schema":{"$ref":"#\/definitions\/vendors_config"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"get the Vendors config","tags":["vendors_config"],"x-koha-authorization":{"permissions":[{"acquisition":"*"},{"erm":1}]},"x-mojo-to":"Acquisitions::Vendors#config"}},"\/acquisitions\/vendors\/{vendor_id}":{"delete":{"operationId":"deleteVendor","parameters":[{"description":"Vendor id","in":"path","name":"vendor_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Vendor deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Vendor not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Unable to perform action on vendor","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete vendor","tags":["vendors"],"x-koha-authorization":{"permissions":{"acquisition":"vendors_manage"}},"x-mojo-to":"Acquisitions::Vendors#delete"},"get":{"operationId":"getVendor","parameters":[{"description":"Vendor id","in":"path","name":"vendor_id","required":true,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["aliases","baskets+count","subscriptions+count","invoices+count","interfaces","contacts","contracts"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A vendor","schema":{"$ref":"#\/definitions\/vendor"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Vendor not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get vendor","tags":["vendors"],"x-koha-authorization":{"permissions":{"acquisition":"vendors_manage"}},"x-mojo-to":"Acquisitions::Vendors#get"},"put":{"operationId":"updateVendor","parameters":[{"description":"Vendor id","in":"path","name":"vendor_id","required":true,"type":"integer"},{"description":"A JSON object representing a vendor","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/vendor"}}],"produces":["application\/json"],"responses":{"200":{"description":"A vendor","schema":{"$ref":"#\/definitions\/vendor"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Vendor not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update vendor","tags":["vendors"],"x-koha-authorization":{"permissions":{"acquisition":"vendors_manage"}},"x-mojo-to":"Acquisitions::Vendors#update"}},"\/acquisitions\/vendors\/{vendor_id}\/issues":{"get":{"operationId":"listVendorIssues","parameters":[{"description":"Vendor id","in":"path","name":"vendor_id","required":true,"type":"integer"},{"description":"Case insensitive search on issue's id","in":"query","name":"issue_id","required":false,"type":"integer"},{"description":"Case insensitive search on vendor's id","in":"query","name":"vendor_id","required":false,"type":"integer"},{"description":"Case insensitive search on issue type","in":"query","name":"type","required":false,"type":"string"},{"description":"Case insensitive search on issue start date","in":"query","name":"started_on","required":false,"type":"string"},{"description":"Case insensitive search on issue end date","in":"query","name":"ended_on","required":false,"type":"string"},{"description":"Case insensitive search on issue's notes","in":"query","name":"notes","required":false,"type":"string"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["+strings"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of issues","schema":{"items":{"$ref":"#\/definitions\/vendor_issue"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Resource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List vendor issues","tags":["vendors"],"x-koha-authorization":{"permissions":{"acquisition":"issue_manage"}},"x-mojo-to":"Acquisitions::Vendor::Issues#list"}},"\/advanced_editor\/macros":{"get":{"operationId":"listMacro","parameters":[{"description":"Case insensative search on macro name","in":"query","name":"name","required":false,"type":"string"},{"description":"Case insensative search on macro text","in":"query","name":"macro_text","required":false,"type":"string"},{"description":"Search on internal patron_id","in":"query","name":"patron_id","required":false,"type":"string"},{"description":"Search on shared macros","in":"query","name":"shared","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of macros","schema":{"items":{"$ref":"#\/definitions\/advancededitormacro"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List advanced editor macros","tags":["macros"],"x-koha-authorization":{"permissions":{"editcatalogue":"advanced_editor"}},"x-mojo-to":"AdvancedEditorMacro#list"},"post":{"operationId":"addAdvancedEditorMacro","parameters":[{"description":"A JSON object containing informations about the new macro","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/advancededitormacro"}}],"produces":["application\/json"],"responses":{"201":{"description":"Macro added","schema":{"$ref":"#\/definitions\/advancededitormacro"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add advanced editor macros","tags":["macros"],"x-koha-authorization":{"permissions":{"editcatalogue":"advanced_editor"}},"x-mojo-to":"AdvancedEditorMacro#add"}},"\/advanced_editor\/macros\/shared":{"post":{"operationId":"addsharedAdvancedEditorMacro","parameters":[{"description":"A JSON object containing informations about the new macro","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/advancededitormacro"}}],"produces":["application\/json"],"responses":{"201":{"description":"Macro added","schema":{"$ref":"#\/definitions\/advancededitormacro"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add shared advanced editor macros","tags":["macros"],"x-koha-authorization":{"permissions":{"editcatalogue":{"advanced_editor":1,"create_shared_macros":1}}},"x-mojo-to":"AdvancedEditorMacro#add_shared"}},"\/advanced_editor\/macros\/shared\/{advancededitormacro_id}":{"delete":{"operationId":"deletesharedAdvancedEditorMacro","parameters":[{"description":"Advanced editor macro internal identifier","in":"path","name":"advancededitormacro_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Advanced editor macro deleted","schema":{"type":"string"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Macro not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete shared advanced editor macro","tags":["macros"],"x-koha-authorization":{"permissions":{"editcatalogue":{"advanced_editor":1,"delete_shared_macros":1}}},"x-mojo-to":"AdvancedEditorMacro#delete_shared"},"get":{"operationId":"getsharedAdvancedEditorMacro","parameters":[{"description":"Advanced editor macro internal identifier","in":"path","name":"advancededitormacro_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A macro","schema":{"$ref":"#\/definitions\/advancededitormacro"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"AdvancedEditorMacro not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get shared advanced editor macro","tags":["macros"],"x-koha-authorization":{"permissions":{"editcatalogue":"advanced_editor"}},"x-mojo-to":"AdvancedEditorMacro#get_shared"},"put":{"operationId":"updatesharedAdvancedEditorMacro","parameters":[{"description":"Advanced editor macro internal identifier","in":"path","name":"advancededitormacro_id","required":true,"type":"integer"},{"description":"An advanced editor macro object","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/advancededitormacro"}}],"produces":["application\/json"],"responses":{"200":{"description":"An advanced editor macro","schema":{"$ref":"#\/definitions\/advancededitormacro"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Macro not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update shared advanced editor macro","tags":["macros"],"x-koha-authorization":{"permissions":{"editcatalogue":{"advanced_editor":1,"create_shared_macros":1}}},"x-mojo-to":"AdvancedEditorMacro#update_shared"}},"\/advanced_editor\/macros\/{advancededitormacro_id}":{"delete":{"operationId":"deleteAdvancedEditorMacro","parameters":[{"description":"Advanced editor macro internal identifier","in":"path","name":"advancededitormacro_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Advanced editor macro deleted","schema":{"type":"string"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Macro not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete advanced editor macro","tags":["macros"],"x-koha-authorization":{"permissions":{"editcatalogue":"advanced_editor"}},"x-mojo-to":"AdvancedEditorMacro#delete"},"get":{"operationId":"getAdvancedEditorMacro","parameters":[{"description":"Advanced editor macro internal identifier","in":"path","name":"advancededitormacro_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A macro","schema":{"$ref":"#\/definitions\/advancededitormacro"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"AdvancedEditorMacro not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get advanced editor macro","tags":["macros"],"x-koha-authorization":{"permissions":{"editcatalogue":"advanced_editor"}},"x-mojo-to":"AdvancedEditorMacro#get"},"put":{"operationId":"updateAdvancedEditorMacro","parameters":[{"description":"Advanced editor macro internal identifier","in":"path","name":"advancededitormacro_id","required":true,"type":"integer"},{"description":"An advanced editor macro object","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/advancededitormacro"}}],"produces":["application\/json"],"responses":{"200":{"description":"An advanced editor macro","schema":{"$ref":"#\/definitions\/advancededitormacro"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Macro not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update advanced editor macro","tags":["macros"],"x-koha-authorization":{"permissions":{"editcatalogue":"advanced_editor"}},"x-mojo-to":"AdvancedEditorMacro#update"}},"\/article_requests\/{article_request_id}":{"delete":{"operationId":"cancelArticleRequest","parameters":[{"description":"Article request identifier","in":"path","name":"article_request_id","required":true,"type":"integer"},{"description":"Article request cancellation reason","in":"query","name":"cancellation_reason","required":false,"type":"string"},{"description":"Article request custom cancellation reason","in":"query","name":"notes","required":false,"type":"string"}],"produces":["application\/json"],"responses":{"204":{"description":"Article request canceled"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Cancel article requests","tags":["article_requests"],"x-koha-authorization":{"permissions":{"circulate":"circulate_remaining_permissions"}},"x-mojo-to":"ArticleRequests#cancel"}},"\/auth\/identity_providers":{"get":{"operationId":"listIdentityProviders","parameters":[{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["domains"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of identity providers","schema":{"items":{"$ref":"#\/definitions\/identity_provider"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List configured identity providers","tags":["identity_providers"],"x-koha-authorization":{"permissions":{"parameters":"manage_identity_providers"}},"x-mojo-to":"Auth::Identity::Providers#list"},"post":{"operationId":"addIdentityProvider","parameters":[{"description":"A JSON object containing OAuth provider parameters.\n\nThe `config` object required attributes depends on the chosen `protocol`\n\n## OAuth\n\nRequires:\n\n* key\n* secret\n* authorize_url\n* token_url\n\n## OIDC\n\nRequires:\n\n* key\n* secret\n* well_known_url\n","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/identity_provider"}}],"produces":["application\/json"],"responses":{"201":{"description":"The generated identity provider","schema":{"$ref":"#\/definitions\/identity_provider"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add a new identity provider","tags":["identity_providers"],"x-koha-authorization":{"permissions":{"parameters":"manage_identity_providers"}},"x-mojo-to":"Auth::Identity::Providers#add"}},"\/auth\/identity_providers\/{identity_provider_id}":{"delete":{"operationId":"delIdentityProvider","parameters":[{"description":"Identity provider internal identifier","in":"path","name":"identity_provider_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Identity provider deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"City not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n"},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete identity provider","tags":["identity_providers"],"x-koha-authorization":{"permissions":{"parameters":"manage_identity_providers"}},"x-mojo-to":"Auth::Identity::Providers#delete"},"get":{"operationId":"getIdentityProvider","parameters":[{"description":"Identity provider internal identifier","in":"path","name":"identity_provider_id","required":true,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["domains"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"An identity provider","schema":{"$ref":"#\/definitions\/identity_provider"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"404":{"description":"Object not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get identity provider","tags":["identity_providers"],"x-koha-authorization":{"permissions":{"parameters":"manage_identity_providers"}},"x-mojo-to":"Auth::Identity::Providers#get"},"put":{"operationId":"updateIdentityProvider","parameters":[{"description":"Identity provider internal identifier","in":"path","name":"identity_provider_id","required":true,"type":"integer"},{"description":"A JSON object containing OAuth provider parameters.\n\nThe `config` object required attributes depends on the chosen `protocol`\n\n## OAuth\n\nRequires:\n\n* key\n* secret\n* authorize_url\n* token_url\n\n## OIDC\n\nRequires:\n\n* key\n* secret\n* well_known_url\n","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/identity_provider"}}],"produces":["application\/json"],"responses":{"200":{"description":"Updated identity provider","schema":{"$ref":"#\/definitions\/identity_provider"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Object not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update an identity provider","tags":["identity_providers"],"x-koha-authorization":{"permissions":{"parameters":"manage_identity_providers"}},"x-mojo-to":"Auth::Identity::Providers#update"}},"\/auth\/identity_providers\/{identity_provider_id}\/domains":{"get":{"operationId":"listIdentityProviderDomains","parameters":[{"description":"Identity provider internal identifier","in":"path","name":"identity_provider_id","required":true,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["domains"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"An identity provider","schema":{"items":{"$ref":"#\/definitions\/identity_provider_domain"}}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"404":{"description":"Object not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get identity provider configured domains","tags":["identity_providers"],"x-koha-authorization":{"permissions":{"parameters":"manage_identity_providers"}},"x-mojo-to":"Auth::Identity::Provider::Domains#list"},"post":{"operationId":"addIdentityProviderDomain","parameters":[{"description":"Identity provider internal identifier","in":"path","name":"identity_provider_id","required":true,"type":"integer"},{"description":"An identity provider domain object","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/identity_provider_domain"}}],"produces":["application\/json"],"responses":{"201":{"description":"Updated identity provider domain","schema":{"$ref":"#\/definitions\/identity_provider_domain"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Object not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add an identity provider domain","tags":["identity_providers"],"x-koha-authorization":{"permissions":{"parameters":"manage_identity_providers"}},"x-mojo-to":"Auth::Identity::Provider::Domains#add"}},"\/auth\/identity_providers\/{identity_provider_id}\/domains\/{identity_provider_domain_id}":{"delete":{"operationId":"delIdentityProviderDomain","parameters":[{"description":"Identity provider internal identifier","in":"path","name":"identity_provider_id","required":true,"type":"integer"},{"description":"Identity provider domain internal identifier","in":"path","name":"identity_provider_domain_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"identity provider deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"City not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n"},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete identity provider","tags":["identity_providers"],"x-koha-authorization":{"permissions":{"parameters":"manage_identity_providers"}},"x-mojo-to":"Auth::Identity::Provider::Domains#delete"},"get":{"operationId":"getIdentityProviderDomain","parameters":[{"description":"Identity provider internal identifier","in":"path","name":"identity_provider_id","required":true,"type":"integer"},{"description":"Identity provider domain internal identifier","in":"path","name":"identity_provider_domain_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"An identity provider","schema":{"$ref":"#\/definitions\/identity_provider_domain"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"404":{"description":"Object not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get identity provider domain","tags":["identity_providers"],"x-koha-authorization":{"permissions":{"parameters":"manage_identity_providers"}},"x-mojo-to":"Auth::Identity::Provider::Domains#get"},"put":{"operationId":"updateIdentityProviderDomain","parameters":[{"description":"Identity provider internal identifier","in":"path","name":"identity_provider_id","required":true,"type":"integer"},{"description":"Identity provider domain internal identifier","in":"path","name":"identity_provider_domain_id","required":true,"type":"integer"},{"description":"An identity provider domain object","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/identity_provider_domain"}}],"produces":["application\/json"],"responses":{"200":{"description":"Updated identity provider domain","schema":{"$ref":"#\/definitions\/identity_provider_domain"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Object not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update an identity provider domain","tags":["identity_providers"],"x-koha-authorization":{"permissions":{"parameters":"manage_identity_providers"}},"x-mojo-to":"Auth::Identity::Provider::Domains#update"}},"\/auth\/otp\/token_delivery":{"post":{"operationId":"send_otp_token","produces":["application\/json"],"responses":{"200":{"description":"OK","schema":{"additionalProperties":false,"properties":{"access_token":{"type":"string"},"expires_in":{"type":"integer"},"token_type":{"type":"string"}},"type":"object"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}}},"summary":"Send OTP token for second step authentication","tags":["2fa"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"TwoFactorAuth#send_otp_token"}},"\/auth\/password\/validation":{"post":{"operationId":"validateUserAndPassword","parameters":[{"description":"A JSON object containing a patron identifier and password information.\n\nThe identifier will be used to match patrons on the database using the\nfollowing order:\n\n* userid\n* cardnumber\n\nOptionally, you can specify the `userid` attribute if you don't want it\nto be checked against the patron cardnumbers.\n","in":"body","name":"body","schema":{"additionalProperties":false,"properties":{"identifier":{"description":"A patron identifier (`userid` or `cardnumber`)","type":"string"},"password":{"description":"Password (plain text)","type":"string"},"userid":{"description":"A patron userid","type":"string"}},"required":["password"],"type":"object"}}],"produces":["application\/json"],"responses":{"201":{"description":"Validation successful","schema":{"additionalProperties":false,"properties":{"cardnumber":{"description":"cardnumber for the validated patron","type":"string"},"patron_id":{"description":"Internal patron identifier","type":"integer"},"userid":{"description":"userid for the validated patron","type":"string"}},"type":"object"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Check validity of username and password","tags":["patrons"],"x-koha-authorization":{"permissions":{"borrowers":"api_validate_password"}},"x-mojo-to":"Auth::Password#validate"}},"\/auth\/two-factor\/registration":{"post":{"operationId":"Two factor register","produces":["application\/json"],"responses":{"201":{"description":"OK","schema":{"additionalProperties":false,"properties":{"issuer":{"type":"string"},"key_id":{"type":"string"},"qr_code":{"type":"string"},"secret32":{"type":"string"}},"type":"object"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}}},"summary":"Generate a secret","tags":["2fa"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"TwoFactorAuth#registration"}},"\/auth\/two-factor\/registration\/verification":{"post":{"operationId":"Two factor register verification","parameters":[{"description":"the secret","in":"formData","name":"secret32","required":true,"type":"string"},{"description":"the pin code","in":"formData","name":"pin_code","required":true,"type":"string"}],"produces":["application\/json"],"responses":{"204":{"description":"OK"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}}},"summary":"Verify two-factor registration","tags":["2fa"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"TwoFactorAuth#verification"}},"\/authorised_value_categories":{"get":{"operationId":"listAuthorisedValueCategories","parameters":[{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["authorised_values"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of authorised value categories","schema":{"items":{"$ref":"#\/definitions\/authorised_value_category"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Resource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List authorised value categories","tags":["authorised_value_categories"],"x-koha-authorization":{"permissions":{"catalogue":1}},"x-mojo-to":"AuthorisedValueCategories#list"}},"\/authorised_value_categories\/{authorised_value_category_name}\/authorised_values":{"get":{"operationId":"listAuthorisedValues","parameters":[{"description":"category name","in":"path","name":"authorised_value_category_name","required":true,"type":"string"},{"description":"Case insensitive search on authorised value id","in":"query","name":"authorised_value_id","required":false,"type":"integer"},{"description":"Case insensitive search on authorised value category name","in":"query","name":"category_name","required":false,"type":"string"},{"description":"Case insensitive search on value","in":"query","name":"value","required":false,"type":"string"},{"description":"Case insensitive search on description","in":"query","name":"description","required":false,"type":"string"},{"description":"Case insensitive search on opac description","in":"query","name":"opac_description","required":false,"type":"string"},{"description":"Case insensitive search on image url","in":"query","name":"image_url","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of authorised values","schema":{"items":{"$ref":"#\/definitions\/authorised_value"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List authorised values for a given category","tags":["authorised_values"],"x-koha-authorization":{"permissions":{"catalogue":1}},"x-mojo-to":"AuthorisedValues#list_av_from_category"}},"\/authorities":{"get":{"operationId":"listAuthorities","parameters":[{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json","application\/marcxml+xml","application\/marc-in-json","application\/marc","text\/plain"],"responses":{"200":{"description":"A list of authorities"},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Authority not found","schema":{"$ref":"#\/definitions\/error"}},"406":{"description":"Not acceptable","schema":{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List authorities","tags":["authorities"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"Authorities#list"},"post":{"description":"Add an authority record to Koha. An optional `x-authority-type`\nmay be passed to specify the cataloguing framework to be used (instead\nof the default).\n\nThe request body is expected to contain a MARC record in the format specified in\nthe `Content-type` header you pass. Possible values for this header and the corresponding\nrecord formats expected are listed below:\n\n* application\/marcxml+xml: MARCXML\n* application\/marc-in-json: MARC-in-JSON\n* application\/marc: Raw USMARC binary data\n","operationId":"addAuthority","parameters":[{"description":"Authority type code. Use when content type is not application\/json","in":"header","name":"x-authority-type","required":false,"type":"string"},{"collectionFormat":"csv","description":"Overrides list sent as a request header","in":"header","items":{"enum":["any","duplicate"],"type":"string"},"name":"x-koha-override","required":false,"type":"array"}],"responses":{"201":{"description":"An authority"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"406":{"description":"Not acceptable","schema":{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}},"409":{"description":"Conflict creating the resource. Possible `error_code` attribute values:\n\n* `duplicate`\n","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add authority","tags":["authorities"],"x-koha-authorization":{"permissions":{"editauthorities":"1"}},"x-mojo-to":"Authorities#add"}},"\/authorities\/{authority_id}":{"delete":{"operationId":"deleteAuthority","parameters":[{"description":"Authority identifier","in":"path","name":"authority_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Authority deleted","schema":{"type":"string"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Authority not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete authority","tags":["authorities"],"x-koha-authorization":{"permissions":{"editauthorities":"1"}},"x-mojo-to":"Authorities#delete"},"get":{"operationId":"getAuthority","parameters":[{"description":"Authority identifier","in":"path","name":"authority_id","required":true,"type":"integer"}],"produces":["application\/json","application\/marcxml+xml","application\/marc-in-json","application\/marc","text\/plain"],"responses":{"200":{"description":"An authority"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Authority not found","schema":{"$ref":"#\/definitions\/error"}},"406":{"description":"Not acceptable","schema":{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get authority","tags":["authorities"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"Authorities#get"},"put":{"operationId":"updateAuthority","parameters":[{"description":"Authority identifier","in":"path","name":"authority_id","required":true,"type":"integer"},{"description":"Authority type code. Use when content type is not application\/json","in":"header","name":"x-authority-type","required":false,"type":"string"}],"produces":["application\/json"],"responses":{"200":{"description":"An authority id"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Authority not found","schema":{"$ref":"#\/definitions\/error"}},"406":{"description":"Not acceptable","schema":{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update authority","tags":["authorities"],"x-koha-authorization":{"permissions":{"editauthorities":"1"}},"x-mojo-to":"Authorities#update"}},"\/biblios":{"get":{"operationId":"listBiblio","parameters":[{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json","application\/marcxml+xml","application\/marc-in-json","application\/marc","text\/plain"],"responses":{"200":{"description":"A list of biblios"},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Bibliographic record not found","schema":{"$ref":"#\/definitions\/error"}},"406":{"description":"Not acceptable","schema":{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List biblios","tags":["biblios"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"Biblios#list"},"post":{"description":"Add a bibliographic record to Koha. An optional `x-framework-id`\nmay be passed to specify the cataloguing framework to be used (instead\nof the default).\n\nThe request body is expected to contain a MARC record in the format specified in\nthe `Content-type` header you pass. Possible values for this header and the corresponding\nrecord formats expected are listed below:\n\n* application\/marcxml+xml: MARCXML\n* application\/marc-in-json: MARC-in-JSON\n* application\/marc: Raw USMARC binary data\n","operationId":"addBiblio","parameters":[{"description":"Framework id. Use when content type is not application\/json","in":"header","name":"x-framework-id","required":false,"type":"string"},{"description":"March schema. One of MARC21 or UNIMARC","enum":["MARC21","UNIMARC"],"in":"header","name":"x-record-schema","required":false,"type":"string"},{"description":"Confirm the posted element is not a duplicate","in":"header","name":"x-confirm-not-duplicate","required":false,"type":"integer"},{"description":"Internal record source identifier.","in":"header","name":"x-record-source-id","required":false,"type":"string"}],"produces":["application\/json"],"responses":{"200":{"description":"A biblio"},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `record_creation_failed`: An error occurred during record creation. The cause could not be determined.\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"406":{"description":"Not acceptable","schema":{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add biblio","tags":["biblios"],"x-koha-authorization":{"permissions":{"editcatalogue":"edit_catalogue"}},"x-mojo-to":"Biblios#add"}},"\/biblios\/{biblio_id}":{"delete":{"operationId":"deleteBiblio","parameters":[{"description":"Record internal identifier","in":"path","name":"biblio_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Biblio deleted","schema":{"type":"string"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Bibliographic record not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Unable to perform action on biblio","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete biblio","tags":["biblios"],"x-koha-authorization":{"permissions":{"editcatalogue":"edit_catalogue"}},"x-mojo-to":"Biblios#delete"},"get":{"operationId":"getBiblio","parameters":[{"description":"Record internal identifier","in":"path","name":"biblio_id","required":true,"type":"integer"}],"produces":["application\/json","application\/marcxml+xml","application\/marc-in-json","application\/marc","text\/plain"],"responses":{"200":{"description":"A biblio"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Bibliographic record not found","schema":{"$ref":"#\/definitions\/error"}},"406":{"description":"Not acceptable","schema":{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get biblio","tags":["biblios"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"Biblios#get"},"put":{"description":"Updates a bibliographic record to Koha. An optional `x-framework-id`\nmay be passed, to specify the cataloguing framework to be used (instead\nof the default).\n\nThe request body is expected to contain a MARC record in the format specified by\nthe `Content-type` header passed. Possible values for this headers and the corresponding\nrecord formats expected are listed below:\n\n* application\/marcxml+xml: MARCXML\n* application\/marc-in-json: MARC-in-JSON\n* application\/marc: Raw USMARC binary data\n","operationId":"updateBiblio","parameters":[{"description":"Record internal identifier","in":"path","name":"biblio_id","required":true,"type":"integer"},{"description":"Framework id. Use when content type is not application\/json","in":"header","name":"x-framework-id","required":false,"type":"string"},{"description":"March schema. One of MARC21 or UNIMARC","enum":["MARC21","UNIMARC"],"in":"header","name":"x-record-schema","required":false,"type":"string"},{"description":"Confirm the posted element is not a duplicate","in":"header","name":"x-confirm-not-duplicate","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A biblio"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Bibliographic record not found","schema":{"$ref":"#\/definitions\/error"}},"406":{"description":"Not acceptable","schema":{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update biblio","tags":["biblios"],"x-koha-authorization":{"permissions":{"editcatalogue":"edit_catalogue"}},"x-mojo-to":"Biblios#update"}},"\/biblios\/{biblio_id}\/bookings":{"get":{"consumes":["application\/json"],"operationId":"getBiblioBookings","parameters":[{"description":"Record internal identifier","in":"path","name":"biblio_id","required":true,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["item","patron","pickup_library"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of the bookings attached to the record","schema":{"items":{"$ref":"#\/definitions\/booking"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Bibliographic record not found","schema":{"$ref":"#\/definitions\/error"}},"406":{"description":"Not acceptable","schema":{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}},"500":{"description":"Internal server error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get bookings for a biblio","tags":["bookings"],"x-koha-authorization":{"permissions":{"circulate":"manage_bookings"}},"x-mojo-to":"Biblios#get_bookings"}},"\/biblios\/{biblio_id}\/checkouts":{"get":{"operationId":"listBiblioCheckouts","parameters":[{"description":"Record internal identifier","in":"path","name":"biblio_id","required":true,"type":"integer"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["issuer","item","patron","library"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"By default, current checkouts are returned, when this is true then checked in checkouts are returned as result.","in":"query","name":"checked_in","type":"boolean"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of checkouts","schema":{"$ref":"#\/definitions\/checkouts"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Bibliographic record not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List checkouts for a biblio","tags":["checkouts"],"x-koha-authorization":{"permissions":[{"circulate":"circulate_remaining_permissions"},{"circulate":"manage_bookings"}]},"x-mojo-to":"Biblios#get_checkouts"}},"\/biblios\/{biblio_id}\/item_groups":{"get":{"operationId":"listItemGroups","parameters":[{"description":"Internal identifier for the parent bibliographic record","in":"path","name":"biblio_id","required":true,"type":"string"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["items"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/yaml"],"responses":{"200":{"description":"A list of item_groups","schema":{"items":{"$ref":"#\/definitions\/item_group"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List item_groups","tags":["item_groups"],"x-koha-authorization":{"permissions":{"catalogue":"manage_item_groups"}},"x-mojo-to":"Biblios::ItemGroups#list"},"post":{"operationId":"addItemGroup","parameters":[{"description":"Internal identifier for the parent bibliographic record","in":"path","name":"biblio_id","required":true,"type":"string"},{"description":"A JSON object representing an item group","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"description":{"description":"ItemGroup description","type":"string"},"display_order":{"description":"Position in waiting queue","type":"integer"}},"type":"object"}}],"produces":["application\/yaml"],"responses":{"201":{"description":"A successfully created item group","schema":{"$ref":"#\/definitions\/item_group"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Resource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add item group","tags":["item_groups"],"x-koha-authorization":{"permissions":{"catalogue":"manage_item_groups"}},"x-mojo-to":"Biblios::ItemGroups#add"}},"\/biblios\/{biblio_id}\/item_groups\/{item_group_id}":{"delete":{"operationId":"deleteItemGroup","parameters":[{"description":"Internal identifier for the parent bibliographic record","in":"path","name":"biblio_id","required":true,"type":"string"},{"description":"Internal identifier for the item group","in":"path","name":"item_group_id","required":true,"type":"string"}],"produces":["application\/yaml"],"responses":{"204":{"description":"ItemGroup deleted","schema":{"type":"string"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ItemGroup not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete item group","tags":["item_groups"],"x-koha-authorization":{"permissions":{"catalogue":"manage_item_groups"}},"x-mojo-to":"Biblios::ItemGroups#delete"},"get":{"operationId":"getItemGroup","parameters":[{"description":"Internal identifier for the parent bibliographic record","in":"path","name":"biblio_id","required":true,"type":"string"},{"description":"Internal identifier for the item_group","in":"path","name":"item_group_id","required":true,"type":"string"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["items"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/yaml"],"responses":{"200":{"description":"An item group","schema":{"$ref":"#\/definitions\/item_group"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"404":{"description":"ItemGroup not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get item group","tags":["item_groups"],"x-koha-authorization":{"permissions":{"catalogue":"manage_item_groups"}},"x-mojo-to":"Biblios::ItemGroups#get"},"put":{"operationId":"updateItemGroup","parameters":[{"description":"Internal identifier for the parent bibliographic record","in":"path","name":"biblio_id","required":true,"type":"string"},{"description":"Internal identifier for the item group","in":"path","name":"item_group_id","required":true,"type":"string"},{"description":"A JSON object with the new values for the item group","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"description":{"description":"ItemGroup description","type":"string"},"display_order":{"description":"Position in waiting queue","type":"integer"}},"type":"object"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["items"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/yaml"],"responses":{"200":{"description":"The updated item group","schema":{"$ref":"#\/definitions\/item_group"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ItemGroup not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update item group","tags":["item_groups"],"x-koha-authorization":{"permissions":{"catalogue":"manage_item_groups"}},"x-mojo-to":"Biblios::ItemGroups#update"}},"\/biblios\/{biblio_id}\/item_groups\/{item_group_id}\/items":{"post":{"operationId":"addItemGroupItem","parameters":[{"description":"Internal identifier for the parent bibliographic record","in":"path","name":"biblio_id","required":true,"type":"string"},{"description":"Internal identifier for the item group","in":"path","name":"item_group_id","required":true,"type":"string"},{"description":"A JSON object containing an item_id","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"item_id":{"description":"Internal identifier for an item to be linked","type":"integer"}},"type":"object"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["items"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/yaml"],"responses":{"201":{"description":"Item linked to item group"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"409":{"description":"Request conflicts","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add item to item group","tags":["item_groups"],"x-koha-authorization":{"permissions":{"catalogue":"manage_item_groups"}},"x-mojo-to":"Biblios::ItemGroups::Items#add"}},"\/biblios\/{biblio_id}\/item_groups\/{item_group_id}\/items\/{item_id}":{"delete":{"operationId":"deleteItemGroupItems","parameters":[{"description":"Internal identifier for the parent bibliographic record","in":"path","name":"biblio_id","required":true,"type":"string"},{"description":"Internal identifier for the item group","in":"path","name":"item_group_id","required":true,"type":"string"},{"description":"Internal identifier for the item","in":"path","name":"item_id","required":true,"type":"string"}],"produces":["application\/yaml"],"responses":{"204":{"description":"Item unlinked from item group","schema":{"type":"string"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Item not linked to item group","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete item from item group","tags":["item_groups"],"x-koha-authorization":{"permissions":{"catalogue":"manage_item_groups"}},"x-mojo-to":"Biblios::ItemGroups::Items#delete"}},"\/biblios\/{biblio_id}\/items":{"get":{"consumes":["application\/json"],"operationId":"getBiblioItems","parameters":[{"description":"Record internal identifier","in":"path","name":"biblio_id","required":true,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["+strings","_status","home_library","holding_library","biblio.title","checkout","checkout.patron","transfer","transfer+strings","first_hold","first_hold+strings","first_hold.patron","first_hold.desk","recall","recall+strings","recall.patron","item_type","in_bundle","bundle_host","bundle_host.biblio","bundle_items_lost+count","bundle_items_not_lost+count","course_item.course_reserves.course","analytics_count","cover_image_ids","item_group_item.item_group.description","serial_item.serial","return_claims","effective_bookable"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"description":"Limit to items that are bookable","in":"query","name":"bookable","required":false,"type":"boolean"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of the items attached to the record","schema":{"items":{"$ref":"#\/definitions\/item"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Bibliographic record not found","schema":{"$ref":"#\/definitions\/error"}},"406":{"description":"Not acceptable","schema":{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get items for a biblio","tags":["biblios"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"Biblios#get_items"},"post":{"operationId":"addBiblioItem","parameters":[{"description":"Record internal identifier","in":"path","name":"biblio_id","required":true,"type":"integer"},{"description":"A JSON object containing information about the new item","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/item"}}],"produces":["application\/json"],"responses":{"201":{"description":"Item added","schema":{"$ref":"#\/definitions\/item"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add an item for a biblio","tags":["biblios"],"x-koha-authorization":{"permissions":{"editcatalogue":"edit_items"}},"x-mojo-to":"Biblios#add_item"}},"\/biblios\/{biblio_id}\/items\/{item_id}":{"put":{"operationId":"updateBiblioItem","parameters":[{"description":"Record internal identifier","in":"path","name":"biblio_id","required":true,"type":"integer"},{"description":"Internal item identifier","in":"path","name":"item_id","required":true,"type":"integer"},{"description":"A JSON object containing information about the item","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/item"}}],"produces":["application\/json"],"responses":{"200":{"description":"Item updated","schema":{"$ref":"#\/definitions\/item"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update an item for a biblio","tags":["biblios"],"x-koha-authorization":{"permissions":{"editcatalogue":"edit_items"}},"x-mojo-to":"Biblios#update_item"}},"\/biblios\/{biblio_id}\/merge":{"post":{"consumes":["application\/json"],"operationId":"mergeBiblios","parameters":[{"description":"Bilblionumber","in":"path","name":"biblio_id","required":true,"type":"string"},{"description":"JSON Object with params and an optional marc record in MARC-in-JSON format","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/merge_biblios"}}],"produces":["application\/marc-in-json"],"responses":{"200":{"description":"The merge result as a biblio record"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Bibliographic record not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Merge Biblios","tags":["biblios"],"x-koha-authorization":{"permissions":{"catalogue":"editcatalogue"}},"x-mojo-to":"Biblios#merge"}},"\/biblios\/{biblio_id}\/pickup_locations":{"get":{"consumes":["application\/json"],"operationId":"getBiblioPickupLocations","parameters":[{"description":"Record internal identifier","in":"path","name":"biblio_id","required":true,"type":"integer"},{"description":"Internal patron identifier","in":"query","name":"patron_id","required":true,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"Biblio pickup locations","schema":{"items":{"$ref":"#\/definitions\/library"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Bibliographic record not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get valid pickup locations for a biblio","tags":["biblios"],"x-koha-authorization":{"permissions":{"reserveforothers":"place_holds"}},"x-mojo-to":"Biblios#pickup_locations"}},"\/bookings":{"get":{"operationId":"listBookings","parameters":[{"description":"Case insensative search on booking biblio_id","in":"query","name":"biblio_id","required":false,"type":"string"},{"description":"Case insensative search on booking item_id","in":"query","name":"item_id","required":false,"type":"string"},{"description":"Case insensative search on booking patron_id","in":"query","name":"patron_id","required":false,"type":"string"},{"description":"Case Insensative search on booking start_date","in":"query","name":"start_date","required":false,"type":"string"},{"description":"Case Insensative search on booking end_date","in":"query","name":"end_date","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["biblio","item","item+strings","item.checkout","patron","pickup_library"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of bookings","schema":{"items":{"$ref":"#\/definitions\/booking"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List bookings","tags":["bookings"],"x-koha-authorization":{"permissions":{"catalogue":1}},"x-mojo-to":"Bookings#list"},"post":{"operationId":"addBooking","parameters":[{"description":"A JSON object containing informations about the new booking","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/booking"}}],"produces":["application\/json"],"responses":{"201":{"description":"Booking added","schema":{"$ref":"#\/definitions\/booking"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"409":{"description":"Conflict","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add booking","tags":["bookings"],"x-koha-authorization":{"permissions":{"circulate":"manage_bookings"}},"x-mojo-to":"Bookings#add"}},"\/bookings\/{booking_id}":{"delete":{"operationId":"deleteBooking","parameters":[{"description":"Booking identifier","in":"path","name":"booking_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Booking deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Booking not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete booking","tags":["bookings"],"x-koha-authorization":{"permissions":{"circulate":"manage_bookings"}},"x-mojo-to":"Bookings#delete"},"get":{"operationId":"getBooking","parameters":[{"description":"Booking identifier","in":"path","name":"booking_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A booking","schema":{"$ref":"#\/definitions\/booking"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"404":{"description":"Booking not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get booking","tags":["bookings"],"x-koha-authorization":{"permissions":{"catalogue":1}},"x-mojo-to":"Bookings#get"},"patch":{"consumes":["application\/json"],"operationId":"editBooking","parameters":[{"description":"Booking identifier","in":"path","name":"booking_id","required":true,"type":"integer"},{"description":"A partial booking object containing fields to modify","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/booking_patch"}}],"produces":["application\/json"],"responses":{"200":{"description":"Updated booking","schema":{"$ref":"#\/definitions\/booking"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Booking not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update booking","tags":["bookings"],"x-koha-authorization":{"permissions":{"circulate":"manage_bookings"}},"x-mojo-to":"Bookings#update"},"put":{"consumes":["application\/json"],"operationId":"updateBooking","parameters":[{"description":"Booking identifier","in":"path","name":"booking_id","required":true,"type":"integer"},{"description":"A complete booking object to replace the current one","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/booking"}}],"produces":["application\/json"],"responses":{"200":{"description":"Updated booking","schema":{"$ref":"#\/definitions\/booking"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Booking not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update booking","tags":["bookings"],"x-koha-authorization":{"permissions":{"circulate":"manage_bookings"}},"x-mojo-to":"Bookings#update"}},"\/cash_registers":{"get":{"operationId":"listCashRegisters","parameters":[{"collectionFormat":"csv","description":"Case insensitive search on cash register cash_register_id","in":"query","name":"cash_register_id","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of cash registers","schema":{"items":{"$ref":"#\/definitions\/cash_register"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List cash registers","tags":["cash_registers"],"x-koha-authorization":{"permissions":{"parameters":"catalogue"}},"x-mojo-to":"CashRegisters::Registers#list"}},"\/cash_registers\/{cash_register_id}\/cashups":{"get":{"operationId":"listCashups","parameters":[{"description":"Cash register internal identifier","in":"path","name":"cash_register_id","required":true,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["manager"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"Cashups performed on this register","schema":{"items":{"$ref":"#\/definitions\/cashup"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Register not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List cashups for the cash register","tags":["cashups"],"x-koha-authorization":{"permissions":{"cash_management":"cashup"}},"x-mojo-to":"CashRegisters::Cashups#list"}},"\/cashups\/{cashup_id}":{"get":{"operationId":"getCashup","parameters":[{"description":"Cashup internal identifier","in":"path","name":"cashup_id","required":true,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["summary"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A cashup","schema":{"$ref":"#\/definitions\/cashup"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get cashup","tags":["cashups"],"x-koha-authorization":{"permissions":{"cash_management":"cashup"}},"x-mojo-to":"CashRegisters::Cashups#get"}},"\/checkouts":{"get":{"operationId":"listCheckouts","parameters":[{"description":"Internal patron identifier","in":"query","name":"patron_id","type":"integer"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"description":"By default, current checkouts are returned, when this is true then checked in checkouts are returned as result.","in":"query","name":"checked_in","type":"boolean"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["booking","issuer","item","item.biblio","library","patron","renewals"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of checkouts","schema":{"$ref":"#\/definitions\/checkouts"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List checkouts","tags":["checkouts"],"x-koha-authorization":{"permissions":[{"circulate":"circulate_remaining_permissions"},{"circulate":"manage_bookings"}]},"x-mojo-to":"Checkouts#list"},"post":{"consumes":["application\/json"],"operationId":"addCheckout","parameters":[{"description":"A JSON object containing information about the new checkout","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/checkout"}},{"description":"A JWT confirmation token","in":"query","name":"confirmation","required":false,"type":"string"}],"produces":["application\/json"],"responses":{"201":{"description":"Created checkout","schema":{"$ref":"#\/definitions\/checkout"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Cannot create checkout","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"409":{"description":"Conflict in creating checkout","schema":{"$ref":"#\/definitions\/error"}},"412":{"description":"Precondition failed","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add a new checkout","tags":["checkouts","patrons"],"x-koha-authorization":{"permissions":{"circulate":"circulate_remaining_permissions"}},"x-mojo-to":"Checkouts#add"}},"\/checkouts\/availability":{"get":{"operationId":"availabilityCheckouts","parameters":[{"description":"Internal patron identifier","in":"query","name":"patron_id","type":"integer"},{"description":"Internal item identifier","in":"query","name":"item_id","type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"Availability","schema":{"$ref":"#\/definitions\/checkout_availability"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get checkout availability","tags":["checkouts"],"x-koha-authorization":{"permissions":{"circulate":"circulate_remaining_permissions"}},"x-mojo-to":"Checkouts#get_availability"}},"\/checkouts\/{checkout_id}":{"get":{"operationId":"getCheckout","parameters":[{"description":"Internal checkout identifier","in":"path","name":"checkout_id","required":true,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["booking","issuer","item","item.biblio","library","patron","renewals"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"Updated borrower's checkout","schema":{"$ref":"#\/definitions\/checkout"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Checkout not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get checkout","tags":["checkouts"],"x-koha-authorization":{"permissions":{"circulate":"circulate_remaining_permissions"}},"x-mojo-to":"Checkouts#get"}},"\/checkouts\/{checkout_id}\/allows_renewal":{"get":{"operationId":"allows_renewalCheckout","parameters":[{"description":"Internal checkout identifier","in":"path","name":"checkout_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"Checkout renewability information","schema":{"$ref":"#\/definitions\/allows_renewal"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Checkout not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get renewability for a checkout","tags":["checkouts"],"x-koha-authorization":{"permissions":{"circulate":"circulate_remaining_permissions"}},"x-mojo-to":"Checkouts#allows_renewal"}},"\/checkouts\/{checkout_id}\/renewal":{"post":{"operationId":"renewCheckout","parameters":[{"description":"Internal checkout identifier","in":"path","name":"checkout_id","required":true,"type":"integer"},{"description":"Item was seen flag","in":"query","name":"seen","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"201":{"description":"Updated borrower's checkout","schema":{"$ref":"#\/definitions\/checkout"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Cannot renew checkout","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Checkout not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Renew a checkout","tags":["checkouts"],"x-koha-authorization":{"permissions":{"circulate":"circulate_remaining_permissions"}},"x-mojo-to":"Checkouts#renew"}},"\/checkouts\/{checkout_id}\/renewals":{"get":{"operationId":"getRenewals","parameters":[{"description":"Internal checkout identifier","in":"path","name":"checkout_id","required":true,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["renewer"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"List of checkouts renewals","schema":{"$ref":"#\/definitions\/renewals"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Checkout not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List renewals for a checkout","tags":["checkouts"],"x-koha-authorization":{"permissions":{"circulate":"circulate_remaining_permissions"}},"x-mojo-to":"Checkouts#get_renewals"},"post":{"operationId":"renewsCheckout","parameters":[{"description":"Internal checkout identifier","in":"path","name":"checkout_id","required":true,"type":"integer"},{"description":"Item was seen flag","in":"query","name":"seen","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"201":{"description":"Updated borrower's checkout","schema":{"$ref":"#\/definitions\/checkout"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Cannot renew checkout","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Checkout not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Renew a checkout","tags":["checkouts"],"x-koha-authorization":{"permissions":{"circulate":"circulate_remaining_permissions"}},"x-mojo-to":"Checkouts#renew"}},"\/circulation_rules":{"get":{"operationId":"listCirculationRules","parameters":[{"description":"Boolean indicating whether to return effective rules or all rules. Defaults to true.","in":"query","name":"effective","required":false,"type":"boolean"},{"description":"The item type identifier","in":"query","name":"item_type_id","required":false,"type":"string"},{"description":"The library identifier","in":"query","name":"library_id","required":false,"type":"string"},{"description":"The patron category identifier","in":"query","name":"patron_category_id","required":false,"type":"string"},{"description":"A comma-separated list of rule kinds","in":"query","name":"rules","required":false,"type":"string"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of rules for this item type, library and patron category combination","schema":{"items":{"$ref":"#\/definitions\/circulation_rules"},"type":"array"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get circulation rules for a given item type\/library\/patron combination.","tags":["circulation_rules"],"x-koha-authorization":{"permissions":[{"circulate":"circulate_remaining_permissions"}]},"x-mojo-to":"CirculationRules#list_rules"},"put":{"consumes":["application\/json"],"operationId":"setCirculationRules","parameters":[{"description":"A JSON object containing new information about circulation rules","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/circulation_rules"}}],"produces":["application\/json"],"responses":{"200":{"description":"A successfully updated circulation rules set","schema":{"items":{"$ref":"#\/definitions\/circulation_rules"}}},"400":{"description":"Bad request.\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Resource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in updating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update circulation rules","tags":["circulation_rules"],"x-koha-authorization":{"permissions":[{"circulate":"circulate_remaining_permissions"}]},"x-mojo-to":"CirculationRules#set_rules"}},"\/circulation_rules\/kinds":{"get":{"operationId":"getCirculationRuleKinds","produces":["application\/json"],"responses":{"200":{"description":"A map of rule kind information","schema":{"additionalProperties":{"$ref":"#\/definitions\/circ-rule-kind"},"type":"object"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get circulation rules kinds","tags":["circulation_rules"],"x-koha-authorization":{"permissions":[{"circulate":"circulate_remaining_permissions"}]},"x-mojo-to":"CirculationRules#get_kinds"}},"\/cities":{"get":{"operationId":"listCities","parameters":[{"description":"Case insensative search on city name","in":"query","name":"name","required":false,"type":"string"},{"description":"Case insensative search on city state","in":"query","name":"state","required":false,"type":"string"},{"description":"Case insensative search on city country","in":"query","name":"country","required":false,"type":"string"},{"description":"Case Insensative search on city postal code","in":"query","name":"postal_code","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of cities","schema":{"items":{"$ref":"#\/definitions\/city"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List cities","tags":["cities"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"Cities#list"},"post":{"operationId":"addCity","parameters":[{"description":"A JSON object containing informations about the new hold","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/city"}}],"produces":["application\/json"],"responses":{"201":{"description":"City added","schema":{"$ref":"#\/definitions\/city"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add city","tags":["cities"],"x-koha-authorization":{"permissions":{"parameters":"manage_cities"}},"x-mojo-to":"Cities#add"}},"\/cities\/{city_id}":{"delete":{"operationId":"deleteCity","parameters":[{"description":"City internal identifier","in":"path","name":"city_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"City deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"City not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete city","tags":["cities"],"x-koha-authorization":{"permissions":{"parameters":"manage_cities"}},"x-mojo-to":"Cities#delete"},"get":{"operationId":"getCity","parameters":[{"description":"City internal identifier","in":"path","name":"city_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A city","schema":{"$ref":"#\/definitions\/city"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"404":{"description":"City not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get city","tags":["cities"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"Cities#get"},"put":{"operationId":"updateCity","parameters":[{"description":"City internal identifier","in":"path","name":"city_id","required":true,"type":"integer"},{"description":"A city object","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/city"}}],"produces":["application\/json"],"responses":{"200":{"description":"A city","schema":{"$ref":"#\/definitions\/city"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"City not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update city","tags":["cities"],"x-koha-authorization":{"permissions":{"parameters":"manage_cities"}},"x-mojo-to":"Cities#update"}},"\/clubs\/{club_id}\/holds":{"post":{"consumes":["application\/json"],"operationId":"addClubHold","parameters":[{"description":"Internal club identifier","in":"path","name":"club_id","required":true,"type":"integer"},{"description":"A JSON object containing informations about the new hold","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"biblio_id":{"description":"Internal biblio identifier","type":["integer","null"]},"default_patron_home":{"description":"For each patron, set pickup location to patron's home library if possible","type":"integer"},"expiration_date":{"description":"Hold end date","format":"date","type":["string","null"]},"item_id":{"description":"Internal item identifier","type":["integer","null"]},"item_type":{"description":"Limit hold on one itemtype (ignored for item-level holds)","type":["string","null"]},"notes":{"description":"Notes related to this hold","type":["string","null"]},"pickup_library_id":{"description":"Internal library identifier for the pickup library","type":"string"}},"required":["pickup_library_id"],"type":"object"}}],"produces":["application\/json"],"responses":{"201":{"description":"Created club hold","schema":{"$ref":"#\/definitions\/club_hold"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Hold not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Club not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Hold not allowed","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add a club hold","tags":["clubs"],"x-koha-authorization":{"permissions":{"reserveforothers":"place_holds"}},"x-mojo-to":"Clubs::Holds#add"}},"\/config\/file_transports":{"get":{"operationId":"listFileTransportServers","parameters":[{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of File transports","schema":{"items":{"$ref":"#\/definitions\/file_transport"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List File transports","tags":["file_transports"],"x-koha-authorization":{"permissions":{"parameters":"manage_file_transports"}},"x-mojo-to":"Config::File::Transports#list"},"post":{"operationId":"addFileTransportServer","parameters":[{"description":"A JSON object representing a new File transport configuration","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/file_transport"}}],"produces":["application\/json"],"responses":{"201":{"description":"An File transport object","schema":{"$ref":"#\/definitions\/file_transport"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add File transport","tags":["file_transports"],"x-koha-authorization":{"permissions":{"parameters":"manage_file_transports"}},"x-mojo-to":"Config::File::Transports#add"}},"\/config\/file_transports\/{file_transport_id}":{"delete":{"operationId":"deleteFileTransportServer","parameters":[{"description":"File transport internal identifier","in":"path","name":"file_transport_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"File transport deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Object not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete File transport","tags":["file_transports"],"x-koha-authorization":{"permissions":{"parameters":"manage_file_transports"}},"x-mojo-to":"Config::File::Transports#delete"},"get":{"operationId":"getFileTransportServer","parameters":[{"description":"File transport internal identifier","in":"path","name":"file_transport_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"An File transport object","schema":{"$ref":"#\/definitions\/file_transport"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"404":{"description":"Object not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict updating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get File transport","tags":["file_transports"],"x-koha-authorization":{"permissions":{"parameters":"manage_file_transports"}},"x-mojo-to":"Config::File::Transports#get"},"put":{"operationId":"updateFileTransportServer","parameters":[{"description":"File transport internal identifier","in":"path","name":"file_transport_id","required":true,"type":"integer"},{"description":"An File transport object","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/file_transport"}}],"produces":["application\/json"],"responses":{"200":{"description":"An File transport object","schema":{"$ref":"#\/definitions\/file_transport"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Object not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update File transport","tags":["file_transports"],"x-koha-authorization":{"permissions":{"parameters":"manage_file_transports"}},"x-mojo-to":"Config::File::Transports#update"}},"\/config\/smtp_servers":{"get":{"operationId":"listSMTPServers","parameters":[{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of SMTP servers","schema":{"items":{"$ref":"#\/definitions\/smtp_server"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List SMTP servers","tags":["smtp_servers"],"x-koha-authorization":{"permissions":{"parameters":"manage_smtp_servers"}},"x-mojo-to":"Config::SMTP::Servers#list"},"post":{"operationId":"addSMTPServer","parameters":[{"description":"A JSON object representing a new SMTP server configuration","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/smtp_server"}}],"produces":["application\/json"],"responses":{"201":{"description":"An SMTP server object","schema":{"$ref":"#\/definitions\/smtp_server"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add SMTP server","tags":["smtp_servers"],"x-koha-authorization":{"permissions":{"parameters":"manage_smtp_servers"}},"x-mojo-to":"Config::SMTP::Servers#add"}},"\/config\/smtp_servers\/{smtp_server_id}":{"delete":{"operationId":"deleteSMTPServer","parameters":[{"description":"SMTP server internal identifier","in":"path","name":"smtp_server_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"SMTP server deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Object not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete SMTP server","tags":["smtp_servers"],"x-koha-authorization":{"permissions":{"parameters":"manage_smtp_servers"}},"x-mojo-to":"Config::SMTP::Servers#delete"},"get":{"operationId":"getSMTPServer","parameters":[{"description":"SMTP server internal identifier","in":"path","name":"smtp_server_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"An SMTP server object","schema":{"$ref":"#\/definitions\/smtp_server"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"404":{"description":"Object not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict updating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get SMTP server","tags":["smtp_servers"],"x-koha-authorization":{"permissions":{"parameters":"manage_smtp_servers"}},"x-mojo-to":"Config::SMTP::Servers#get"},"put":{"operationId":"updateSMTPServer","parameters":[{"description":"SMTP server internal identifier","in":"path","name":"smtp_server_id","required":true,"type":"integer"},{"description":"An SMTP server object","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/smtp_server"}}],"produces":["application\/json"],"responses":{"200":{"description":"An SMTP server object","schema":{"$ref":"#\/definitions\/smtp_server"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Object not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update SMTP server","tags":["smtp_servers"],"x-koha-authorization":{"permissions":{"parameters":"manage_smtp_servers"}},"x-mojo-to":"Config::SMTP::Servers#update"}},"\/contrib\/patronemailer\/patrons\/unsubscribe\/{patron_id_hash}\/{cardnumber}\/{branchcode}\/{module}\/{code}":{"get":{"operationId":"LandingPage","parameters":[{"description":"Internal salted patron data hash","in":"path","name":"patron_id_hash","required":true,"type":"string"},{"description":"Internal patron identifier","in":"path","name":"cardnumber","required":true,"type":"string"},{"description":"Branchcode for this notice","in":"path","name":"branchcode","required":true,"type":"string"},{"description":"Module for this notice","in":"path","name":"module","required":true,"type":"string"},{"description":"Code for this notice","in":"path","name":"code","required":true,"type":"string"},{"description":"Will unsub be for this notice code, or for all","in":"query","name":"unsubscribe_type","required":false,"type":"string"}],"produces":["text\/html"],"responses":{"200":{"description":"Patron emailer unsubscribe unsubscribe page","schema":{"properties":{"pissed":{"description":"HTML of unsubscribe page","type":"boolean"}},"type":"object"}},"400":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"404":{"description":"An error occured","schema":{"properties":{"error":{"description":"An explanation for the error","type":"string"}},"type":"object"}},"500":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}}},"tags":["patrons"],"x-mojo-to":"Com::ByWaterSolutions::PatronEmailer::ApiController#unsubscribe"}},"\/deleted\/biblios":{"get":{"operationId":"listDeletedBiblios","parameters":[{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json","application\/marcxml+xml","application\/marc-in-json","application\/marc","text\/plain"],"responses":{"200":{"description":"A list of deleted biblios"},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Bibliographic record not found","schema":{"$ref":"#\/definitions\/error"}},"406":{"description":"Not acceptable","schema":{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List deleted biblios","tags":["biblios"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"DeletedBiblios#list"}},"\/deleted\/biblios\/{biblio_id}":{"get":{"operationId":"getDeletedBiblio","parameters":[{"description":"Record internal identifier","in":"path","name":"biblio_id","required":true,"type":"integer"}],"produces":["application\/json","application\/marcxml+xml","application\/marc-in-json","application\/marc","text\/plain"],"responses":{"200":{"description":"A deleted biblio"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Bibliographic record not found","schema":{"$ref":"#\/definitions\/error"}},"406":{"description":"Not acceptable","schema":{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get deleted biblio","tags":["biblios"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"DeletedBiblios#get"}},"\/erm\/agreements":{"get":{"operationId":"listErmAgreements","parameters":[{"description":"Case insensitive search on agreement agreement_id","in":"query","name":"agreement_id","required":false,"type":"integer"},{"description":"Case insensitive search on agreement vendor_id","in":"query","name":"vendor_id","required":false,"type":"integer"},{"description":"Case insensitive search on agreement name","in":"query","name":"name","required":false,"type":"string"},{"description":"Case insensitive search on agreement description","in":"query","name":"description","required":false,"type":"string"},{"description":"Case insensitive search on agreement status","in":"query","name":"status","required":false,"type":"string"},{"description":"Case insensitive search on agreement closure_reason","in":"query","name":"closure_reason","required":false,"type":"string"},{"description":"Case insensitive search on agreement is_perpetual","in":"query","name":"is_perpetual","required":false,"type":"boolean"},{"description":"Case insensitive search on agreement renewal_priority","in":"query","name":"renewal_priority","required":false,"type":"string"},{"description":"Case insensitive search on agreement license_info","in":"query","name":"license_info","required":false,"type":"string"},{"description":"filter by expired agreements","format":"date","in":"query","name":"max_expiration_date","type":"string"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["user_roles","vendor","extended_attributes","+strings"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of agreement","schema":{"items":{"$ref":"#\/definitions\/erm_agreement"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List agreements","tags":["erm_agreements"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::Agreements#list"},"post":{"consumes":["application\/json"],"operationId":"addErmAgreements","parameters":[{"description":"A JSON object containing information about the new agreement","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/erm_agreement"}}],"produces":["application\/json"],"responses":{"201":{"description":"A successfully created agreement","schema":{"items":{"$ref":"#\/definitions\/erm_agreement"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add agreement","tags":["erm_agreements"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::Agreements#add"}},"\/erm\/agreements\/{agreement_id}":{"delete":{"operationId":"deleteErmAgreements","parameters":[{"description":"Agreement internal identifier","in":"path","name":"agreement_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Agreement deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in deleting resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete agreement","tags":["erm_agreements"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::Agreements#delete"},"get":{"operationId":"getErmAgreements","parameters":[{"description":"Agreement internal identifier","in":"path","name":"agreement_id","required":true,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["periods","user_roles","user_roles.patron","agreement_licenses","agreement_licenses.license","agreement_relationships","agreement_relationships.agreement","agreement_relationships.related_agreement","agreement_packages","agreement_packages.package","documents","vendor","extended_attributes","+strings"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"An agreement","schema":{"items":{"$ref":"#\/definitions\/erm_agreement"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get agreement","tags":["erm_agreements"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::Agreements#get"},"put":{"consumes":["application\/json"],"operationId":"updateErmAgreements","parameters":[{"description":"Agreement internal identifier","in":"path","name":"agreement_id","required":true,"type":"integer"},{"description":"A JSON object containing new information about existing agreement","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/erm_agreement"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["periods","user_roles","agreement_licenses","agreement_relationships","documents","extended_attributes","+strings"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A successfully updated agreement","schema":{"items":{"$ref":"#\/definitions\/erm_agreement"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in updating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update agreement","tags":["erm_agreements"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::Agreements#update"}},"\/erm\/config":{"get":{"description":"This resource returns a list of options needed for the ERM Vue app. EXPERIMENTAL - DO NOT RELY on this, it is subject to change!","operationId":"getERMconfig","produces":["application\/json"],"responses":{"200":{"description":"The ERM config","schema":{"$ref":"#\/definitions\/erm_config"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"get the ERM config","tags":["erm_config"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM#config"}},"\/erm\/counter_files":{"get":{"operationId":"listErmCounterFiles","parameters":[{"description":"Case insensitive search on counter_file erm_counter_files_id","in":"query","name":"erm_counter_files_id","required":false,"type":"integer"},{"description":"Case insensitive search on counter_file usage_data_provider_id","in":"query","name":"usage_data_provider_id","required":false,"type":"integer"},{"description":"Case insensitive search on counter_file filename","in":"query","name":"filename","required":false,"type":"string"},{"description":"Case insensitive search on counter_file type","in":"query","name":"type","required":false,"type":"string"},{"description":"Case insensitive search on counter_file file_content","in":"query","name":"file_content","required":false,"type":"string"},{"description":"Case insensitive search on counter_file date_uploaded","in":"query","name":"date_uploaded","required":false,"type":"string"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["counter_logs"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of counter_files","schema":{"items":{"$ref":"#\/definitions\/erm_counter_file"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List counter_files","tags":["erm_counter_files"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::CounterFiles#list"}},"\/erm\/counter_files\/{erm_counter_files_id}":{"delete":{"operationId":"deleteERMCounterFiles","parameters":[{"description":"ERM counter_files internal identifier","in":"path","name":"erm_counter_files_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"counter_file deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"conflict in deleting resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"internal server error. possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete counter_file","tags":["erm_counter_files"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::CounterFiles#delete"}},"\/erm\/counter_files\/{erm_counter_files_id}\/file\/content":{"get":{"operationId":"downloadCounterFile","parameters":[{"description":"Case insensitive search on erm_counter_files_id","in":"path","name":"erm_counter_files_id","required":true,"type":"integer"}],"produces":["application\/octet-stream"],"responses":{"200":{"description":"A counter file","schema":{"type":"file"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Download Counter file","tags":["erm_counter_files"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::CounterFiles#get"}},"\/erm\/counter_logs":{"get":{"operationId":"listErmCounterLogs","parameters":[{"description":"Case insensitive search on counter_log usage_data_provider_id","in":"query","name":"usage_data_provider_id","required":false,"type":"integer"},{"description":"Embed list sent as a request header","in":"header","items":{"enum":["patron"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of counter_logs","schema":{"items":{"$ref":"#\/definitions\/erm_counter_log"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List counter_logs","tags":["erm_counter_logs"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::CounterLogs#list"}},"\/erm\/counter_registry":{"get":{"operationId":"listCounterRegisteredPlatforms","parameters":[{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of counter registered platforms","schema":{"items":{"$ref":"#\/definitions\/erm_counter_registry"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List platforms currently registered with the counter registry","tags":["erm_counter_registry"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::CounterRegistry#list"}},"\/erm\/default_usage_reports":{"get":{"operationId":"listErmDefaultUsageReports","parameters":[{"description":"Case insensitive search on erm_default_usage_report_id","in":"query","name":"erm_default_usage_report_id","required":false,"type":"integer"},{"description":"Case insensitive search on default_usage_report report_name","in":"query","name":"report_name","required":false,"type":"integer"},{"description":"Case insensitive search on default_usage_report report_url_params","in":"query","name":"report_url_params","required":false,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of default_usage_reports","schema":{"items":{"$ref":"#\/definitions\/erm_default_usage_report"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List default_usage_reports","tags":["erm_default_usage_reports"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::DefaultUsageReports#list"},"post":{"consumes":["application\/json"],"operationId":"addErmDefaultUsageReports","parameters":[{"description":"A JSON object containing information about the new default_usage_report","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/erm_default_usage_report"}}],"produces":["application\/json"],"responses":{"201":{"description":"A successfully created default_usage_report","schema":{"items":{"$ref":"#\/definitions\/erm_default_usage_report"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add default_usage_report","tags":["erm_default_usage_reports"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::DefaultUsageReports#add"}},"\/erm\/default_usage_reports\/{erm_default_usage_report_id}":{"delete":{"operationId":"deleteERMDefaultUsageReports","parameters":[{"description":"ERM default_usage_report internal identifier","in":"path","name":"erm_default_usage_report_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"default_usage_report deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"conflict in deleting resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"internal server error. possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete default_usage_report","tags":["erm_default_usage_reports"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::DefaultUsageReports#delete"}},"\/erm\/documents\/{document_id}\/file\/content":{"get":{"operationId":"downloadErmDocument","parameters":[{"description":"Case insensitive search on document_id","in":"path","name":"document_id","required":true,"type":"integer"}],"produces":["application\/octet-stream"],"responses":{"200":{"description":"Anagreement","schema":{"type":"file"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Download erm document","tags":["erm_documents"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::Documents#get"}},"\/erm\/eUsage\/metric_types_report\/{data_type}":{"get":{"operationId":"getERMUsageMetricTypesReport","parameters":[{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["erm_usage_muses"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"ERM custom report data type","in":"path","name":"data_type","required":true,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"custom_report","schema":{"items":{"$ref":"#\/definitions\/erm_custom_report"}}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"internal server error. possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"get usage metric_types report","tags":["erm_usage_reports"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::CustomReports#metric_types_report"}},"\/erm\/eUsage\/monthly_report\/{data_type}":{"get":{"operationId":"getERMUsageMonthlyReport","parameters":[{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["erm_usage_muses"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"ERM custom report data type","in":"path","name":"data_type","required":true,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"custom_report","schema":{"items":{"$ref":"#\/definitions\/erm_custom_report"}}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"internal server error. possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"get usage monthly report","tags":["erm_usage_reports"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::CustomReports#monthly_report"}},"\/erm\/eUsage\/provider_rollup_report\/{data_type}":{"get":{"operationId":"getERMUsageProviderRollupReport","parameters":[{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["erm_usage_titles.erm_usage_muses","erm_usage_platforms.erm_usage_muses","erm_usage_databases.erm_usage_muses","erm_usage_items.erm_usage_muses"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"ERM custom report data type","in":"path","name":"data_type","required":true,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"custom_report","schema":{"items":{"$ref":"#\/definitions\/erm_custom_report"}}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"internal server error. possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"get usage provider rollup report","tags":["erm_usage_reports"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::CustomReports#provider_rollup_report"}},"\/erm\/eUsage\/yearly_report\/{data_type}":{"get":{"operationId":"getERMUsageYearlyReport","parameters":[{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["erm_usage_yuses"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"ERM custom report data type","in":"path","name":"data_type","required":true,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"custom_report","schema":{"items":{"$ref":"#\/definitions\/erm_custom_report"}}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"internal server error. possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"get usage yearly report","tags":["erm_usage_reports"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::CustomReports#yearly_report"}},"\/erm\/eholdings\/local\/titles\/import":{"post":{"consumes":["application\/json"],"operationId":"importErmEHoldingsTitles","parameters":[{"description":"The list_id of the list to import","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"list_id":{"type":"string"},"package_id":{"type":"string"}},"type":"object"}}],"produces":["application\/json"],"responses":{"201":{"description":"Successfully enqueued the import job","schema":{"additionalProperties":false,"properties":{"job_id":{"type":"string"}},"type":"object"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Import local titles","tags":["erm_eholdings_titles"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EHoldings::Titles#import_from_list"}},"\/erm\/eholdings\/local\/titles\/import_kbart":{"post":{"consumes":["application\/json"],"operationId":"importErmEHoldingsTitlesFromKbart","parameters":[{"description":"The file to import","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"create_linked_biblio":{"type":"boolean"},"file":{"type":"object"},"package_id":{"type":"string"}},"type":"object"}}],"produces":["application\/json"],"responses":{"201":{"description":"Successfully enqueued the import job","schema":{"additionalProperties":false,"properties":{"invalid_columns":{"type":"array"},"invalid_filetype":{"type":"integer"},"job_ids":{"type":"array"},"valid_columns":{"type":"array"},"warnings":{"type":"object"}},"type":"object"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Import local titles from a KBART file","tags":["erm_eholdings_titles"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EHoldings::Titles#import_from_kbart_file"}},"\/erm\/eholdings\/{provider}\/packages":{"get":{"operationId":"listErmEHoldingsPackages","parameters":[{"description":"Provider name","in":"path","name":"provider","required":true,"type":"string"},{"description":"Case insensitive search on package package_id","in":"query","name":"package_id","required":false,"type":"string"},{"description":"Case insensitive search on package vendor_id","in":"query","name":"vendor_id","required":false,"type":"integer"},{"description":"Case insensitive search on package name","in":"query","name":"name","required":false,"type":"string"},{"description":"Case insensitive search on package external_package_id","in":"query","name":"external_package_id","required":false,"type":"integer"},{"description":"Case insensitive search on package type","in":"query","name":"package_type","required":false,"type":"string"},{"description":"Case insensitive search on package content_type","in":"query","name":"content_type","required":false,"type":"string"},{"description":"Case insensitive search on package notes","in":"query","name":"notes","required":false,"type":"string"},{"description":"Case insensitive search on package creation date","in":"query","name":"created_on","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["vendor","vendor.name","resources+count","resources","extended_attributes","+strings"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of package","schema":{"items":{"$ref":"#\/definitions\/erm_eholdings_package"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List packages","tags":["erm_eholdings_packages"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EHoldings::Packages#list"},"post":{"consumes":["application\/json"],"operationId":"addErmEHoldingsPackages","parameters":[{"description":"Provider name","in":"path","name":"provider","required":true,"type":"string"},{"description":"A JSON object containing information about the new package","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/erm_eholdings_package"}}],"produces":["application\/json"],"responses":{"201":{"description":"A successfully created package","schema":{"items":{"$ref":"#\/definitions\/erm_eholdings_package"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add package","tags":["erm_eholdings_packages"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EHoldings::Packages#add"}},"\/erm\/eholdings\/{provider}\/packages\/{package_id}":{"delete":{"operationId":"deleteErmEHoldingsPackages","parameters":[{"description":"Provider name","in":"path","name":"provider","required":true,"type":"string"},{"description":"Package internal identifier","in":"path","name":"package_id","required":true,"type":"string"}],"produces":["application\/json"],"responses":{"204":{"description":"package deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in deleting resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete eHoldings package","tags":["erm_eholdings_packages"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EHoldings::Packages#delete"},"get":{"operationId":"getErmEHoldingsPackages","parameters":[{"description":"Provider name","in":"path","name":"provider","required":true,"type":"string"},{"description":"Package internal identifier","in":"path","name":"package_id","required":true,"type":"string"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["package_agreements","package_agreements.agreement","resources+count","vendor","extended_attributes","+strings"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A package","schema":{"items":{"$ref":"#\/definitions\/erm_eholdings_package"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get eHoldings package","tags":["erm_eholdings_packages"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EHoldings::Packages#get"},"patch":{"operationId":"editErmEHoldingsPackages","parameters":[{"description":"Provider name","in":"path","name":"provider","required":true,"type":"string"},{"description":"A JSON object containing the fields to edit","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"is_selected":{"description":"Add or remove this package from remote holdings","type":"boolean"}},"type":"object"}},{"description":"Package internal identifier","in":"path","name":"package_id","required":true,"type":"string"}],"produces":["application\/json"],"responses":{"200":{"description":"What has been modified","schema":{"additionalProperties":false,"properties":{"is_selected":{"description":"Add or remove this package from remote holdings","type":"boolean"}},"type":"object"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Package not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Edit a package","tags":["erm_eholdings_packages"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EHoldings::Packages#edit"},"put":{"consumes":["application\/json"],"operationId":"updateErmEHoldingsPackages","parameters":[{"description":"Provider name","in":"path","name":"provider","required":true,"type":"string"},{"description":"Package internal identifier","in":"path","name":"package_id","required":true,"type":"string"},{"description":"A JSON object containing new information about existing package","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/erm_eholdings_package"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["agreements","resources","extended_attributes","+strings"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A successfully updated package","schema":{"items":{"$ref":"#\/definitions\/erm_eholdings_package"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in updating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update eHoldings package","tags":["erm_eholdings_packages"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EHoldings::Packages#update"}},"\/erm\/eholdings\/{provider}\/packages\/{package_id}\/resources":{"get":{"operationId":"listErmEHoldingsPackagesResources","parameters":[{"description":"Provider name","in":"path","name":"provider","required":true,"type":"string"},{"description":"Case insensitive search on resource_id","in":"query","name":"resource_id","required":false,"type":"string"},{"description":"Case insensitive search on started_on","in":"query","name":"started_on","required":false,"type":"string"},{"description":"Case insensitive search on ended_on","in":"query","name":"ended_on","required":false,"type":"string"},{"description":"Case insensitive search on proxy","in":"query","name":"proxy","required":false,"type":"string"},{"description":"Package internal identifier","in":"path","name":"package_id","required":true,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["title"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of eHoldings resources","schema":{"items":{"$ref":"#\/definitions\/erm_eholdings_resource"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List eholdings resources","tags":["erm_eholdings_packages"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EHoldings::Resources#list"}},"\/erm\/eholdings\/{provider}\/resources":{"get":{"operationId":"listErmEHoldingsResources","parameters":[{"description":"Provider name","in":"path","name":"provider","required":true,"type":"string"},{"description":"Case insensitive search on resource_id","in":"query","name":"resource_id","required":false,"type":"string"},{"description":"Case insensitive search on package_id","in":"query","name":"package_id","required":false,"type":"string"},{"description":"Case insensitive search on title vendor_id","in":"query","name":"vendor_id","required":false,"type":"integer"},{"description":"Case insensitive search on started_on","in":"query","name":"started_on","required":false,"type":"string"},{"description":"Case insensitive search on ended_on","in":"query","name":"ended_on","required":false,"type":"string"},{"description":"Case insensitive search on proxy","in":"query","name":"proxy","required":false,"type":"string"},{"description":"Embed list sent as a request header","in":"header","items":{"enum":["package","title"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of eHoldings resources","schema":{"items":{"$ref":"#\/definitions\/erm_eholdings_resource"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List eholdings resources","tags":["erm_eholdings_resources"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EHoldings::Resources#list"}},"\/erm\/eholdings\/{provider}\/resources\/{resource_id}":{"get":{"operationId":"getErmEHoldingsResources","parameters":[{"description":"Provider name","in":"path","name":"provider","required":true,"type":"string"},{"description":"Resource internal identifier","in":"path","name":"resource_id","required":true,"type":"string"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["title","package","vendor"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"An eHolding resource","schema":{"items":{"$ref":"#\/definitions\/erm_eholdings_resource"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get resources","tags":["erm_eholdings_resources"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EHoldings::Resources#get"},"patch":{"operationId":"editErmEHoldingsResources","parameters":[{"description":"Provider name","in":"path","name":"provider","required":true,"type":"string"},{"description":"A JSON object containing the fields to edit","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"is_selected":{"description":"Add or remove this resource from remote holdings","type":"boolean"}},"type":"object"}},{"description":"Resource internal identifier","in":"path","name":"resource_id","required":true,"type":"string"}],"produces":["application\/json"],"responses":{"200":{"description":"What has been modified","schema":{"additionalProperties":false,"properties":{"is_selected":{"description":"Add or remove this resource from remote holdings","type":"boolean"}},"type":"object"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Edit a resource","tags":["erm_eholdings_resources"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EHoldings::Resources#edit"}},"\/erm\/eholdings\/{provider}\/titles":{"get":{"operationId":"listErmEHoldingsTitles","parameters":[{"description":"Provider name","in":"path","name":"provider","required":true,"type":"string"},{"description":"Case insensitive search on title title_id","in":"query","name":"title_id","required":false,"type":"integer"},{"description":"Case insensitive search on title publication_title","in":"query","name":"publication_title","required":false,"type":"string"},{"description":"Case insensitive search on title external_id","in":"query","name":"external_id","required":false,"type":"string"},{"description":"Case insensitive search on title print_identifier","in":"query","name":"print_identifier","required":false,"type":"string"},{"description":"Case insensitive search on title online_identifier","in":"query","name":"online_identifier","required":false,"type":"string"},{"description":"Case insensitive search on title date_first_issue_online","in":"query","name":"date_first_issue_online","required":false,"type":"string"},{"description":"Case insensitive search on title num_first_vol_online","in":"query","name":"num_first_vol_online","required":false,"type":"string"},{"description":"Case insensitive search on title num_first_issue_online","in":"query","name":"num_first_issue_online","required":false,"type":"string"},{"description":"Case insensitive search on title date_last_issue_online","in":"query","name":"date_last_issue_online","required":false,"type":"string"},{"description":"Case insensitive search on title num_last_vol_online","in":"query","name":"num_last_vol_online","required":false,"type":"string"},{"description":"Case insensitive search on title num_last_issue_online","in":"query","name":"num_last_issue_online","required":false,"type":"string"},{"description":"Case insensitive search on title title_url","in":"query","name":"title_url","required":false,"type":"string"},{"description":"Case insensitive search on title first_author","in":"query","name":"first_author","required":false,"type":"string"},{"description":"Case insensitive search on title embargo_info","in":"query","name":"embargo_info","required":false,"type":"string"},{"description":"Case insensitive search on title coverage_depth","in":"query","name":"coverage_depth","required":false,"type":"string"},{"description":"Case insensitive search on title notes","in":"query","name":"notes","required":false,"type":"string"},{"description":"Case insensitive search on title publisher_name","in":"query","name":"publisher_name","required":false,"type":"string"},{"description":"Case insensitive search on title publication_type","in":"query","name":"publication_type","required":false,"type":"string"},{"description":"Case insensitive search on title date_monograph_published_print","in":"query","name":"date_monograph_published_print","required":false,"type":"string"},{"description":"Case insensitive search on title date_monograph_published_online","in":"query","name":"date_monograph_published_online","required":false,"type":"string"},{"description":"Case insensitive search on title monograph_volume","in":"query","name":"monograph_volume","required":false,"type":"string"},{"description":"Case insensitive search on title monograph_edition","in":"query","name":"monograph_edition","required":false,"type":"string"},{"description":"Case insensitive search on title first_editor","in":"query","name":"first_editor","required":false,"type":"string"},{"description":"Case insensitive search on title parent_publication_title_id","in":"query","name":"parent_publication_title_id","required":false,"type":"string"},{"description":"Case insensitive search on title preceding_publication_title_id","in":"query","name":"preceding_publication_title_id","required":false,"type":"string"},{"description":"Case insensitive search on title access_type","in":"query","name":"access_type","required":false,"type":"string"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["resources.package"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of eHoldings titles","schema":{"items":{"$ref":"#\/definitions\/erm_eholdings_title"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List eholdings titles","tags":["erm_eholdings_titles"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EHoldings::Titles#list"},"post":{"consumes":["application\/json"],"operationId":"addErmEHoldingsTitles","parameters":[{"description":"Provider name","in":"path","name":"provider","required":true,"type":"string"},{"description":"A JSON object containing information about the new title","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/erm_eholdings_title"}}],"produces":["application\/json"],"responses":{"201":{"description":"A successfully created title","schema":{"items":{"$ref":"#\/definitions\/erm_eholdings_title"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add eholding","tags":["erm_eholdings_titles"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EHoldings::Titles#add"}},"\/erm\/eholdings\/{provider}\/titles\/{title_id}":{"delete":{"operationId":"deleteErmEHoldingsTitles","parameters":[{"description":"Provider name","in":"path","name":"provider","required":true,"type":"string"},{"description":"Title internal identifier","in":"path","name":"title_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"title deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in deleting resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete eHolding title","tags":["erm_eholdings_titles"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EHoldings::Titles#delete"},"get":{"operationId":"getErmEHoldingsTitles","parameters":[{"description":"Provider name","in":"path","name":"provider","required":true,"type":"string"},{"description":"Title internal identifier","in":"path","name":"title_id","required":true,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["resources","resources.package"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"An eHolding title","schema":{"items":{"$ref":"#\/definitions\/erm_eholdings_title"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get titles","tags":["erm_eholdings_titles"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EHoldings::Titles#get"},"put":{"consumes":["application\/json"],"operationId":"updateErmEHoldingsTitles","parameters":[{"description":"Provider name","in":"path","name":"provider","required":true,"type":"string"},{"description":"Title internal identifier","in":"path","name":"title_id","required":true,"type":"integer"},{"description":"A JSON object containing new information about existing title","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/erm_eholdings_title"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["resources","resources.package"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A successfully updated title","schema":{"items":{"$ref":"#\/definitions\/erm_eholdings_title"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in updating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update titles","tags":["erm_eholdings_titles"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EHoldings::Titles#update"}},"\/erm\/eholdings\/{provider}\/titles\/{title_id}\/resources":{"get":{"operationId":"listErmEHoldingsTitlesResources","parameters":[{"description":"Provider name","in":"path","name":"provider","required":true,"type":"string"},{"description":"Case insensitive search on resource_id","in":"query","name":"resource_id","required":false,"type":"string"},{"description":"Case insensitive search on started_on","in":"query","name":"started_on","required":false,"type":"string"},{"description":"Case insensitive search on ended_on","in":"query","name":"ended_on","required":false,"type":"string"},{"description":"Case insensitive search on proxy","in":"query","name":"proxy","required":false,"type":"string"},{"description":"Title internal identifier","in":"path","name":"title_id","required":true,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["title.publication_title"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of eHoldings resources","schema":{"items":{"$ref":"#\/definitions\/erm_eholdings_resource"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List eholdings resources","tags":["erm_eholdings_titles"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EHoldings::Resources#list"}},"\/erm\/extended_attribute_types":{"get":{"operationId":"listErmAdditionalFields","parameters":[{"description":"filter by resource type","enum":["license","agreement","package"],"in":"query","name":"resource_type","type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of extended attribute types for ERM","schema":{"items":{"$ref":"#\/definitions\/extended_attribute_type"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List ERM extended attribute types","tags":["additional_fields"],"x-koha-authorization":{"permissions":[{"parameters":"manage_additional_fields"},{"erm":1}]},"x-mojo-to":"ExtendedAttributeTypes#list_erm"}},"\/erm\/licenses":{"get":{"operationId":"listErmLicenses","parameters":[{"description":"Case insensitive search on license license_id","in":"query","name":"license_id","required":false,"type":"integer"},{"description":"Case insensitive search on agreement vendor_id","in":"query","name":"vendor_id","required":false,"type":"integer"},{"description":"Case insensitive search on license name","in":"query","name":"name","required":false,"type":"string"},{"description":"Case insensitive search on license type","in":"query","name":"type","required":false,"type":"string"},{"description":"Case insensitive search on license status","in":"query","name":"status","required":false,"type":"string"},{"description":"Case insensitive search on license start date","in":"query","name":"started_on","required":false,"type":"string"},{"description":"Case insensitive search on license end date","in":"query","name":"ended_on","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["vendor","extended_attributes","+strings"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of agreements' licenses","schema":{"items":{"$ref":"#\/definitions\/erm_license"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List licenses for agreements","tags":["erm_licences"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::Licenses#list"},"post":{"consumes":["application\/json"],"operationId":"addERMLicenses","parameters":[{"description":"A JSON object containing information about the new agreement's license","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/erm_license"}}],"produces":["application\/json"],"responses":{"201":{"description":"A successfully created license","schema":{"items":{"$ref":"#\/definitions\/erm_license"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add license","tags":["erm_licences"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::Licenses#add"}},"\/erm\/licenses\/{license_id}":{"delete":{"operationId":"deleteERMlicenses","parameters":[{"description":"License internal identifier","in":"path","name":"license_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"license deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"conflict in deleting resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"internal server error. possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete license","tags":["erm_licences"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::Licenses#delete"},"get":{"operationId":"getERMlicense","parameters":[{"description":"License internal identifier","in":"path","name":"license_id","required":true,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["user_roles","user_roles.patron","vendor","documents","extended_attributes","+strings"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"license","schema":{"items":{"$ref":"#\/definitions\/erm_license"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"internal server error. possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"get license","tags":["erm_licences"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::Licenses#get"},"put":{"consumes":["application\/json"],"operationId":"updateERMlicenses","parameters":[{"description":"License internal identifier","in":"path","name":"license_id","required":true,"type":"integer"},{"description":"a json object containing new information about existing license","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/erm_license"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["user_roles","documents","extended_attributes","+strings"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"a successfully updated license","schema":{"items":{"$ref":"#\/definitions\/erm_license"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"conflict in updating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"internal server error. possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"update license","tags":["erm_licences"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::Licenses#update"}},"\/erm\/sushi_service":{"get":{"operationId":"getSushiService","parameters":[{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A sushi service","schema":{"items":{"$ref":"#\/definitions\/erm_sushi_service"}}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get the details for a sushi service from the counter registry","tags":["erm_sushi_service"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::SushiServices#get"}},"\/erm\/usage_data_providers":{"get":{"operationId":"listErmUsageDataProviders","parameters":[{"description":"Case insensitive search on usage_data_provider usage_data_provider_id","in":"query","name":"usage_data_provider_id","required":false,"type":"integer"},{"description":"Case insensitive search on usage_data_provider name","in":"query","name":"name","required":false,"type":"string"},{"description":"Case insensitive search on usage_data_provider description","in":"query","name":"description","required":false,"type":"string"},{"description":"Case insensitive search on usage_data_provider active","in":"query","name":"active","required":false,"type":"integer"},{"description":"Case insensitive search on usage_data_provider method","in":"query","name":"method","required":false,"type":"string"},{"description":"Case insensitive search on usage_data_provider aggregator","in":"query","name":"aggregator","required":false,"type":"string"},{"description":"Case insensitive search on usage_data_provider service_type","in":"query","name":"service_type","required":false,"type":"string"},{"description":"Case insensitive search on usage_data_provider service_url","in":"query","name":"service_url","required":false,"type":"string"},{"description":"Case insensitive search on usage_data_provider report_release","in":"query","name":"report_release","required":false,"type":"string"},{"description":"Case insensitive search on usage_data_provider customer_id","in":"query","name":"customer_id","required":false,"type":"string"},{"description":"Case insensitive search on usage_data_provider requestor_id","in":"query","name":"requestor_id","required":false,"type":"string"},{"description":"Case insensitive search on usage_data_provider api_key","in":"query","name":"api_key","required":false,"type":"string"},{"description":"Case insensitive search on usage_data_provider requestor_name","in":"query","name":"requestor_name","required":false,"type":"string"},{"description":"Case insensitive search on usage_data_provider requestor_email","in":"query","name":"requestor_email","required":false,"type":"string"},{"description":"Case insensitive search on usage_data_provider report_types","in":"query","name":"report_types","required":false,"type":"string"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["counter_files"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of usage_data_providers","schema":{"items":{"$ref":"#\/definitions\/erm_usage_data_provider"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List usage_data_providers","tags":["erm_usage_data_providers"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::UsageDataProviders#list"},"post":{"consumes":["application\/json"],"operationId":"addErmUsageDataProviders","parameters":[{"description":"A JSON object containing information about the new usage_data_provider","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/erm_usage_data_provider"}}],"produces":["application\/json"],"responses":{"201":{"description":"A successfully created usage_data_provider","schema":{"items":{"$ref":"#\/definitions\/erm_usage_data_provider"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add usage_data_provider","tags":["erm_usage_data_providers"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::UsageDataProviders#add"}},"\/erm\/usage_data_providers\/{erm_usage_data_provider_id}":{"delete":{"operationId":"deleteERMUsageDataProviders","parameters":[{"description":"ERM usage_data_provider internal identifier","in":"path","name":"erm_usage_data_provider_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"usage_data_provider deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"conflict in deleting resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"internal server error. possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete usage_data_provider","tags":["erm_usage_data_providers"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::UsageDataProviders#delete"},"get":{"operationId":"getERMUsageDataProvider","parameters":[{"description":"ERM usage_data_provider internal identifier","in":"path","name":"erm_usage_data_provider_id","required":true,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["counter_files","erm_usage_titles.erm_usage_muses"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"usage_data_provider","schema":{"items":{"$ref":"#\/definitions\/erm_usage_data_provider"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"internal server error. possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"get usage_data_provider","tags":["erm_usage_data_providers"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::UsageDataProviders#get"},"put":{"consumes":["application\/json"],"operationId":"updateERMUsageDataProviders","parameters":[{"description":"ERM usage_data_provider internal identifier","in":"path","name":"erm_usage_data_provider_id","required":true,"type":"integer"},{"description":"a json object containing new information about existing usage_data_provider","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/erm_usage_data_provider"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"a successfully updated usage_data_provider","schema":{"items":{"$ref":"#\/definitions\/erm_usage_data_provider"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"conflict in updating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"internal server error. possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"update usage_data_provider","tags":["erm_usage_data_providers"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::UsageDataProviders#update"}},"\/erm\/usage_data_providers\/{erm_usage_data_provider_id}\/process_COUNTER_file":{"post":{"operationId":"processCOUNTERFileUsageDataProviderHarvester","parameters":[{"description":"ERM usage_data_provider internal identifier","in":"path","name":"erm_usage_data_provider_id","required":true,"type":"integer"},{"description":"A JSON object containing information about the new counter_file","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/erm_counter_file"}}],"produces":["application\/json"],"responses":{"200":{"description":"Successful COUNTER file processing","schema":{"items":{"$ref":"#\/definitions\/erm_usage_data_provider"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Process COUNTER file upload for this data provider's harvester","tags":["erm_usage_data_providers"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::UsageDataProviders#process_COUNTER_file"}},"\/erm\/usage_data_providers\/{erm_usage_data_provider_id}\/process_SUSHI_response":{"post":{"operationId":"processSUSHICounterUsageDataProviderHarvester","parameters":[{"description":"ERM usage_data_provider internal identifier","in":"path","name":"erm_usage_data_provider_id","required":true,"type":"integer"},{"description":"A JSON object with the begin and end dates","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"begin_date":{"description":"begin date of the harvest","format":"date","type":"string"},"end_date":{"description":"end date of the harvest","format":"date","type":"string"}},"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"Successful SUSHI COUNTER processing","schema":{"items":{"$ref":"#\/definitions\/erm_usage_data_provider"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Process SUSHI COUNTER for this data provider's harvester","tags":["erm_usage_data_providers"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::UsageDataProviders#process_SUSHI_response"}},"\/erm\/usage_data_providers\/{erm_usage_data_provider_id}\/test_connection":{"get":{"operationId":"testUsageDataProviderHarvester","parameters":[{"description":"ERM usage_data_provider internal identifier","in":"path","name":"erm_usage_data_provider_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"Successful connection test","schema":{"items":{"$ref":"#\/definitions\/erm_usage_data_provider"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Test this data provider's harvester","tags":["erm_usage_data_providers"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::UsageDataProviders#test_connection"}},"\/erm\/usage_databases":{"get":{"operationId":"listErmUsageDatabases","parameters":[{"description":"Case insensitive search on usage_database database_id","in":"query","name":"database_id","required":false,"type":"integer"},{"description":"Case insensitive search on usage_database database","in":"query","name":"database","required":false,"type":"string"},{"description":"Case insensitive search on usage_database usage_data_provider_id","in":"query","name":"usage_data_provider_id","required":false,"type":"string"},{"description":"Case insensitive search on usage_database platform","in":"query","name":"platform","required":false,"type":"string"},{"description":"Case insensitive search on usage_database publisher","in":"query","name":"publisher","required":false,"type":"string"},{"description":"Case insensitive search on usage_title publisher_id","in":"query","name":"publisher_id","required":false,"type":"string"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["erm_usage_muses","erm_usage_yuses"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of usage_databases","schema":{"items":{"$ref":"#\/definitions\/erm_usage_database"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List usage_databases","tags":["erm_usage_databases"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::UsageDatabases#list"}},"\/erm\/usage_items":{"get":{"operationId":"listErmUsageItems","parameters":[{"description":"Case insensitive search on usage_item item_id","in":"query","name":"item_id","required":false,"type":"integer"},{"description":"Case insensitive search on usage_item item","in":"query","name":"item","required":false,"type":"string"},{"description":"Case insensitive search on usage_item usage_data_provider_id","in":"query","name":"usage_data_provider_id","required":false,"type":"string"},{"description":"Case insensitive search on usage_item platform","in":"query","name":"platform","required":false,"type":"string"},{"description":"Case insensitive search on usage_item publisher","in":"query","name":"publisher","required":false,"type":"string"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["erm_usage_muses","erm_usage_yuses"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of usage_items","schema":{"items":{"$ref":"#\/definitions\/erm_usage_item"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List usage_items","tags":["erm_usage_items"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::UsageItems#list"}},"\/erm\/usage_platforms":{"get":{"operationId":"listErmUsagePlatforms","parameters":[{"description":"Case insensitive search on usage_platform platform_id","in":"query","name":"platform_id","required":false,"type":"integer"},{"description":"Case insensitive search on usage_platform platform","in":"query","name":"platform","required":false,"type":"string"},{"description":"Case insensitive search on usage_platform usage_data_provider_id","in":"query","name":"usage_data_provider_id","required":false,"type":"string"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["erm_usage_muses","erm_usage_yuses"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of usage_platforms","schema":{"items":{"$ref":"#\/definitions\/erm_usage_platform"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List usage_platforms","tags":["erm_usage_platforms"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::UsagePlatforms#list"}},"\/erm\/usage_titles":{"get":{"operationId":"listErmUsageTitles","parameters":[{"description":"Case insensitive search on usage_title title_id","in":"query","name":"title_id","required":false,"type":"integer"},{"description":"Case insensitive search on usage_title title","in":"query","name":"title","required":false,"type":"string"},{"description":"Case insensitive search on usage_title usage_data_provider_id","in":"query","name":"usage_data_provider_id","required":false,"type":"string"},{"description":"Case insensitive search on usage_title title_doi","in":"query","name":"title_doi","required":false,"type":"string"},{"description":"Case insensitive search on usage_title print_issn","in":"query","name":"print_issn","required":false,"type":"string"},{"description":"Case insensitive search on usage_title online_issn","in":"query","name":"online_issn","required":false,"type":"string"},{"description":"Case insensitive search on usage_title title_uri","in":"query","name":"title_uri","required":false,"type":"string"},{"description":"Case insensitive search on usage_title publisher","in":"query","name":"publisher","required":false,"type":"string"},{"description":"Case insensitive search on usage_title publisher_id","in":"query","name":"publisher_id","required":false,"type":"string"},{"description":"Case insensitive search on usage_title yop","in":"query","name":"yop","required":false,"type":"string"},{"description":"Case insensitive search on usage_title isbn","in":"query","name":"isbn","required":false,"type":"string"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["erm_usage_muses","erm_usage_yuses"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of usage_titles","schema":{"items":{"$ref":"#\/definitions\/erm_usage_title"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List usage_titles","tags":["erm_usage_titles"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM::EUsage::UsageTitles#list"}},"\/erm\/users":{"get":{"description":"This resource returns a list of patron allowed to be users of the ERM module","operationId":"listERMUsers","parameters":[{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["extended_attributes","library"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of ERM' users","schema":{"items":{"$ref":"#\/definitions\/patron"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List possibe users for ERM","tags":["erm_users"],"x-koha-authorization":{"permissions":{"erm":1}},"x-mojo-to":"ERM#list_users"}},"\/extended_attribute_types":{"get":{"operationId":"listAdditionalFields","parameters":[{"description":"filter by resource type","enum":["basket","credit","debit","invoice","license","agreement","package","order","subscription"],"in":"query","name":"resource_type","type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of extended attribute types","schema":{"items":{"$ref":"#\/definitions\/extended_attribute_type"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List extended attribute types","tags":["additional_fields"],"x-koha-authorization":{"permissions":{"parameters":"manage_additional_fields"}},"x-mojo-to":"ExtendedAttributeTypes#list"}},"\/holds":{"get":{"operationId":"listHolds","parameters":[{"description":"Internal hold identifier","in":"query","name":"hold_id","type":"integer"},{"description":"Internal patron identifier","in":"query","name":"patron_id","type":"integer"},{"description":"Hold","format":"date","in":"query","name":"hold_date","type":"string"},{"description":"Internal biblio identifier","in":"query","name":"biblio_id","type":"integer"},{"description":"Internal item group identifier","in":"query","name":"item_group_id","type":"integer"},{"description":"Internal library identifier for the pickup library","in":"query","name":"pickup_library_id","type":"string"},{"description":"The date the hold was cancelled","format":"date","in":"query","name":"cancellation_date","type":"string"},{"description":"Notes related to this hold","in":"query","name":"notes","type":"string"},{"description":"Where in the queue the patron sits","in":"query","name":"priority","type":"integer"},{"description":"Found status","in":"query","name":"status","type":"string"},{"description":"Time of latest update","in":"query","name":"timestamp","type":"string"},{"description":"Internal item identifier","in":"query","name":"item_id","type":"integer"},{"description":"Date the item was marked as waiting for the patron","in":"query","name":"waiting_date","type":"string"},{"description":"Date the hold expires","in":"query","name":"expiration_date","type":"string"},{"description":"Lowest priority","in":"query","name":"lowest_priority","type":"boolean"},{"description":"Suspended","in":"query","name":"suspended","type":"boolean"},{"description":"Suspended until","in":"query","name":"suspended_until","type":"string"},{"description":"Non priority hold","in":"query","name":"non_priority","type":"boolean"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"description":"By default, current holds are returned, when this is true then old holds are returned as result.","in":"query","name":"old","type":"boolean"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["+strings","cancellation_requested","biblio","deleted_biblio","pickup_library","item","patron"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of holds","schema":{"$ref":"#\/definitions\/holds"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Hold not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Borrower not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List holds","tags":["holds"],"x-koha-authorization":{"permissions":{"reserveforothers":"place_holds"}},"x-mojo-to":"Holds#list"},"post":{"consumes":["application\/json"],"operationId":"addHold","parameters":[{"description":"A JSON object containing informations about the new hold","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"biblio_id":{"description":"Internal biblio identifier","type":["integer","null"]},"expiration_date":{"description":"Hold end date","format":"date","type":["string","null"]},"hold_date":{"description":"The date the hold was placed","format":"date","type":["string","null"]},"item_group_id":{"description":"Internal item group identifier","type":["integer","null"]},"item_id":{"description":"Internal item identifier","type":["integer","null"]},"item_type_id":{"description":"Limit hold on one itemtype (ignored for item-level holds)","type":["string","null"]},"non_priority":{"description":"Set this hold as non priority","type":["boolean","null"]},"notes":{"description":"Notes related to this hold","type":["string","null"]},"patron_id":{"description":"Internal patron identifier","type":"integer"},"pickup_library_id":{"description":"Internal library identifier for the pickup library","type":"string"}},"required":["patron_id","pickup_library_id"],"type":"object"}},{"collectionFormat":"csv","description":"Overrides list sent as a request header","in":"header","items":{"enum":["any","bad_address","card_lost","debt_limit","expired","hold_limit","restricted"],"type":"string"},"name":"x-koha-override","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"201":{"description":"Created hold","schema":{"$ref":"#\/definitions\/hold"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Hold not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Borrower not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict. Possible `error_code` attribute values:\n\n  * `bad_address`\n  * `card_lost`\n  * `debt_limit`\n  * `expired`\n  * `hold_limit`\n  * `restricted`\n","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Place hold","tags":["holds"],"x-koha-authorization":{"permissions":{"reserveforothers":"1"}},"x-mojo-to":"Holds#add"}},"\/holds\/cancellation_bulk":{"delete":{"operationId":"deleteHolds","parameters":[{"description":"Hold ids","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"cancellation_reason":{"description":"Cancellation reason","type":"string"},"hold_ids":{"items":{"type":"integer"},"type":"array"}},"type":"object"}}],"produces":["application\/json"],"responses":{"204":{"description":"Holds deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Hold not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Hold not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Cancel holds","tags":["holds"],"x-koha-authorization":{"permissions":{"reserveforothers":"place_holds"}},"x-mojo-to":"Holds#delete_bulk"}},"\/holds\/suspension_bulk":{"post":{"consumes":["application\/json"],"operationId":"suspendHoldBulk","parameters":[{"description":"Hold ids","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"end_date":{"description":"Date the hold suspension expires","format":"date","type":"string"},"hold_ids":{"items":{"type":"integer"},"type":"array"}},"type":"object"}}],"produces":["application\/json"],"responses":{"201":{"description":"Holds suspended"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Hold not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Hold not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Suspend the holds","tags":["holds"],"x-koha-authorization":{"permissions":{"reserveforothers":"place_holds"}},"x-mojo-to":"Holds#suspend_bulk"}},"\/holds\/{hold_id}":{"delete":{"operationId":"deleteHold","parameters":[{"description":"Internal hold identifier","in":"path","name":"hold_id","required":true,"type":"integer"},{"description":"Cancellation reason","in":"body","name":"body","required":false,"schema":{"type":"string"}},{"collectionFormat":"csv","description":"Overrides list sent as a request header","in":"header","items":{"enum":["cancellation-request-flow"],"type":"string"},"name":"x-koha-override","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"202":{"description":"Hold request recorded"},"204":{"description":"Hold deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Hold not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Hold not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Cancel hold","tags":["holds"],"x-koha-authorization":{"permissions":{"reserveforothers":"place_holds"}},"x-mojo-to":"Holds#delete"},"patch":{"consumes":["application\/json"],"operationId":"editHold","parameters":[{"description":"Internal hold identifier","in":"path","name":"hold_id","required":true,"type":"integer"},{"description":"A JSON object containing fields to modify","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"expiration_date":{"description":"Hold's expiration date","format":"date","type":"string"},"hold_date":{"description":"Hold date","format":"date","type":"string"},"pickup_library_id":{"description":"Internal library identifier for the pickup library","type":"string"},"priority":{"description":"Position in waiting queue","minimum":1,"type":"integer"},"suspended_until":{"description":"Date until which the hold has been suspended","format":"date-time","type":"string"}},"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"Updated hold","schema":{"$ref":"#\/definitions\/hold"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Hold not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Hold not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update hold","tags":["holds"],"x-koha-authorization":{"permissions":{"reserveforothers":"1"}},"x-mojo-to":"Holds#edit"},"put":{"consumes":["application\/json"],"description":"This route is being deprecated and will be removed in future releases. Please migrate your project to use PATCH \/holds\/{hold_id} instead.","operationId":"overwriteHold","parameters":[{"description":"Internal hold identifier","in":"path","name":"hold_id","required":true,"type":"integer"},{"description":"A JSON object containing fields to modify","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"pickup_library_id":{"description":"Internal library identifier for the pickup library","type":"string"},"priority":{"description":"Position in waiting queue","minimum":1,"type":"integer"},"suspended_until":{"description":"Date until which the hold has been suspended","format":"date-time","type":"string"}},"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"Updated hold","schema":{"$ref":"#\/definitions\/hold"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Hold not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Hold not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update hold","tags":["holds"],"x-koha-authorization":{"permissions":{"reserveforothers":"1"}},"x-mojo-to":"Holds#edit"}},"\/holds\/{hold_id}\/lowest_priority":{"put":{"operationId":"toggleLowestPriority","parameters":[{"description":"Internal hold identifier","in":"path","name":"hold_id","required":true,"type":"integer"},{"description":"An integer representing the new priority to be set for the hold","in":"body","name":"body","required":false,"schema":{"type":"integer"}}],"produces":["application\/json"],"responses":{"200":{"description":"Toggle the holds lowest priority value","schema":{"type":"integer"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Hold not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Unable to perform action on hold","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Toggle holds lowest priority","tags":["holds"],"x-koha-authorization":{"permissions":{"reserveforothers":"modify_holds_priority"}},"x-mojo-to":"Holds#lowest_priority"}},"\/holds\/{hold_id}\/pickup_location":{"put":{"description":"Set a new pickup location for the hold","operationId":"updateHoldPickupLocation","parameters":[{"description":"Internal hold identifier","in":"path","name":"hold_id","required":true,"type":"integer"},{"description":"Pickup location","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"pickup_library_id":{"description":"Internal identifier for the pickup library","type":"string"}},"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"The new pickup location value for the hold","schema":{"additionalProperties":false,"properties":{"pickup_library_id":{"description":"Internal identifier for the pickup library","type":"string"}},"type":"object"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Hold not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Unable to perform action on hold. Possible `error_code` attribute values:\n\n* `hold_waiting`\n* `hold_in_transit`\n* `hold_in_processing`\n","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n"},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update pickup location for the hold","tags":["holds"],"x-koha-authorization":{"permissions":{"reserveforothers":"place_holds"}},"x-mojo-to":"Holds#update_pickup_location"}},"\/holds\/{hold_id}\/pickup_locations":{"get":{"operationId":"getHoldPickupLocations","parameters":[{"collectionFormat":"csv","description":"Overrides list sent as a request header","in":"header","items":{"enum":["any"],"type":"string"},"name":"x-koha-override","required":false,"type":"array"},{"description":"Internal hold identifier","in":"path","name":"hold_id","required":true,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"Hold pickup location","schema":{"items":{"$ref":"#\/definitions\/library"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Hold pickup location list not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Hold not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get valid pickup locations for hold","tags":["holds"],"x-koha-authorization":{"permissions":{"reserveforothers":"place_holds"}},"x-mojo-to":"Holds#pickup_locations"}},"\/holds\/{hold_id}\/priority":{"put":{"operationId":"updateHoldPriority","parameters":[{"description":"Internal hold identifier","in":"path","name":"hold_id","required":true,"type":"integer"},{"description":"An integer representing the new priority to be set for the hold","in":"body","name":"body","required":true,"schema":{"type":"integer"}}],"produces":["application\/json"],"responses":{"200":{"description":"The new priority value for the hold","schema":{"type":"integer"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Bibliographic record not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Unable to perform action on biblio","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update priority for the hold","tags":["holds"],"x-koha-authorization":{"permissions":{"reserveforothers":"modify_holds_priority"}},"x-mojo-to":"Holds#update_priority"}},"\/holds\/{hold_id}\/suspension":{"delete":{"consumes":["application\/json"],"operationId":"resumeHold","parameters":[{"description":"Internal hold identifier","in":"path","name":"hold_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Hold resumed"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Hold not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Hold not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Resume hold","tags":["holds"],"x-koha-authorization":{"permissions":{"reserveforothers":"place_holds"}},"x-mojo-to":"Holds#resume"},"post":{"consumes":["application\/json"],"operationId":"suspendHold","parameters":[{"description":"Internal hold identifier","in":"path","name":"hold_id","required":true,"type":"integer"},{"description":"A JSON object containing fields to modify","in":"body","name":"body","required":false,"schema":{"additionalProperties":false,"properties":{"end_date":{"description":"Date the hold suspension expires","format":"date","type":"string"}},"type":"object"}}],"produces":["application\/json"],"responses":{"201":{"description":"Hold suspended"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Hold not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Hold not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Suspend the hold","tags":["holds"],"x-koha-authorization":{"permissions":{"reserveforothers":"place_holds"}},"x-mojo-to":"Holds#suspend"}},"\/ill\/backends":{"get":{"operationId":"listIllBackends","parameters":[{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["statuses+strings"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of ILL backends","schema":{"$ref":"#\/definitions\/ill_backends"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ILL backends not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List ILL backends","tags":["ill_backends"],"x-koha-authorization":{"permissions":{"ill":"1"}},"x-mojo-to":"ILL::Backends#list"}},"\/ill\/backends\/{ill_backend_id}":{"get":{"operationId":"getIllBackends","parameters":[{"description":"ILL backend id\/name","in":"path","name":"ill_backend_id","required":true,"type":"string"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["statuses+strings"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"An ILL backends","schema":{"$ref":"#\/definitions\/ill_backend"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ILL backends not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get ILL backend","tags":["ill_backends"],"x-koha-authorization":{"permissions":{"ill":"1"}},"x-mojo-to":"ILL::Backends#get"}},"\/ill\/batches":{"get":{"operationId":"listIllbatches","parameters":[{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["+strings","requests","requests+count","patron","library"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of ILL batches","schema":{"$ref":"#\/definitions\/ill_batches"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ILL batches not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List ILL batches","tags":["ill_batches"],"x-koha-authorization":{"permissions":{"ill":"1"}},"x-mojo-to":"ILL::Batches#list"},"post":{"operationId":"addIllbatch","parameters":[{"description":"A JSON object containing informations about the new batch","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/ill_batch"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["+strings","requests","requests+count","patron","library"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"201":{"description":"Batch added","schema":{"$ref":"#\/definitions\/ill_batch"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron with given cardnumber not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add ILL batch","tags":["ill_batches"],"x-koha-authorization":{"permissions":{"ill":"1"}},"x-mojo-to":"ILL::Batches#add"}},"\/ill\/batches\/{ill_batch_id}":{"delete":{"operationId":"deleteBatch","parameters":[{"description":"Internal ILL batch identifier","in":"path","name":"ill_batch_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"ILL batch deleted","schema":{"type":"string"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ILL batch not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete ILL batch","tags":["ill_batches"],"x-koha-authorization":{"permissions":{"ill":"1"}},"x-mojo-to":"ILL::Batches#delete"},"get":{"operationId":"getIllbatches","parameters":[{"description":"ILL batch id\/name\/contents","in":"path","name":"ill_batch_id","required":true,"type":"string"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["+strings","requests","requests+count","patron","library"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"An ILL batch","schema":{"$ref":"#\/definitions\/ill_batch"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ILL batch not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get ILL batch","tags":["ill_batches"],"x-koha-authorization":{"permissions":{"ill":"1"}},"x-mojo-to":"ILL::Batches#get"},"put":{"consumes":["application\/json"],"operationId":"updateIllBatch","parameters":[{"description":"Internal ILL batch identifier","in":"path","name":"ill_batch_id","required":true,"type":"integer"},{"description":"A JSON object containing information on the batch","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/ill_batch"}}],"produces":["application\/json"],"responses":{"200":{"description":"An ILL batch","schema":{"$ref":"#\/definitions\/ill_batch"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ILL batch not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update batch","tags":["ill_batches"],"x-koha-authorization":{"permissions":{"ill":"1"}},"x-mojo-to":"ILL::Batches#update"}},"\/ill\/batchstatuses":{"get":{"operationId":"listIllbatchstatuses","parameters":[],"produces":["application\/json"],"responses":{"200":{"description":"A list of ILL batch statuses","schema":{"$ref":"#\/definitions\/ill_batchstatuses"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ILL batch statuses not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List ILL batch statuses","tags":["ill_batchstatuses"],"x-koha-authorization":{"permissions":{"ill":"1"}},"x-mojo-to":"ILL::Batch::Statuses#list"},"post":{"operationId":"addIllbatchstatus","parameters":[{"description":"A JSON object containing informations about the new batch status","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/ill_batchstatus"}}],"produces":["application\/json"],"responses":{"201":{"description":"Batch status added","schema":{"$ref":"#\/definitions\/ill_batchstatus"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add ILL batch status","tags":["ill_batchstatuses"],"x-koha-authorization":{"permissions":{"ill":"1"}},"x-mojo-to":"ILL::Batch::Statuses#add"}},"\/ill\/batchstatuses\/{ill_batchstatus_code}":{"delete":{"operationId":"deleteBatchstatus","parameters":[{"description":"Internal ILL batch status identifier","in":"path","name":"ill_batchstatus_code","required":true,"type":"string"}],"produces":["application\/json"],"responses":{"204":{"description":"ILL batch status deleted","schema":{"type":"string"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ILL batch status not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete ILL batch status","tags":["ill_batchstatuses"],"x-koha-authorization":{"permissions":{"ill":"1"}},"x-mojo-to":"ILL::Batch::Statuses#delete"},"get":{"operationId":"getIllbatchstatuses","parameters":[{"description":"ILL batch status","in":"path","name":"ill_batchstatus_code","required":true,"type":"string"}],"produces":["application\/json"],"responses":{"200":{"description":"An ILL batch status","schema":{"$ref":"#\/definitions\/ill_batchstatus"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ILL batch status not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get ILL batch status","tags":["ill_batchstatuses"],"x-koha-authorization":{"permissions":{"ill":"1"}},"x-mojo-to":"ILL::Batch::Statuses#get"},"put":{"consumes":["application\/json"],"operationId":"updateIllBatchstatus","parameters":[{"description":"Internal ILL batch status identifier","in":"path","name":"ill_batchstatus_code","required":true,"type":"string"},{"description":"A JSON object containing information on the batch status","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/ill_batchstatus"}}],"produces":["application\/json"],"responses":{"200":{"description":"An ILL batch status","schema":{"$ref":"#\/definitions\/ill_batchstatus"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"ILL batch status not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update batch status","tags":["ill_batchstatuses"],"x-koha-authorization":{"permissions":{"ill":"1"}},"x-mojo-to":"ILL::Batch::Statuses#update"}},"\/ill\/requests":{"get":{"operationId":"listIllrequests","parameters":[{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["+strings","biblio","comments","comments+count","extended_attributes","ill_batch","library","id_prefix","patron"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of ILL requests","schema":{"items":{"$ref":"#\/definitions\/ill_request"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List ILL requests","tags":["ill_requests"],"x-koha-authorization":{"permissions":{"ill":"1"}},"x-mojo-to":"ILL::Requests#list"},"post":{"operationId":"addIllrequest","parameters":[{"description":"A JSON object containing informations about the new request","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/ill_request"}}],"produces":["application\/json"],"responses":{"201":{"description":"Request added","schema":{"$ref":"#\/definitions\/ill_request"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add ILL request","tags":["ill_requests"],"x-koha-authorization":{"permissions":{"ill":"1"}},"x-mojo-to":"ILL::Requests#add"}},"\/import_batch_profiles":{"get":{"consumes":["application\/json"],"operationId":"listImportBatchProfiles","parameters":[{"description":"Search on profile's name","in":"query","name":"name","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of import batch profiles","schema":{"$ref":"#\/definitions\/import_batch_profiles"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List batch import profiles","tags":["batch_import_profiles"],"x-koha-authorization":{"permissions":{"tools":"stage_marc_import"}},"x-mojo-to":"ImportBatchProfiles#list"},"post":{"consumes":["application\/json"],"operationId":"addImportBatchProfiles","parameters":[{"description":"A JSON object containing a import batch profile","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"comments":{"description":"any comments added when the file was uploaded","type":["string","null"]},"encoding":{"description":"file encoding","type":["string","null"]},"format":{"description":"marc format","type":["string","null"]},"item_action":{"description":"what to do with item records","type":["string","null"]},"matcher_id":{"description":"the id of the match rule used (matchpoints.matcher_id)","type":["integer","null"]},"name":{"description":"name of this profile","type":"string"},"nomatch_action":{"description":"how to handle records where no match is found","type":["string","null"]},"overlay_action":{"description":"how to handle duplicate records","type":["string","null"]},"parse_items":{"description":"should items be parsed","type":["boolean","null"]},"record_type":{"description":"type of record in the batch","type":["string","null"]},"template_id":{"description":"the id of the marc modification template","type":["integer","null"]}},"type":"object"}}],"produces":["application\/json"],"responses":{"201":{"description":"Created Profile","schema":{"$ref":"#\/definitions\/import_batch_profile"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Hold not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Borrower not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add batch import profile","tags":["batch_import_profiles"],"x-koha-authorization":{"permissions":{"tools":"stage_marc_import"}},"x-mojo-to":"ImportBatchProfiles#add"}},"\/import_batch_profiles\/{import_batch_profile_id}":{"delete":{"operationId":"deleteImportBatchProfiles","parameters":[{"description":"Internal profile identifier","in":"path","name":"import_batch_profile_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Profile deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Hold not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Hold not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete batch import profile","tags":["batch_import_profiles"],"x-koha-authorization":{"permissions":{"tools":"stage_marc_import"}},"x-mojo-to":"ImportBatchProfiles#delete"},"put":{"consumes":["application\/json"],"operationId":"editImportBatchProfiles","parameters":[{"description":"Internal profile identifier","in":"path","name":"import_batch_profile_id","required":true,"type":"integer"},{"description":"A JSON object containing a import batch profile","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"comments":{"description":"any comments added when the file was uploaded","type":["string","null"]},"encoding":{"description":"file encoding","type":["string","null"]},"format":{"description":"marc format","type":["string","null"]},"item_action":{"description":"what to do with item records","type":["string","null"]},"matcher_id":{"description":"the id of the match rule used (matchpoints.matcher_id)","type":["integer","null"]},"name":{"description":"name of this profile","type":"string"},"nomatch_action":{"description":"how to handle records where no match is found","type":["string","null"]},"overlay_action":{"description":"how to handle duplicate records","type":["string","null"]},"parse_items":{"description":"should items be parsed","type":["boolean","null"]},"record_type":{"description":"type of record in the batch","type":["string","null"]},"template_id":{"description":"the id of the marc modification template","type":["integer","null"]}},"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"Updated profile","schema":{"$ref":"#\/definitions\/import_batch_profile"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Hold not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Borrower not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update batch import profile","tags":["batch_import_profiles"],"x-koha-authorization":{"permissions":{"tools":"stage_marc_import"}},"x-mojo-to":"ImportBatchProfiles#edit"}},"\/import_batches\/{import_batch_id}\/records\/{import_record_id}\/matches\/chosen":{"delete":{"operationId":"unsetChosen","parameters":[{"description":"An import_batch ID","in":"path","name":"import_batch_id","required":true,"type":"integer"},{"description":"An import_record ID","in":"path","name":"import_record_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Matches unchosen"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Match management not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Import record matches not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Unset the chosen match for an import record ID","tags":["import_batches"],"x-koha-authorization":{"permissions":{"tools":"manage_staged_marc"}},"x-mojo-to":"ImportRecordMatches#unset_chosen"},"put":{"consumes":["application\/json"],"operationId":"setChosen","parameters":[{"description":"An import_batch ID","in":"path","name":"import_batch_id","required":true,"type":"integer"},{"description":"An import_record ID","in":"path","name":"import_record_id","required":true,"type":"integer"},{"description":"A JSON object containing fields to modify","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"candidate_match_id":{"description":"Candidate match to choose","type":"integer"}},"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"Match updated"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Match management not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Import record match not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Set the chosen match for an import record ID","tags":["import_batches"],"x-koha-authorization":{"permissions":{"tools":"manage_staged_marc"}},"x-mojo-to":"ImportRecordMatches#set_chosen"}},"\/item_types":{"get":{"operationId":"listItemTypes","parameters":[{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["translated_descriptions"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of item types","schema":{"items":{"$ref":"#\/definitions\/item_type"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Resource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List item types","tags":["item_types"],"x-koha-authorization":{"permissions":{"catalogue":1}},"x-mojo-to":"ItemTypes#list"}},"\/items":{"get":{"consumes":["application\/json"],"operationId":"listItems","parameters":[{"description":"Search on the item's barcode","in":"query","name":"external_id","required":false,"type":"string"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["+strings","biblio","effective_bookable"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of item","schema":{"items":{"$ref":"#\/definitions\/item"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List items","tags":["items"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"Items#list"}},"\/items\/{item_id}":{"delete":{"consumes":["application\/json"],"operationId":"deleteItem","parameters":[{"description":"Internal item identifier","in":"path","name":"item_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Deleted item"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Item not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict. Possible `error_code` attribute values:\n\n  * book_on_loan: The item is checked out\n  * book_reserved: Waiting or in-transit hold for the item\n  * last_item_for_hold: The item is the last one on a record on which a biblio-level hold is placed\n  * linked_analytics: The item has linked analytic records\n  * not_same_branch: The item is blocked by independent branches\n","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete item","tags":["items"],"x-koha-authorization":{"permissions":{"editcatalogue":"edit_catalogue"}},"x-mojo-to":"Items#delete"},"get":{"consumes":["application\/json"],"operationId":"getItem","parameters":[{"description":"Internal item identifier","in":"path","name":"item_id","required":true,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["+strings","effective_bookable"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"An item","schema":{"$ref":"#\/definitions\/item"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"404":{"description":"Item not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get item","tags":["items"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"Items#get"}},"\/items\/{item_id}\/bookings":{"get":{"consumes":["application\/json"],"operationId":"getItemBookings","parameters":[{"description":"Internal item identifier","in":"path","name":"item_id","required":true,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"Item bookings","schema":{"items":{"$ref":"#\/definitions\/booking"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Item not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get existing bookings for an item","tags":["items"],"x-koha-authorization":{"permissions":{"circulation":1}},"x-mojo-to":"Items#bookings"}},"\/items\/{item_id}\/bundled_items":{"get":{"consumes":["application\/json"],"operationId":"bundledItems","parameters":[{"description":"Internal item identifier","in":"path","name":"item_id","required":true,"type":"integer"},{"description":"Search on the item's barcode","in":"query","name":"external_id","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["biblio","checkout","return_claims","return_claim","return_claim.patron"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of item","schema":{"items":{"$ref":"#\/definitions\/item"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List bundled items","tags":["items"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"Items#bundled_items"},"post":{"consumes":["application\/json"],"operationId":"addToBundle","parameters":[{"description":"Internal item identifier","in":"path","name":"item_id","required":true,"type":"integer"},{"description":"A JSON object containing information about the new bundle link","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/bundle_link"}}],"produces":["application\/json"],"responses":{"201":{"description":"A successfully created bundle link","schema":{"items":{"$ref":"#\/definitions\/item"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Resource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add item to bundle","tags":["items"],"x-koha-authorization":{"permissions":{"catalogue":1}},"x-mojo-to":"Items#add_to_bundle"}},"\/items\/{item_id}\/bundled_items\/{bundled_item_id}":{"delete":{"consumes":["application\/json"],"operationId":"removeFromBundle","parameters":[{"description":"Internal item identifier","in":"path","name":"item_id","required":true,"type":"integer"},{"description":"Internal identifier for the bundled item","in":"path","name":"bundled_item_id","required":true,"type":"string"}],"produces":["application\/json"],"responses":{"204":{"description":"Bundle link deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Resource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Remove item from bundle","tags":["items"],"x-koha-authorization":{"permissions":{"catalogue":1}},"x-mojo-to":"Items#remove_from_bundle"}},"\/items\/{item_id}\/pickup_locations":{"get":{"consumes":["application\/json"],"operationId":"getItemPickupLocations","parameters":[{"description":"Internal item identifier","in":"path","name":"item_id","required":true,"type":"integer"},{"description":"Internal patron identifier","in":"query","name":"patron_id","required":true,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"Item pickup locations","schema":{"items":{"$ref":"#\/definitions\/library"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Bibliographic record not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get valid pickup locations for an item","tags":["items"],"x-koha-authorization":{"permissions":{"reserveforothers":"place_holds"}},"x-mojo-to":"Items#pickup_locations"}},"\/jobs":{"get":{"operationId":"listJobs","parameters":[{"description":"Only include current jobs","in":"query","name":"only_current","required":false,"type":"boolean"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of jobs","schema":{"items":{"$ref":"#\/definitions\/job"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List jobs","tags":["jobs"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"BackgroundJobs#list"}},"\/jobs\/{job_id}":{"get":{"operationId":"getJob","parameters":[{"description":"Job internal identifier","in":"path","name":"job_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A job","schema":{"$ref":"#\/definitions\/job"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Job not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get a job","tags":["jobs"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"BackgroundJobs#get"}},"\/libraries":{"get":{"operationId":"listLibraries","parameters":[{"description":"Case insensitive 'starts-with' search on name","in":"query","name":"name","required":false,"type":"string"},{"description":"Case insensitive 'starts-with' search on address1","in":"query","name":"address1","required":false,"type":"string"},{"description":"Case insensitive 'starts-with' search on address2","in":"query","name":"address2","required":false,"type":"string"},{"description":"Case insensitive 'starts-with' search on address3","in":"query","name":"address3","required":false,"type":"string"},{"description":"Case insensitive 'starts-with' search on postal code","in":"query","name":"postal_code","required":false,"type":"string"},{"description":"Case insensitive 'starts-with' search on city","in":"query","name":"city","required":false,"type":"string"},{"description":"Case insensitive 'starts-with' search on state","in":"query","name":"state","required":false,"type":"string"},{"description":"Case insensitive 'starts_with' search on country","in":"query","name":"country","required":false,"type":"string"},{"description":"Case insensitive 'starts_with' search on phone number","in":"query","name":"phone","required":false,"type":"string"},{"description":"Case insensitive 'starts_with' search on fax number","in":"query","name":"fax","required":false,"type":"string"},{"description":"Case insensitive 'starts_with' search on email address","in":"query","name":"email","required":false,"type":"string"},{"description":"Case insensitive 'starts_with' search on Reply-To email address","in":"query","name":"reply_to_email","required":false,"type":"string"},{"description":"Case insensitive 'starts_with' search on Return-Path email address","in":"query","name":"return_path_email","required":false,"type":"string"},{"description":"Case insensitive 'starts_with' search on website URL","in":"query","name":"url","required":false,"type":"string"},{"description":"Case insensitive 'starts_with' search on IP address","in":"query","name":"ip","required":false,"type":"string"},{"description":"Case insensitive 'starts_with' search on notes","in":"query","name":"notes","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["cash_registers","desks","smtp_server","library_hours"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of libraries","schema":{"items":{"$ref":"#\/definitions\/library"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List libraries","tags":["libraries"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"Libraries#list"},"post":{"operationId":"addLibrary","parameters":[{"description":"A JSON object containing informations about the new library","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/library"}}],"produces":["application\/json"],"responses":{"201":{"description":"Library added","schema":{"$ref":"#\/definitions\/library"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add library","tags":["libraries"],"x-koha-authorization":{"permissions":{"parameters":"manage_libraries"}},"x-mojo-to":"Libraries#add"}},"\/libraries\/{library_id}":{"delete":{"operationId":"deleteLibrary","parameters":[{"description":"Internal library identifier","in":"path","name":"library_id","required":true,"type":"string"}],"produces":["application\/json"],"responses":{"204":{"description":"Library deleted","schema":{"type":"string"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Library not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete library","tags":["libraries"],"x-koha-authorization":{"permissions":{"parameters":"manage_libraries"}},"x-mojo-to":"Libraries#delete"},"get":{"operationId":"getLibrary","parameters":[{"description":"Internal library identifier","in":"path","name":"library_id","required":true,"type":"string"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["cash_registers","desks","smtp_server","library_hours"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A library","schema":{"$ref":"#\/definitions\/library"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"404":{"description":"Library not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}}},"summary":"Get library","tags":["libraries"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"Libraries#get"},"put":{"consumes":["application\/json"],"operationId":"updateLibrary","parameters":[{"description":"Internal library identifier","in":"path","name":"library_id","required":true,"type":"string"},{"description":"A JSON object containing information on the library","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/library"}}],"produces":["application\/json"],"responses":{"200":{"description":"A library","schema":{"$ref":"#\/definitions\/library"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Library not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update library","tags":["libraries"],"x-koha-authorization":{"permissions":{"parameters":"manage_libraries"}},"x-mojo-to":"Libraries#update"}},"\/libraries\/{library_id}\/cash_registers":{"get":{"operationId":"listLibraryCashRegisters","parameters":[{"description":"Internal library identifier","in":"path","name":"library_id","required":true,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of cash registers for the library","schema":{"items":{"$ref":"#\/definitions\/cash_register"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"404":{"description":"Resource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List the library's cash registers","tags":["cash_registers"],"x-koha-authorization":{"permissions":{"catalogue":1}},"x-mojo-to":"Libraries#list_cash_registers"}},"\/libraries\/{library_id}\/desks":{"get":{"operationId":"listLibraryDesks","parameters":[{"description":"Internal library identifier","in":"path","name":"library_id","required":true,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of desks for the library","schema":{"items":{"$ref":"#\/definitions\/desk"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"404":{"description":"Resource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List the library's desks","tags":["desks"],"x-koha-authorization":{"permissions":{"catalogue":1}},"x-mojo-to":"Libraries#list_desks"}},"\/oauth\/login\/{provider_code}\/{interface}":{"get":{"operationId":"loginOAuthClient","parameters":[{"description":"Code for OAuth provider","in":"path","name":"provider_code","required":true,"type":"string"},{"description":"Name of the interface this login is for","in":"path","name":"interface","required":true,"type":"string"},{"description":"Code returned from OAuth server for Authorization Code grant","in":"query","name":"code","required":false,"type":"string"},{"description":"An opaque value used by the client to maintain state between the request and callback. This is the callback part.","in":"query","name":"state","required":false,"type":"string"},{"description":"Scope returned by OAuth server","in":"query","name":"scope","type":"string"},{"description":"Prompt returned by OAuth server","in":"query","name":"prompt","type":"string"},{"description":"Auth user returned by OAuth server","in":"query","name":"authuser","type":"string"},{"description":"OAuth error code","in":"query","name":"error","type":"string"},{"description":"OAuth error description","in":"query","name":"error_description","type":"string"},{"description":"Web page with user friendly description of the error","in":"query","name":"error_uri","type":"string"},{"description":"Session state returned by OAuth server","in":"query","name":"session_state","type":"string"}],"produces":["application\/json"],"responses":{"302":{"description":"User authorized","schema":{"type":"string"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Login to OAuth provider","tags":["oauth"],"x-mojo-to":"OAuth::Client#login"}},"\/oauth\/token":{"post":{"operationId":"tokenOAuth","parameters":[{"description":"grant type (client_credentials)","in":"formData","name":"grant_type","required":true,"type":"string"},{"description":"client id","in":"formData","name":"client_id","type":"string"},{"description":"client secret","in":"formData","name":"client_secret","type":"string"}],"produces":["application\/json"],"responses":{"200":{"description":"OK","schema":{"additionalProperties":false,"properties":{"access_token":{"type":"string"},"expires_in":{"type":"integer"},"token_type":{"type":"string"}},"type":"object"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}}},"summary":"Get access token","tags":["oauth"],"x-mojo-to":"OAuth#token"}},"\/patron_categories":{"get":{"operationId":"listPatronCategories","parameters":[{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of patron categories","schema":{"items":{"$ref":"#\/definitions\/patron_category"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List patron categories","tags":["patron_categories"],"x-koha-authorization":{"permissions":{"parameters":"manage_patron_categories"}},"x-mojo-to":"Patrons::Categories#list"}},"\/patrons":{"get":{"operationId":"listPatrons","parameters":[{"description":"Search on patron_id","in":"query","name":"patron_id","required":false,"type":"string"},{"description":"Case insensitive search on cardnumber","in":"query","name":"cardnumber","required":false,"type":"string"},{"description":"Case insensitive search on surname","in":"query","name":"surname","required":false,"type":"string"},{"description":"Case insensitive search on firstname","in":"query","name":"firstname","required":false,"type":"string"},{"description":"Case insensitive search on preferred name","in":"query","name":"preferred_name","required":false,"type":"string"},{"description":"Case insensitive search on title","in":"query","name":"title","required":false,"type":"string"},{"description":"Case insensitive search on othernames","in":"query","name":"other_name","required":false,"type":"string"},{"description":"Case insensitive search on initials","in":"query","name":"initials","required":false,"type":"string"},{"description":"Case insensitive search on streetnumber","in":"query","name":"street_number","required":false,"type":"string"},{"description":"Case insensitive search on streettype","in":"query","name":"street_type","required":false,"type":"string"},{"description":"Case insensitive search on address","in":"query","name":"address","required":false,"type":"string"},{"description":"Case insensitive search on address2","in":"query","name":"address2","required":false,"type":"string"},{"description":"Case insensitive search on city","in":"query","name":"city","required":false,"type":"string"},{"description":"Case insensitive search on state","in":"query","name":"state","required":false,"type":"string"},{"description":"Case insensitive search on zipcode","in":"query","name":"postal_code","required":false,"type":"string"},{"description":"Case insensitive search on country","in":"query","name":"country","required":false,"type":"string"},{"description":"Case insensitive search on email","in":"query","name":"email","required":false,"type":"string"},{"description":"Case insensitive search on phone","in":"query","name":"phone","required":false,"type":"string"},{"description":"Case insensitive search on mobile","in":"query","name":"mobile","required":false,"type":"string"},{"description":"Case insensitive search on fax","in":"query","name":"fax","required":false,"type":"string"},{"description":"Case insensitive search on secondary_email","in":"query","name":"secondary_email","required":false,"type":"string"},{"description":"Case insensitive search on secondary_phone","in":"query","name":"secondary_phone","required":false,"type":"string"},{"description":"Case insensitive search on altaddress_street_number","in":"query","name":"altaddress_street_number","required":false,"type":"string"},{"description":"Case insensitive search on altaddress_street_type","in":"query","name":"altaddress_street_type","required":false,"type":"string"},{"description":"Case insensitive search on altaddress_address","in":"query","name":"altaddress_address","required":false,"type":"string"},{"description":"Case insensitive search on altaddress_address2","in":"query","name":"altaddress_address2","required":false,"type":"string"},{"description":"Case insensitive search on altaddress_city","in":"query","name":"altaddress_city","required":false,"type":"string"},{"description":"Case insensitive search on altaddress_state","in":"query","name":"altaddress_state","required":false,"type":"string"},{"description":"Case insensitive search on altaddress_postal_code","in":"query","name":"altaddress_postal_code","required":false,"type":"string"},{"description":"Case insensitive search on altaddress_country","in":"query","name":"altaddress_country","required":false,"type":"string"},{"description":"Case insensitive search on altaddress_email","in":"query","name":"altaddress_email","required":false,"type":"string"},{"description":"Case insensitive search on altaddress_phone","in":"query","name":"altaddress_phone","required":false,"type":"string"},{"description":"Case insensitive search on date_of_birth","in":"query","name":"date_of_birth","required":false,"type":"string"},{"description":"Case insensitive search on library_id","in":"query","name":"library_id","required":false,"type":"string"},{"description":"Case insensitive search on category_id","in":"query","name":"category_id","required":false,"type":"string"},{"description":"Case insensitive search on date_enrolled","in":"query","name":"date_enrolled","required":false,"type":"string"},{"description":"Case insensitive search on expiry_date","in":"query","name":"expiry_date","required":false,"type":"string"},{"description":"Search on incorrect_address","in":"query","name":"incorrect_address","required":false,"type":"boolean"},{"description":"Search on patron_card_lost","in":"query","name":"patron_card_lost","required":false,"type":"boolean"},{"description":"Filter search by restricted","in":"query","name":"restricted","required":false,"type":"boolean"},{"description":"Case insensitive search on staff_notes","in":"query","name":"staff_notes","required":false,"type":"string"},{"description":"Case insensitive search on relationship_type","in":"query","name":"relationship_type","required":false,"type":"string"},{"description":"Case insensitive search on gender","in":"query","name":"gender","required":false,"type":"string"},{"description":"Case insensitive search on userid","in":"query","name":"userid","required":false,"type":"string"},{"description":"Case insensitive search on opac_notes","in":"query","name":"opac_notes","required":false,"type":"string"},{"description":"Case insensitive search on altaddress_notes","in":"query","name":"altaddress_notes","required":false,"type":"string"},{"description":"Case insensitive search on statistics_1","in":"query","name":"statistics_1","required":false,"type":"string"},{"description":"Case insensitive search on statistics_2","in":"query","name":"statistics_2","required":false,"type":"string"},{"description":"Search on autorenew_checkouts","in":"query","name":"autorenew_checkouts","required":false,"type":"boolean"},{"description":"Case insensitive search on altcontact_firstname","in":"query","name":"altcontact_firstname","required":false,"type":"string"},{"description":"Case insensitive search on altcontact_surname","in":"query","name":"altcontact_surname","required":false,"type":"string"},{"description":"Case insensitive search on altcontact_address","in":"query","name":"altcontact_address","required":false,"type":"string"},{"description":"Case insensitive search on altcontact_address2","in":"query","name":"altcontact_address2","required":false,"type":"string"},{"description":"Case insensitive search on altcontact_city","in":"query","name":"altcontact_city","required":false,"type":"string"},{"description":"Case insensitive search on altcontact_state","in":"query","name":"altcontact_state","required":false,"type":"string"},{"description":"Case insensitive search on altcontact_postal_code","in":"query","name":"altcontact_postal_code","required":false,"type":"string"},{"description":"Case insensitive search on altcontact_country","in":"query","name":"altcontact_country","required":false,"type":"string"},{"description":"Case insensitive search on altcontact_phone","in":"query","name":"altcontact_phone","required":false,"type":"string"},{"description":"Case insensitive search on sms_number","in":"query","name":"sms_number","required":false,"type":"string"},{"description":"Case insensitive search on sms_provider_id","in":"query","name":"sms_provider_id","required":false,"type":"string"},{"description":"Search on privacy","in":"query","name":"privacy","required":false,"type":"string"},{"description":"Search on privacy_guarantor_checkouts","in":"query","name":"privacy_guarantor_checkouts","required":false,"type":"string"},{"description":"Case insensitive search on check_previous_checkout","in":"query","name":"check_previous_checkout","required":false,"type":"string"},{"description":"Search on updated_on","in":"query","name":"updated_on","required":false,"type":"string"},{"description":"Case insensitive search on last_seen","in":"query","name":"last_seen","required":false,"type":"string"},{"description":"Case insensitive search on lang","in":"query","name":"lang","required":false,"type":"string"},{"description":"Search on login_attempts","in":"query","name":"login_attempts","required":false,"type":"string"},{"description":"Search on protected status","in":"query","name":"protected","required":false,"type":"boolean"},{"description":"Case insensitive search on primary_contact_method","in":"query","name":"primary_contact_method","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["extended_attributes","checkouts+count","overdues+count","account_balance","library"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of patrons","schema":{"items":{"$ref":"#\/definitions\/patron"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List patrons","tags":["patrons"],"x-koha-authorization":{"permissions":[{"borrowers":"list_borrowers"}]},"x-mojo-to":"Patrons#list"},"post":{"consumes":["application\/json"],"operationId":"addPatron","parameters":[{"description":"Confirm the posted element is not a duplicate","in":"header","name":"x-confirm-not-duplicate","required":false,"type":"integer"},{"description":"A JSON object containing information about the new patron","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/patron"}},{"collectionFormat":"csv","description":"Overrides list sent as a request header","in":"header","items":{"enum":["welcome_yes","welcome_no"],"type":"string"},"name":"x-koha-override","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"201":{"description":"A successfully created patron","schema":{"items":{"$ref":"#\/definitions\/patron"}}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_attribute_type`\n  * `attribute_not_unique`\n  * `non_repeatable_attribute`\n  * `missing_mandatory_attribute`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Resource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add patron","tags":["patrons"],"x-koha-authorization":{"permissions":{"borrowers":"edit_borrowers"}},"x-mojo-to":"Patrons#add"}},"\/patrons\/{patron_id}":{"delete":{"operationId":"deletePatron","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Patron deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict. Possible `error_code` attribute values:\n\n  * `has_checkouts`: The patron has pending checkouts\n  * `has_debt`: The patron has pending debts\n  * `has_guarantees`: The patron has guarantees\n  * `is_anonymous_patron`: The system-wide anonymous patron cannot be deleted\n  * `is_protected`: Protected patrons cannot be deleted\n","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete patron","tags":["patrons"],"x-koha-authorization":{"permissions":{"borrowers":"delete_borrowers"}},"x-mojo-to":"Patrons#delete"},"get":{"operationId":"getPatron","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["+strings","extended_attributes"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A patron","schema":{"$ref":"#\/definitions\/patron"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get patron","tags":["patrons"],"x-koha-authorization":{"permissions":[{"borrowers":"list_borrowers"},{"borrowers":"edit_borrowers"}]},"x-mojo-to":"Patrons#get"},"put":{"consumes":["application\/json"],"operationId":"updatePatron","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"A JSON object containing new information about existing patron","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/patron"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["extended_attributes"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A successfully updated patron","schema":{"items":{"$ref":"#\/definitions\/patron"}}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_attribute_type`\n  * `attribute_not_unique`\n  * `non_repeatable_attribute`\n  * `missing_mandatory_attribute`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Resource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in updating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update patron","tags":["patrons"],"x-koha-authorization":{"permissions":{"borrowers":"1"}},"x-mojo-to":"Patrons#update"}},"\/patrons\/{patron_id}\/account":{"get":{"operationId":"getPatronAccount","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"Patron's account balance","schema":{"$ref":"#\/definitions\/patron_balance"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get account information for a patron","tags":["patrons"],"x-koha-authorization":{"permissions":{"borrowers":"edit_borrowers","updatecharges":"remaining_permissions"}},"x-mojo-to":"Patrons::Account#get"}},"\/patrons\/{patron_id}\/account\/credits":{"get":{"operationId":"listPatronCredits","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of credits","schema":{"items":{"$ref":"#\/definitions\/credit"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List patron credits","tags":["patrons"],"x-koha-authorization":{"permissions":{"borrowers":"edit_borrowers","updatecharges":"remaining_permissions"}},"x-mojo-to":"Patrons::Account#list_credits"},"post":{"operationId":"addPatronCredit","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"A JSON object containing credit information","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/patron_account_credit"}}],"produces":["application\/json"],"responses":{"201":{"description":"Credit added","schema":{"$ref":"#\/definitions\/account_line"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add credit to a patron's account","tags":["patrons"],"x-koha-authorization":{"permissions":{"updatecharges":"remaining_permissions"}},"x-mojo-to":"Patrons::Account#add_credit"}},"\/patrons\/{patron_id}\/account\/credits\/{credit_id}":{"get":{"operationId":"getPatronCredit","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"Internal credit identifier","in":"path","name":"credit_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A patron credit","schema":{"$ref":"#\/definitions\/credit"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get a patron credit","tags":["patrons"],"x-koha-authorization":{"permissions":{"borrowers":"edit_borrowers","updatecharges":"remaining_permissions"}},"x-mojo-to":"Patrons::Account#get_credit"}},"\/patrons\/{patron_id}\/account\/debits":{"get":{"operationId":"listPatronDebits","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of debits","schema":{"items":{"$ref":"#\/definitions\/debit"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List patron debits","tags":["patrons"],"x-koha-authorization":{"permissions":{"borrowers":"edit_borrowers","updatecharges":"remaining_permissions"}},"x-mojo-to":"Patrons::Account#list_debits"},"post":{"operationId":"addPatronDebit","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"A JSON object containing debit information","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/debit"}}],"produces":["application\/json"],"responses":{"201":{"description":"Debit added","schema":{"$ref":"#\/definitions\/debit"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add debit to a patron's account","tags":["patrons"],"x-koha-authorization":{"permissions":{"updatecharges":"remaining_permissions"}},"x-mojo-to":"Patrons::Account#add_debit"}},"\/patrons\/{patron_id}\/account\/debits\/{debit_id}":{"get":{"operationId":"getPatronDebit","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"Internal debit identifier","in":"path","name":"debit_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A patron debit","schema":{"$ref":"#\/definitions\/debit"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get a patron debit","tags":["patrons"],"x-koha-authorization":{"permissions":{"borrowers":"edit_borrowers","updatecharges":"remaining_permissions"}},"x-mojo-to":"Patrons::Account#get_debit"}},"\/patrons\/{patron_id}\/checkouts":{"get":{"operationId":"getPatronCheckouts","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["booking","issuer","item","item.biblio","library","patron","renewals"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"The patron checkouts","schema":{"items":{"$ref":"#\/definitions\/checkout"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List checkouts for a patron","tags":["checkouts"],"x-koha-authorization":{"permissions":[{"circulate":"circulate_remaining_permissions"},{"circulate":"manage_bookings"}]},"x-mojo-to":"Patrons::Checkouts#list"}},"\/patrons\/{patron_id}\/extended_attributes":{"get":{"operationId":"getPatronAttributes","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"The patron extended attributes","schema":{"items":{"$ref":"#\/definitions\/patron_extended_attribute"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List extended attributes for a patron","tags":["patrons"],"x-koha-authorization":{"permissions":{"borrowers":"edit_borrowers"}},"x-mojo-to":"Patrons::Attributes#list_patron_attributes"},"post":{"operationId":"addPatronAttribute","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"A JSON representation of the patron extended attribute","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/patron_extended_attribute"}}],"produces":["application\/json"],"responses":{"201":{"description":"A successfully created patron extended attribute","schema":{"$ref":"#\/definitions\/patron_extended_attribute"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add extended attribute for a patron","tags":["patrons"],"x-koha-authorization":{"permissions":{"borrowers":"edit_borrowers"}},"x-mojo-to":"Patrons::Attributes#add"},"put":{"operationId":"overwritePatronAttributes","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"A JSON representation of the patron extended attribute","in":"body","name":"body","required":true,"schema":{"items":{"$ref":"#\/definitions\/patron_extended_attribute"},"type":"array"}}],"produces":["application\/json"],"responses":{"200":{"description":"The successfully created patron extended attributes","schema":{"items":{"$ref":"#\/definitions\/patron_extended_attribute"},"type":"array"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Overwrite extended attributes for a patron","tags":["patrons"],"x-koha-authorization":{"permissions":{"borrowers":"edit_borrowers"}},"x-mojo-to":"Patrons::Attributes#overwrite"}},"\/patrons\/{patron_id}\/extended_attributes\/{extended_attribute_id}":{"delete":{"operationId":"deletePatronAttribute","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"Internal patron extended attribute identifier","in":"path","name":"extended_attribute_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Extended patron attribute deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete extended attribute","tags":["patrons"],"x-koha-authorization":{"permissions":{"borrowers":"edit_borrowers"}},"x-mojo-to":"Patrons::Attributes#delete"},"patch":{"operationId":"updatePatronAttribute","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"Internal patron extended attribute identifier","in":"path","name":"extended_attribute_id","required":true,"type":"integer"},{"description":"An object containing the updated values for the patron extended attribute","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"value":{"description":"Extended attribute value","type":"string"}},"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A successfully updated patron extended attribute","schema":{"$ref":"#\/definitions\/patron_extended_attribute"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Object not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in updating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update extended attribute","tags":["patrons"],"x-koha-authorization":{"permissions":{"borrowers":"edit_borrowers"}},"x-mojo-to":"Patrons::Attributes#update"}},"\/patrons\/{patron_id}\/hold_groups":{"get":{"operationId":"getPatronHoldGroups","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["holds"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"The patron hold groups","schema":{"items":{"$ref":"#\/definitions\/hold_group"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List hold groups for a patron","tags":["hold_groups"],"x-koha-authorization":{"permissions":{"borrowers":"edit_borrowers"}},"x-mojo-to":"Patrons::HoldGroups#list"},"post":{"consumes":["application\/json"],"operationId":"addPatronHoldGroups","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"A JSON object containing informations about the new hold group","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"force_grouped":{"description":"Whether to force creation of a new hold group","type":["boolean","null"]},"hold_ids":{"description":"List of holds to add to hold group","type":["array","null"]}},"type":"object"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["holds"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"201":{"description":"Created hold group","schema":{"$ref":"#\/definitions\/hold_group"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Hold not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Borrower not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict. Possible `error_code` attribute values:\n\n  * `bad_address`\n  * `card_lost`\n  * `debt_limit`\n  * `expired`\n  * `hold_limit`\n  * `restricted`\n","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add hold group. May contain hold ids of existing holds","tags":["hold_groups"],"x-koha-authorization":{"permissions":{"reserveforothers":"1"}},"x-mojo-to":"Patrons::HoldGroups#add"}},"\/patrons\/{patron_id}\/hold_groups\/{hold_group_id}":{"delete":{"operationId":"deletePatronHoldGroups","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"Internal hold group identifier","in":"path","name":"hold_group_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Hold group deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Hold group not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict. Possible `error_code` attribute values:\n","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete hold group","tags":["hold_groups"],"x-koha-authorization":{"permissions":{"reserveforothers":"1"}},"x-mojo-to":"Patrons::HoldGroups#delete"}},"\/patrons\/{patron_id}\/holds":{"get":{"operationId":"getPatronHolds","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"description":"By default, current holds are returned, when this is true then old holds are returned as result.","in":"query","name":"old","type":"boolean"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["+strings","cancellation_requested","biblio","deleted_biblio","item","pickup_library"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"The patron holds","schema":{"items":{"$ref":"#\/definitions\/hold"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List holds for a patron","tags":["holds"],"x-koha-authorization":{"permissions":{"borrowers":"edit_borrowers"}},"x-mojo-to":"Patrons::Holds#list"}},"\/patrons\/{patron_id}\/ill\/requests":{"get":{"operationId":"getPatronIllRequests","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["+strings","extended_attributes"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of parton's ILL requests","schema":{"items":{"$ref":"#\/definitions\/ill_request"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get patron's ILL requests","tags":["ill_requests"],"x-koha-authorization":{"permissions":{"ill":"1"}},"x-mojo-to":"ILL::Requests#patron_list"}},"\/patrons\/{patron_id}\/password":{"post":{"operationId":"setPatronPassword","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"A JSON object containing password information","in":"body","name":"body","schema":{"additionalProperties":false,"properties":{"password":{"description":"New password (plain text)","type":"string"},"password_2":{"description":"Repeated new password (plain text)","type":"string"}},"required":["password","password_2"],"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"Password changed"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Set password for a patron","tags":["patrons"],"x-koha-authorization":{"permissions":{"borrowers":"1"}},"x-mojo-to":"Patrons::Password#set"}},"\/patrons\/{patron_id}\/password\/expiration_date":{"put":{"operationId":"setPatronPasswordExpiration","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"A JSON object containing password expiration date","in":"body","name":"body","schema":{"additionalProperties":false,"properties":{"expiration_date":{"description":"Date to expire password","format":"date","type":"string"}},"required":["expiration_date"],"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"Password expiration changed"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Set password expiration for a patron","tags":["patrons"],"x-koha-authorization":{"permissions":{"superlibrarian":"1"}},"x-mojo-to":"Patrons::Password::Expiration#set"}},"\/patrons\/{patron_id}\/recalls":{"get":{"operationId":"getPatronRecalls","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"The patron's recalls","schema":{"items":{"$ref":"#\/definitions\/recall"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List recalls for a patron","tags":["recalls"],"x-koha-authorization":{"permissions":{"recalls":"manage_recalls"}},"x-mojo-to":"Patrons::Recalls#list"}},"\/preservation\/config":{"get":{"description":"This resource returns a list of options needed for the Preservation Vue app. EXPERIMENTAL - DO NOT RELY on this, it is subject to change!","operationId":"getPreservationconfig","produces":["application\/json"],"responses":{"200":{"description":"The Preservation module config","schema":{"$ref":"#\/definitions\/preservation_config"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"get the Preservation config","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation#config"}},"\/preservation\/processings":{"get":{"operationId":"listPreservationProcessings","parameters":[{"description":"Case insensitive search on processing id","in":"query","name":"processing_id","required":false,"type":"integer"},{"description":"Case insensitive search on processing name","in":"query","name":"name","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of processings","schema":{"items":{"$ref":"#\/definitions\/preservation_processing"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List processings","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation::Processings#list"},"post":{"consumes":["application\/json"],"operationId":"addPreservationProcessings","parameters":[{"description":"A JSON object containing information about the new processing","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/preservation_processing"}}],"produces":["application\/json"],"responses":{"201":{"description":"A successfully created processing","schema":{"items":{"$ref":"#\/definitions\/preservation_processing"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add processing","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation::Processings#add"}},"\/preservation\/processings\/{processing_id}":{"delete":{"operationId":"deletePreservationProcessings","parameters":[{"description":"processing internal identifier","in":"path","name":"processing_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"processing deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in deleting resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete processing","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation::Processings#delete"},"get":{"operationId":"getPreservationProcessings","parameters":[{"description":"processing internal identifier","in":"path","name":"processing_id","required":true,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["attributes"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A processing","schema":{"items":{"$ref":"#\/definitions\/preservation_processing"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get processing","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation::Processings#get"},"put":{"consumes":["application\/json"],"operationId":"updatePreservationProcessings","parameters":[{"description":"processing internal identifier","in":"path","name":"processing_id","required":true,"type":"integer"},{"description":"A JSON object containing new information about existing processing","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/preservation_processing"}}],"produces":["application\/json"],"responses":{"200":{"description":"A successfully updated processing","schema":{"items":{"$ref":"#\/definitions\/preservation_processing"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in updating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update processing","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation::Processings#update"}},"\/preservation\/trains":{"get":{"operationId":"listPreservationTrains","parameters":[{"description":"Case insensitive search on train id","in":"query","name":"train_id","required":false,"type":"integer"},{"description":"Case insensitive search on train name","in":"query","name":"name","required":false,"type":"string"},{"description":"Case insensitive search on train description","in":"query","name":"description","required":false,"type":"string"},{"description":"Case insensitive search on not for loan value","in":"query","name":"not_for_loan","required":false,"type":"string"},{"description":"Case insensitive search on train creation date","in":"query","name":"created_on","required":false,"type":"string"},{"description":"Case insensitive search on train closing date","in":"query","name":"closed_on","required":false,"type":"string"},{"description":"Case insensitive search on train sent date","in":"query","name":"sent_on","required":false,"type":"string"},{"description":"Case insensitive search on train receiving date","in":"query","name":"received_on","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of trains","schema":{"items":{"$ref":"#\/definitions\/preservation_train"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List trains","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation::Trains#list"},"post":{"consumes":["application\/json"],"operationId":"addPreservationTrains","parameters":[{"description":"A JSON object containing information about the new train","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/preservation_train"}}],"produces":["application\/json"],"responses":{"201":{"description":"A successfully created train","schema":{"items":{"$ref":"#\/definitions\/preservation_train"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add train","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation::Trains#add"}},"\/preservation\/trains\/{train_id}":{"delete":{"operationId":"deletePreservationTrains","parameters":[{"description":"train internal identifier","in":"path","name":"train_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Train deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in deleting resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete train","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation::Trains#delete"},"get":{"operationId":"getPreservationTrains","parameters":[{"description":"train internal identifier","in":"path","name":"train_id","required":true,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["items","items.attributes","items.attributes+strings","items.attributes.processing_attribute","items.processing","default_processing","default_processing.attributes"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A train","schema":{"items":{"$ref":"#\/definitions\/preservation_train"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get train","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation::Trains#get"},"put":{"consumes":["application\/json"],"operationId":"updatePreservationTrains","parameters":[{"description":"train internal identifier","in":"path","name":"train_id","required":true,"type":"integer"},{"description":"A JSON object containing new information about existing train","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/preservation_train"}}],"produces":["application\/json"],"responses":{"200":{"description":"A successfully updated train","schema":{"items":{"$ref":"#\/definitions\/preservation_train"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in updating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update train","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation::Trains#update"}},"\/preservation\/trains\/{train_id}\/items":{"post":{"consumes":["application\/json"],"operationId":"addItemToTrain","parameters":[{"description":"train internal identifier","in":"path","name":"train_id","required":true,"type":"integer"},{"description":"An item","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/preservation_train_item"}}],"produces":["application\/json"],"responses":{"201":{"description":"A successfully added item","schema":{"$ref":"#\/definitions\/preservation_train_item"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add item to train","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation::Trains#add_item"}},"\/preservation\/trains\/{train_id}\/items\/batch":{"post":{"consumes":["application\/json"],"operationId":"addItemsToTrain","parameters":[{"description":"train internal identifier","in":"path","name":"train_id","required":true,"type":"integer"},{"description":"A list of items","in":"body","name":"body","required":true,"schema":{"items":{"type":"object"},"type":"array"}}],"produces":["application\/json"],"responses":{"201":{"description":"A successfully added list of items","schema":{"items":{"type":"object"},"type":"array"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add items to train","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation::Trains#add_items"}},"\/preservation\/trains\/{train_id}\/items\/{train_item_id}":{"delete":{"operationId":"removeItemFromTrain","parameters":[{"description":"train internal identifier","in":"path","name":"train_id","required":true,"type":"integer"},{"description":"train item internal identifier","in":"path","name":"train_item_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Item removed"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Item not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Remove item from train","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation::Trains#remove_item"},"get":{"operationId":"getItemFromPreservationTrains","parameters":[{"description":"train internal identifier","in":"path","name":"train_id","required":true,"type":"integer"},{"description":"train item internal identifier","in":"path","name":"train_item_id","required":true,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["attributes","catalogue_item","catalogue_item.biblio"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"An item in train","schema":{"$ref":"#\/definitions\/preservation_train_item"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get item from train","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation::Trains#get_item"},"put":{"consumes":["application\/json"],"operationId":"updateItemFromTrain","parameters":[{"description":"train internal identifier","in":"path","name":"train_id","required":true,"type":"integer"},{"description":"train item internal identifier","in":"path","name":"train_item_id","required":true,"type":"integer"},{"description":"An item","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/preservation_train_item"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["attributes"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A successfully updated item","schema":{"$ref":"#\/definitions\/preservation_train_item"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in updating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update item from train","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation::Trains#update_item"}},"\/preservation\/trains\/{train_id}\/items\/{train_item_id}\/copy":{"post":{"consumes":["application\/json"],"operationId":"copyItemToAnotherTrain","parameters":[{"description":"train internal identifier","in":"path","name":"train_id","required":true,"type":"integer"},{"description":"train item internal identifier","in":"path","name":"train_item_id","required":true,"type":"integer"},{"description":"The train_id of the new train","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"train_id":{"description":"Train id","type":"integer"}},"type":"object"}}],"produces":["application\/json"],"responses":{"201":{"description":"A successfully copied item","schema":{"$ref":"#\/definitions\/preservation_train_item"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Copy an item to an other train","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation::Trains#copy_item"}},"\/preservation\/waiting-list\/items":{"get":{"consumes":["application\/json"],"operationId":"listItemsFromWaitingList","parameters":[{"description":"Search on the item's barcode","in":"query","name":"external_id","required":false,"type":"string"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["biblio"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of item","schema":{"items":{"$ref":"#\/definitions\/item"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List items from waiting list","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation::WaitingList#list"},"post":{"consumes":["application\/json"],"operationId":"addItemsToWaitingList","parameters":[{"description":"A list of itemnumbers or barcodes","in":"body","name":"body","required":true,"schema":{"items":{"type":"object"},"type":"array"}}],"produces":["application\/json"],"responses":{"201":{"description":"A successfully added list of items","schema":{"items":{"type":"object"},"type":"array"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add items to waiting list","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation::WaitingList#add_items"}},"\/preservation\/waiting-list\/items\/{item_id}":{"delete":{"operationId":"removeItemFromWaitingList","parameters":[{"description":"Internal item identifier","in":"path","name":"item_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Item removed"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Item not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Remove item from waiting list","tags":["preservation"],"x-koha-authorization":{"permissions":{"preservation":1}},"x-mojo-to":"Preservation::WaitingList#remove_item"}},"\/public\/additional_contents":{"get":{"operationId":"listAdditionalContents","parameters":[{"description":"Case insensitive search on additional_contents id","in":"query","name":"additional_content_id","required":false,"type":"string"},{"description":"Case insensitive search on additional_contents category","in":"query","name":"category","required":false,"type":"string"},{"description":"Case insensitive search on additional_contents code","in":"query","name":"code","required":false,"type":"string"},{"description":"Case insensitive search on additional_contents location","in":"query","name":"location","required":false,"type":"string"},{"description":"Case insensitive search on additional_contents library_id","in":"query","name":"library_id","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Embed list sent as a request header","in":"header","items":{"collectionFormat":"csv","enum":["translated_contents"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of additional contents","schema":{"items":{"$ref":"#\/definitions\/additional_content"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List public additional contents","tags":["additional_contents"],"x-mojo-to":"AdditionalContents#list_public"}},"\/public\/biblios\/{biblio_id}":{"get":{"operationId":"getBiblioPublic","parameters":[{"description":"Record internal identifier","in":"path","name":"biblio_id","required":true,"type":"integer"}],"produces":["application\/marcxml+xml","application\/marc-in-json","application\/marc","text\/plain"],"responses":{"200":{"description":"A biblio"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Bibliographic record not found","schema":{"$ref":"#\/definitions\/error"}},"406":{"description":"Not acceptable","schema":{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get biblio (public)","tags":["biblios"],"x-mojo-to":"Biblios#get_public"}},"\/public\/biblios\/{biblio_id}\/items":{"get":{"consumes":["application\/json"],"operationId":"getBiblioItemsPublic","parameters":[{"description":"Record internal identifier","in":"path","name":"biblio_id","required":true,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["+strings"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of the items attached to the record","schema":{"items":{"$ref":"#\/definitions\/item"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Bibliographic record not found","schema":{"$ref":"#\/definitions\/error"}},"406":{"description":"Not acceptable","schema":{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"tags":["biblios","items"],"x-mojo-to":"Biblios#get_items_public"}},"\/public\/biblios\/{biblio_id}\/ratings":{"post":{"operationId":"setBiblioRating","parameters":[{"description":"Record internal identifier","in":"path","name":"biblio_id","required":true,"type":"integer"},{"description":"A JSON object containing rating information","in":"body","name":"body","schema":{"additionalProperties":false,"properties":{"rating":{"description":"the rating","type":["integer","null"]}},"required":["rating"],"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"Rating set","schema":{"additionalProperties":false,"properties":{"average":{"description":"average rating","type":"number"},"count":{"description":"number of ratings","type":"integer"},"rating":{"description":"user's rating","type":["number","null"]}},"type":"object"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Bibliographic record not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"set biblio rating (public)","tags":["biblios"],"x-mojo-to":"Biblios#set_rating"}},"\/public\/checkouts\/availability":{"get":{"operationId":"availabilityCheckoutsPublic","parameters":[{"description":"Internal patron identifier","in":"query","name":"patron_id","type":"integer"},{"description":"Internal item identifier","in":"query","name":"item_id","type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"Availability","schema":{"additionalProperties":false,"properties":{"blockers":{"type":"object"},"confirmation_token":{"type":"string"},"confirms":{"type":"object"},"warnings":{"type":"object"}},"type":"object"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get checkout availability","tags":["checkouts"],"x-mojo-to":"Checkouts#get_availability"}},"\/public\/items":{"get":{"consumes":["application\/json"],"operationId":"listItemsPublic","parameters":[{"description":"Search on the item's barcode","in":"query","name":"external_id","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["+strings","biblio"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of item","schema":{"items":{"$ref":"#\/definitions\/item"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List items publically visible","tags":["items"],"x-mojo-to":"Items#list_public"}},"\/public\/libraries":{"get":{"operationId":"listLibrariesPublic","parameters":[{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of libraries","schema":{"items":{"$ref":"#\/definitions\/library"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List libraries","tags":["libraries"],"x-mojo-to":"Libraries#list"}},"\/public\/libraries\/{library_id}":{"get":{"operationId":"getLibraryPublic","parameters":[{"description":"Internal library identifier","in":"path","name":"library_id","required":true,"type":"string"}],"produces":["application\/json"],"responses":{"200":{"description":"A library"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Library not found","schema":{"$ref":"#\/definitions\/error"}},"406":{"description":"Not acceptable","schema":{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get library (public)","tags":["libraries"],"x-mojo-to":"Libraries#get"}},"\/public\/lists":{"get":{"description":"This resource returns a list of existing bibliographic lists.","operationId":"listListsPublic","parameters":[{"description":"Only return the users' lists","in":"query","name":"only_mine","required":false,"type":"string"},{"description":"Only return public lists","in":"query","name":"only_public","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of lists","schema":{"items":{"$ref":"#\/definitions\/list"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `bad_request`\n  * `invalid_query`\n  * `only_mine_forbidden`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List bibliographic lists","tags":["lists"],"x-mojo-to":"Lists#list_public"}},"\/public\/oauth\/login\/{provider_code}\/{interface}":{"get":{"operationId":"loginOAuthClientPublic","parameters":[{"description":"Code for OAuth provider","in":"path","name":"provider_code","required":true,"type":"string"},{"description":"Name of the interface this login is for","in":"path","name":"interface","required":true,"type":"string"},{"description":"Code returned from OAuth server for Authorization Code grant","in":"query","name":"code","required":false,"type":"string"},{"description":"An opaque value used by the client to maintain state between the request and callback. This is the callback part.","in":"query","name":"state","required":false,"type":"string"},{"description":"Scope returned by OAuth server","in":"query","name":"scope","type":"string"},{"description":"Prompt returned by OAuth server","in":"query","name":"prompt","type":"string"},{"description":"Auth user returned by OAuth server","in":"query","name":"authuser","type":"string"},{"description":"OAuth error code","in":"query","name":"error","type":"string"},{"description":"OAuth error description","in":"query","name":"error_description","type":"string"},{"description":"Web page with user friendly description of the error","in":"query","name":"error_uri","type":"string"},{"description":"Session state returned by OAuth server","in":"query","name":"session_state","type":"string"}],"produces":["application\/json"],"responses":{"302":{"description":"User authorized","schema":{"type":"string"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Login to OAuth provider","tags":["oauth"],"x-mojo-to":"OAuth::Client#login"}},"\/public\/patrons\/{patron_id}\/article_requests\/{article_request_id}":{"delete":{"operationId":"publicCancelPatronArticleRequest","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"Article request identifier","in":"path","name":"article_request_id","required":true,"type":"integer"},{"description":"Article request cancellation reason","in":"query","name":"cancellation_reason","required":false,"type":"string"},{"description":"Article request custom cancellation reason","in":"query","name":"notes","required":false,"type":"string"}],"produces":["application\/json"],"responses":{"204":{"description":"Patron's article request canceled"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Cancel patron's article requests","tags":["article_requests"],"x-mojo-to":"ArticleRequests#patron_cancel"}},"\/public\/patrons\/{patron_id}\/checkouts":{"post":{"operationId":"addCheckoutPublic","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"A JSON object containing information about the new checkout","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/checkout"}},{"description":"A JWT confirmation token","in":"query","name":"confirmation","required":false,"type":"string"}],"produces":["application\/json"],"responses":{"201":{"description":"Created checkout","schema":{"$ref":"#\/definitions\/checkout"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Cannot create checkout","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"405":{"description":"Method not allowed. Possible `error_code` attribute values:\n\n* `FEATURE_DISABLED`\n","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating checkout. Possible `error_code` attribute values:\n\n* `ITEM_NOT_FOUND`\n* `PATRON_NOT_FOUND`\n","schema":{"$ref":"#\/definitions\/error"}},"412":{"description":"Precondition failed","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add a new checkout (public)","tags":["checkouts","patrons"],"x-mojo-to":"Checkouts#add"}},"\/public\/patrons\/{patron_id}\/guarantors\/can_see_charges":{"put":{"operationId":"setPatronGuarantorsCanSeeCharges","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"A boolean representing if guarantors should be able to see the patron's charges","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"allowed":{"type":"boolean"}},"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"Charges view policy for guarantors changed"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Set if guarantors can see charges (public)","tags":["patrons"],"x-mojo-to":"Patrons#guarantors_can_see_charges"}},"\/public\/patrons\/{patron_id}\/guarantors\/can_see_checkouts":{"put":{"operationId":"setPatronGuarantorsCanSeeCheckouts","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"A boolean representing if guarantors should be able to see the patron's checkouts","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"allowed":{"type":"boolean"}},"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"Check-out view policy for guarantors changed"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Set if guarantors can see checkouts","tags":["patrons"],"x-mojo-to":"Patrons#guarantors_can_see_checkouts"}},"\/public\/patrons\/{patron_id}\/holds\/{hold_id}":{"delete":{"operationId":"cancelPatronHoldPublic","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"Internal hold identifier","in":"path","name":"hold_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"202":{"description":"Hold cancellation request accepted"},"204":{"description":"Hold cancelled"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Hold not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Cancel a patron's hold (public)","tags":["patrons"],"x-mojo-to":"Patrons::Holds#delete_public"}},"\/public\/patrons\/{patron_id}\/ill\/requests":{"get":{"operationId":"getPublicPatronIllRequests","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["+strings","extended_attributes"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of parton's ILL requests","schema":{"items":{"$ref":"#\/definitions\/ill_request"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get patron's ILL requests","tags":["ill_requests"],"x-mojo-to":"ILL::Requests#public_patron_list"}},"\/public\/patrons\/{patron_id}\/password":{"post":{"operationId":"setPatronPasswordPublic","parameters":[{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"},{"description":"A JSON object containing password information","in":"body","name":"body","schema":{"additionalProperties":false,"properties":{"old_password":{"description":"Patron's original password","type":"string"},"password":{"description":"New password (plain text)","type":"string"},"password_repeated":{"description":"Repeated new password (plain text)","type":"string"}},"required":["password","password_repeated","old_password"],"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"Password changed"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Patron not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Set password for a patron (public)","tags":["patrons"],"x-mojo-to":"Patrons::Password#set_public"}},"\/public\/tickets":{"post":{"operationId":"addTicketPublic","parameters":[{"description":"A JSON object containing informations about the new ticket","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/ticket"}}],"produces":["application\/json"],"responses":{"201":{"description":"Ticket added","schema":{"$ref":"#\/definitions\/ticket"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add ticket","tags":["tickets"],"x-mojo-to":"Tickets#add"}},"\/quotes":{"get":{"operationId":"listQuotes","parameters":[{"description":"Case insensitive search on quote id","in":"query","name":"quote_id","required":false,"type":"string"},{"description":"Case insensitive search on source","in":"query","name":"source","required":false,"type":"string"},{"description":"Case insensitive search on text","in":"query","name":"text","required":false,"type":"string"},{"description":"Case Insensative search on last displayed date","in":"query","name":"displayed_on","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of quotes","schema":{"items":{"$ref":"#\/definitions\/quote"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List quotes","tags":["quotes"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"Quotes#list"},"post":{"operationId":"addQuote","parameters":[{"description":"A JSON object containing informations about the new quote","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/quote"}}],"produces":["application\/json"],"responses":{"201":{"description":"Quote added","schema":{"$ref":"#\/definitions\/quote"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add quote","tags":["quotes"],"x-koha-authorization":{"permissions":{"tools":"edit_quotes"}},"x-mojo-to":"Quotes#add"}},"\/quotes\/{quote_id}":{"delete":{"operationId":"deleteQuote","parameters":[{"description":"Quote internal identifier","in":"path","name":"quote_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Quote deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Quote not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete quote","tags":["quotes"],"x-koha-authorization":{"permissions":{"tools":"edit_quotes"}},"x-mojo-to":"Quotes#delete"},"get":{"operationId":"getQuote","parameters":[{"description":"Quote internal identifier","in":"path","name":"quote_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A Quote","schema":{"$ref":"#\/definitions\/quote"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"404":{"description":"Quote not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get quote","tags":["quotes"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"Quotes#get"},"put":{"operationId":"updateQuote","parameters":[{"description":"Quote internal identifier","in":"path","name":"quote_id","required":true,"type":"integer"},{"description":"a quote object","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/quote"}}],"produces":["application\/json"],"responses":{"200":{"description":"A quote","schema":{"$ref":"#\/definitions\/quote"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Quote not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update quote","tags":["quotes"],"x-koha-authorization":{"permissions":{"tools":"edit_quotes"}},"x-mojo-to":"Quotes#update"}},"\/record_sources":{"get":{"consumes":["application\/json"],"operationId":"listRecordSources","parameters":[{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["usage_count"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of record sources","schema":{"items":{"$ref":"#\/definitions\/record_source"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List record sources","tags":["record_sources"],"x-koha-authorization":{"permissions":{"parameters":"manage_record_sources"}},"x-mojo-to":"RecordSources#list"},"post":{"consumes":["application\/json"],"operationId":"addRecordSources","parameters":[{"description":"A JSON object containing informations about the new record source","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/record_source"}}],"produces":["application\/json"],"responses":{"201":{"description":"A record source","schema":{"$ref":"#\/definitions\/record_source"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add a record source","tags":["record_sources"],"x-koha-authorization":{"permissions":{"parameters":"manage_record_sources"}},"x-mojo-to":"RecordSources#add"}},"\/record_sources\/{record_source_id}":{"delete":{"consumes":["application\/json"],"operationId":"deleteRecordSources","parameters":[{"description":"Internal record source identifier","in":"path","name":"record_source_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in deleting resource. Possible `error_code` attribute values:\n\n* `cannot_delete_used`: record source linked to a record cannot be deleted.\n","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete a record source","tags":["record_sources"],"x-koha-authorization":{"permissions":{"parameters":"manage_record_sources"}},"x-mojo-to":"RecordSources#delete"},"get":{"consumes":["application\/json"],"operationId":"getRecordSources","parameters":[{"description":"Internal record source identifier","in":"path","name":"record_source_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A record source","schema":{"$ref":"#\/definitions\/record_source"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get a record source","tags":["record_sources"],"x-koha-authorization":{"permissions":{"parameters":"manage_record_sources"}},"x-mojo-to":"RecordSources#get"},"put":{"consumes":["application\/json"],"operationId":"updateRecordSources","parameters":[{"description":"Internal record source identifier","in":"path","name":"record_source_id","required":true,"type":"integer"},{"description":"A JSON object containing informations about the new record source","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/record_source"}}],"produces":["application\/json"],"responses":{"200":{"description":"A record source","schema":{"$ref":"#\/definitions\/record_source"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Not allowed","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update a record source","tags":["record_sources"],"x-koha-authorization":{"permissions":{"parameters":"manage_record_sources"}},"x-mojo-to":"RecordSources#update"}},"\/return_claims":{"post":{"operationId":"claimReturned","parameters":[{"description":"A JSON object containing fields to modify","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"charge_lost_fee":{"description":"Charge a lost fee if true and Koha is set to allow a choice. Ignored otherwise.","type":"boolean"},"created_by":{"description":"User id for the librarian submitting this claim","type":"string"},"item_id":{"description":"Internal item id to claim as returned","type":"integer"},"notes":{"description":"Notes about this return claim","type":"string"},"refund_lost_fee":{"description":"Refund a lost fee if true and a lost fee has previously been charged for the item. Ignored otherwise.","type":"boolean"}},"type":"object"}}],"produces":["application\/json"],"responses":{"201":{"description":"Created claim","schema":{"$ref":"#\/definitions\/return_claim"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Checkout not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict creating the resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add a return claim","tags":["return_claims"],"x-koha-authorization":{"permissions":{"circulate":"circulate_remaining_permissions"}},"x-mojo-to":"ReturnClaims#claim_returned"}},"\/return_claims\/{claim_id}":{"delete":{"operationId":"deletedClaim","parameters":[{"description":"Unique identifier for the claim to be deleted","in":"path","name":"claim_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Claim deleted","schema":{"$ref":"#\/definitions\/return_claim"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Claim not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete claim","tags":["return_claims"],"x-koha-authorization":{"permissions":{"circulate":"circulate_remaining_permissions"}},"x-mojo-to":"ReturnClaims#delete_claim"}},"\/return_claims\/{claim_id}\/notes":{"put":{"operationId":"updateClaimNotes","parameters":[{"description":"Unique identifier for the claim whose notes are to be updated","in":"path","name":"claim_id","required":true,"type":"integer"},{"description":"A JSON object containing fields to modify","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"notes":{"description":"Notes about this return claim","type":"string"},"updated_by":{"description":"Interal identifier for the librarian updating the claim notes","type":"string"}},"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"Claim notes updated","schema":{"$ref":"#\/definitions\/return_claim"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Claim not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update notes","tags":["return_claims"],"x-koha-authorization":{"permissions":{"circulate":"circulate_remaining_permissions"}},"x-mojo-to":"ReturnClaims#update_notes"}},"\/return_claims\/{claim_id}\/resolve":{"put":{"operationId":"updateClaimResolve","parameters":[{"description":"Unique identifier for the claim to be resolved","in":"path","name":"claim_id","required":true,"type":"integer"},{"description":"A JSON object containing fields to modify","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"new_lost_status":{"description":"New lost status to set to the item","type":"string"},"resolution":{"description":"The RETURN_CLAIM_RESOLUTION code to be used to resolve the calim","type":"string"},"resolved_by":{"description":"User id for the librarian resolving the claim","type":"string"}},"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"Claim resolved","schema":{"$ref":"#\/definitions\/return_claim"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Claim not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Resolve claim","tags":["return_claims"],"x-koha-authorization":{"permissions":{"circulate":"circulate_remaining_permissions"}},"x-mojo-to":"ReturnClaims#resolve_claim"}},"\/rotas":{"get":{"operationId":"listRotas","parameters":[{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of stockrotation rotas","schema":{"items":{"$ref":"#\/definitions\/rota"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List rotas","tags":["stockrotation"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"StockRotation::Rotas#list"},"post":{"operationId":"addRota","parameters":[{"description":"A JSON object containing informations about the new hold","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/rota"}}],"produces":["application\/json"],"responses":{"201":{"description":"Rota added","schema":{"$ref":"#\/definitions\/rota"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add rota","tags":["stockrotation"],"x-koha-authorization":{"permissions":{"stockrotation":"1"}},"x-mojo-to":"StockRotation::Rotas#add"}},"\/rotas\/{rota_id}":{"delete":{"operationId":"deleteRota","parameters":[{"description":"Rota internal identifier","in":"path","name":"rota_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Rota deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Rota not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete rota","tags":["stockrotation"],"x-koha-authorization":{"permissions":{"stockrotation":"1"}},"x-mojo-to":"StockRotation::Rotas#delete"},"get":{"operationId":"getRota","parameters":[{"description":"Rota internal identifier","in":"path","name":"rota_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A rota","schema":{"$ref":"#\/definitions\/rota"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"404":{"description":"Rota not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get rota","tags":["stockrotation"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"StockRotation::Rotas#get"},"put":{"operationId":"updateRota","parameters":[{"description":"Rota internal identifier","in":"path","name":"rota_id","required":true,"type":"integer"},{"description":"A rota object","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/rota"}}],"produces":["application\/json"],"responses":{"200":{"description":"A rota","schema":{"$ref":"#\/definitions\/rota"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Rota not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update rota","tags":["stockrotation"],"x-koha-authorization":{"permissions":{"stockrotation":"1"}},"x-mojo-to":"StockRotation::Rotas#update"}},"\/rotas\/{rota_id}\/stages\/{stage_id}\/position":{"put":{"operationId":"moveStage","parameters":[{"description":"A rotas ID","in":"path","name":"rota_id","required":true,"type":"integer"},{"description":"A stages ID","in":"path","name":"stage_id","required":true,"type":"integer"},{"description":"A stages position in the rota","in":"body","name":"position","required":true,"schema":{"type":"integer"}}],"produces":["application\/json"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Position not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update stage","tags":["stockrotation"],"x-koha-authorization":{"permissions":{"stockrotation":"1"}},"x-mojo-to":"StockRotation::Stage#move"}},"\/search_filters":{"get":{"operationId":"listFilters","parameters":[{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of search filters","schema":{"items":{"$ref":"#\/definitions\/search_filter"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List search filters","tags":["search_filters"],"x-koha-authorization":{"permissions":{"parameters":"manage_search_filters"}},"x-mojo-to":"SearchFilter#list"},"post":{"operationId":"addSearchFilter","parameters":[{"description":"A JSON object containing informations about the new search filter","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/search_filter"}}],"produces":["application\/json"],"responses":{"201":{"description":"Search filter added","schema":{"$ref":"#\/definitions\/search_filter"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"409":{"description":"Conflict in creating the resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add search filter","tags":["search_filters"],"x-koha-authorization":{"permissions":{"parameters":"manage_search_filters"}},"x-mojo-to":"SearchFilter#add"}},"\/search_filters\/{search_filter_id}":{"delete":{"operationId":"deleteSearchFilter","parameters":[{"description":"Search filter internal identifier","in":"path","name":"search_filter_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Searc filter deleted","schema":{"type":"string"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Search filter not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete search filter","tags":["search_filters"],"x-koha-authorization":{"permissions":{"parameters":"manage_search_filters"}},"x-mojo-to":"SearchFilter#delete"},"get":{"operationId":"getSearchFilter","parameters":[{"description":"Search filter internal identifier","in":"path","name":"search_filter_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A search filter","schema":{"$ref":"#\/definitions\/search_filter"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"SearchFilter not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get search filter","tags":["search_filters"],"x-koha-authorization":{"permissions":{"parameters":"manage_search_filters"}},"x-mojo-to":"SearchFilter#get"},"put":{"operationId":"updateSearchFilter","parameters":[{"description":"Search filter internal identifier","in":"path","name":"search_filter_id","required":true,"type":"integer"},{"description":"A search filter object","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/search_filter"}}],"produces":["application\/json"],"responses":{"200":{"description":"An search_filter","schema":{"$ref":"#\/definitions\/search_filter"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Search filter not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update search filter","tags":["search_filters"],"x-koha-authorization":{"permissions":{"parameters":"manage_search_filters"}},"x-mojo-to":"SearchFilter#update"}},"\/sip2\/accounts":{"get":{"operationId":"listSip2Accounts","parameters":[{"description":"Case insensitive search on account sip_account_id","in":"query","name":"sip_account_id","required":false,"type":"string"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["institution","custom_item_fields","item_fields","custom_patron_fields","patron_attributes","screen_msg_regexs","sort_bin_mappings","system_preference_overrides"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of SIP2 accounts","schema":{"items":{"$ref":"#\/definitions\/sip2_account"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List accounts","tags":["sip2_accounts"],"x-koha-authorization":{"permissions":{"sip2":1}},"x-mojo-to":"SIP2::Accounts#list"},"post":{"consumes":["application\/json"],"operationId":"addSip2Accounts","parameters":[{"description":"A JSON object containing information about the new account","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/sip2_account"}}],"produces":["application\/json"],"responses":{"201":{"description":"A successfully created account","schema":{"items":{"$ref":"#\/definitions\/sip2_account"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add accounts","tags":["sip2_accounts"],"x-koha-authorization":{"permissions":{"sip2":1}},"x-mojo-to":"SIP2::Accounts#add"}},"\/sip2\/accounts\/{sip_account_id}":{"delete":{"operationId":"deleteSip2Accounts","parameters":[{"description":"SIP2 account internal identifier","in":"path","name":"sip_account_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Account deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Resource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in deleting resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete account","tags":["sip2_accounts"],"x-koha-authorization":{"permissions":{"sip2":1}},"x-mojo-to":"SIP2::Accounts#delete"},"get":{"operationId":"getSip2Accounts","parameters":[{"description":"SIP2 account internal identifier","in":"path","name":"sip_account_id","required":true,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["institution","custom_item_fields","item_fields","custom_patron_fields","patron_attributes","screen_msg_regexs","sort_bin_mappings","system_preference_overrides"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A SIP2 account","schema":{"items":{"$ref":"#\/definitions\/sip2_account"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get SIP2 account","tags":["sip2_accounts"],"x-koha-authorization":{"permissions":{"sip2":1}},"x-mojo-to":"SIP2::Accounts#get"},"put":{"consumes":["application\/json"],"operationId":"updateSip2Accounts","parameters":[{"description":"SIP2 account internal identifier","in":"path","name":"sip_account_id","required":true,"type":"integer"},{"description":"A JSON object containing new information about existing account","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/sip2_account"}}],"produces":["application\/json"],"responses":{"200":{"description":"A successfully updated account","schema":{"items":{"$ref":"#\/definitions\/sip2_account"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in updating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update account","tags":["sip2_accounts"],"x-koha-authorization":{"permissions":{"sip2":1}},"x-mojo-to":"SIP2::Accounts#update"}},"\/sip2\/institutions":{"get":{"operationId":"listSip2Institutions","parameters":[{"description":"Case insensitive search on institution sip_institution_id","in":"query","name":"sip_institution_id","required":false,"type":"string"},{"description":"Case insensitive search on institution name","in":"query","name":"name","required":false,"type":"string"},{"description":"Case insensitive search on institution implementation","in":"query","name":"implementation","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of SIP2 institutions","schema":{"items":{"$ref":"#\/definitions\/sip2_institution"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List institutions","tags":["sip2_institutions"],"x-koha-authorization":{"permissions":{"sip2":1}},"x-mojo-to":"SIP2::Institutions#list"},"post":{"consumes":["application\/json"],"operationId":"addSip2Institutions","parameters":[{"description":"A JSON object containing information about the new institution","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/sip2_institution"}}],"produces":["application\/json"],"responses":{"201":{"description":"A successfully created institution","schema":{"items":{"$ref":"#\/definitions\/sip2_institution"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add institutions","tags":["sip2_institutions"],"x-koha-authorization":{"permissions":{"sip2":1}},"x-mojo-to":"SIP2::Institutions#add"}},"\/sip2\/institutions\/{sip_institution_id}":{"delete":{"operationId":"deleteSip2Institutions","parameters":[{"description":"SIP2 institution internal identifier","in":"path","name":"sip_institution_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Institution deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Resource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in deleting resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete institution","tags":["sip2_institutions"],"x-koha-authorization":{"permissions":{"sip2":1}},"x-mojo-to":"SIP2::Institutions#delete"},"get":{"operationId":"getSip2Institutions","parameters":[{"description":"SIP2 institution internal identifier","in":"path","name":"sip_institution_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A SIP2 institution","schema":{"items":{"$ref":"#\/definitions\/sip2_institution"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get SIP2 institution","tags":["sip2_institutions"],"x-koha-authorization":{"permissions":{"sip2":1}},"x-mojo-to":"SIP2::Institutions#get"},"put":{"consumes":["application\/json"],"operationId":"updateSip2Institutions","parameters":[{"description":"SIP2 institution internal identifier","in":"path","name":"sip_institution_id","required":true,"type":"integer"},{"description":"A JSON object containing new information about existing institution","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/sip2_institution"}}],"produces":["application\/json"],"responses":{"200":{"description":"A successfully updated institution","schema":{"items":{"$ref":"#\/definitions\/sip2_institution"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in updating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update institution","tags":["sip2_institutions"],"x-koha-authorization":{"permissions":{"sip2":1}},"x-mojo-to":"SIP2::Institutions#update"}},"\/sip2\/system_preference_overrides":{"get":{"operationId":"listSip2SystemPreferenceOverrides","parameters":[{"collectionFormat":"csv","description":"Case insensitive search on system preference override sip_system_preference_override_id","in":"query","name":"sip_system_preference_override_id","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}],"produces":["application\/json"],"responses":{"200":{"description":"A list of SIP2 system preference overrides","schema":{"items":{"$ref":"#\/definitions\/sip2_system_preference_override"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List system preference overrides","tags":["sip2_system_preference_overrides"],"x-koha-authorization":{"permissions":{"sip2":1}},"x-mojo-to":"SIP2::SystemPreferenceOverrides#list"},"post":{"consumes":["application\/json"],"operationId":"addSip2SystemPreferenceOverrides","parameters":[{"description":"A JSON object containing information about the new system preference override","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/sip2_system_preference_override"}}],"produces":["application\/json"],"responses":{"201":{"description":"A successfully created system preference override","schema":{"items":{"$ref":"#\/definitions\/sip2_system_preference_override"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add system preference overrides","tags":["sip2_system_preference_overrides"],"x-koha-authorization":{"permissions":{"sip2":1}},"x-mojo-to":"SIP2::SystemPreferenceOverrides#add"}},"\/sip2\/system_preference_overrides\/{sip_system_preference_override_id}":{"delete":{"operationId":"deleteSip2SystemPreferenceOverrides","parameters":[{"description":"SIP2 system preference override internal identifier","in":"path","name":"sip_system_preference_override_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"System preference override deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Resource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in deleting resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete system preference override","tags":["sip2_system_preference_overrides"],"x-koha-authorization":{"permissions":{"sip2":1}},"x-mojo-to":"SIP2::SystemPreferenceOverrides#delete"},"get":{"operationId":"getSipSystemPreferenceOverrides","parameters":[{"description":"SIP2 system preference override internal identifier","in":"path","name":"sip_system_preference_override_id","required":true,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["custom_item_fields","item_fields","custom_patron_fields","patron_attributes"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A SIP2 system preference override","schema":{"items":{"$ref":"#\/definitions\/sip2_system_preference_override"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get SIP2 system preference overrides","tags":["sip2_system_preference_overrides"],"x-koha-authorization":{"permissions":{"sip2":1}},"x-mojo-to":"SIP2::SystemPreferenceOverrides#get"},"put":{"consumes":["application\/json"],"operationId":"updateSip2SystemPreferenceOverrides","parameters":[{"description":"SIP2 system preference override internal identifier","in":"path","name":"sip_system_preference_override_id","required":true,"type":"integer"},{"description":"A JSON object containing new information about existing system preference override","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/sip2_system_preference_override"}}],"produces":["application\/json"],"responses":{"200":{"description":"A successfully updated system preference override","schema":{"items":{"$ref":"#\/definitions\/sip2_system_preference_override"}}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ressource not found","schema":{"$ref":"#\/definitions\/error"}},"409":{"description":"Conflict in updating resource","schema":{"$ref":"#\/definitions\/error"}},"413":{"description":"Payload too large","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n* `internal_server_error`","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update system preference override","tags":["sip2_system_preference_overrides"],"x-koha-authorization":{"permissions":{"sip2":1}},"x-mojo-to":"SIP2::SystemPreferenceOverrides#update"}},"\/suggestions":{"get":{"description":"This resource returns a list of purchase suggestions","operationId":"listSuggestions","parameters":[{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["+strings","suggester","suggester.category","manager","last_modifier","library","fund"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of suggestions","schema":{"items":{"$ref":"#\/definitions\/suggestion"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List purchase suggestions","tags":["suggestions"],"x-koha-authorization":{"permissions":{"suggestions":["suggestions_manage","suggestions_delete","suggestions_create"]}},"x-mojo-to":"Suggestions#list"},"post":{"description":"This resource accepts a new purchase suggestion and creates it","operationId":"addSuggestions","parameters":[{"description":"A JSON object containing informations about the new suggestion","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/suggestion"}},{"collectionFormat":"csv","description":"Overrides list sent as a request header","in":"header","items":{"enum":["any","max_total","max_pending"],"type":"string"},"name":"x-koha-override","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"201":{"description":"Suggestion added","schema":{"$ref":"#\/definitions\/suggestion"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n* `max_total_reached`\n* `max_pending_reached`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add a purchase suggestion","tags":["suggestions"],"x-koha-authorization":{"permissions":{"suggestions":"suggestions_create"}},"x-mojo-to":"Suggestions#add"}},"\/suggestions\/managers":{"get":{"description":"This resource returns a list of patron allowed to be a manager for suggestions","operationId":"listSuggestionsManagers","parameters":[{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["extended_attributes","library"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of suggestions' managers","schema":{"items":{"$ref":"#\/definitions\/patron"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List possibe managers for suggestions","tags":["suggestions"],"x-koha-authorization":{"permissions":{"suggestions":["suggestions_manage","suggestions_delete","suggestions_create"]}},"x-mojo-to":"Suggestions#list_managers"}},"\/suggestions\/{suggestion_id}":{"delete":{"description":"This resource deletes an existing purchase suggestion","operationId":"deleteSuggestion","parameters":[{"description":"Internal suggestion identifier","in":"path","name":"suggestion_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Suggestion deleted","schema":{"type":"string"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Suggestion not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete purchase suggestion","tags":["suggestions"],"x-koha-authorization":{"permissions":{"suggestions":"suggestions_delete"}},"x-mojo-to":"Suggestions#delete"},"get":{"description":"This resource gives access to a specific purchase suggestion","operationId":"getSuggestion","parameters":[{"description":"Internal suggestion identifier","in":"path","name":"suggestion_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A suggestion","schema":{"$ref":"#\/definitions\/suggestion"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Suggestion not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get purchase suggestion","tags":["suggestions"],"x-koha-authorization":{"permissions":{"suggestions":["suggestions_manage","suggestions_delete","suggestions_create"]}},"x-mojo-to":"Suggestions#get"},"put":{"description":"This resource allows updating an existing purchase suggestion","operationId":"updateSuggestion","parameters":[{"description":"Internal suggestion identifier","in":"path","name":"suggestion_id","required":true,"type":"integer"},{"description":"A JSON object containing informations about the new hold","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/suggestion"}}],"produces":["application\/json"],"responses":{"200":{"description":"A suggestion","schema":{"$ref":"#\/definitions\/suggestion"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Suggestion not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update purchase suggestion","tags":["suggestions"],"x-koha-authorization":{"permissions":{"suggestions":"suggestions_manage"}},"x-mojo-to":"Suggestions#update"}},"\/tickets":{"get":{"operationId":"listTickets","parameters":[{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["assignee","reporter","resolver","biblio","updates+count","+strings"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of tickets","schema":{"items":{"$ref":"#\/definitions\/ticket"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List tickets","tags":["tickets"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"Tickets#list"},"post":{"operationId":"addTicket","parameters":[{"description":"A JSON object containing informations about the new ticket","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/ticket"}}],"produces":["application\/json"],"responses":{"201":{"description":"Ticket added","schema":{"$ref":"#\/definitions\/ticket"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add ticket","tags":["tickets"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"Tickets#add"}},"\/tickets\/{ticket_id}":{"delete":{"operationId":"deleteTicket","parameters":[{"description":"Internal ticket identifier","in":"path","name":"ticket_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"204":{"description":"Ticket deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ticket not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete ticket","tags":["tickets"],"x-koha-authorization":{"permissions":{"editcatalogue":"edit_catalogue"}},"x-mojo-to":"Tickets#delete"},"get":{"operationId":"getTicket","parameters":[{"description":"Internal ticket identifier","in":"path","name":"ticket_id","required":true,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A ticket","schema":{"$ref":"#\/definitions\/ticket"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"404":{"description":"Ticket not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Get ticket","tags":["tickets"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"Tickets#get"},"put":{"operationId":"updateTicket","parameters":[{"description":"Internal ticket identifier","in":"path","name":"ticket_id","required":true,"type":"integer"},{"description":"A ticket object","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/ticket"}}],"produces":["application\/json"],"responses":{"200":{"description":"A ticket","schema":{"$ref":"#\/definitions\/ticket"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ticket not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Update ticket","tags":["tickets"],"x-koha-authorization":{"permissions":{"editcatalogue":"edit_catalogue"}},"x-mojo-to":"Tickets#update"}},"\/tickets\/{ticket_id}\/updates":{"get":{"operationId":"listTicketUpdates","parameters":[{"description":"Internal ticket identifier","in":"path","name":"ticket_id","required":true,"type":"integer"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"},{"collectionFormat":"csv","description":"Embed list sent as a request header","in":"header","items":{"enum":["assignee","user","+strings"],"type":"string"},"name":"x-koha-embed","required":false,"type":"array"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of ticket updates","schema":{"items":{"$ref":"#\/definitions\/ticket_update"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ticket not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List ticket updates","tags":["tickets"],"x-koha-authorization":{"permissions":{"catalogue":"1"}},"x-mojo-to":"Tickets#list_updates"},"post":{"operationId":"addTicketUpdate","parameters":[{"description":"Internal ticket identifier","in":"path","name":"ticket_id","required":true,"type":"integer"},{"description":"A ticket update object","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/ticket_update"}}],"produces":["application\/json"],"responses":{"201":{"description":"Ticket added","schema":{"$ref":"#\/definitions\/ticket_update"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Ticket not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal error","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add an update to the ticket","tags":["tickets"],"x-koha-authorization":{"permissions":{"editcatalogue":"edit_catalogue"}},"x-mojo-to":"Tickets#add_update"}},"\/transfer_limits":{"get":{"description":"This resource returns a list of existing transfer limits.","operationId":"listTransferLimits","parameters":[{"description":"Search on to_library_id","in":"query","name":"to_library_id","required":false,"type":"string"},{"description":"Search on from_library_id","in":"query","name":"from_library_id","required":false,"type":"string"},{"description":"Search on item_type","in":"query","name":"item_type","required":false,"type":"string"},{"description":"Search on collection_code","in":"query","name":"collection_code","required":false,"type":"string"},{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"},{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"},{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"},{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"},{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"},{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}},{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}],"produces":["application\/json"],"responses":{"200":{"description":"A list of transfer limits","schema":{"items":{"$ref":"#\/definitions\/transfer_limit"},"type":"array"}},"400":{"description":"Bad request. Possible `error_code` attribute values:\n\n  * `invalid_query`\n","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"List transfer limits","tags":["transfer_limits"],"x-koha-authorization":{"permissions":{"parameters":"manage_transfers"}},"x-mojo-to":"TransferLimits#list"},"post":{"description":"This resource accepts a new transfer limit and creates it if it does not already exist.","operationId":"addTransferLimit","parameters":[{"description":"A JSON object containing information about a new transfer limit","in":"body","name":"body","required":true,"schema":{"$ref":"#\/definitions\/transfer_limit"}}],"produces":["application\/json"],"responses":{"201":{"description":"Transfer limit added","schema":{"$ref":"#\/definitions\/transfer_limit"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Add a transfer limit","tags":["transfer_limits"],"x-koha-authorization":{"permissions":{"parameters":"manage_transfers"}},"x-mojo-to":"TransferLimits#add"}},"\/transfer_limits\/batch":{"delete":{"description":"This endpoint works just like [the POST version](#op-post-transfer_limits-batch), except it deletes transfer in batch rather than creating them.","operationId":"batchDeleteTransferLimits","parameters":[{"description":"A JSON object containing information about new transfer limits.","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"collection_code":{"description":"Authorized value for the collection code associated with this limit","type":["string","null"]},"from_library_id":{"description":"Internal library id for which library the item is coming from","type":"string"},"item_type":{"description":"Itemtype defining the type for this limi","type":["string","null"]},"to_library_id":{"description":"Internal library id for which library the item is going to","type":"string"}},"type":"object"}}],"produces":["application\/json"],"responses":{"204":{"description":"Transfer limits deleted"},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Library not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Batch delete transfer limits","tags":["transfer_limits"],"x-koha-authorization":{"permissions":{"parameters":"manage_transfers"}},"x-mojo-to":"TransferLimits#batch_delete"},"post":{"description":"\nThis resource batch creates new transfer limits based on the given data.\nTransfer limits can be defined based on `collection_code` or `item_type`. The endpoint only accepts one at a time, and which one is used will depend on the value of the `BranchTransferLimitsType` system preference.\nFor example, if the paramters `to_library_id: 'BranchA'` and `item_type: 'BOOK'` are passed in new transfer limits for `BOOK`s will be created, with one transfer limit each for all the branches defined in Koha. Given 4 branches, 3 limits would be created:\n* to_library_id: 'BranchA', from_library_id: 'BranchB', item_type: 'BOOK' * to_library_id: 'BranchA', from_library_id: 'BranchC', item_type: 'BOOK' * to_library_id: 'BranchA', from_library_id: 'BranchD', item_type: 'BOOK'\n\nThe body of the query would look like\n``` {\n    'to_library_id': 'BranchA',\n    'item_type': 'BOOK'\n\n} ```\nAs another example, imagine we have an itemtype that is never supposed to be transferred to another library. If we call that itemtype `LOCAL_ONLY` we would need to just pass `item_type: 'LOCAL_ONLY'`, which would create transfer limits for all libraries, meaning those items would never be allowed to transfer to another library. The body of the query would look like\n``` {\n    'item_type': 'LOCAL_ONLY'\n} ```\n","operationId":"batchAddTransferLimits","parameters":[{"description":"A JSON object containing information about new transfer limits.","in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"collection_code":{"description":"Authorized value for the collection code associated with this limit","type":["string","null"]},"from_library_id":{"description":"Internal library id for which library the item is coming from","type":"string"},"item_type":{"description":"Itemtype defining the type for this limi","type":["string","null"]},"to_library_id":{"description":"Internal library id for which library the item is going to","type":"string"}},"type":"object"}}],"produces":["application\/json"],"responses":{"201":{"description":"A list of transfer limits","schema":{"items":{"$ref":"#\/definitions\/transfer_limit"},"type":"array"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"409":{"description":"Conflict in creating resource","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Batch add transfer limits","tags":["transfer_limits"],"x-koha-authorization":{"permissions":{"parameters":"manage_transfers"}},"x-mojo-to":"TransferLimits#batch_add"}},"\/transfer_limits\/{limit_id}":{"delete":{"description":"This resource deletes a transfer limit for the given limit id","operationId":"deleteTransferLimit","parameters":[{"description":"Internal transfer limit identifier","in":"path","name":"limit_id","required":true,"type":"string"}],"produces":["application\/json"],"responses":{"204":{"description":"Transfer limit deleted","schema":{"type":"string"}},"400":{"description":"Bad request","schema":{"$ref":"#\/definitions\/error"}},"401":{"description":"Authentication required","schema":{"$ref":"#\/definitions\/error"}},"403":{"description":"Access forbidden","schema":{"$ref":"#\/definitions\/error"}},"404":{"description":"Library not found","schema":{"$ref":"#\/definitions\/error"}},"500":{"description":"Internal server error. Possible `error_code` attribute values:\n\n* `internal_server_error`\n","schema":{"$ref":"#\/definitions\/error"}},"501":{"description":"Default response.","schema":{"$ref":"#\/definitions\/DefaultResponse"}},"503":{"description":"Under maintenance","schema":{"$ref":"#\/definitions\/error"}}},"summary":"Delete transfer limit","tags":["transfer_limits"],"x-koha-authorization":{"permissions":{"parameters":"manage_transfers"}},"x-mojo-to":"TransferLimits#delete"}}},"schemes":["http"],"swagger":"2.0","tags":[{"description":"Manage additional contents\n","name":"additional_contents","x-displayName":"Additional contents"},{"description":"Manage additional fields\n","name":"additional_fields","x-displayName":"Additional fields"},{"description":"Manage article requests\n","name":"article_requests","x-displayName":"Article requests"},{"description":"Manage authorised value categories\n","name":"authorised_value_categories","x-displayName":"Authorised value categories"},{"description":"Manage authorised values\n","name":"authorised_values","x-displayName":"Authorised values"},{"description":"Manage batch import profiles\n","name":"batch_import_profiles","x-displayName":"Batch import profiles"},{"description":"Manage baskets for the acquisitions module\n","name":"baskets","x-displayName":"Baskets"},{"description":"Manage Authority records\n","name":"authorities","x-displayName":"Authorities"},{"description":"Manage bibliographic records\n","name":"biblios","x-displayName":"Biblios"},{"description":"Manage bookings\n","name":"bookings","x-displayName":"Bookings"},{"description":"Manage cash registers\n","name":"cash_registers","x-displayName":"Cash registers"},{"description":"Manage cash register cashups\n","name":"cashups","x-displayName":"Cashups"},{"description":"Manage checkouts\n","name":"checkouts","x-displayName":"Checkouts"},{"description":"Manage circulation desks\n","name":"desks","x-displayName":"Circulation desks"},{"description":"Manage circulation rules\n","name":"circulation_rules","x-displayName":"Circulation rules"},{"description":"Manage cities\n","name":"cities","x-displayName":"Cities"},{"description":"Manage patron clubs\n","name":"clubs","x-displayName":"Clubs"},{"description":"Manage EDI files\n","name":"edi_files","x-displayName":"EDI files"},{"description":"Manage ERM agreements\n","name":"erm_agreements","x-displayName":"ERM agreements"},{"description":"Manage ERM configuration\n","name":"erm_config","x-displayName":"ERM configuration"},{"description":"Manage ERM counter files\n","name":"erm_counter_files","x-displayName":"ERM counter files"},{"description":"Manage ERM counter logs\n","name":"erm_counter_logs","x-displayName":"ERM counter logs"},{"description":"Retrieve counter registry data\n","name":"erm_counter_registry","x-displayName":"ERM counter registry"},{"description":"Manage ERM saved reports\n","name":"erm_default_usage_reports","x-displayName":"ERM saved reports"},{"description":"Manage ERM docuemnts\n","name":"erm_documents","x-displayName":"ERM documents"},{"description":"Manage ERM eHoldings packages\n","name":"erm_eholdings_packages","x-displayName":"ERM eHoldings packages"},{"description":"Manage ERM eHoldings resources\n","name":"erm_eholdings_resources","x-displayName":"ERM eHoldings resources"},{"description":"Manage ERM eHoldings titles\n","name":"erm_eholdings_titles","x-displayName":"ERM eHoldings titles"},{"description":"Manage ERM licences\n","name":"erm_licences","x-displayName":"ERM licences"},{"description":"Retrieve SUSHI service data\n","name":"erm_sushi_service","x-displayName":"ERM SUSHI services"},{"description":"Manage ERM usage data providers\n","name":"erm_usage_data_providers","x-displayName":"ERM usage data providers"},{"description":"Manage ERM usage databases\n","name":"erm_usage_databases","x-displayName":"ERM usage databases"},{"description":"Manage ERM usage items\n","name":"erm_usage_items","x-displayName":"ERM usage items"},{"description":"Manage ERM usage platforms\n","name":"erm_usage_platforms","x-displayName":"ERM usage platforms"},{"description":"Manage ERM usage titles\n","name":"erm_usage_titles","x-displayName":"ERM usage titles"},{"description":"Manage ERM usage reports\n","name":"erm_usage_reports","x-displayName":"ERM usage reports"},{"description":"Manage ERM users\n","name":"erm_users","x-displayName":"ERM users"},{"description":"Manage funds for the acquisitions module\n","name":"funds","x-displayName":"Funds"},{"description":"Manage holds\n","name":"holds","x-displayName":"Holds"},{"description":"Manage hold groups\n","name":"hold_groups","x-displayName":"Hold groups"},{"description":"Manage identity providers\n","name":"identity_providers","x-displayName":"Identity providers"},{"description":"Manage ILL module backends\n","name":"ill_backends","x-displayName":"ILL backends"},{"description":"Manage ILL module batches\n","name":"ill_batches","x-displayName":"ILL batches"},{"description":"Manage ILL module batch statuses\n","name":"ill_batchstatuses","x-displayName":"ILL batch statuses"},{"description":"Manage ILL requests\n","name":"ill_requests","x-displayName":"ILL requests"},{"description":"Manage import batches\n","name":"import_batches","x-displayName":"Import batches"},{"description":"Manage item groups\n","name":"item_groups","x-displayName":"Item groups"},{"description":"Manage record sources\n","name":"record_sources","x-displayName":"Record source"},{"description":"Manage items\n","name":"items","x-displayName":"Items"},{"description":"Manage item types\n","name":"item_types","x-displayName":"Item Types"},{"description":"Manage jobs\n","name":"jobs","x-displayName":"Jobs"},{"description":"Manage libraries\n","name":"libraries","x-displayName":"Libraries"},{"description":"Manage lists","name":"lists","x-displayName":"Lists"},{"description":"Manage macros\n","name":"macros","x-displayName":"Macros"},{"description":"Manage acquisition orders\n","name":"orders","x-displayName":"Orders"},{"description":"Handle OAuth flows\n","name":"oauth","x-displayName":"OAuth"},{"description":"Manage patron categories\n","name":"patron_categories","x-displayName":"Patron categories"},{"description":"Manage patrons\n","name":"patrons","x-displayName":"Patrons"},{"description":"Manage preservation tasks\n","name":"preservation","x-displayName":"Preservation"},{"description":"Manage purchase suggestions\n","name":"suggestions","x-displayName":"Purchase suggestions"},{"description":"Manage quotes\n","name":"quotes","x-displayName":"Quotes"},{"description":"Manage recalls\n","name":"recalls","x-displayName":"Recalls"},{"description":"Manage return claims\n","name":"return_claims","x-displayName":"Return claims"},{"description":"Manage stock rotation\n","name":"stockrotation","x-displayName":"Rotas"},{"description":"Manage search filters","name":"search_filters","x-displayName":"Search filters"},{"description":"Manage SIP2 accounts","name":"sip2_accounts","x-displayName":"SIP2 Accounts"},{"description":"Manage SIP2 institutions","name":"sip2_institutions","x-displayName":"SIP2 Institutions"},{"description":"Manage SIP2 system preference overrides","name":"sip2_system_preference_overrides","x-displayName":"SIP2 System preference overrides"},{"description":"Manage SMTP servers configurations\n","name":"smtp_servers","x-displayName":"SMTP servers"},{"description":"Manage file transport configurations\n","name":"file_transports","x-displayName":"File transports"},{"description":"Manage tickets\n","name":"tickets","x-displayName":"Tickets"},{"description":"Manage transfer limits\n","name":"transfer_limits","x-displayName":"Transfer limits"},{"description":"Handle two factor authentication flows\n","name":"2fa","x-displayName":"Two factor authentication"},{"description":"Manage vendors for the acquisitions module\n","name":"vendors","x-displayName":"Vendors"},{"description":"Manage vendors configuration\n","name":"vendors_config","x-displayName":"Vendors configuration"}]}