5 "$ref": "../x-primitives.json#/patron_id"
8 "$ref": "../x-primitives.json#/cardnumber"
11 "$ref": "../x-primitives.json#/surname"
14 "$ref": "../x-primitives.json#/firstname"
17 "type": ["string", "null"],
18 "description": "patron's title"
21 "type": ["string", "null"],
22 "description": "any other names associated with the patron"
25 "type": ["string", "null"],
26 "description": "initials of the patron"
29 "type": ["string", "null"],
30 "description": "street number of patron's primary address"
33 "type": ["string", "null"],
34 "description": "street type of patron's primary address"
37 "type": ["string", "null"],
38 "description": "first address line of patron's primary address"
41 "type": ["string", "null"],
42 "description": "second address line of patron's primary address"
45 "type": ["string", "null"],
46 "description": "city or town of patron's primary address"
49 "type": ["string", "null"],
50 "description": "state or province of patron's primary address"
53 "type": ["string", "null"],
54 "description": "zip or postal code of patron's primary address"
57 "type": ["string", "null"],
58 "description": "country of patron's primary address"
61 "$ref": "../x-primitives.json#/email"
64 "$ref": "../x-primitives.json#/phone"
67 "type": ["string", "null"],
68 "description": "the other phone number for patron's primary address"
71 "type": ["string", "null"],
72 "description": "fax number for patron's primary address"
75 "type": ["string", "null"],
76 "description": "secondary email address for patron's primary address"
79 "type": ["string", "null"],
80 "description": "secondary phone number for patron's primary address"
82 "altaddress_street_number": {
83 "type": ["string", "null"],
84 "description": "street number of patron's alternate address"
86 "altaddress_street_type": {
87 "type": ["string", "null"],
88 "description": "street type of patron's alternate address"
90 "altaddress_address": {
91 "type": ["string", "null"],
92 "description": "first address line of patron's alternate address"
94 "altaddress_address2": {
95 "type": ["string", "null"],
96 "description": "second address line of patron's alternate address"
99 "type": ["string", "null"],
100 "description": "city or town of patron's alternate address"
102 "altaddress_state": {
103 "type": ["string", "null"],
104 "description": "state or province of patron's alternate address"
106 "altaddress_postal_code": {
107 "type": ["string", "null"],
108 "description": "zip or postal code of patron's alternate address"
110 "altaddress_country": {
111 "type": ["string", "null"],
112 "description": "country of patron's alternate address"
114 "altaddress_email": {
115 "type": ["string", "null"],
116 "description": "email address for patron's alternate address"
118 "altaddress_phone": {
119 "type": ["string", "null"],
120 "description": "phone number for patron's alternate address"
123 "type": ["string", "null"],
125 "description": "patron's date of birth"
129 "description": "Internal identifier for the patron's home library"
133 "description": "Internal identifier for the patron's category"
136 "type": ["string", "null"],
138 "description": "date the patron was added to Koha"
141 "type": ["string", "null"],
143 "description": "date the patron's card is set to expire"
146 "type": ["string", "null"],
147 "description": "date the patron's card was last renewed"
149 "incorrect_address": {
150 "type": ["boolean", "null"],
151 "description": "set to 1 if library marked this patron as having an unconfirmed address"
153 "patron_card_lost": {
154 "type": ["boolean", "null"],
155 "description": "set to 1 if library marked this patron as having lost his card"
160 "description": "If any restriction applies to the patron"
163 "type": ["string", "null"],
164 "description": "a note on the patron's account"
166 "relationship_type": {
167 "type": ["string", "null"],
168 "description": "used for children to include the relationship to their guarantor"
171 "type": ["string", "null"],
172 "description": "patron's gender"
175 "type": ["string", "null"],
176 "description": "patron's login"
179 "type": ["string", "null"],
180 "description": "a note on the patron's account visible in OPAC and staff interface"
182 "altaddress_notes": {
183 "type": ["string", "null"],
184 "description": "a note related to patron's alternate address"
187 "type": ["string", "null"],
188 "description": "a field that can be used for any information unique to the library"
191 "type": ["string", "null"],
192 "description": "a field that can be used for any information unique to the library"
194 "autorenew_checkouts": {
196 "description": "indicate whether auto-renewal is allowed for patron"
198 "altcontact_firstname": {
199 "type": ["string", "null"],
200 "description": "first name of alternate contact for the patron"
202 "altcontact_surname": {
203 "type": ["string", "null"],
204 "description": "surname or last name of the alternate contact for the patron"
206 "altcontact_address": {
207 "type": ["string", "null"],
208 "description": "the first address line for the alternate contact for the patron"
210 "altcontact_address2": {
211 "type": ["string", "null"],
212 "description": "the second address line for the alternate contact for the patron"
215 "type": ["string", "null"],
216 "description": "the city for the alternate contact for the patron"
218 "altcontact_state": {
219 "type": ["string", "null"],
220 "description": "the state for the alternate contact for the patron"
222 "altcontact_postal_code": {
223 "type": ["string", "null"],
224 "description": "the zipcode for the alternate contact for the patron"
226 "altcontact_country": {
227 "type": ["string", "null"],
228 "description": "the country for the alternate contact for the patron"
230 "altcontact_phone": {
231 "type": ["string", "null"],
232 "description": "the phone number for the alternate contact for the patron"
235 "type": ["string", "null"],
236 "description": "the mobile phone number where the patron would like to receive notices (if SMS turned on)"
239 "type": ["integer", "null"],
240 "description": "the provider of the mobile phone number defined in smsalertnumber"
244 "description": "patron's privacy settings related to their checkout history"
246 "privacy_guarantor_checkouts": {
248 "description": "controls if relatives can see this patron's checkouts"
250 "privacy_guarantor_fines": {
252 "description": "controls if relatives can see this patron's fines"
254 "check_previous_checkout": {
256 "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'"
260 "format": "date-time",
261 "description": "time of last change could be useful for synchronization with external systems (among others)"
264 "type": ["string", "null"],
265 "format": "date-time",
266 "description": "last time a patron has been seen (connected at the OPAC or staff interface)"
270 "description": "lang to use to send notices to this patron"
273 "type": ["integer", "null"],
274 "description": "number of failed login attemps"
276 "overdrive_auth_token": {
277 "type": ["string", "null"],
278 "description": "persist OverDrive auth token"
283 "description": "If the patron has been anonymized"
286 "additionalProperties": false,
287 "required": ["surname", "address", "city", "library_id", "category_id"]