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

Return to bug 13799