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

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

Return to bug 15126