4 "x-mojo-to": "Patron#list",
5 "operationId": "listPatrons",
11 "name": "borrowernumber",
13 "description": "Case insensitive search on borrowernumber",
19 "description": "Case insensitive search on cardnumber",
25 "description": "Case insensitive search on surname",
31 "description": "Case insensitive search on firstname",
37 "description": "Case insensitive search on title",
43 "description": "Case insensitive search on othernames",
49 "description": "Case insensitive search on initials",
53 "name": "streetnumber",
55 "description": "Case insensitive search on streetnumber",
61 "description": "Case insensitive search on streettype",
67 "description": "Case insensitive search on address",
73 "description": "Case insensitive search on address2",
79 "description": "Case insensitive search on city",
85 "description": "Case insensitive search on state",
91 "description": "Case insensitive search on zipcode",
97 "description": "Case insensitive search on country",
103 "description": "Case insensitive search on email",
109 "description": "Case insensitive search on phone",
115 "description": "Case insensitive search on mobile",
121 "description": "Case insensitive search on fax",
127 "description": "Case insensitive search on emailpro",
133 "description": "Case insensitive search on phonepro",
137 "name": "B_streetnumber",
139 "description": "Case insensitive search on B_streetnumber",
143 "name": "B_streettype",
145 "description": "Case insensitive search on B_streettype",
151 "description": "Case insensitive search on B_address",
155 "name": "B_address2",
157 "description": "Case insensitive search on B_address2",
163 "description": "Case insensitive search on B_city",
169 "description": "Case insensitive search on B_state",
175 "description": "Case insensitive search on B_zipcode",
181 "description": "Case insensitive search on B_country",
187 "description": "Case insensitive search on B_email",
193 "description": "Case insensitive search on B_phone",
197 "name": "dateofbirth",
199 "description": "Case insensitive search on dateofbirth",
203 "name": "branchcode",
205 "description": "Case insensitive search on branchcode",
209 "name": "categorycode",
211 "description": "Case insensitive search on categorycode",
215 "name": "dateenrolled",
217 "description": "Case insensitive search on dateenrolled",
221 "name": "dateexpiry",
223 "description": "Case insensitive search on dateexpiry",
227 "name": "gonenoaddress",
229 "description": "Search on gonenoaddress",
235 "description": "Search on lost",
241 "description": "Case insensitive search on debarred",
245 "name": "debarredcomment",
247 "description": "Case insensitive search on debarredcomment",
251 "name": "contactname",
253 "description": "Case insensitive search on contactname",
257 "name": "contactfirstname",
259 "description": "Case insensitive search on contactfirstname",
263 "name": "contacttitle",
265 "description": "Case insensitive search on contacttitle",
269 "name": "guarantorid",
271 "description": "Case insensitive search on guarantorid",
275 "name": "borrowernotes",
277 "description": "Case insensitive search on borrowernotes",
281 "name": "relationship",
283 "description": "Case insensitive search on relationship",
289 "description": "Case insensitive search on sex",
295 "description": "Case insensitive search on password",
301 "description": "Case insensitive search on flags",
307 "description": "Case insensitive search on userid",
313 "description": "Case insensitive search on opacnote",
317 "name": "contactnote",
319 "description": "Case insensitive search on contactnote",
325 "description": "Case insensitive search on sort1",
331 "description": "Case insensitive search on sort2",
335 "name": "altcontactfirstname",
337 "description": "Case insensitive search on altcontactfirstname",
341 "name": "altcontactsurname",
343 "description": "Case insensitive search on altcontactsurname",
347 "name": "altcontactaddress1",
349 "description": "Case insensitive search on altcontactaddress1",
353 "name": "altcontactaddress2",
355 "description": "Case insensitive search on altcontactaddress2",
359 "name": "altcontactaddress3",
361 "description": "Case insensitive search on altcontactaddress3",
365 "name": "altcontactstate",
367 "description": "Case insensitive search on altcontactstate",
371 "name": "altcontactzipcode",
373 "description": "Case insensitive search on altcontactzipcode",
377 "name": "altcontactcountry",
379 "description": "Case insensitive search on altcontactcountry",
383 "name": "altcontactphone",
385 "description": "Case insensitive search on altcontactphone",
389 "name": "smsalertnumber",
391 "description": "Case insensitive search on smsalertnumber",
395 "name": "sms_provider_id",
397 "description": "Case insensitive search on sms_provider_id",
403 "description": "Case insensitive search on privacy",
407 "name": "privacy_guarantor_checkouts",
409 "description": "Case insensitive search on privacy_guarantor_checkouts",
413 "name": "checkprevcheckout",
415 "description": "Case insensitive search on checkprevcheckout",
419 "name": "updated_on",
421 "description": "Case insensitive search on updated_on",
427 "description": "Case insensitive search on lastseen",
433 "description": "Case insensitive search on lang",
437 "name": "login_attempts",
439 "description": "Case insensitive search on login_attempts",
443 "name": "overdrive_auth_token",
445 "description": "Case insensitive search on overdrive_auth_token",
449 "$ref": "../parameters.json#/match"
451 "$ref": "../parameters.json#/order_by"
453 "$ref": "../parameters.json#/page"
455 "$ref": "../parameters.json#/per_page"
459 "description": "A list of patrons",
463 "$ref": "../definitions.json#/patron"
468 "description": "Authentication required",
470 "$ref": "../definitions.json#/error"
474 "description": "Access forbidden",
476 "$ref": "../definitions.json#/error"
480 "description": "Internal server error",
482 "$ref": "../definitions.json#/error"
486 "x-koha-authorization": {
493 "x-mojo-to": "Patron#add",
494 "operationId": "addPatron",
499 "description": "A JSON object containing information about the new patron",
502 "$ref": "../definitions.json#/patron"
505 "consumes": ["application/json"],
506 "produces": ["application/json"],
509 "description": "A successfully created patron",
512 "$ref": "../definitions.json#/patron"
517 "description": "Bad parameter",
519 "$ref": "../definitions.json#/error"
523 "description": "Authentication required",
525 "$ref": "../definitions.json#/error"
529 "description": "Access forbidden",
531 "$ref": "../definitions.json#/error"
535 "description": "Resource not found",
537 "$ref": "../definitions.json#/error"
541 "description": "Conflict in creating resource",
543 "$ref": "../definitions.json#/error"
547 "description": "Internal server error",
549 "$ref": "../definitions.json#/error"
553 "description": "Under maintenance",
555 "$ref": "../definitions.json#/error"
559 "x-koha-authorization": {
561 "borrowers": "edit_borrowers"
566 "/patrons/{borrowernumber}": {
568 "x-mojo-to": "Patron#get",
569 "operationId": "getPatron",
572 "$ref": "../parameters.json#/borrowernumberPathParam"
579 "description": "A patron",
581 "$ref": "../definitions.json#/patron"
585 "description": "Authentication required",
587 "$ref": "../definitions.json#/error"
591 "description": "Access forbidden",
593 "$ref": "../definitions.json#/error"
597 "description": "Patron not found",
599 "$ref": "../definitions.json#/error"
603 "description": "Internal server error",
605 "$ref": "../definitions.json#/error"
609 "description": "Under maintenance",
611 "$ref": "../definitions.json#/error"
615 "x-koha-authorization": {
617 "allow-guarantor": true,
619 "borrowers": "edit_borrowers"
624 "x-mojo-to": "Patron#update",
625 "operationId": "updatePatron",
629 "$ref": "../parameters.json#/borrowernumberPathParam"
634 "description": "A JSON object containing new information about existing patron",
637 "$ref": "../definitions.json#/patron"
641 "consumes": ["application/json"],
642 "produces": ["application/json"],
645 "description": "A successfully updated patron",
648 "$ref": "../definitions.json#/patron"
653 "description": "Accepted and waiting for librarian verification",
659 "description": "No Content",
665 "description": "Bad parameter",
667 "$ref": "../definitions.json#/error"
671 "description": "Access forbidden",
673 "$ref": "../definitions.json#/error"
677 "description": "Resource not found",
679 "$ref": "../definitions.json#/error"
683 "description": "Conflict in updating resource",
685 "$ref": "../definitions.json#/error"
689 "description": "Internal server error",
691 "$ref": "../definitions.json#/error"
695 "x-koha-authorization": {
702 "x-mojo-to": "Patron#delete",
703 "operationId": "deletePatron",
706 "$ref": "../parameters.json#/borrowernumberPathParam"
708 "produces": ["application/json"],
711 "description": "Patron deleted successfully",
717 "description": "Patron deletion failed",
719 "$ref": "../definitions.json#/error"
723 "description": "Authentication required",
725 "$ref": "../definitions.json#/error"
729 "description": "Access forbidden",
731 "$ref": "../definitions.json#/error"
735 "description": "Patron not found",
737 "$ref": "../definitions.json#/error"
741 "x-koha-authorization": {