4 x-mojo-to: Patrons#list
5 operationId: listPatrons
14 description: Search on patron_id
19 description: Case insensitive search on cardnumber
24 description: Case insensitive search on surname
29 description: Case insensitive search on firstname
34 description: Case insensitive search on title
39 description: Case insensitive search on othernames
44 description: Case insensitive search on initials
49 description: Case insensitive search on streetnumber
54 description: Case insensitive search on streettype
59 description: Case insensitive search on address
64 description: Case insensitive search on address2
69 description: Case insensitive search on city
74 description: Case insensitive search on state
79 description: Case insensitive search on zipcode
84 description: Case insensitive search on country
89 description: Case insensitive search on email
94 description: Case insensitive search on phone
99 description: Case insensitive search on mobile
104 description: Case insensitive search on fax
107 - name: secondary_email
109 description: Case insensitive search on secondary_email
112 - name: secondary_phone
114 description: Case insensitive search on secondary_phone
117 - name: altaddress_street_number
119 description: Case insensitive search on altaddress_street_number
122 - name: altaddress_street_type
124 description: Case insensitive search on altaddress_street_type
127 - name: altaddress_address
129 description: Case insensitive search on altaddress_address
132 - name: altaddress_address2
134 description: Case insensitive search on altaddress_address2
137 - name: altaddress_city
139 description: Case insensitive search on altaddress_city
142 - name: altaddress_state
144 description: Case insensitive search on altaddress_state
147 - name: altaddress_postal_code
149 description: Case insensitive search on altaddress_postal_code
152 - name: altaddress_country
154 description: Case insensitive search on altaddress_country
157 - name: altaddress_email
159 description: Case insensitive search on altaddress_email
162 - name: altaddress_phone
164 description: Case insensitive search on altaddress_phone
167 - name: date_of_birth
169 description: Case insensitive search on date_of_birth
174 description: Case insensitive search on library_id
179 description: Case insensitive search on category_id
182 - name: date_enrolled
184 description: Case insensitive search on date_enrolled
189 description: Case insensitive search on expiry_date
192 - name: incorrect_address
194 description: Search on incorrect_address
197 - name: patron_card_lost
199 description: Search on patron_card_lost
204 description: Filter search by restricted
209 description: Search on guarantor_id
214 description: Case insensitive search on staff_notes
217 - name: relationship_type
219 description: Case insensitive search on relationship_type
224 description: Case insensitive search on gender
229 description: Case insensitive search on userid
234 description: Case insensitive search on opac_notes
237 - name: altaddress_notes
239 description: Case insensitive search on altaddress_notes
244 description: Case insensitive search on statistics_1
249 description: Case insensitive search on statistics_2
252 - name: autorenew_checkouts
254 description: Search on autorenew_checkouts
257 - name: altcontact_firstname
259 description: Case insensitive search on altcontact_firstname
262 - name: altcontact_surname
264 description: Case insensitive search on altcontact_surname
267 - name: altcontact_address
269 description: Case insensitive search on altcontact_address
272 - name: altcontact_address2
274 description: Case insensitive search on altcontact_address2
277 - name: altcontact_city
279 description: Case insensitive search on altcontact_city
282 - name: altcontact_state
284 description: Case insensitive search on altcontact_state
287 - name: altcontact_postal_code
289 description: Case insensitive search on altcontact_postal_code
292 - name: altcontact_country
294 description: Case insensitive search on altcontact_country
297 - name: altcontact_phone
299 description: Case insensitive search on altcontact_phone
304 description: Case insensitive search on sms_number
307 - name: sms_provider_id
309 description: Case insensitive search on sms_provider_id
314 description: Search on privacy
317 - name: privacy_guarantor_checkouts
319 description: Search on privacy_guarantor_checkouts
322 - name: check_previous_checkout
324 description: Case insensitive search on check_previous_checkout
329 description: Search on updated_on
334 description: Case insensitive search on last_seen
339 description: Case insensitive search on lang
342 - name: login_attempts
344 description: Search on login_attempts
347 - $ref: "../swagger.yaml#/parameters/match"
348 - $ref: "../swagger.yaml#/parameters/order_by"
349 - $ref: "../swagger.yaml#/parameters/page"
350 - $ref: "../swagger.yaml#/parameters/per_page"
351 - $ref: "../swagger.yaml#/parameters/q_param"
352 - $ref: "../swagger.yaml#/parameters/q_body"
353 - $ref: "../swagger.yaml#/parameters/q_header"
356 description: A list of patrons
360 $ref: "../swagger.yaml#/definitions/patron"
362 description: Authentication required
364 $ref: "../swagger.yaml#/definitions/error"
366 description: Access forbidden
368 $ref: "../swagger.yaml#/definitions/error"
371 Internal server error. Possible `error_code` attribute values:
373 * `internal_server_error`
375 $ref: "../swagger.yaml#/definitions/error"
377 description: Under maintenance
379 $ref: "../swagger.yaml#/definitions/error"
380 x-koha-authorization:
383 - tools: "label_creator"
385 - extended_attributes
387 x-mojo-to: Patrons#add
388 operationId: addPatron
395 description: A JSON object containing information about the new patron
398 $ref: "../swagger.yaml#/definitions/patron"
405 description: A successfully created patron
408 $ref: "../swagger.yaml#/definitions/patron"
410 description: Bad parameter
412 $ref: "../swagger.yaml#/definitions/error"
414 description: Authentication required
416 $ref: "../swagger.yaml#/definitions/error"
418 description: Access forbidden
420 $ref: "../swagger.yaml#/definitions/error"
422 description: Resource not found
424 $ref: "../swagger.yaml#/definitions/error"
426 description: Conflict in creating resource
428 $ref: "../swagger.yaml#/definitions/error"
431 Internal server error. Possible `error_code` attribute values:
433 * `internal_server_error`
435 $ref: "../swagger.yaml#/definitions/error"
437 description: Under maintenance
439 $ref: "../swagger.yaml#/definitions/error"
440 x-koha-authorization:
442 borrowers: edit_borrowers
443 "/patrons/{patron_id}":
445 x-mojo-to: Patrons#get
446 operationId: getPatron
451 - $ref: "../swagger.yaml#/parameters/patron_id_pp"
456 description: A patron
458 $ref: "../swagger.yaml#/definitions/patron"
460 description: Authentication required
462 $ref: "../swagger.yaml#/definitions/error"
464 description: Access forbidden
466 $ref: "../swagger.yaml#/definitions/error"
468 description: Patron not found
470 $ref: "../swagger.yaml#/definitions/error"
473 Internal server error. Possible `error_code` attribute values:
475 * `internal_server_error`
477 $ref: "../swagger.yaml#/definitions/error"
479 description: Under maintenance
481 $ref: "../swagger.yaml#/definitions/error"
482 x-koha-authorization:
484 borrowers: edit_borrowers
486 - extended_attributes
488 x-mojo-to: Patrons#update
489 operationId: updatePatron
492 summary: Update patron
494 - $ref: "../swagger.yaml#/parameters/patron_id_pp"
497 description: A JSON object containing new information about existing patron
500 $ref: "../swagger.yaml#/definitions/patron"
507 description: A successfully updated patron
510 $ref: "../swagger.yaml#/definitions/patron"
512 description: Bad parameter
514 $ref: "../swagger.yaml#/definitions/error"
516 description: Access forbidden
518 $ref: "../swagger.yaml#/definitions/error"
520 description: Resource not found
522 $ref: "../swagger.yaml#/definitions/error"
524 description: Conflict in updating resource
526 $ref: "../swagger.yaml#/definitions/error"
529 Internal server error. Possible `error_code` attribute values:
531 * `internal_server_error`
533 $ref: "../swagger.yaml#/definitions/error"
535 description: Under maintenance
537 $ref: "../swagger.yaml#/definitions/error"
538 x-koha-authorization:
542 x-mojo-to: Patrons#delete
543 operationId: deletePatron
546 summary: Delete patron
548 - $ref: "../swagger.yaml#/parameters/patron_id_pp"
553 description: Patron deleted
555 description: Patron deletion failed
557 $ref: "../swagger.yaml#/definitions/error"
559 description: Authentication required
561 $ref: "../swagger.yaml#/definitions/error"
563 description: Access forbidden
565 $ref: "../swagger.yaml#/definitions/error"
567 description: Patron not found
569 $ref: "../swagger.yaml#/definitions/error"
572 Conflict. Possible `error_code` attribute values:
574 * `has_checkouts`: The patron has pending checkouts
575 * `has_debt`: The patron has pending debts
576 * `has_guarantees`: The patron has guarantees
577 * `is_anonymous_patron`: The system-wide anonymous patron cannot be deleted
579 $ref: "../swagger.yaml#/definitions/error"
582 Internal server error. Possible `error_code` attribute values:
584 * `internal_server_error`
586 $ref: "../swagger.yaml#/definitions/error"
588 description: Under maintenance
590 $ref: "../swagger.yaml#/definitions/error"
591 x-koha-authorization:
593 borrowers: delete_borrowers