View | Details | Raw Unified | Return to bug 13799
Collapse All | Expand All

(-)a/api/v1/swagger.json (-67 / +132 lines)
Lines 85-286 Link Here
85
          "$ref": "#/definitions/borrowernumber"
85
          "$ref": "#/definitions/borrowernumber"
86
        },
86
        },
87
        "cardnumber": {
87
        "cardnumber": {
88
          "description": "library assigned ID number for patrons"
88
          "description": "library assigned ID number for patrons",
89
          "type": ["string", "null"]
89
        },
90
        },
90
        "surname": {
91
        "surname": {
91
          "description": "patron's last name"
92
          "description": "patron's last name",
93
          "type": ["string", "null"]
92
        },
94
        },
93
        "firstname": {
95
        "firstname": {
94
          "description": "patron's first name"
96
          "description": "patron's first name",
97
          "type": ["string", "null"]
95
        },
98
        },
96
        "title": {
99
        "title": {
97
          "description": "patron's title"
100
          "description": "patron's title",
101
          "type": ["string", "null"]
98
        },
102
        },
99
        "othernames": {
103
        "othernames": {
100
          "description": "any other names associated with the patron"
104
          "description": "any other names associated with the patron",
105
          "type": ["string", "null"]
101
        },
106
        },
102
        "initials": {
107
        "initials": {
103
          "description": "initials of the patron"
108
          "description": "initials of the patron",
109
          "type": ["string", "null"]
104
        },
110
        },
105
        "streetnumber": {
111
        "streetnumber": {
106
          "description": "street number of patron's primary address"
112
          "description": "street number of patron's primary address",
113
          "type": ["string", "null"]
107
        },
114
        },
108
        "streettype": {
115
        "streettype": {
109
          "description": "street type of patron's primary address"
116
          "description": "street type of patron's primary address",
117
          "type": ["string", "null"]
110
        },
118
        },
111
        "address": {
119
        "address": {
112
          "description": "first address line of patron's primary address"
120
          "description": "first address line of patron's primary address",
121
          "type": ["string", "null"]
113
        },
122
        },
114
        "address2": {
123
        "address2": {
115
          "description": "second address line of patron's primary address"
124
          "description": "second address line of patron's primary address",
125
          "type": ["string", "null"]
116
        },
126
        },
117
        "city": {
127
        "city": {
118
          "description": "city or town of patron's primary address"
128
          "description": "city or town of patron's primary address",
129
          "type": ["string", "null"]
119
        },
130
        },
120
        "state": {
131
        "state": {
121
          "description": "state or province of patron's primary address"
132
          "description": "state or province of patron's primary address",
133
          "type": ["string", "null"]
122
        },
134
        },
123
        "zipcode": {
135
        "zipcode": {
124
          "description": "zip or postal code of patron's primary address"
136
          "description": "zip or postal code of patron's primary address",
137
          "type": ["string", "null"]
125
        },
138
        },
126
        "country": {
139
        "country": {
127
          "description": "country of patron's primary address"
140
          "description": "country of patron's primary address",
141
          "type": ["string", "null"]
128
        },
142
        },
129
        "email": {
143
        "email": {
130
          "description": "primary email address for patron's primary address"
144
          "description": "primary email address for patron's primary address",
145
          "type": ["string", "null"]
131
        },
146
        },
132
        "phone": {
147
        "phone": {
133
          "description": "primary phone number for patron's primary address"
148
          "description": "primary phone number for patron's primary address",
149
          "type": ["string", "null"]
134
        },
150
        },
135
        "mobile": {
151
        "mobile": {
136
          "description": "the other phone number for patron's primary address"
152
          "description": "the other phone number for patron's primary address",
153
          "type": ["string", "null"]
137
        },
154
        },
138
        "fax": {
155
        "fax": {
139
          "description": "fax number for patron's primary address"
156
          "description": "fax number for patron's primary address",
157
          "type": ["string", "null"]
140
        },
158
        },
141
        "emailpro": {
159
        "emailpro": {
142
          "description": "secondary email address for patron's primary address"
160
          "description": "secondary email address for patron's primary address",
161
          "type": ["string", "null"]
143
        },
162
        },
144
        "phonepro": {
163
        "phonepro": {
145
          "description": "secondary phone number for patron's primary address"
164
          "description": "secondary phone number for patron's primary address",
165
          "type": ["string", "null"]
146
        },
166
        },
147
        "B_streetnumber": {
167
        "B_streetnumber": {
148
          "description": "street number of patron's alternate address"
168
          "description": "street number of patron's alternate address",
169
          "type": ["string", "null"]
149
        },
170
        },
150
        "B_streettype": {
171
        "B_streettype": {
151
          "description": "street type of patron's alternate address"
172
          "description": "street type of patron's alternate address",
173
          "type": ["string", "null"]
152
        },
174
        },
153
        "B_address": {
175
        "B_address": {
154
          "description": "first address line of patron's alternate address"
176
          "description": "first address line of patron's alternate address",
177
          "type": ["string", "null"]
155
        },
178
        },
156
        "B_address2": {
179
        "B_address2": {
157
          "description": "second address line of patron's alternate address"
180
          "description": "second address line of patron's alternate address",
181
          "type": ["string", "null"]
158
        },
182
        },
159
        "B_city": {
183
        "B_city": {
160
          "description": "city or town of patron's alternate address"
184
          "description": "city or town of patron's alternate address",
185
          "type": ["string", "null"]
161
        },
186
        },
162
        "B_state": {
187
        "B_state": {
163
          "description": "state or province of patron's alternate address"
188
          "description": "state or province of patron's alternate address",
189
          "type": ["string", "null"]
164
        },
190
        },
165
        "B_zipcode": {
191
        "B_zipcode": {
166
          "description": "zip or postal code of patron's alternate address"
192
          "description": "zip or postal code of patron's alternate address",
193
          "type": ["string", "null"]
167
        },
194
        },
168
        "B_country": {
195
        "B_country": {
169
          "description": "country of patron's alternate address"
196
          "description": "country of patron's alternate address",
197
          "type": ["string", "null"]
170
        },
198
        },
171
        "B_email": {
199
        "B_email": {
172
          "description": "email address for patron's alternate address"
200
          "description": "email address for patron's alternate address",
201
          "type": ["string", "null"]
173
        },
202
        },
174
        "B_phone": {
203
        "B_phone": {
175
          "description": "phone number for patron's alternate address"
204
          "description": "phone number for patron's alternate address",
205
          "type": ["string", "null"]
176
        },
206
        },
177
        "dateofbirth": {
207
        "dateofbirth": {
178
          "description": "patron's date of birth"
208
          "description": "patron's date of birth",
209
          "type": ["string", "null"]
179
        },
210
        },
180
        "branchcode": {
211
        "branchcode": {
181
          "description": "code of patron's home branch"
212
          "description": "code of patron's home branch",
213
          "type": ["string", "null"]
182
        },
214
        },
183
        "categorycode": {
215
        "categorycode": {
184
          "description": "code of patron's category"
216
          "description": "code of patron's category",
217
          "type": ["string", "null"]
185
        },
218
        },
186
        "dateenrolled": {
219
        "dateenrolled": {
187
          "description": "date the patron was added to Koha"
220
          "description": "date the patron was added to Koha",
221
          "type": ["string", "null"]
188
        },
222
        },
189
        "dateexpiry": {
223
        "dateexpiry": {
190
          "description": "date the patron's card is set to expire"
224
          "description": "date the patron's card is set to expire",
225
          "type": ["string", "null"]
191
        },
226
        },
192
        "gonenoaddress": {
227
        "gonenoaddress": {
193
          "description": "set to 1 if library marked this patron as having an unconfirmed address"
228
          "description": "set to 1 if library marked this patron as having an unconfirmed address",
229
          "type": ["string", "null"]
194
        },
230
        },
195
        "lost": {
231
        "lost": {
196
          "description": "set to 1 if library marked this patron as having lost his card"
232
          "description": "set to 1 if library marked this patron as having lost his card",
233
          "type": ["string", "null"]
197
        },
234
        },
198
        "debarred": {
235
        "debarred": {
199
          "description": "until this date the patron can only check-in"
236
          "description": "until this date the patron can only check-in",
237
          "type": ["string", "null"]
200
        },
238
        },
201
        "debarredcomment": {
239
        "debarredcomment": {
202
          "description": "comment on the stop of the patron"
240
          "description": "comment on the stop of the patron",
241
          "type": ["string", "null"]
203
        },
242
        },
204
        "contactname": {
243
        "contactname": {
205
          "description": "used for children and professionals to include surname or last name of guarantor or organization name"
244
          "description": "used for children and professionals to include surname or last name of guarantor or organization name",
245
          "type": ["string", "null"]
206
        },
246
        },
207
        "contactfirstname": {
247
        "contactfirstname": {
208
          "description": "used for children to include first name of guarantor"
248
          "description": "used for children to include first name of guarantor",
249
          "type": ["string", "null"]
209
        },
250
        },
210
        "contacttitle": {
251
        "contacttitle": {
211
          "description": "used for children to include title of guarantor"
252
          "description": "used for children to include title of guarantor",
253
          "type": ["string", "null"]
212
        },
254
        },
213
        "guarantorid": {
255
        "guarantorid": {
214
          "description": "borrowernumber used for children or professionals to link them to guarantor or organizations"
256
          "description": "borrowernumber used for children or professionals to link them to guarantor or organizations",
257
          "type": ["string", "null"]
215
        },
258
        },
216
        "borrowernotes": {
259
        "borrowernotes": {
217
          "description": "a note on the patron's account"
260
          "description": "a note on the patron's account",
261
          "type": ["string", "null"]
218
        },
262
        },
219
        "relationship": {
263
        "relationship": {
220
          "description": "used for children to include the relationship to their guarantor"
264
          "description": "used for children to include the relationship to their guarantor",
265
          "type": ["string", "null"]
221
        },
266
        },
222
        "ethnicity": {
267
        "ethnicity": {
223
          "description": "unused"
268
          "description": "unused",
269
          "type": ["string", "null"]
224
        },
270
        },
225
        "ethnotes": {
271
        "ethnotes": {
226
          "description": "unused"
272
          "description": "unused",
273
          "type": ["string", "null"]
227
        },
274
        },
228
        "sex": {
275
        "sex": {
229
          "description": "patron's gender"
276
          "description": "patron's gender",
277
          "type": ["string", "null"]
230
        },
278
        },
231
        "password": {
279
        "password": {
232
          "description": "patron's encrypted password"
280
          "description": "patron's encrypted password",
281
          "type": ["string", "null"]
233
        },
282
        },
234
        "flags": {
283
        "flags": {
235
          "description": "a number associated with the patron's permissions"
284
          "description": "a number associated with the patron's permissions",
285
          "type": ["string", "null"]
236
        },
286
        },
237
        "userid": {
287
        "userid": {
238
          "description": "patron's login"
288
          "description": "patron's login",
289
          "type": ["string", "null"]
239
        },
290
        },
240
        "opacnote": {
291
        "opacnote": {
241
          "description": "a note on the patron's account visible in OPAC and staff client"
292
          "description": "a note on the patron's account visible in OPAC and staff client",
293
          "type": ["string", "null"]
242
        },
294
        },
243
        "contactnote": {
295
        "contactnote": {
244
          "description": "a note related to patron's alternate address"
296
          "description": "a note related to patron's alternate address",
297
          "type": ["string", "null"]
245
        },
298
        },
246
        "sort1": {
299
        "sort1": {
247
          "description": "a field that can be used for any information unique to the library"
300
          "description": "a field that can be used for any information unique to the library",
301
          "type": ["string", "null"]
248
        },
302
        },
249
        "sort2": {
303
        "sort2": {
250
          "description": "a field that can be used for any information unique to the library"
304
          "description": "a field that can be used for any information unique to the library",
305
          "type": ["string", "null"]
251
        },
306
        },
252
        "altcontactfirstname": {
307
        "altcontactfirstname": {
253
          "description": "first name of alternate contact for the patron"
308
          "description": "first name of alternate contact for the patron",
309
          "type": ["string", "null"]
254
        },
310
        },
255
        "altcontactsurname": {
311
        "altcontactsurname": {
256
          "description": "surname or last name of the alternate contact for the patron"
312
          "description": "surname or last name of the alternate contact for the patron",
313
          "type": ["string", "null"]
257
        },
314
        },
258
        "altcontactaddress1": {
315
        "altcontactaddress1": {
259
          "description": "the first address line for the alternate contact for the patron"
316
          "description": "the first address line for the alternate contact for the patron",
317
          "type": ["string", "null"]
260
        },
318
        },
261
        "altcontactaddress2": {
319
        "altcontactaddress2": {
262
          "description": "the second address line for the alternate contact for the patron"
320
          "description": "the second address line for the alternate contact for the patron",
321
          "type": ["string", "null"]
263
        },
322
        },
264
        "altcontactaddress3": {
323
        "altcontactaddress3": {
265
          "description": "the city for the alternate contact for the patron"
324
          "description": "the city for the alternate contact for the patron",
325
          "type": ["string", "null"]
266
        },
326
        },
267
        "altcontactstate": {
327
        "altcontactstate": {
268
          "description": "the state for the alternate contact for the patron"
328
          "description": "the state for the alternate contact for the patron",
329
          "type": ["string", "null"]
269
        },
330
        },
270
        "altcontactzipcode": {
331
        "altcontactzipcode": {
271
          "description": "the zipcode for the alternate contact for the patron"
332
          "description": "the zipcode for the alternate contact for the patron",
333
          "type": ["string", "null"]
272
        },
334
        },
273
        "altcontactcountry": {
335
        "altcontactcountry": {
274
          "description": "the country for the alternate contact for the patron"
336
          "description": "the country for the alternate contact for the patron",
337
          "type": ["string", "null"]
275
        },
338
        },
276
        "altcontactphone": {
339
        "altcontactphone": {
277
          "description": "the phone number for the alternate contact for the patron"
340
          "description": "the phone number for the alternate contact for the patron",
341
          "type": ["string", "null"]
278
        },
342
        },
279
        "smsalertnumber": {
343
        "smsalertnumber": {
280
          "description": "the mobile phone number where the patron would like to receive notices (if SMS turned on)"
344
          "description": "the mobile phone number where the patron would like to receive notices (if SMS turned on)",
345
          "type": ["string", "null"]
281
        },
346
        },
282
        "privacy": {
347
        "privacy": {
283
          "description": "patron's privacy settings related to their reading history"
348
          "description": "patron's privacy settings related to their reading history",
349
          "type": ["string", "null"]
284
        }
350
        }
285
      }
351
      }
286
    },
352
    },
287
- 

Return to bug 13799