|
Lines 1-8
Link Here
|
| 1 |
{ |
1 |
{ |
| 2 |
"type": "object", |
2 |
"type": "object", |
| 3 |
"properties": { |
3 |
"properties": { |
| 4 |
"borrowernumber": { |
4 |
"patron_id": { |
| 5 |
"$ref": "../x-primitives.json#/borrowernumber" |
5 |
"$ref": "../x-primitives.json#/patron_id" |
| 6 |
}, |
6 |
}, |
| 7 |
"cardnumber": { |
7 |
"cardnumber": { |
| 8 |
"$ref": "../x-primitives.json#/cardnumber" |
8 |
"$ref": "../x-primitives.json#/cardnumber" |
|
Lines 17-23
Link Here
|
| 17 |
"type": ["string", "null"], |
17 |
"type": ["string", "null"], |
| 18 |
"description": "patron's title" |
18 |
"description": "patron's title" |
| 19 |
}, |
19 |
}, |
| 20 |
"othernames": { |
20 |
"other_name": { |
| 21 |
"type": ["string", "null"], |
21 |
"type": ["string", "null"], |
| 22 |
"description": "any other names associated with the patron" |
22 |
"description": "any other names associated with the patron" |
| 23 |
}, |
23 |
}, |
|
Lines 25-35
Link Here
|
| 25 |
"type": ["string", "null"], |
25 |
"type": ["string", "null"], |
| 26 |
"description": "initials of the patron" |
26 |
"description": "initials of the patron" |
| 27 |
}, |
27 |
}, |
| 28 |
"streetnumber": { |
28 |
"street_number": { |
| 29 |
"type": ["string", "null"], |
29 |
"type": ["string", "null"], |
| 30 |
"description": "street number of patron's primary address" |
30 |
"description": "street number of patron's primary address" |
| 31 |
}, |
31 |
}, |
| 32 |
"streettype": { |
32 |
"street_type": { |
| 33 |
"type": ["string", "null"], |
33 |
"type": ["string", "null"], |
| 34 |
"description": "street type of patron's primary address" |
34 |
"description": "street type of patron's primary address" |
| 35 |
}, |
35 |
}, |
|
Lines 49-55
Link Here
|
| 49 |
"type": ["string", "null"], |
49 |
"type": ["string", "null"], |
| 50 |
"description": "state or province of patron's primary address" |
50 |
"description": "state or province of patron's primary address" |
| 51 |
}, |
51 |
}, |
| 52 |
"zipcode": { |
52 |
"postal_code": { |
| 53 |
"type": ["string", "null"], |
53 |
"type": ["string", "null"], |
| 54 |
"description": "zip or postal code of patron's primary address" |
54 |
"description": "zip or postal code of patron's primary address" |
| 55 |
}, |
55 |
}, |
|
Lines 71-143
Link Here
|
| 71 |
"type": ["string", "null"], |
71 |
"type": ["string", "null"], |
| 72 |
"description": "fax number for patron's primary address" |
72 |
"description": "fax number for patron's primary address" |
| 73 |
}, |
73 |
}, |
| 74 |
"emailpro": { |
74 |
"secondary_email": { |
| 75 |
"type": ["string", "null"], |
75 |
"type": ["string", "null"], |
| 76 |
"description": "secondary email address for patron's primary address" |
76 |
"description": "secondary email address for patron's primary address" |
| 77 |
}, |
77 |
}, |
| 78 |
"phonepro": { |
78 |
"secondary_phone": { |
| 79 |
"type": ["string", "null"], |
79 |
"type": ["string", "null"], |
| 80 |
"description": "secondary phone number for patron's primary address" |
80 |
"description": "secondary phone number for patron's primary address" |
| 81 |
}, |
81 |
}, |
| 82 |
"B_streetnumber": { |
82 |
"altaddress_street_number": { |
| 83 |
"type": ["string", "null"], |
83 |
"type": ["string", "null"], |
| 84 |
"description": "street number of patron's alternate address" |
84 |
"description": "street number of patron's alternate address" |
| 85 |
}, |
85 |
}, |
| 86 |
"B_streettype": { |
86 |
"altaddress_street_type": { |
| 87 |
"type": ["string", "null"], |
87 |
"type": ["string", "null"], |
| 88 |
"description": "street type of patron's alternate address" |
88 |
"description": "street type of patron's alternate address" |
| 89 |
}, |
89 |
}, |
| 90 |
"B_address": { |
90 |
"altaddress_address": { |
| 91 |
"type": ["string", "null"], |
91 |
"type": ["string", "null"], |
| 92 |
"description": "first address line of patron's alternate address" |
92 |
"description": "first address line of patron's alternate address" |
| 93 |
}, |
93 |
}, |
| 94 |
"B_address2": { |
94 |
"altaddress_address2": { |
| 95 |
"type": ["string", "null"], |
95 |
"type": ["string", "null"], |
| 96 |
"description": "second address line of patron's alternate address" |
96 |
"description": "second address line of patron's alternate address" |
| 97 |
}, |
97 |
}, |
| 98 |
"B_city": { |
98 |
"altaddress_city": { |
| 99 |
"type": ["string", "null"], |
99 |
"type": ["string", "null"], |
| 100 |
"description": "city or town of patron's alternate address" |
100 |
"description": "city or town of patron's alternate address" |
| 101 |
}, |
101 |
}, |
| 102 |
"B_state": { |
102 |
"altaddress_state": { |
| 103 |
"type": ["string", "null"], |
103 |
"type": ["string", "null"], |
| 104 |
"description": "state or province of patron's alternate address" |
104 |
"description": "state or province of patron's alternate address" |
| 105 |
}, |
105 |
}, |
| 106 |
"B_zipcode": { |
106 |
"altaddress_postal_code": { |
| 107 |
"type": ["string", "null"], |
107 |
"type": ["string", "null"], |
| 108 |
"description": "zip or postal code of patron's alternate address" |
108 |
"description": "zip or postal code of patron's alternate address" |
| 109 |
}, |
109 |
}, |
| 110 |
"B_country": { |
110 |
"altaddress_country": { |
| 111 |
"type": ["string", "null"], |
111 |
"type": ["string", "null"], |
| 112 |
"description": "country of patron's alternate address" |
112 |
"description": "country of patron's alternate address" |
| 113 |
}, |
113 |
}, |
| 114 |
"B_email": { |
114 |
"altaddress_email": { |
| 115 |
"type": ["string", "null"], |
115 |
"type": ["string", "null"], |
| 116 |
"description": "email address for patron's alternate address" |
116 |
"description": "email address for patron's alternate address" |
| 117 |
}, |
117 |
}, |
| 118 |
"B_phone": { |
118 |
"altaddress_phone": { |
| 119 |
"type": ["string", "null"], |
119 |
"type": ["string", "null"], |
| 120 |
"description": "phone number for patron's alternate address" |
120 |
"description": "phone number for patron's alternate address" |
| 121 |
}, |
121 |
}, |
| 122 |
"dateofbirth": { |
122 |
"date_of_birth": { |
| 123 |
"type": ["string", "null"], |
123 |
"type": ["string", "null"], |
| 124 |
"format": "date", |
124 |
"format": "date", |
| 125 |
"description": "patron's date of birth" |
125 |
"description": "patron's date of birth" |
| 126 |
}, |
126 |
}, |
| 127 |
"branchcode": { |
127 |
"library_id": { |
| 128 |
"type": "string", |
128 |
"type": "string", |
| 129 |
"description": "code of patron's home branch" |
129 |
"description": "Internal identifier for the patron's home library" |
| 130 |
}, |
130 |
}, |
| 131 |
"categorycode": { |
131 |
"category_id": { |
| 132 |
"type": "string", |
132 |
"type": "string", |
| 133 |
"description": "code of patron's category" |
133 |
"description": "Internal identifier for the patron's category" |
| 134 |
}, |
134 |
}, |
| 135 |
"dateenrolled": { |
135 |
"date_enrolled": { |
| 136 |
"type": ["string", "null"], |
136 |
"type": ["string", "null"], |
| 137 |
"format": "date", |
137 |
"format": "date", |
| 138 |
"description": "date the patron was added to Koha" |
138 |
"description": "date the patron was added to Koha" |
| 139 |
}, |
139 |
}, |
| 140 |
"dateexpiry": { |
140 |
"expiry_date": { |
| 141 |
"type": ["string", "null"], |
141 |
"type": ["string", "null"], |
| 142 |
"format": "date", |
142 |
"format": "date", |
| 143 |
"description": "date the patron's card is set to expire" |
143 |
"description": "date the patron's card is set to expire" |
|
Lines 146-261
Link Here
|
| 146 |
"type": ["string", "null"], |
146 |
"type": ["string", "null"], |
| 147 |
"description": "date the patron's card was last renewed" |
147 |
"description": "date the patron's card was last renewed" |
| 148 |
}, |
148 |
}, |
| 149 |
"gonenoaddress": { |
149 |
"incorrect_address": { |
| 150 |
"type": ["boolean", "null"], |
150 |
"type": ["boolean", "null"], |
| 151 |
"description": "set to 1 if library marked this patron as having an unconfirmed address" |
151 |
"description": "set to 1 if library marked this patron as having an unconfirmed address" |
| 152 |
}, |
152 |
}, |
| 153 |
"lost": { |
153 |
"patron_card_lost": { |
| 154 |
"type": ["boolean", "null"], |
154 |
"type": ["boolean", "null"], |
| 155 |
"description": "set to 1 if library marked this patron as having lost his card" |
155 |
"description": "set to 1 if library marked this patron as having lost his card" |
| 156 |
}, |
156 |
}, |
| 157 |
"debarred": { |
157 |
"restricted": { |
| 158 |
"type": ["string", "null"], |
158 |
"type": "boolean", |
| 159 |
"format": "date", |
159 |
"readOnly": true, |
| 160 |
"description": "until this date the patron can only check-in" |
160 |
"description": "If any restriction applies to the patron" |
| 161 |
}, |
|
|
| 162 |
"debarredcomment": { |
| 163 |
"type": ["string", "null"], |
| 164 |
"description": "comment on the stop of the patron" |
| 165 |
}, |
| 166 |
"contactname": { |
| 167 |
"type": ["string", "null"], |
| 168 |
"description": "used for children and professionals to include surname or last name of guarantor or organization name" |
| 169 |
}, |
| 170 |
"contactfirstname": { |
| 171 |
"type": ["string", "null"], |
| 172 |
"description": "used for children to include first name of guarantor" |
| 173 |
}, |
| 174 |
"contacttitle": { |
| 175 |
"type": ["string", "null"], |
| 176 |
"description": "used for children to include title of guarantor" |
| 177 |
}, |
161 |
}, |
| 178 |
"guarantorid": { |
162 |
"guarantor_id": { |
| 179 |
"type": ["integer", "null"], |
163 |
"type": ["integer", "null"], |
| 180 |
"description": "borrowernumber used for children or professionals to link them to guarantor or organizations" |
164 |
"description": "patron_id used for children or professionals to link them to guarantor or organizations" |
| 181 |
}, |
165 |
}, |
| 182 |
"borrowernotes": { |
166 |
"staff_notes": { |
| 183 |
"type": ["string", "null"], |
167 |
"type": ["string", "null"], |
| 184 |
"description": "a note on the patron's account" |
168 |
"description": "a note on the patron's account" |
| 185 |
}, |
169 |
}, |
| 186 |
"relationship": { |
170 |
"relationship_type": { |
| 187 |
"type": ["string", "null"], |
171 |
"type": ["string", "null"], |
| 188 |
"description": "used for children to include the relationship to their guarantor" |
172 |
"description": "used for children to include the relationship to their guarantor" |
| 189 |
}, |
173 |
}, |
| 190 |
"sex": { |
174 |
"gender": { |
| 191 |
"type": ["string", "null"], |
175 |
"type": ["string", "null"], |
| 192 |
"description": "patron's gender" |
176 |
"description": "patron's gender" |
| 193 |
}, |
177 |
}, |
| 194 |
"password": { |
|
|
| 195 |
"type": ["string", "null"], |
| 196 |
"description": "patron's encrypted password" |
| 197 |
}, |
| 198 |
"flags": { |
| 199 |
"type": ["integer", "null"], |
| 200 |
"description": "a number associated with the patron's permissions" |
| 201 |
}, |
| 202 |
"userid": { |
178 |
"userid": { |
| 203 |
"type": ["string", "null"], |
179 |
"type": ["string", "null"], |
| 204 |
"description": "patron's login" |
180 |
"description": "patron's login" |
| 205 |
}, |
181 |
}, |
| 206 |
"opacnote": { |
182 |
"opac_notes": { |
| 207 |
"type": ["string", "null"], |
183 |
"type": ["string", "null"], |
| 208 |
"description": "a note on the patron's account visible in OPAC and staff client" |
184 |
"description": "a note on the patron's account visible in OPAC and staff client" |
| 209 |
}, |
185 |
}, |
| 210 |
"contactnote": { |
186 |
"altaddress_notes": { |
| 211 |
"type": ["string", "null"], |
187 |
"type": ["string", "null"], |
| 212 |
"description": "a note related to patron's alternate address" |
188 |
"description": "a note related to patron's alternate address" |
| 213 |
}, |
189 |
}, |
| 214 |
"sort1": { |
190 |
"statistics_1": { |
| 215 |
"type": ["string", "null"], |
191 |
"type": ["string", "null"], |
| 216 |
"description": "a field that can be used for any information unique to the library" |
192 |
"description": "a field that can be used for any information unique to the library" |
| 217 |
}, |
193 |
}, |
| 218 |
"sort2": { |
194 |
"statistics_2": { |
| 219 |
"type": ["string", "null"], |
195 |
"type": ["string", "null"], |
| 220 |
"description": "a field that can be used for any information unique to the library" |
196 |
"description": "a field that can be used for any information unique to the library" |
| 221 |
}, |
197 |
}, |
| 222 |
"altcontactfirstname": { |
198 |
"altcontact_firstname": { |
| 223 |
"type": ["string", "null"], |
199 |
"type": ["string", "null"], |
| 224 |
"description": "first name of alternate contact for the patron" |
200 |
"description": "first name of alternate contact for the patron" |
| 225 |
}, |
201 |
}, |
| 226 |
"altcontactsurname": { |
202 |
"altcontact_surname": { |
| 227 |
"type": ["string", "null"], |
203 |
"type": ["string", "null"], |
| 228 |
"description": "surname or last name of the alternate contact for the patron" |
204 |
"description": "surname or last name of the alternate contact for the patron" |
| 229 |
}, |
205 |
}, |
| 230 |
"altcontactaddress1": { |
206 |
"altcontact_address": { |
| 231 |
"type": ["string", "null"], |
207 |
"type": ["string", "null"], |
| 232 |
"description": "the first address line for the alternate contact for the patron" |
208 |
"description": "the first address line for the alternate contact for the patron" |
| 233 |
}, |
209 |
}, |
| 234 |
"altcontactaddress2": { |
210 |
"altcontact_address2": { |
| 235 |
"type": ["string", "null"], |
211 |
"type": ["string", "null"], |
| 236 |
"description": "the second address line for the alternate contact for the patron" |
212 |
"description": "the second address line for the alternate contact for the patron" |
| 237 |
}, |
213 |
}, |
| 238 |
"altcontactaddress3": { |
214 |
"altcontact_city": { |
| 239 |
"type": ["string", "null"], |
215 |
"type": ["string", "null"], |
| 240 |
"description": "the city for the alternate contact for the patron" |
216 |
"description": "the city for the alternate contact for the patron" |
| 241 |
}, |
217 |
}, |
| 242 |
"altcontactstate": { |
218 |
"altcontact_state": { |
| 243 |
"type": ["string", "null"], |
219 |
"type": ["string", "null"], |
| 244 |
"description": "the state for the alternate contact for the patron" |
220 |
"description": "the state for the alternate contact for the patron" |
| 245 |
}, |
221 |
}, |
| 246 |
"altcontactzipcode": { |
222 |
"altcontact_postal_code": { |
| 247 |
"type": ["string", "null"], |
223 |
"type": ["string", "null"], |
| 248 |
"description": "the zipcode for the alternate contact for the patron" |
224 |
"description": "the zipcode for the alternate contact for the patron" |
| 249 |
}, |
225 |
}, |
| 250 |
"altcontactcountry": { |
226 |
"altcontact_country": { |
| 251 |
"type": ["string", "null"], |
227 |
"type": ["string", "null"], |
| 252 |
"description": "the country for the alternate contact for the patron" |
228 |
"description": "the country for the alternate contact for the patron" |
| 253 |
}, |
229 |
}, |
| 254 |
"altcontactphone": { |
230 |
"altcontact_phone": { |
| 255 |
"type": ["string", "null"], |
231 |
"type": ["string", "null"], |
| 256 |
"description": "the phone number for the alternate contact for the patron" |
232 |
"description": "the phone number for the alternate contact for the patron" |
| 257 |
}, |
233 |
}, |
| 258 |
"smsalertnumber": { |
234 |
"sms_number": { |
| 259 |
"type": ["string", "null"], |
235 |
"type": ["string", "null"], |
| 260 |
"description": "the mobile phone number where the patron would like to receive notices (if SMS turned on)" |
236 |
"description": "the mobile phone number where the patron would like to receive notices (if SMS turned on)" |
| 261 |
}, |
237 |
}, |
|
Lines 271-277
Link Here
|
| 271 |
"type": "integer", |
247 |
"type": "integer", |
| 272 |
"description": "controls if relatives can see this patron's checkouts" |
248 |
"description": "controls if relatives can see this patron's checkouts" |
| 273 |
}, |
249 |
}, |
| 274 |
"checkprevcheckout": { |
250 |
"check_previous_checkout": { |
| 275 |
"type": "string", |
251 |
"type": "string", |
| 276 |
"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'" |
252 |
"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'" |
| 277 |
}, |
253 |
}, |
|
Lines 280-286
Link Here
|
| 280 |
"format": "date-time", |
256 |
"format": "date-time", |
| 281 |
"description": "time of last change could be useful for synchronization with external systems (among others)" |
257 |
"description": "time of last change could be useful for synchronization with external systems (among others)" |
| 282 |
}, |
258 |
}, |
| 283 |
"lastseen": { |
259 |
"last_seen": { |
| 284 |
"type": ["string", "null"], |
260 |
"type": ["string", "null"], |
| 285 |
"format": "date-time", |
261 |
"format": "date-time", |
| 286 |
"description": "last time a patron has been seen (connected at the OPAC or staff interface)" |
262 |
"description": "last time a patron has been seen (connected at the OPAC or staff interface)" |
|
Lines 299-303
Link Here
|
| 299 |
} |
275 |
} |
| 300 |
}, |
276 |
}, |
| 301 |
"additionalProperties": false, |
277 |
"additionalProperties": false, |
| 302 |
"required": ["surname", "address", "city", "branchcode", "categorycode"] |
278 |
"required": ["surname", "address", "city", "library_id", "category_id"] |
| 303 |
} |
279 |
} |