Koha/api/v1/swagger/definitions/patron.json
Kyle M Hall 109334102f
Bug 14570: Make it possible to add multiple guarantors to a record
This patch adds the ability to set an unlimited number of guarantors
for a given patron. As before, each guarantor may be linked to another
Koha patron, and all the behavior that applies to a given guarantor
remains the same.

Test Plan:
 1) Apply this patch
 2) Run updatedatabase.pl
 3) Find some patrons with guarantors, verify the still have their guarantor
 4) Test adding and removing guarantors on a patron record, both Koha users and not
 5) Verify the "Add child" button works
 6) Verify NoIssuesChargeGuarantees still works
 7) Verify tools/cleanborrowers.pl will not delete a guarantor
 8) Verify the guarantors are displayed on moremember.pl
 9) Verify the guarantor is removed by members/update-child.pl
10) Verify the guarantor is removed by misc/cronjobs/j2a.pl
11) Verify import patrons converts guarantor_id, relationship, contactfirstname,
  and contactsurname into a guarantor
12) prove t/Patron.t
13) prove t/db_dependent/Circulation.t
14) prove t/db_dependent/Circulation/NoIssuesChargeGuarantees.t
15) prove t/db_dependent/Items.t
16) prove t/db_dependent/Koha/Patrons.t
17) prove t/db_dependent/Members.t
18) prove t/db_dependent/Patron/Relationships.t

Signed-off-by: Kim Peine <kmpeine@gmail.com>
Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Agustin Moyano <agustinmoyano@theke.io>
Signed-off-by: Liz Rea <wizzyrea@gmail.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
2019-08-20 16:04:48 +01:00

280 lines
9 KiB
JSON

{
"type": "object",
"properties": {
"patron_id": {
"$ref": "../x-primitives.json#/patron_id"
},
"cardnumber": {
"$ref": "../x-primitives.json#/cardnumber"
},
"surname": {
"$ref": "../x-primitives.json#/surname"
},
"firstname": {
"$ref": "../x-primitives.json#/firstname"
},
"title": {
"type": ["string", "null"],
"description": "patron's title"
},
"other_name": {
"type": ["string", "null"],
"description": "any other names associated with the patron"
},
"initials": {
"type": ["string", "null"],
"description": "initials of the patron"
},
"street_number": {
"type": ["string", "null"],
"description": "street number of patron's primary address"
},
"street_type": {
"type": ["string", "null"],
"description": "street type of patron's primary address"
},
"address": {
"type": ["string", "null"],
"description": "first address line of patron's primary address"
},
"address2": {
"type": ["string", "null"],
"description": "second address line of patron's primary address"
},
"city": {
"type": ["string", "null"],
"description": "city or town of patron's primary address"
},
"state": {
"type": ["string", "null"],
"description": "state or province of patron's primary address"
},
"postal_code": {
"type": ["string", "null"],
"description": "zip or postal code of patron's primary address"
},
"country": {
"type": ["string", "null"],
"description": "country of patron's primary address"
},
"email": {
"$ref": "../x-primitives.json#/email"
},
"phone": {
"$ref": "../x-primitives.json#/phone"
},
"mobile": {
"type": ["string", "null"],
"description": "the other phone number for patron's primary address"
},
"fax": {
"type": ["string", "null"],
"description": "fax number for patron's primary address"
},
"secondary_email": {
"type": ["string", "null"],
"description": "secondary email address for patron's primary address"
},
"secondary_phone": {
"type": ["string", "null"],
"description": "secondary phone number for patron's primary address"
},
"altaddress_street_number": {
"type": ["string", "null"],
"description": "street number of patron's alternate address"
},
"altaddress_street_type": {
"type": ["string", "null"],
"description": "street type of patron's alternate address"
},
"altaddress_address": {
"type": ["string", "null"],
"description": "first address line of patron's alternate address"
},
"altaddress_address2": {
"type": ["string", "null"],
"description": "second address line of patron's alternate address"
},
"altaddress_city": {
"type": ["string", "null"],
"description": "city or town of patron's alternate address"
},
"altaddress_state": {
"type": ["string", "null"],
"description": "state or province of patron's alternate address"
},
"altaddress_postal_code": {
"type": ["string", "null"],
"description": "zip or postal code of patron's alternate address"
},
"altaddress_country": {
"type": ["string", "null"],
"description": "country of patron's alternate address"
},
"altaddress_email": {
"type": ["string", "null"],
"description": "email address for patron's alternate address"
},
"altaddress_phone": {
"type": ["string", "null"],
"description": "phone number for patron's alternate address"
},
"date_of_birth": {
"type": ["string", "null"],
"format": "date",
"description": "patron's date of birth"
},
"library_id": {
"type": "string",
"description": "Internal identifier for the patron's home library"
},
"category_id": {
"type": "string",
"description": "Internal identifier for the patron's category"
},
"date_enrolled": {
"type": ["string", "null"],
"format": "date",
"description": "date the patron was added to Koha"
},
"expiry_date": {
"type": ["string", "null"],
"format": "date",
"description": "date the patron's card is set to expire"
},
"date_renewed": {
"type": ["string", "null"],
"description": "date the patron's card was last renewed"
},
"incorrect_address": {
"type": ["boolean", "null"],
"description": "set to 1 if library marked this patron as having an unconfirmed address"
},
"patron_card_lost": {
"type": ["boolean", "null"],
"description": "set to 1 if library marked this patron as having lost his card"
},
"restricted": {
"type": "boolean",
"readOnly": true,
"description": "If any restriction applies to the patron"
},
"staff_notes": {
"type": ["string", "null"],
"description": "a note on the patron's account"
},
"relationship_type": {
"type": ["string", "null"],
"description": "used for children to include the relationship to their guarantor"
},
"gender": {
"type": ["string", "null"],
"description": "patron's gender"
},
"userid": {
"type": ["string", "null"],
"description": "patron's login"
},
"opac_notes": {
"type": ["string", "null"],
"description": "a note on the patron's account visible in OPAC and staff client"
},
"altaddress_notes": {
"type": ["string", "null"],
"description": "a note related to patron's alternate address"
},
"statistics_1": {
"type": ["string", "null"],
"description": "a field that can be used for any information unique to the library"
},
"statistics_2": {
"type": ["string", "null"],
"description": "a field that can be used for any information unique to the library"
},
"altcontact_firstname": {
"type": ["string", "null"],
"description": "first name of alternate contact for the patron"
},
"altcontact_surname": {
"type": ["string", "null"],
"description": "surname or last name of the alternate contact for the patron"
},
"altcontact_address": {
"type": ["string", "null"],
"description": "the first address line for the alternate contact for the patron"
},
"altcontact_address2": {
"type": ["string", "null"],
"description": "the second address line for the alternate contact for the patron"
},
"altcontact_city": {
"type": ["string", "null"],
"description": "the city for the alternate contact for the patron"
},
"altcontact_state": {
"type": ["string", "null"],
"description": "the state for the alternate contact for the patron"
},
"altcontact_postal_code": {
"type": ["string", "null"],
"description": "the zipcode for the alternate contact for the patron"
},
"altcontact_country": {
"type": ["string", "null"],
"description": "the country for the alternate contact for the patron"
},
"altcontact_phone": {
"type": ["string", "null"],
"description": "the phone number for the alternate contact for the patron"
},
"sms_number": {
"type": ["string", "null"],
"description": "the mobile phone number where the patron would like to receive notices (if SMS turned on)"
},
"sms_provider_id": {
"type": ["integer", "null"],
"description": "the provider of the mobile phone number defined in smsalertnumber"
},
"privacy": {
"type": "integer",
"description": "patron's privacy settings related to their reading history"
},
"privacy_guarantor_checkouts": {
"type": "integer",
"description": "controls if relatives can see this patron's checkouts"
},
"check_previous_checkout": {
"type": "string",
"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'"
},
"updated_on": {
"type": "string",
"format": "date-time",
"description": "time of last change could be useful for synchronization with external systems (among others)"
},
"last_seen": {
"type": ["string", "null"],
"format": "date-time",
"description": "last time a patron has been seen (connected at the OPAC or staff interface)"
},
"lang": {
"type": "string",
"description": "lang to use to send notices to this patron"
},
"login_attempts": {
"type": ["integer", "null"],
"description": "number of failed login attemps"
},
"overdrive_auth_token": {
"type": ["string", "null"],
"description": "persist OverDrive auth token"
},
"anonymized": {
"type": "boolean",
"readOnly": true,
"description": "If the patron has been anonymized"
}
},
"additionalProperties": false,
"required": ["surname", "address", "city", "library_id", "category_id"]
}