4 "x-mojo-to": "Patrons#list",
5 "operationId": "listPatrons",
13 "description": "Search on patron_id",
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": "street_number",
55 "description": "Case insensitive search on streetnumber",
59 "name": "street_type",
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",
89 "name": "postal_code",
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",
125 "name": "secondary_email",
127 "description": "Case insensitive search on secondary_email",
131 "name": "secondary_phone",
133 "description": "Case insensitive search on secondary_phone",
137 "name": "altaddress_street_number",
139 "description": "Case insensitive search on altaddress_street_number",
143 "name": "altaddress_street_type",
145 "description": "Case insensitive search on altaddress_street_type",
149 "name": "altaddress_address",
151 "description": "Case insensitive search on altaddress_address",
155 "name": "altaddress_address2",
157 "description": "Case insensitive search on altaddress_address2",
161 "name": "altaddress_city",
163 "description": "Case insensitive search on altaddress_city",
167 "name": "altaddress_state",
169 "description": "Case insensitive search on altaddress_state",
173 "name": "altaddress_postal_code",
175 "description": "Case insensitive search on altaddress_postal_code",
179 "name": "altaddress_country",
181 "description": "Case insensitive search on altaddress_country",
185 "name": "altaddress_email",
187 "description": "Case insensitive search on altaddress_email",
191 "name": "altaddress_phone",
193 "description": "Case insensitive search on altaddress_phone",
197 "name": "date_of_birth",
199 "description": "Case insensitive search on date_of_birth",
203 "name": "library_id",
205 "description": "Case insensitive search on library_id",
209 "name": "category_id",
211 "description": "Case insensitive search on category_id",
215 "name": "date_enrolled",
217 "description": "Case insensitive search on date_enrolled",
221 "name": "expiry_date",
223 "description": "Case insensitive search on expiry_date",
227 "name": "incorrect_address",
229 "description": "Search on incorrect_address",
233 "name": "patron_card_lost",
235 "description": "Search on patron_card_lost",
239 "name": "restricted",
241 "description": "Filter search by restricted",
245 "name": "guarantor_id",
247 "description": "Search on guarantor_id",
251 "name": "staff_notes",
253 "description": "Case insensitive search on staff_notes",
257 "name": "relationship_type",
259 "description": "Case insensitive search on relationship_type",
265 "description": "Case insensitive search on gender",
271 "description": "Case insensitive search on userid",
275 "name": "opac_notes",
277 "description": "Case insensitive search on opac_notes",
281 "name": "altaddress_notes",
283 "description": "Case insensitive search on altaddress_notes",
287 "name": "statistics_1",
289 "description": "Case insensitive search on statistics_1",
293 "name": "statistics_2",
295 "description": "Case insensitive search on statistics_2",
299 "name": "autorenew_checkouts",
301 "description": "Search on autorenew_checkouts",
305 "name": "altcontact_firstname",
307 "description": "Case insensitive search on altcontact_firstname",
311 "name": "altcontact_surname",
313 "description": "Case insensitive search on altcontact_surname",
317 "name": "altcontact_address",
319 "description": "Case insensitive search on altcontact_address",
323 "name": "altcontact_address2",
325 "description": "Case insensitive search on altcontact_address2",
329 "name": "altcontact_city",
331 "description": "Case insensitive search on altcontact_city",
335 "name": "altcontact_state",
337 "description": "Case insensitive search on altcontact_state",
341 "name": "altcontact_postal_code",
343 "description": "Case insensitive search on altcontact_postal_code",
347 "name": "altcontact_country",
349 "description": "Case insensitive search on altcontact_country",
353 "name": "altcontact_phone",
355 "description": "Case insensitive search on altcontact_phone",
359 "name": "sms_number",
361 "description": "Case insensitive search on sms_number",
365 "name": "sms_provider_id",
367 "description": "Case insensitive search on sms_provider_id",
373 "description": "Search on privacy",
377 "name": "privacy_guarantor_checkouts",
379 "description": "Search on privacy_guarantor_checkouts",
383 "name": "check_previous_checkout",
385 "description": "Case insensitive search on check_previous_checkout",
389 "name": "updated_on",
391 "description": "Search on updated_on",
397 "description": "Case insensitive search on last_seen",
403 "description": "Case insensitive search on lang",
407 "name": "login_attempts",
409 "description": "Search on login_attempts",
413 "$ref": "../parameters.json#/match"
415 "$ref": "../parameters.json#/order_by"
417 "$ref": "../parameters.json#/page"
419 "$ref": "../parameters.json#/per_page"
423 "description": "A list of patrons",
427 "$ref": "../definitions.json#/patron"
432 "description": "Authentication required",
434 "$ref": "../definitions.json#/error"
438 "description": "Access forbidden",
440 "$ref": "../definitions.json#/error"
444 "description": "Internal server error",
446 "$ref": "../definitions.json#/error"
450 "x-koha-authorization": {
457 "x-mojo-to": "Patrons#add",
458 "operationId": "addPatron",
463 "description": "A JSON object containing information about the new patron",
466 "$ref": "../definitions.json#/patron"
469 "consumes": ["application/json"],
470 "produces": ["application/json"],
473 "description": "A successfully created patron",
476 "$ref": "../definitions.json#/patron"
481 "description": "Bad parameter",
483 "$ref": "../definitions.json#/error"
487 "description": "Authentication required",
489 "$ref": "../definitions.json#/error"
493 "description": "Access forbidden",
495 "$ref": "../definitions.json#/error"
499 "description": "Resource not found",
501 "$ref": "../definitions.json#/error"
505 "description": "Conflict in creating resource",
507 "$ref": "../definitions.json#/error"
511 "description": "Internal server error",
513 "$ref": "../definitions.json#/error"
517 "description": "Under maintenance",
519 "$ref": "../definitions.json#/error"
523 "x-koha-authorization": {
525 "borrowers": "edit_borrowers"
530 "/patrons/{patron_id}": {
532 "x-mojo-to": "Patrons#get",
533 "operationId": "getPatron",
536 "$ref": "../parameters.json#/patron_id_pp"
543 "description": "A patron",
545 "$ref": "../definitions.json#/patron"
549 "description": "Authentication required",
551 "$ref": "../definitions.json#/error"
555 "description": "Access forbidden",
557 "$ref": "../definitions.json#/error"
561 "description": "Patron not found",
563 "$ref": "../definitions.json#/error"
567 "description": "Internal server error",
569 "$ref": "../definitions.json#/error"
573 "description": "Under maintenance",
575 "$ref": "../definitions.json#/error"
579 "x-koha-authorization": {
581 "borrowers": "edit_borrowers"
586 "x-mojo-to": "Patrons#update",
587 "operationId": "updatePatron",
591 "$ref": "../parameters.json#/patron_id_pp"
596 "description": "A JSON object containing new information about existing patron",
599 "$ref": "../definitions.json#/patron"
603 "consumes": ["application/json"],
604 "produces": ["application/json"],
607 "description": "A successfully updated patron",
610 "$ref": "../definitions.json#/patron"
615 "description": "Accepted and waiting for librarian verification",
621 "description": "No Content",
627 "description": "Bad parameter",
629 "$ref": "../definitions.json#/error"
633 "description": "Access forbidden",
635 "$ref": "../definitions.json#/error"
639 "description": "Resource not found",
641 "$ref": "../definitions.json#/error"
645 "description": "Conflict in updating resource",
647 "$ref": "../definitions.json#/error"
651 "description": "Internal server error",
653 "$ref": "../definitions.json#/error"
657 "x-koha-authorization": {
664 "x-mojo-to": "Patrons#delete",
665 "operationId": "deletePatron",
668 "$ref": "../parameters.json#/patron_id_pp"
670 "produces": ["application/json"],
673 "description": "Patron deleted successfully",
679 "description": "Patron deletion failed",
681 "$ref": "../definitions.json#/error"
685 "description": "Authentication required",
687 "$ref": "../definitions.json#/error"
691 "description": "Access forbidden",
693 "$ref": "../definitions.json#/error"
697 "description": "Patron not found",
699 "$ref": "../definitions.json#/error"
703 "x-koha-authorization": {