|
|
1 |
{"basePath":"\/api\/v1","swagger":"2.0","id":"swagger\/swagger.json","x-mojo-around-action":"Koha::REST::V1::koha_authenticate","info":{"contact":{"name":"Koha Team","url":"http:\/\/koha-community.org\/"},"title":"Koha REST API","license":{"name":"GPL v3","url":"http:\/\/www.gnu.org\/licenses\/gpl.txt"},"version":"1"},"parameters":{"holdingbranchQueryParam":{"type":"string","in":"query","name":"holdingbranch","description":"The code of the branch where the Items have been last seen.","required":false},"borrowernumberPathParam":{"description":"Internal borrower identifier","required":true,"type":"integer","in":"path","name":"borrowernumber"},"borrowernumberQueryParam":{"name":"borrowernumber","in":"query","type":"integer","required":false,"description":"The internal id of the Borrower, unique value"},"pattern_yQueryParam":{"type":"string","in":"query","name":"pattern_y","description":"the second enumeration, eg volume.","required":false},"biblionumberPathParam":{"description":"Internal biblio identifier","required":true,"type":"integer","in":"path","name":"biblionumber"},"sheet_identifierPathParam":{"required":true,"description":"Internal sheet identifier","name":"sheet_identifier","type":"integer","in":"path"},"listContent":{"in":"body","name":"listContent","schema":{"type":"object","properties":{"listContentNumber":{"type":"integer","description":"The internal identifier for this list article"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"itemnumber":{"type":"integer","description":"Item internal identifier"},"biblionumber":{"description":"Biblio internal identifier","type":"integer"}}},"description":"The list article","required":true},"messagenumberPathParam":{"name":"messagenumber","in":"path","type":"integer","required":true,"description":"Internal message identifier"},"useridQueryParam":{"name":"userid","type":"string","in":"query","required":false,"description":"The userid of the Borrower, unique value"},"pattern_zQueryParam":{"type":"string","in":"query","name":"pattern_z","description":"the third enumeration field.","required":false},"session":{"description":"The CGISESSID Cookie used to authenticate a session","schema":{"required":["sessionid"],"properties":{"sessionid":{"type":"string","description":"The Koha sessionid to be tested"}},"type":"object"},"required":true,"in":"body","name":"session"},"serialStatusQueryParam":{"description":"Status of a serial. 1 = Expected, 2 = Received, 3 = Late, 4 = Not issued, 7 = Claimed.","required":false,"in":"query","type":"integer","name":"serialStatus"},"sheet_versionPathParam":{"name":"sheet_version","in":"path","type":"number","format":"float","required":true,"description":"Sheet version number. If omitted, operations target the newest version. Set to '631373.00' to affect all versions."},"listnamePathParam":{"type":"string","in":"path","name":"listname","description":"list name","required":true},"pattern_xQueryParam":{"name":"pattern_x","type":"string","in":"query","required":false,"description":"The first serial issue enumeration field, typically the year."},"cardnumberQueryParam":{"description":"The cardnumber of the Borrower, unique value","required":false,"type":"string","in":"query","name":"cardnumber"},"biblionumberQueryParam":{"name":"biblionumber","in":"query","type":"integer","required":true,"description":"Internal biblio identifier"},"limitQueryParam":{"required":false,"description":"Limit the resultset to this many results.","name":"limit","type":"integer","in":"query"}},"definitions":{"listContent":{"properties":{"listContentNumber":{"type":"integer","description":"The internal identifier for this list article"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"itemnumber":{"type":"integer","description":"Item internal identifier"},"biblionumber":{"description":"Biblio internal identifier","type":"integer"}},"type":"object"},"borrower":{"properties":{"cardnumber":{"type":"string","description":"library assigned ID number for borrowers"},"firstname":{"type":"string","description":"borrower's first name"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"surname":{"type":"string","description":"borrower's last name"}},"type":"object"},"biblionumber":{"description":"Biblio internal identifier","type":"integer"},"message":{"type":"object","properties":{"letter_code":{"type":"string","description":""},"to_address":{"type":"string","description":"Destination email address"},"message_transport_type":{"type":"string","description":"Transport method. Values accepted by default are 'email', 'sms', 'phone' and 'print'"},"from_address":{"description":"Source address of email","type":"string"},"metadata":{"description":"","type":"string"},"time_queued":{"description":"Date and time of when message was placed in queue","type":"string"},"content":{"type":"string","description":"Content of the message"},"content_type":{"description":"Content type","type":"string"},"subject":{"description":"Subject of the message","type":"string"},"status":{"description":"Delivery status","type":"string"},"message_id":{"type":"integer","description":"Message internal identifier"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"delivery_note":{"description":"Additional delivery notes","type":"string"}}},"session":{"type":"object","properties":{"lastname":{"type":"string","description":"borrower's last name"},"email":{"description":"borrower's primary email address","type":"string"},"firstname":{"description":"borrower's first name","type":"string"}}},"cardnumber":{"type":"string","description":"Library assigned ID number for Borrowers"},"holds":{"items":{"type":"object","properties":{"notificationdate":{"description":"currently unused","type":"string"},"found":{"description":"a one letter code defining what the status of the reserve is after it has been confirmed","type":"string"},"itemnumber":{"type":"integer","description":"Item internal identifier"},"timestamp":{"description":"date and time the reserve was last updated","type":"string"},"lowestPriority":{"description":"","type":"string"},"priority":{"description":"where in the queue the patron sits","type":"string"},"reservedate":{"type":"string","description":"the date the reserve was placed"},"waitingdate":{"description":"the date the item was marked as waiting for the patron at the library","type":"string"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"cancellationdate":{"type":"string","description":"the date the reserve was cancelled"},"branchcode":{"type":"string","description":"Code identifying a library"},"constrainttype":{"description":"type of constraint","type":"string"},"reserve_id":{"type":"number","description":"Internal reserve identifier"},"reminderdate":{"type":"string","description":"currently unused"},"expirationdate":{"type":"string","description":"the date the reserve expires"},"suspend_until":{"description":"","type":"string"},"biblionumber":{"description":"Biblio internal identifier","type":"integer"},"reservenotes":{"description":"notes related to this reserve","type":"string"},"suspend":{"description":"","type":"string"}}},"type":"array"},"branchcode":{"type":"string","description":"Code identifying a library"},"error":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}},"testedSession":{"required":["sessionid"],"properties":{"sessionid":{"type":"string","description":"The Koha sessionid to be tested"}},"type":"object"},"listContentNumber":{"description":"The internal identifier for this list article","type":"integer"},"hold":{"properties":{"notificationdate":{"description":"currently unused","type":"string"},"found":{"description":"a one letter code defining what the status of the reserve is after it has been confirmed","type":"string"},"itemnumber":{"type":"integer","description":"Item internal identifier"},"timestamp":{"description":"date and time the reserve was last updated","type":"string"},"lowestPriority":{"description":"","type":"string"},"priority":{"description":"where in the queue the patron sits","type":"string"},"reservedate":{"type":"string","description":"the date the reserve was placed"},"waitingdate":{"description":"the date the item was marked as waiting for the patron at the library","type":"string"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"cancellationdate":{"type":"string","description":"the date the reserve was cancelled"},"branchcode":{"type":"string","description":"Code identifying a library"},"constrainttype":{"description":"type of constraint","type":"string"},"reserve_id":{"type":"number","description":"Internal reserve identifier"},"reminderdate":{"type":"string","description":"currently unused"},"expirationdate":{"type":"string","description":"the date the reserve expires"},"suspend_until":{"description":"","type":"string"},"biblionumber":{"description":"Biblio internal identifier","type":"integer"},"reservenotes":{"description":"notes related to this reserve","type":"string"},"suspend":{"description":"","type":"string"}},"type":"object"},"borrowerStatus":{"type":"object","properties":{"too_many_renewals":{"description":"","type":"boolean"},"too_many_items_lost":{"description":"","type":"boolean"},"fines":{"format":"double","description":"Total due fines","type":"number"},"recall_overdue":{"type":"boolean","description":""},"borrowernumber":{"description":"Borrower internal identifier","type":"integer"},"homebranch":{"description":"Home library\/branch.","type":"string"},"too_many_items_billed":{"description":"","type":"boolean"},"excessive_outstanding_fees":{"type":"boolean","description":""},"language":{"type":"string","description":"Desired language of service"},"too_many_items_charged":{"type":"boolean","description":""},"firstname":{"description":"First name","type":"string"},"hold_privileges_denied":{"type":"boolean","description":""},"card_reported_lost":{"type":"boolean","description":""},"surname":{"type":"string","description":"Last name"},"recall_privileges_denied":{"description":"","type":"boolean"},"cardnumber":{"type":"string","description":"Library assigned ID number for Borrowers"},"too_many_items_overdue":{"type":"boolean","description":""},"excessive_outstanding_fines":{"type":"boolean","description":""},"too_many_claims_of_items_returned":{"description":"","type":"boolean"},"charge_privileges_denied":{"description":"","type":"boolean"},"renewal_privileges_denied":{"description":"","type":"boolean"}}},"newBorrowerHoldBody":{"properties":{"expirationdate":{"type":"string","format":"date","description":"Reserve end date"},"itemnumber":{"description":"Item internal identifier","type":"integer"},"branchcode":{"description":"Pickup location","type":"string"},"biblionumber":{"type":"integer","description":"Biblio internal identifier"},"suspend_until":{"type":"string","description":"Suspend the Hold until this date, so the Hold won't get caught but advances in queue.","format":"date"}},"type":"object"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"itemnumber":{"type":"integer","description":"Item internal identifier"}},"securityDefinitions":{"multi_key_auth":{"name":"Authorization","type":"apiKey","in":"header","description":"Example: 'Authorization: Koha 1:0f049b5ba2f04da7e719b7166dd9e1b0efacf23747798f19efe51eb6e437f84c'\n\nConstructing the Authorization header\n\n-You brand the authorization header with 'Koha'\n-Then you give the userid\/cardnumber of the user authenticating.\n-Then the hashed signature.\n\nThe signature is a HMAC-SHA256-HEX hash of several elements of the request,\nseparated by spaces:\n - HTTP method (uppercase)\n - userid\/cardnumber\n - X-Koha-Date-header\nSigned with the Borrowers API key\n\n\nPseudocode example:\n\nSignature = HMAC-SHA256-HEX('HTTPS' + ' ' +\n '\/api\/v1\/borrowers\/12?howdoyoudo=voodoo' + ' ' +\n 'admin69' + ' ' +\n '760818212' + ' ' +\n 'frJIUN8DYpKDtOLCwo\/\/yllqDzg='\n );\n"}},"paths":{"\/borrowers\/{borrowernumber}\/holds":{"get":{"operationId":"listBorrowerHolds","produces":["application\/json"],"x-mojo-controller":"Koha::REST::V1::Borrowers::Holds","responses":{"404":{"description":"Borrower not found","schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}},"200":{"schema":{"items":{"type":"object","properties":{"notificationdate":{"description":"currently unused","type":"string"},"found":{"description":"a one letter code defining what the status of the reserve is after it has been confirmed","type":"string"},"itemnumber":{"type":"integer","description":"Item internal identifier"},"timestamp":{"description":"date and time the reserve was last updated","type":"string"},"lowestPriority":{"description":"","type":"string"},"priority":{"description":"where in the queue the patron sits","type":"string"},"reservedate":{"type":"string","description":"the date the reserve was placed"},"waitingdate":{"description":"the date the item was marked as waiting for the patron at the library","type":"string"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"cancellationdate":{"type":"string","description":"the date the reserve was cancelled"},"branchcode":{"type":"string","description":"Code identifying a library"},"constrainttype":{"description":"type of constraint","type":"string"},"reserve_id":{"type":"number","description":"Internal reserve identifier"},"reminderdate":{"type":"string","description":"currently unused"},"expirationdate":{"type":"string","description":"the date the reserve expires"},"suspend_until":{"description":"","type":"string"},"biblionumber":{"description":"Biblio internal identifier","type":"integer"},"reservenotes":{"description":"notes related to this reserve","type":"string"},"suspend":{"description":"","type":"string"}}},"type":"array"},"description":"A list of holds"}},"parameters":[{"in":"path","type":"integer","name":"borrowernumber","description":"Internal borrower identifier","required":true}],"tags":["borrowers","holds"],"x-koha-permission":{"borrowers":"*"}},"post":{"responses":{"404":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}},"description":"Borrower not found"},"201":{"schema":{"properties":{"notificationdate":{"description":"currently unused","type":"string"},"found":{"description":"a one letter code defining what the status of the reserve is after it has been confirmed","type":"string"},"itemnumber":{"type":"integer","description":"Item internal identifier"},"timestamp":{"description":"date and time the reserve was last updated","type":"string"},"lowestPriority":{"description":"","type":"string"},"priority":{"description":"where in the queue the patron sits","type":"string"},"reservedate":{"type":"string","description":"the date the reserve was placed"},"waitingdate":{"description":"the date the item was marked as waiting for the patron at the library","type":"string"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"cancellationdate":{"type":"string","description":"the date the reserve was cancelled"},"branchcode":{"type":"string","description":"Code identifying a library"},"constrainttype":{"description":"type of constraint","type":"string"},"reserve_id":{"type":"number","description":"Internal reserve identifier"},"reminderdate":{"type":"string","description":"currently unused"},"expirationdate":{"type":"string","description":"the date the reserve expires"},"suspend_until":{"description":"","type":"string"},"biblionumber":{"description":"Biblio internal identifier","type":"integer"},"reservenotes":{"description":"notes related to this reserve","type":"string"},"suspend":{"description":"","type":"string"}},"type":"object"},"description":"Created hold"},"500":{"description":"Internal error","schema":{"properties":{"error":{"type":"string","description":"Error message"}},"type":"object"}},"403":{"schema":{"properties":{"error":{"type":"string","description":"Error message"}},"type":"object"},"description":"Hold not allowed"},"400":{"description":"Missing or wrong parameters","schema":{"properties":{"error":{"type":"string","description":"Error message"}},"type":"object"}}},"parameters":[{"required":true,"description":"Internal borrower identifier","name":"borrowernumber","in":"path","type":"integer"},{"in":"body","name":"body","schema":{"properties":{"expirationdate":{"type":"string","format":"date","description":"Reserve end date"},"itemnumber":{"description":"Item internal identifier","type":"integer"},"branchcode":{"description":"Pickup location","type":"string"},"biblionumber":{"type":"integer","description":"Biblio internal identifier"},"suspend_until":{"type":"string","description":"Suspend the Hold until this date, so the Hold won't get caught but advances in queue.","format":"date"}},"type":"object"},"description":"A Hold-object","required":true}],"x-koha-permission":{"circulate":"*"},"operationId":"addBorrowerHold","consumes":["application\/json"],"x-mojo-controller":"Koha::REST::V1::Borrowers::Holds","produces":["application\/json"],"tags":["borrowers","holds"]}},"\/labels\/sheets\/version":{"get":{"operationId":"listSheetVersions","x-mojo-controller":"Koha::REST::V1::Labels::Sheets","responses":{"500":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}},"description":"Internal server error"},"404":{"description":"No sheets in Koha","schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}},"200":{"description":"A list of sheet ids and versions","schema":{"type":"array","items":{"required":["id","version"],"properties":{"version":{"format":"float","type":"number"},"id":{"type":"integer"}},"type":"object"}}}},"produces":["application\/json"],"tags":["labels"],"x-koha-permission":{"labels":"sheets_get"},"summary":"Get a list of label positioning sheet ids and versions."}},"\/auth\/session":{"get":{"x-koha-permission":{"auth":"get_session"},"tags":["auth"],"parameters":[{"in":"body","name":"session","description":"The CGISESSID Cookie used to authenticate a session","schema":{"required":["sessionid"],"properties":{"sessionid":{"type":"string","description":"The Koha sessionid to be tested"}},"type":"object"},"required":true}],"operationId":"getSession","x-mojo-controller":"Koha::REST::V1::Auth","produces":["application\/json"],"responses":{"200":{"description":"A borrower with SSO-relevant fields","schema":{"properties":{"lastname":{"type":"string","description":"borrower's last name"},"email":{"description":"borrower's primary email address","type":"string"},"firstname":{"description":"borrower's first name","type":"string"}},"type":"object"}},"404":{"description":"Session not found","schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}}},"\/biblios\/{biblionumber}":{"delete":{"x-koha-permission":{"editcatalogue":"delete_catalogue"},"summary":"Deletes the given Bibliographic Record","description":"Can fail if there are dependecies to the Biblio.","parameters":[{"required":true,"description":"Internal biblio identifier","name":"biblionumber","in":"path","type":"integer"}],"security":[{"multi_key_auth":[]}],"responses":{"204":{"schema":{"type":"string"},"description":"Deleting the Record succeeded."},"400":{"description":"Cannot delete the Bibliographic Record due to constraints. A constraint can be for example the presence of dependant Items.","schema":{"properties":{"error":{"type":"string","description":"Error message"}},"type":"object"}},"404":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}},"description":"No such Bibliographic record found"}},"tags":["biblios"],"operationId":"deleteBiblio","x-mojo-controller":"Koha::REST::V1::Biblios","produces":[""]}},"\/messages\/{messagenumber}\/resend":{"post":{"operationId":"createResend","produces":["application\/json"],"x-mojo-controller":"Koha::REST::V1::Messages","tags":["messages"],"responses":{"204":{"description":"Resending the message succeeded.","schema":{"type":"string"}},"404":{"description":"Message not found","schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}},"parameters":[{"required":true,"description":"Internal message identifier","name":"messagenumber","in":"path","type":"integer"}],"description":"Resends a message.","x-koha-permission":{"messages":"resend_message"}}},"\/messages":{"get":{"operationId":"listMessages","x-mojo-controller":"Koha::REST::V1::Messages","responses":{"200":{"schema":{"type":"array","items":{"properties":{"letter_code":{"type":"string","description":""},"to_address":{"type":"string","description":"Destination email address"},"message_transport_type":{"type":"string","description":"Transport method. Values accepted by default are 'email', 'sms', 'phone' and 'print'"},"from_address":{"description":"Source address of email","type":"string"},"metadata":{"description":"","type":"string"},"time_queued":{"description":"Date and time of when message was placed in queue","type":"string"},"content":{"type":"string","description":"Content of the message"},"content_type":{"description":"Content type","type":"string"},"subject":{"description":"Subject of the message","type":"string"},"status":{"description":"Delivery status","type":"string"},"message_id":{"type":"integer","description":"Message internal identifier"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"delivery_note":{"description":"Additional delivery notes","type":"string"}},"type":"object"}},"description":"A list of messages"},"404":{"schema":{"properties":{"error":{"type":"string","description":"Error message"}},"type":"object"},"description":"Messages not found"}},"produces":["application\/json"],"tags":["messages"],"x-koha-permission":{"messages":"get_message"}},"post":{"x-koha-permission":{"messages":"create_message"},"parameters":[{"in":"body","name":"body","schema":{"properties":{"letter_code":{"type":"string","description":""},"to_address":{"type":"string","description":"Destination email address"},"message_transport_type":{"type":"string","description":"Transport method. Values accepted by default are 'email', 'sms', 'phone' and 'print'"},"from_address":{"description":"Source address of email","type":"string"},"metadata":{"description":"","type":"string"},"time_queued":{"description":"Date and time of when message was placed in queue","type":"string"},"content":{"type":"string","description":"Content of the message"},"content_type":{"description":"Content type","type":"string"},"subject":{"description":"Subject of the message","type":"string"},"status":{"description":"Delivery status","type":"string"},"message_id":{"type":"integer","description":"Message internal identifier"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"delivery_note":{"description":"Additional delivery notes","type":"string"}},"type":"object"},"description":"A JSON object containing informations about the new message","required":true}],"tags":["messages"],"produces":["application\/json"],"x-mojo-controller":"Koha::REST::V1::Messages","responses":{"201":{"schema":{"properties":{"letter_code":{"type":"string","description":""},"to_address":{"type":"string","description":"Destination email address"},"message_transport_type":{"type":"string","description":"Transport method. Values accepted by default are 'email', 'sms', 'phone' and 'print'"},"from_address":{"description":"Source address of email","type":"string"},"metadata":{"description":"","type":"string"},"time_queued":{"description":"Date and time of when message was placed in queue","type":"string"},"content":{"type":"string","description":"Content of the message"},"content_type":{"description":"Content type","type":"string"},"subject":{"description":"Subject of the message","type":"string"},"status":{"description":"Delivery status","type":"string"},"message_id":{"type":"integer","description":"Message internal identifier"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"delivery_note":{"description":"Additional delivery notes","type":"string"}},"type":"object"},"description":"A message"},"400":{"description":"Missing or wrong parameters","schema":{"properties":{"error":{"type":"string","description":"Error message"}},"type":"object"}}},"operationId":"createMessage"}},"\/borrowers":{"get":{"x-koha-permission":{"borrowers":"*"},"summary":"Searches for Borrowers","description":"Search borrowers from Koha, optionally filter the search with specific parameters. All parameters given, must be present in the returned Borrower-objects. If no search parameters are given, all borrowers are returned! This is certainly not what you want.","parameters":[{"in":"query","type":"string","name":"cardnumber","description":"The cardnumber of the Borrower, unique value","required":false},{"in":"query","type":"string","name":"userid","description":"The userid of the Borrower, unique value","required":false},{"description":"The internal id of the Borrower, unique value","required":false,"in":"query","type":"integer","name":"borrowernumber"}],"security":[{"multi_key_auth":[]}],"responses":{"200":{"schema":{"items":{"properties":{"cardnumber":{"type":"string","description":"library assigned ID number for borrowers"},"firstname":{"type":"string","description":"borrower's first name"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"surname":{"type":"string","description":"borrower's last name"}},"type":"object"},"type":"array"},"description":"A list of borrowers"}},"tags":["borrowers"],"produces":["application\/json"],"x-mojo-controller":"Koha::REST::V1::Borrowers","operationId":"listBorrowers"}},"\/lists\/{listname}\/contents":{"delete":{"parameters":[{"required":true,"description":"list name","name":"listname","type":"string","in":"path"},{"name":"listContent","in":"body","required":true,"schema":{"type":"object","properties":{"listContentNumber":{"type":"integer","description":"The internal identifier for this list article"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"itemnumber":{"type":"integer","description":"Item internal identifier"},"biblionumber":{"description":"Biblio internal identifier","type":"integer"}}},"description":"The list article"}],"tags":["lists"],"operationId":"deleteContents","responses":{"404":{"schema":{"properties":{"error":{"type":"string","description":"Error message"}},"type":"object"},"description":"The given list doesn't exist"},"200":{"schema":{"properties":{"listContentNumber":{"type":"integer","description":"The internal identifier for this list article"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"itemnumber":{"type":"integer","description":"Item internal identifier"},"biblionumber":{"description":"Biblio internal identifier","type":"integer"}},"type":"object"},"description":"All list articles are deleted"}},"x-mojo-controller":"Koha::REST::V1::Lists::Contents","produces":["application\/json"],"x-koha-permission":{"catalogue":"*"}},"post":{"produces":["application\/json"],"x-mojo-controller":"Koha::REST::V1::Lists::Contents","responses":{"404":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}},"description":"The given list doesn't exist"},"200":{"schema":{"type":"object","properties":{"listContentNumber":{"type":"integer","description":"The internal identifier for this list article"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"itemnumber":{"type":"integer","description":"Item internal identifier"},"biblionumber":{"description":"Biblio internal identifier","type":"integer"}}},"description":"The list article"}},"operationId":"addToList","tags":["lists"],"parameters":[{"name":"listname","type":"string","in":"path","required":true,"description":"list name"},{"required":true,"description":"The list article","schema":{"type":"object","properties":{"listContentNumber":{"type":"integer","description":"The internal identifier for this list article"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"itemnumber":{"type":"integer","description":"Item internal identifier"},"biblionumber":{"description":"Biblio internal identifier","type":"integer"}}},"name":"listContent","in":"body"}],"x-koha-permission":{"catalogue":"*"}}},"\/borrowers\/{borrowernumber}":{"get":{"x-koha-permission":{"borrowers":"*"},"parameters":[{"required":true,"description":"Internal borrower identifier","name":"borrowernumber","in":"path","type":"integer"}],"security":[{"multi_key_auth":[]}],"responses":{"404":{"schema":{"properties":{"error":{"type":"string","description":"Error message"}},"type":"object"},"description":"Borrower not found"},"200":{"schema":{"type":"object","properties":{"cardnumber":{"type":"string","description":"library assigned ID number for borrowers"},"firstname":{"type":"string","description":"borrower's first name"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"surname":{"type":"string","description":"borrower's last name"}}},"description":"A borrower"}},"tags":["borrowers"],"x-mojo-controller":"Koha::REST::V1::Borrowers","produces":["application\/json"],"operationId":"getBorrower"}},"\/messages\/{messagenumber}":{"delete":{"produces":["application\/json"],"x-mojo-controller":"Koha::REST::V1::Messages","responses":{"204":{"schema":{"type":"string"},"description":"Deleting the message succeeded."},"404":{"schema":{"properties":{"error":{"type":"string","description":"Error message"}},"type":"object"},"description":"Message not found."}},"operationId":"deleteMessage","parameters":[{"required":true,"description":"Internal message identifier","name":"messagenumber","type":"integer","in":"path"}],"tags":["messages"],"x-koha-permission":{"messages":"delete_message"}},"put":{"x-koha-permission":{"messages":"update_message"},"parameters":[{"name":"body","in":"body","required":false,"description":"A JSON object containing informations about the new message","schema":{"properties":{"letter_code":{"type":"string","description":""},"to_address":{"type":"string","description":"Destination email address"},"message_transport_type":{"type":"string","description":"Transport method. Values accepted by default are 'email', 'sms', 'phone' and 'print'"},"from_address":{"description":"Source address of email","type":"string"},"metadata":{"description":"","type":"string"},"time_queued":{"description":"Date and time of when message was placed in queue","type":"string"},"content":{"type":"string","description":"Content of the message"},"content_type":{"description":"Content type","type":"string"},"subject":{"description":"Subject of the message","type":"string"},"status":{"description":"Delivery status","type":"string"},"message_id":{"type":"integer","description":"Message internal identifier"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"delivery_note":{"description":"Additional delivery notes","type":"string"}},"type":"object"}},{"name":"messagenumber","type":"integer","in":"path","required":true,"description":"Internal message identifier"}],"tags":["messages"],"x-mojo-controller":"Koha::REST::V1::Messages","responses":{"200":{"schema":{"type":"object","properties":{"letter_code":{"type":"string","description":""},"to_address":{"type":"string","description":"Destination email address"},"message_transport_type":{"type":"string","description":"Transport method. Values accepted by default are 'email', 'sms', 'phone' and 'print'"},"from_address":{"description":"Source address of email","type":"string"},"metadata":{"description":"","type":"string"},"time_queued":{"description":"Date and time of when message was placed in queue","type":"string"},"content":{"type":"string","description":"Content of the message"},"content_type":{"description":"Content type","type":"string"},"subject":{"description":"Subject of the message","type":"string"},"status":{"description":"Delivery status","type":"string"},"message_id":{"type":"integer","description":"Message internal identifier"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"delivery_note":{"description":"Additional delivery notes","type":"string"}}},"description":"A message"},"400":{"description":"Missing or wrong parameters","schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}},"404":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}},"description":"Message not found"}},"produces":["application\/json"],"operationId":"updateMessage"},"get":{"x-koha-permission":{"messages":"get_message"},"parameters":[{"description":"Internal message identifier","required":true,"type":"integer","in":"path","name":"messagenumber"}],"tags":["messages"],"x-mojo-controller":"Koha::REST::V1::Messages","responses":{"404":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}},"description":"Message not found"},"200":{"description":"A message","schema":{"type":"object","properties":{"letter_code":{"type":"string","description":""},"to_address":{"type":"string","description":"Destination email address"},"message_transport_type":{"type":"string","description":"Transport method. Values accepted by default are 'email', 'sms', 'phone' and 'print'"},"from_address":{"description":"Source address of email","type":"string"},"metadata":{"description":"","type":"string"},"time_queued":{"description":"Date and time of when message was placed in queue","type":"string"},"content":{"type":"string","description":"Content of the message"},"content_type":{"description":"Content type","type":"string"},"subject":{"description":"Subject of the message","type":"string"},"status":{"description":"Delivery status","type":"string"},"message_id":{"type":"integer","description":"Message internal identifier"},"borrowernumber":{"type":"integer","description":"Borrower internal identifier"},"delivery_note":{"description":"Additional delivery notes","type":"string"}}}}},"produces":["application\/json"],"operationId":"getMessage"}},"\/serialitems":{"get":{"tags":["serials"],"operationId":"getSerialItems","produces":["application\/json"],"x-mojo-controller":"Koha::REST::V1::Serials","summary":"Fetches SerialItems representing Serials (without an Item-object) and Magazines (with an Item-object)","description":"You cannot return all SerialItems, but you must filter your search with GET-parameters.","parameters":[{"type":"integer","in":"query","name":"biblionumber","description":"Internal biblio identifier","required":true}],"responses":{"200":{"description":"Fetching the objects succeeded.","schema":{"type":"object"}}}}},"\/serials\/collection":{"get":{"summary":"Fetches a volume overview of all serials in the system, and a count of how many have been received.","description":"Fetches a volume overview of all serials in the system, and a count of how many have been received.","parameters":[{"name":"biblionumber","type":"integer","in":"query","required":true,"description":"Internal biblio identifier"},{"description":"The code of the branch where the Items have been last seen.","required":false,"in":"query","type":"string","name":"holdingbranch"},{"description":"Status of a serial. 1 = Expected, 2 = Received, 3 = Late, 4 = Not issued, 7 = Claimed.","required":false,"in":"query","type":"integer","name":"serialStatus"}],"responses":{"400":{"description":"Bad search parameters.","schema":{"properties":{"error":{"type":"string","description":"Error message"}},"type":"object"}},"200":{"description":"Fetching the objects succeeded.","schema":{"type":"object"}},"404":{"description":"No objects match the search request","schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}},"500":{"description":"Server-side error. I am sorry :(","schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}},"tags":["serials"],"produces":["application\/json"],"x-mojo-controller":"Koha::REST::V1::Serials","operationId":"getCollection"}},"\/borrowers\/status":{"get":{"summary":"Returns the Borrower's details and statuses","description":"This endpoint doesn't need other authentication than the proper username and password, and can be used anonymously.<br\/>Note: Does not authenticate the Borrower to Koha!","parameters":[{"in":"formData","type":"string","name":"uname","description":"The Username the Borrower uses to authenticate","required":true},{"description":"The Password the Borrower uses to authenticate","required":true,"in":"formData","type":"string","name":"passwd"}],"responses":{"200":{"description":"Borrower information","schema":{"type":"object","properties":{"too_many_renewals":{"description":"","type":"boolean"},"too_many_items_lost":{"description":"","type":"boolean"},"fines":{"format":"double","description":"Total due fines","type":"number"},"recall_overdue":{"type":"boolean","description":""},"borrowernumber":{"description":"Borrower internal identifier","type":"integer"},"homebranch":{"description":"Home library\/branch.","type":"string"},"too_many_items_billed":{"description":"","type":"boolean"},"excessive_outstanding_fees":{"type":"boolean","description":""},"language":{"type":"string","description":"Desired language of service"},"too_many_items_charged":{"type":"boolean","description":""},"firstname":{"description":"First name","type":"string"},"hold_privileges_denied":{"type":"boolean","description":""},"card_reported_lost":{"type":"boolean","description":""},"surname":{"type":"string","description":"Last name"},"recall_privileges_denied":{"description":"","type":"boolean"},"cardnumber":{"type":"string","description":"Library assigned ID number for Borrowers"},"too_many_items_overdue":{"type":"boolean","description":""},"excessive_outstanding_fines":{"type":"boolean","description":""},"too_many_claims_of_items_returned":{"description":"","type":"boolean"},"charge_privileges_denied":{"description":"","type":"boolean"},"renewal_privileges_denied":{"description":"","type":"boolean"}}}},"400":{"description":"Password authentication failed using username or password","schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}},"tags":["borrowers"],"operationId":"status","produces":["application\/json","application\/xml"],"x-mojo-controller":"Koha::REST::V1::Borrowers"}},"\/messages\/{messagenumber}\/report\/labyrintti":{"post":{"operationId":"createLabyrinttiReport","consumes":["application\/x-www-form-urlencoded"],"produces":["application\/json"],"x-mojo-controller":"Koha::REST::V1::Messages::Reports","responses":{"404":{"description":"Message not found","schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}},"200":{"schema":{"type":"string"},"description":"Response for receiving the report."}},"tags":["messages"],"parameters":[{"required":true,"description":"Internal message identifier","name":"messagenumber","type":"integer","in":"path"},{"name":"status","in":"formData","type":"string","required":true,"description":"Status of the delivery"},{"description":"Delivery notes","required":true,"in":"formData","type":"string","name":"message"}]}},"\/labels\/sheets\/{sheet_identifier}\/{sheet_version}":{"get":{"tags":["labels"],"produces":["application\/json"],"x-mojo-controller":"Koha::REST::V1::Labels::Sheets","operationId":"getSheet","summary":"Get a label positioning sheet","x-koha-permission":{"labels":"sheets_get"},"parameters":[{"required":true,"description":"Internal sheet identifier","name":"sheet_identifier","in":"path","type":"integer"},{"name":"sheet_version","in":"path","type":"number","format":"float","required":true,"description":"Sheet version number. If omitted, operations target the newest version. Set to '631373.00' to affect all versions."}],"responses":{"200":{"description":"The sheet","schema":{"type":"object"}},"404":{"schema":{"properties":{"error":{"type":"string","description":"Error message"}},"type":"object"},"description":"Sheet not found"},"500":{"description":"Internal server error","schema":{"properties":{"error":{"type":"string","description":"Error message"}},"type":"object"}}}},"delete":{"tags":["labels"],"operationId":"deleteSheet","produces":[""],"x-mojo-controller":"Koha::REST::V1::Labels::Sheets","parameters":[{"name":"sheet_identifier","in":"path","type":"integer","required":true,"description":"Internal sheet identifier"},{"description":"Sheet version number. If omitted, operations target the newest version. Set to '631373.00' to affect all versions.","format":"float","required":true,"in":"path","type":"number","name":"sheet_version"}],"responses":{"204":{"schema":{"type":"string"},"description":"Deleting the message succeeded."},"404":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}},"description":"Sheet not found"},"500":{"description":"Internal server error","schema":{"properties":{"error":{"type":"string","description":"Error message"}},"type":"object"}}},"x-koha-permission":{"labels":"sheets_del"},"summary":"Delete a label positioning sheet","description":"By default only deletes the newest version, exposing the older version."}},"\/labels\/sheets":{"put":{"x-koha-permission":{"labels":"sheets_mod"},"summary":"Modify a label positioning sheet","responses":{"400":{"schema":{"properties":{"error":{"type":"string","description":"Error message"}},"type":"object"},"description":"Missing or wrong parameters"},"201":{"schema":{"type":"string"},"description":"The modified sheet"},"500":{"schema":{"properties":{"error":{"type":"string","description":"Error message"}},"type":"object"},"description":"Internal server error"},"404":{"description":"Sheet not found","schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}},"parameters":[{"required":true,"description":"A JSON object of the sheet, containing the items, regions and elements.","name":"sheet","in":"formData","type":"string"}],"operationId":"updateSheet","x-mojo-controller":"Koha::REST::V1::Labels::Sheets","produces":["application\/json"],"tags":["labels"]},"post":{"parameters":[{"in":"formData","type":"string","name":"sheet","description":"A JSON object of the sheet, containing the items, regions and elements.","required":true}],"responses":{"400":{"description":"Missing or wrong parameters","schema":{"properties":{"error":{"type":"string","description":"Error message"}},"type":"object"}},"201":{"schema":{"type":"string"},"description":"The created sheet"},"500":{"description":"Internal server error","schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}},"summary":"Create a new label positioning sheet","x-koha-permission":{"labels":"sheets_new"},"tags":["labels"],"operationId":"createSheet","x-mojo-controller":"Koha::REST::V1::Labels::Sheets","produces":["text\/plain"]},"get":{"operationId":"listSheets","x-mojo-controller":"Koha::REST::V1::Labels::Sheets","produces":["application\/json"],"tags":["labels"],"description":"Not designed for external use. Use this to see the structure of the sheet-objects.","x-koha-permission":{"labels":"sheets_get"},"summary":"Get a list of label positioning sheets.","responses":{"404":{"schema":{"properties":{"error":{"type":"string","description":"Error message"}},"type":"object"},"description":"No sheets in Koha"},"500":{"schema":{"properties":{"error":{"type":"string","description":"Error message"}},"type":"object"},"description":"Internal server error"},"200":{"schema":{"type":"array","items":{"type":"string"}},"description":"A list of sheets"}}}}}} |