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

(-)a/api/v1/definitions/hold.json (-64 / +64 lines)
Lines 1-67 Link Here
1
{
1
{
2
    "type": "object",
2
  "type": "object",
3
    "properties": {
3
  "properties": {
4
        "reserve_id": {
4
    "reserve_id": {
5
            "description": "Internal hold identifier"
5
      "description": "Internal hold identifier"
6
        },
6
    },
7
        "borrowernumber": {
7
    "borrowernumber": {
8
            "type": "string",
8
      "type": "string",
9
            "description": "internally assigned user identifier"
9
      "description": "internally assigned user identifier"
10
        },
10
    },
11
        "reservedate": {
11
    "reservedate": {
12
            "description": "the date the hold was placed"
12
      "description": "the date the hold was placed"
13
        },
13
    },
14
        "biblionumber": {
14
    "biblionumber": {
15
            "type": "string",
15
      "type": "string",
16
            "description": "internally assigned biblio identifier"
16
      "description": "internally assigned biblio identifier"
17
        },
17
    },
18
        "branchcode": {
18
    "branchcode": {
19
            "type": ["string", "null"],
19
      "type": ["string", "null"],
20
            "description": "internally assigned branch identifier"
20
      "description": "internally assigned branch identifier"
21
        },
21
    },
22
        "notificationdate": {
22
    "notificationdate": {
23
            "description": "currently unused"
23
      "description": "currently unused"
24
        },
24
    },
25
        "reminderdate": {
25
    "reminderdate": {
26
            "description": "currently unused"
26
      "description": "currently unused"
27
        },
27
    },
28
        "cancellationdate": {
28
    "cancellationdate": {
29
            "description": "the date the hold was cancelled"
29
      "description": "the date the hold was cancelled"
30
        },
30
    },
31
        "reservenotes": {
31
    "reservenotes": {
32
            "description": "notes related to this hold"
32
      "description": "notes related to this hold"
33
        },
33
    },
34
        "priority": {
34
    "priority": {
35
            "description": "where in the queue the patron sits"
35
      "description": "where in the queue the patron sits"
36
        },
36
    },
37
        "found": {
37
    "found": {
38
            "description": "a one letter code defining what the status of the hold is after it has been confirmed"
38
      "description": "a one letter code defining what the status of the hold is after it has been confirmed"
39
        },
39
    },
40
        "timestamp": {
40
    "timestamp": {
41
            "description": "date and time the hold was last updated"
41
      "description": "date and time the hold was last updated"
42
        },
42
    },
43
        "itemnumber": {
43
    "itemnumber": {
44
            "type": ["string", "null"],
44
      "type": ["string", "null"],
45
            "description": "internally assigned item identifier"
45
      "description": "internally assigned item identifier"
46
        },
46
    },
47
        "waitingdate": {
47
    "waitingdate": {
48
            "description": "the date the item was marked as waiting for the patron at the library"
48
      "description": "the date the item was marked as waiting for the patron at the library"
49
        },
49
    },
50
        "expirationdate": {
50
    "expirationdate": {
51
            "description": "the date the hold expires"
51
      "description": "the date the hold expires"
52
        },
52
    },
53
        "lowestPriority": {
53
    "lowestPriority": {
54
            "description": ""
54
      "description": ""
55
        },
55
    },
56
        "suspend": {
56
    "suspend": {
57
            "description": ""
57
      "description": ""
58
        },
58
    },
59
        "suspend_until": {
59
    "suspend_until": {
60
            "description": ""
60
      "description": ""
61
        },
61
    },
62
        "itemtype": {
62
    "itemtype": {
63
            "type": ["string", "null"],
63
      "type": ["string", "null"],
64
            "description": "If record level hold, the optional itemtype of the item the patron is requesting"
64
      "description": "If record level hold, the optional itemtype of the item the patron is requesting"
65
        }
66
    }
65
    }
66
  }
67
}
67
}
(-)a/api/v1/definitions/holds.json (-2 / +4 lines)
Lines 1-4 Link Here
1
{
1
{
2
    "type": "array",
2
  "type": "array",
3
    "items": { "$ref": "hold.json" }
3
  "items": {
4
    "$ref": "hold.json"
5
  }
4
}
6
}
(-)a/api/v1/definitions/patron.json (-280 / +279 lines)
Lines 1-281 Link Here
1
{
1
{
2
      "type": "object",
2
  "type": "object",
3
      "properties": {
3
  "properties": {
4
        "borrowernumber": {
4
    "borrowernumber": {
5
          "type": "string",
5
      "type": "string",
6
          "description": "internally assigned user identifier"
6
      "description": "internally assigned user identifier"
7
        },
7
    },
8
        "cardnumber": {
8
    "cardnumber": {
9
          "type": ["string", "null"],
9
      "type": ["string", "null"],
10
          "description": "library assigned user identifier"
10
      "description": "library assigned user identifier"
11
        },
11
    },
12
        "surname": {
12
    "surname": {
13
          "type": "string",
13
      "type": "string",
14
          "description": "patron's last name"
14
      "description": "patron's last name"
15
        },
15
    },
16
        "firstname": {
16
    "firstname": {
17
          "type": ["string", "null"],
17
      "type": ["string", "null"],
18
          "description": "patron's first name"
18
      "description": "patron's first name"
19
        },
19
    },
20
        "title": {
20
    "title": {
21
          "type": ["string", "null"],
21
      "type": ["string", "null"],
22
          "description": "patron's title"
22
      "description": "patron's title"
23
        },
23
    },
24
        "othernames": {
24
    "othernames": {
25
          "type": ["string", "null"],
25
      "type": ["string", "null"],
26
          "description": "any other names associated with the patron"
26
      "description": "any other names associated with the patron"
27
        },
27
    },
28
        "initials": {
28
    "initials": {
29
          "type": ["string", "null"],
29
      "type": ["string", "null"],
30
          "description": "initials of the patron"
30
      "description": "initials of the patron"
31
        },
31
    },
32
        "streetnumber": {
32
    "streetnumber": {
33
          "type": ["string", "null"],
33
      "type": ["string", "null"],
34
          "description": "street number of patron's primary address"
34
      "description": "street number of patron's primary address"
35
        },
35
    },
36
        "streettype": {
36
    "streettype": {
37
          "type": ["string", "null"],
37
      "type": ["string", "null"],
38
          "description": "street type of patron's primary address"
38
      "description": "street type of patron's primary address"
39
        },
39
    },
40
        "address": {
40
    "address": {
41
          "type": "string",
41
      "type": "string",
42
          "description": "first address line of patron's primary address"
42
      "description": "first address line of patron's primary address"
43
        },
43
    },
44
        "address2": {
44
    "address2": {
45
          "type": ["string", "null"],
45
      "type": ["string", "null"],
46
          "description": "second address line of patron's primary address"
46
      "description": "second address line of patron's primary address"
47
        },
47
    },
48
        "city": {
48
    "city": {
49
          "type": "string",
49
      "type": "string",
50
          "description": "city or town of patron's primary address"
50
      "description": "city or town of patron's primary address"
51
        },
51
    },
52
        "state": {
52
    "state": {
53
          "type": ["string", "null"],
53
      "type": ["string", "null"],
54
          "description": "state or province of patron's primary address"
54
      "description": "state or province of patron's primary address"
55
        },
55
    },
56
        "zipcode": {
56
    "zipcode": {
57
          "type": ["string", "null"],
57
      "type": ["string", "null"],
58
          "description": "zip or postal code of patron's primary address"
58
      "description": "zip or postal code of patron's primary address"
59
        },
59
    },
60
        "country": {
60
    "country": {
61
          "type": ["string", "null"],
61
      "type": ["string", "null"],
62
          "description": "country of patron's primary address"
62
      "description": "country of patron's primary address"
63
        },
63
    },
64
        "email": {
64
    "email": {
65
          "type": ["string", "null"],
65
      "type": ["string", "null"],
66
          "description": "primary email address for patron's primary address"
66
      "description": "primary email address for patron's primary address"
67
        },
67
    },
68
        "phone": {
68
    "phone": {
69
          "type": ["string", "null"],
69
      "type": ["string", "null"],
70
          "description": "primary phone number for patron's primary address"
70
      "description": "primary phone number for patron's primary address"
71
        },
71
    },
72
        "mobile": {
72
    "mobile": {
73
          "type": ["string", "null"],
73
      "type": ["string", "null"],
74
          "description": "the other phone number for patron's primary address"
74
      "description": "the other phone number for patron's primary address"
75
        },
75
    },
76
        "fax": {
76
    "fax": {
77
          "type": ["string", "null"],
77
      "type": ["string", "null"],
78
          "description": "fax number for patron's primary address"
78
      "description": "fax number for patron's primary address"
79
        },
79
    },
80
        "emailpro": {
80
    "emailpro": {
81
          "type": ["string", "null"],
81
      "type": ["string", "null"],
82
          "description": "secondary email address for patron's primary address"
82
      "description": "secondary email address for patron's primary address"
83
        },
83
    },
84
        "phonepro": {
84
    "phonepro": {
85
          "type": ["string", "null"],
85
      "type": ["string", "null"],
86
          "description": "secondary phone number for patron's primary address"
86
      "description": "secondary phone number for patron's primary address"
87
        },
87
    },
88
        "B_streetnumber": {
88
    "B_streetnumber": {
89
          "type": ["string", "null"],
89
      "type": ["string", "null"],
90
          "description": "street number of patron's alternate address"
90
      "description": "street number of patron's alternate address"
91
        },
91
    },
92
        "B_streettype": {
92
    "B_streettype": {
93
          "type": ["string", "null"],
93
      "type": ["string", "null"],
94
          "description": "street type of patron's alternate address"
94
      "description": "street type of patron's alternate address"
95
        },
95
    },
96
        "B_address": {
96
    "B_address": {
97
          "type": ["string", "null"],
97
      "type": ["string", "null"],
98
          "description": "first address line of patron's alternate address"
98
      "description": "first address line of patron's alternate address"
99
        },
99
    },
100
        "B_address2": {
100
    "B_address2": {
101
          "type": ["string", "null"],
101
      "type": ["string", "null"],
102
          "description": "second address line of patron's alternate address"
102
      "description": "second address line of patron's alternate address"
103
        },
103
    },
104
        "B_city": {
104
    "B_city": {
105
          "type": ["string", "null"],
105
      "type": ["string", "null"],
106
          "description": "city or town of patron's alternate address"
106
      "description": "city or town of patron's alternate address"
107
        },
107
    },
108
        "B_state": {
108
    "B_state": {
109
          "type": ["string", "null"],
109
      "type": ["string", "null"],
110
          "description": "state or province of patron's alternate address"
110
      "description": "state or province of patron's alternate address"
111
        },
111
    },
112
        "B_zipcode": {
112
    "B_zipcode": {
113
          "type": ["string", "null"],
113
      "type": ["string", "null"],
114
          "description": "zip or postal code of patron's alternate address"
114
      "description": "zip or postal code of patron's alternate address"
115
        },
115
    },
116
        "B_country": {
116
    "B_country": {
117
          "type": ["string", "null"],
117
      "type": ["string", "null"],
118
          "description": "country of patron's alternate address"
118
      "description": "country of patron's alternate address"
119
        },
119
    },
120
        "B_email": {
120
    "B_email": {
121
          "type": ["string", "null"],
121
      "type": ["string", "null"],
122
          "description": "email address for patron's alternate address"
122
      "description": "email address for patron's alternate address"
123
        },
123
    },
124
        "B_phone": {
124
    "B_phone": {
125
          "type": ["string", "null"],
125
      "type": ["string", "null"],
126
          "description": "phone number for patron's alternate address"
126
      "description": "phone number for patron's alternate address"
127
        },
127
    },
128
        "dateofbirth": {
128
    "dateofbirth": {
129
          "type": ["string", "null"],
129
      "type": ["string", "null"],
130
          "description": "patron's date of birth"
130
      "description": "patron's date of birth"
131
        },
131
    },
132
        "branchcode": {
132
    "branchcode": {
133
          "type": "string",
133
      "type": "string",
134
          "description": "code of patron's home branch"
134
      "description": "code of patron's home branch"
135
        },
135
    },
136
        "categorycode": {
136
    "categorycode": {
137
          "type": "string",
137
      "type": "string",
138
          "description": "code of patron's category"
138
      "description": "code of patron's category"
139
        },
139
    },
140
        "dateenrolled": {
140
    "dateenrolled": {
141
          "type": ["string", "null"],
141
      "type": ["string", "null"],
142
          "description": "date the patron was added to Koha"
142
      "description": "date the patron was added to Koha"
143
        },
143
    },
144
        "dateexpiry": {
144
    "dateexpiry": {
145
          "type": ["string", "null"],
145
      "type": ["string", "null"],
146
          "description": "date the patron's card is set to expire"
146
      "description": "date the patron's card is set to expire"
147
        },
147
    },
148
        "gonenoaddress": {
148
    "gonenoaddress": {
149
          "type": ["string", "null"],
149
      "type": ["string", "null"],
150
          "description": "set to 1 if library marked this patron as having an unconfirmed address"
150
      "description": "set to 1 if library marked this patron as having an unconfirmed address"
151
        },
151
    },
152
        "lost": {
152
    "lost": {
153
          "type": ["string", "null"],
153
      "type": ["string", "null"],
154
          "description": "set to 1 if library marked this patron as having lost his card"
154
      "description": "set to 1 if library marked this patron as having lost his card"
155
        },
155
    },
156
        "debarred": {
156
    "debarred": {
157
          "type": ["string", "null"],
157
      "type": ["string", "null"],
158
          "description": "until this date the patron can only check-in"
158
      "description": "until this date the patron can only check-in"
159
        },
159
    },
160
        "debarredcomment": {
160
    "debarredcomment": {
161
          "type": ["string", "null"],
161
      "type": ["string", "null"],
162
          "description": "comment on the stop of the patron"
162
      "description": "comment on the stop of the patron"
163
        },
163
    },
164
        "contactname": {
164
    "contactname": {
165
          "type": ["string", "null"],
165
      "type": ["string", "null"],
166
          "description": "used for children and professionals to include surname or last name of guarantor or organization name"
166
      "description": "used for children and professionals to include surname or last name of guarantor or organization name"
167
        },
167
    },
168
        "contactfirstname": {
168
    "contactfirstname": {
169
          "type": ["string", "null"],
169
      "type": ["string", "null"],
170
          "description": "used for children to include first name of guarantor"
170
      "description": "used for children to include first name of guarantor"
171
        },
171
    },
172
        "contacttitle": {
172
    "contacttitle": {
173
          "type": ["string", "null"],
173
      "type": ["string", "null"],
174
          "description": "used for children to include title of guarantor"
174
      "description": "used for children to include title of guarantor"
175
        },
175
    },
176
        "guarantorid": {
176
    "guarantorid": {
177
          "type": ["string", "null"],
177
      "type": ["string", "null"],
178
          "description": "borrowernumber used for children or professionals to link them to guarantor or organizations"
178
      "description": "borrowernumber used for children or professionals to link them to guarantor or organizations"
179
        },
179
    },
180
        "borrowernotes": {
180
    "borrowernotes": {
181
          "type": ["string", "null"],
181
      "type": ["string", "null"],
182
          "description": "a note on the patron's account"
182
      "description": "a note on the patron's account"
183
        },
183
    },
184
        "relationship": {
184
    "relationship": {
185
          "type": ["string", "null"],
185
      "type": ["string", "null"],
186
          "description": "used for children to include the relationship to their guarantor"
186
      "description": "used for children to include the relationship to their guarantor"
187
        },
187
    },
188
        "sex": {
188
    "sex": {
189
          "type": ["string", "null"],
189
      "type": ["string", "null"],
190
          "description": "patron's gender"
190
      "description": "patron's gender"
191
        },
191
    },
192
        "password": {
192
    "password": {
193
          "type": ["string", "null"],
193
      "type": ["string", "null"],
194
          "description": "patron's encrypted password"
194
      "description": "patron's encrypted password"
195
        },
195
    },
196
        "flags": {
196
    "flags": {
197
          "type": ["string", "null"],
197
      "type": ["string", "null"],
198
          "description": "a number associated with the patron's permissions"
198
      "description": "a number associated with the patron's permissions"
199
        },
199
    },
200
        "userid": {
200
    "userid": {
201
          "type": ["string", "null"],
201
      "type": ["string", "null"],
202
          "description": "patron's login"
202
      "description": "patron's login"
203
        },
203
    },
204
        "opacnote": {
204
    "opacnote": {
205
          "type": ["string", "null"],
205
      "type": ["string", "null"],
206
          "description": "a note on the patron's account visible in OPAC and staff client"
206
      "description": "a note on the patron's account visible in OPAC and staff client"
207
        },
207
    },
208
        "contactnote": {
208
    "contactnote": {
209
          "type": ["string", "null"],
209
      "type": ["string", "null"],
210
          "description": "a note related to patron's alternate address"
210
      "description": "a note related to patron's alternate address"
211
        },
211
    },
212
        "sort1": {
212
    "sort1": {
213
          "type": ["string", "null"],
213
      "type": ["string", "null"],
214
          "description": "a field that can be used for any information unique to the library"
214
      "description": "a field that can be used for any information unique to the library"
215
        },
215
    },
216
        "sort2": {
216
    "sort2": {
217
          "type": ["string", "null"],
217
      "type": ["string", "null"],
218
          "description": "a field that can be used for any information unique to the library"
218
      "description": "a field that can be used for any information unique to the library"
219
        },
219
    },
220
        "altcontactfirstname": {
220
    "altcontactfirstname": {
221
          "type": ["string", "null"],
221
      "type": ["string", "null"],
222
          "description": "first name of alternate contact for the patron"
222
      "description": "first name of alternate contact for the patron"
223
        },
223
    },
224
        "altcontactsurname": {
224
    "altcontactsurname": {
225
          "type": ["string", "null"],
225
      "type": ["string", "null"],
226
          "description": "surname or last name of the alternate contact for the patron"
226
      "description": "surname or last name of the alternate contact for the patron"
227
        },
227
    },
228
        "altcontactaddress1": {
228
    "altcontactaddress1": {
229
          "type": ["string", "null"],
229
      "type": ["string", "null"],
230
          "description": "the first address line for the alternate contact for the patron"
230
      "description": "the first address line for the alternate contact for the patron"
231
        },
231
    },
232
        "altcontactaddress2": {
232
    "altcontactaddress2": {
233
          "type": ["string", "null"],
233
      "type": ["string", "null"],
234
          "description": "the second address line for the alternate contact for the patron"
234
      "description": "the second address line for the alternate contact for the patron"
235
        },
235
    },
236
        "altcontactaddress3": {
236
    "altcontactaddress3": {
237
          "type": ["string", "null"],
237
      "type": ["string", "null"],
238
          "description": "the city for the alternate contact for the patron"
238
      "description": "the city for the alternate contact for the patron"
239
        },
239
    },
240
        "altcontactstate": {
240
    "altcontactstate": {
241
          "type": ["string", "null"],
241
      "type": ["string", "null"],
242
          "description": "the state for the alternate contact for the patron"
242
      "description": "the state for the alternate contact for the patron"
243
        },
243
    },
244
        "altcontactzipcode": {
244
    "altcontactzipcode": {
245
          "type": ["string", "null"],
245
      "type": ["string", "null"],
246
          "description": "the zipcode for the alternate contact for the patron"
246
      "description": "the zipcode for the alternate contact for the patron"
247
        },
247
    },
248
        "altcontactcountry": {
248
    "altcontactcountry": {
249
          "type": ["string", "null"],
249
      "type": ["string", "null"],
250
          "description": "the country for the alternate contact for the patron"
250
      "description": "the country for the alternate contact for the patron"
251
        },
251
    },
252
        "altcontactphone": {
252
    "altcontactphone": {
253
          "type": ["string", "null"],
253
      "type": ["string", "null"],
254
          "description": "the phone number for the alternate contact for the patron"
254
      "description": "the phone number for the alternate contact for the patron"
255
        },
255
    },
256
        "smsalertnumber": {
256
    "smsalertnumber": {
257
          "type": ["string", "null"],
257
      "type": ["string", "null"],
258
          "description": "the mobile phone number where the patron would like to receive notices (if SMS turned on)"
258
      "description": "the mobile phone number where the patron would like to receive notices (if SMS turned on)"
259
        },
259
    },
260
        "sms_provider_id": {
260
    "sms_provider_id": {
261
          "type": ["string", "null"],
261
      "type": ["string", "null"],
262
          "description": "the provider of the mobile phone number defined in smsalertnumber"
262
      "description": "the provider of the mobile phone number defined in smsalertnumber"
263
        },
263
    },
264
        "privacy": {
264
    "privacy": {
265
          "type": "string",
265
      "type": "string",
266
          "description": "patron's privacy settings related to their reading history"
266
      "description": "patron's privacy settings related to their reading history"
267
        },
267
    },
268
        "privacy_guarantor_checkouts": {
268
    "privacy_guarantor_checkouts": {
269
          "type": "string",
269
      "type": "string",
270
          "description": "controls if relatives can see this patron's checkouts"
270
      "description": "controls if relatives can see this patron's checkouts"
271
        },
271
    },
272
        "checkprevcheckout": {
272
    "checkprevcheckout": {
273
          "type": "string",
273
      "type": "string",
274
          "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'"
274
      "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'"
275
        },
275
    },
276
        "updated_on": {
276
    "updated_on": {
277
          "type": "string",
277
      "type": "string",
278
          "description": "time of last change could be useful for synchronization with external systems (among others)"
278
      "description": "time of last change could be useful for synchronization with external systems (among others)"
279
        }
279
    }
280
      }
280
  }
281
}
281
}
282
- 

Return to bug 16699