Skip to content

Commit 60d2b1b

Browse files
Merge pull request #22 from multnomah-county-it/dev
Dev
2 parents a1345f2 + 02a0401 commit 60d2b1b

4 files changed

Lines changed: 978 additions & 3268 deletions

File tree

README.md

Lines changed: 144 additions & 136 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ uid
2121

2222
Output:
2323
```
24-
<USER>
25-
<USER_INFO>
26-
<USER_BARCODE>21168045392313</USER_BARCODE>
27-
<USER_KEY>445800</USER_KEY>
28-
<USER_LIBRARY>NPO</USER_LIBRARY>
29-
<USER_BARCODE_EXPIRATION>99990101</USER_BARCODE_EXPIRATION>
30-
</USER_INFO>
31-
</USER>
24+
<USER>
25+
<USER_INFO>
26+
<USER_BARCODE>21168045392313</USER_BARCODE>
27+
<USER_KEY>445800</USER_KEY>
28+
<USER_LIBRARY>NPO</USER_LIBRARY>
29+
<USER_BARCODE_EXPIRATION>99990101</USER_BARCODE_EXPIRATION>
30+
</USER_INFO>
31+
</USER>
3232
```
3333

3434
### _userbarcode_ – returns user key/user barcode/home library/barcode expiration date when querying a user key
@@ -42,14 +42,14 @@ ukey
4242

4343
Output:
4444
```
45-
<USER>
46-
<USER_INFO>
47-
<USER_BARCODE>21168045392313</USER_BARCODE>
48-
<USER_KEY>445800</USER_KEY>
49-
<USER_LIBRARY>NPO</USER_LIBRARY>
50-
<USER_BARCODE_EXPIRATION>99990101</USER_BARCODE_EXPIRATION>
51-
</USER_INFO>
52-
</USER>
45+
<USER>
46+
<USER_INFO>
47+
<USER_BARCODE>21168045392313</USER_BARCODE>
48+
<USER_KEY>445800</USER_KEY>
49+
<USER_LIBRARY>NPO</USER_LIBRARY>
50+
<USER_BARCODE_EXPIRATION>99990101</USER_BARCODE_EXPIRATION>
51+
</USER_INFO>
52+
</USER>
5353
```
5454

5555
### _holds_ – returns barcode and item hold available for pickup and not yet filled, when querying a user barcode
@@ -63,37 +63,39 @@ uid
6363

6464
Output:
6565
```
66-
<USER>
67-
<USER_BARCODE>21967002133994</USER_BARCODE>
68-
<HOLDS>
69-
<HOLD_ITEM>
70-
<HOLD_BARCODE>31967011537878</HOLD_BARCODE>
71-
<HOLD_TITLE>The violets of March : a novel / Sarah Jio</HOLD_TITLE>
72-
<HOLD_AVAILABLE_DATE>20110621</HOLD_AVAILABLE_DATE>
73-
<HOLD_PICKUP_LOCATION>JBBB</HOLD_PICKUP_LOCATION>
74-
<HOLD_PICKUP_DATE>20110626</HOLD_PICKUP_DATE>
75-
< HOLD_DB_KEY>1234566</HOLD_DB_KEY >
76-
</HOLD_ITEM>
77-
<HOLD_ITEM>
78-
<HOLD_BARCODE>31967012061787</HOLD_BARCODE>
79-
<HOLD_TITLE>The search / Nora Roberts</HOLD_TITLE>
80-
<HOLD_AVAILABLE_DATE>20110620</HOLD_AVAILABLE_DATE>
81-
<HOLD_PICKUP_LOCATION>JBBB</HOLD_PICKUP_LOCATION>
82-
<HOLD_PICKUP_DATE>20110625</HOLD_PICKUP_DATE>
83-
<HOLD_DB_KEY>1234567</HOLD_DB_KEY >
84-
</HOLD_ITEM>
85-
</HOLDS>
86-
<HOLDS_UNAVAILABLE>
87-
<HOLD_ITEM_UNAVAILABLE>
88-
<HOLD_TITLE_UNAVAILABLE>Battlestar Galactica. Season 3</HOLD_TITLE_UNAVAILABLE>
89-
<HOLD_DB_KEY>6492350</HOLD_DB_KEY>
90-
</HOLD_ITEM_UNAVAILABLE>
91-
<HOLD_ITEM_UNAVAILABLE>
92-
<HOLD_TITLE_UNAVAILABLE>Battlestar Galactica. Season 2.5</HOLD_TITLE_UNAVAILABLE>
93-
<HOLD_DB_KEY>6492352</HOLD_DB_KEY>
94-
</HOLD_ITEM_UNAVAILABLE>
95-
</HOLDS_UNAVAILABLE>
96-
</USER>
66+
<USER>
67+
<USER_BARCODE>21967002133994</USER_BARCODE>
68+
<HOLDS>
69+
<HOLD_ITEM>
70+
<HOLD_BARCODE>31967011537878</HOLD_BARCODE>
71+
<HOLD_ITEM_KEY>1399486:1:2</HOLD_ITEM_KEY>
72+
<HOLD_TITLE>The violets of March : a novel / Sarah Jio</HOLD_TITLE>
73+
<HOLD_AVAILABLE_DATE>20110621</HOLD_AVAILABLE_DATE>
74+
<HOLD_PICKUP_LOCATION>JBBB</HOLD_PICKUP_LOCATION>
75+
<HOLD_PICKUP_DATE>20110626</HOLD_PICKUP_DATE>
76+
< HOLD_DB_KEY>1234566</HOLD_DB_KEY >
77+
</HOLD_ITEM>
78+
<HOLD_ITEM>
79+
<HOLD_BARCODE>31967012061787</HOLD_BARCODE>
80+
<HOLD_ITEM_KEY>1399486:1:3</HOLD_ITEM_KEY>
81+
<HOLD_TITLE>The search / Nora Roberts</HOLD_TITLE>
82+
<HOLD_AVAILABLE_DATE>20110620</HOLD_AVAILABLE_DATE>
83+
<HOLD_PICKUP_LOCATION>JBBB</HOLD_PICKUP_LOCATION>
84+
<HOLD_PICKUP_DATE>20110625</HOLD_PICKUP_DATE>
85+
<HOLD_DB_KEY>1234567</HOLD_DB_KEY >
86+
</HOLD_ITEM>
87+
</HOLDS>
88+
<HOLDS_UNAVAILABLE>
89+
<HOLD_ITEM_UNAVAILABLE>
90+
<HOLD_TITLE_UNAVAILABLE>Battlestar Galactica. Season 3</HOLD_TITLE_UNAVAILABLE>
91+
<HOLD_DB_KEY>6492350</HOLD_DB_KEY>
92+
</HOLD_ITEM_UNAVAILABLE>
93+
<HOLD_ITEM_UNAVAILABLE>
94+
<HOLD_TITLE_UNAVAILABLE>Battlestar Galactica. Season 2.5</HOLD_TITLE_UNAVAILABLE>
95+
<HOLD_DB_KEY>6492352</HOLD_DB_KEY>
96+
</HOLD_ITEM_UNAVAILABLE>
97+
</HOLDS_UNAVAILABLE>
98+
</USER>
9799
```
98100

99101
`</HOLD_DB_KEY>` is needed to enable the cancellation of this item hold.
@@ -109,35 +111,39 @@ uid
109111

110112
Output:
111113
```
112-
<USER>
113-
<USER_BARCODE>21967002133994</USER_BARCODE>
114-
<COURTESY>
115-
<COURTESY_ITEM>
116-
<COURTESY_BARCODE>31967010702333</COURTESY_BARCODE>
117-
<COURTESY_TITLE>Snacktime! / Barenaked Ladies</COURTESY_TITLE>
118-
<COURTESY_DUE_DATE>20110624</COURTESY_DUE_DATE>
119-
<COURTESY_RENEW_FLAG/>
120-
</COURTESY_ITEM>
121-
<COURTESY_ITEM>
122-
<COURTESY_BARCODE>31967011418475</COURTESY_BARCODE>
123-
<COURTESY_TITLE>But not the hippopotamus / by Sandra Boynton</COURTESY_TITLE>
124-
<COURTESY_DUE_DATE>20110624</COURTESY_DUE_DATE>
125-
<COURTESY_RENEW_FLAG/>
126-
</COURTESY_ITEM>
127-
<COURTESY_ITEM>
128-
<COURTESY_BARCODE>31967011418236</COURTESY_BARCODE>
129-
<COURTESY_TITLE>The going to bed book / by Sandra Boynton</COURTESY_TITLE>
130-
<COURTESY_DUE_DATE>20110624</COURTESY_DUE_DATE>
131-
<COURTESY_RENEW_FLAG/>
132-
</COURTESY_ITEM>
133-
<COURTESY_ITEM>
134-
<COURTESY_BARCODE>31967011418350</COURTESY_BARCODE>
135-
<COURTESY_TITLE>Blue hat, green hat / Sandra Boynton</COURTESY_TITLE>
136-
<COURTESY_DUE_DATE>20110624</COURTESY_DUE_DATE>
137-
<COURTESY_RENEW_FLAG/>
138-
</COURTESY_ITEM>
139-
</COURTESY>
140-
</USER>
114+
<USER>
115+
<USER_BARCODE>21967002133994</USER_BARCODE>
116+
<COURTESY>
117+
<COURTESY_ITEM>
118+
<COURTESY_BARCODE>31967010702333</COURTESY_BARCODE>
119+
<COURTESY_ITEM_KEY>1399486:1:2</COURTESY_ITEM_KEY>
120+
<COURTESY_TITLE>Snacktime! / Barenaked Ladies</COURTESY_TITLE>
121+
<COURTESY_DUE_DATE>20110624</COURTESY_DUE_DATE>
122+
<COURTESY_RENEW_FLAG/>
123+
</COURTESY_ITEM>
124+
<COURTESY_ITEM>
125+
<COURTESY_BARCODE>31967011418475</COURTESY_BARCODE>
126+
<COURTESY_ITEM_KEY>1399486:1:2</COURTESY_ITEM_KEY>
127+
<COURTESY_TITLE>But not the hippopotamus / by Sandra Boynton</COURTESY_TITLE>
128+
<COURTESY_DUE_DATE>20110624</COURTESY_DUE_DATE>
129+
<COURTESY_RENEW_FLAG/>
130+
</COURTESY_ITEM>
131+
<COURTESY_ITEM>
132+
<COURTESY_BARCODE>31967011418236</COURTESY_BARCODE>
133+
<COURTESY_ITEM_KEY>1399486:1:2</COURTESY_ITEM_KEY>
134+
<COURTESY_TITLE>The going to bed book / by Sandra Boynton</COURTESY_TITLE>
135+
<COURTESY_DUE_DATE>20110624</COURTESY_DUE_DATE>
136+
<COURTESY_RENEW_FLAG/>
137+
</COURTESY_ITEM>
138+
<COURTESY_ITEM>
139+
<COURTESY_BARCODE>31967011418350</COURTESY_BARCODE>
140+
<COURTESY_ITEM_KEY>1399486:1:2</COURTESY_ITEM_KEY>
141+
<COURTESY_TITLE>Blue hat, green hat / Sandra Boynton</COURTESY_TITLE>
142+
<COURTESY_DUE_DATE>20110624</COURTESY_DUE_DATE>
143+
<COURTESY_RENEW_FLAG/>
144+
</COURTESY_ITEM>
145+
</COURTESY>
146+
</USER>
141147
```
142148

143149
`<COURTESY_RENEWAL_FLAG>` has the following possible values
@@ -158,23 +164,25 @@ uid
158164

159165
Output:
160166
```
161-
<USER>
162-
<USER_BARCODE>21967002133994</USER_BARCODE>
163-
<OVERDUE>
164-
<OVERDUE_ITEM>
165-
<OVERDUE_BARCODE>31967011342030</OVERDUE_BARCODE>
166-
<OVERDUE_TITLE>End of days / Steve Alten</OVERDUE_TITLE>
167-
<OVERDUE_DUE_DATE>20110620</OVERDUE_DUE_DATE>
168-
<OVERDUE_RENEW_FLAG>13</OVERDUE_RENEW_FLAG>
169-
</OVERDUE_ITEM>
170-
<OVERDUE_ITEM>
171-
<OVERDUE_BARCODE>31967011066951</OVERDUE_BARCODE>
172-
<OVERDUE_TITLE>Sworn to silence / Linda Castillo</OVERDUE_TITLE>
173-
<OVERDUE_DUE_DATE>20110620</OVERDUE_DUE_DATE>
174-
<OVERDUE_RENEW_FLAG>13</OVERDUE_RENEW_FLAG>
175-
</OVERDUE_ITEM>
176-
</OVERDUE>
177-
</USER>
167+
<USER>
168+
<USER_BARCODE>21967002133994</USER_BARCODE>
169+
<OVERDUE>
170+
<OVERDUE_ITEM>
171+
<OVERDUE_BARCODE>31967011342030</OVERDUE_BARCODE>
172+
<OVERDUE_ITEM_KEY>1399486:1:2</OVERDUE_ITEM_KEY>
173+
<OVERDUE_TITLE>End of days / Steve Alten</OVERDUE_TITLE>
174+
<OVERDUE_DUE_DATE>20110620</OVERDUE_DUE_DATE>
175+
<OVERDUE_RENEW_FLAG>13</OVERDUE_RENEW_FLAG>
176+
</OVERDUE_ITEM>
177+
<OVERDUE_ITEM>
178+
<OVERDUE_BARCODE>31967011066951</OVERDUE_BARCODE>
179+
<OVERDUE_ITEM_KEY>1399486:1:2</OVERDUE_ITEM_KEY>
180+
<OVERDUE_TITLE>Sworn to silence / Linda Castillo</OVERDUE_TITLE>
181+
<OVERDUE_DUE_DATE>20110620</OVERDUE_DUE_DATE>
182+
<OVERDUE_RENEW_FLAG>13</OVERDUE_RENEW_FLAG>
183+
</OVERDUE_ITEM>
184+
</OVERDUE>
185+
</USER>
178186
```
179187

180188
`<OVERDUE_RENEWAL_FLAG>` has the following possible values
@@ -189,16 +197,16 @@ Output:
189197

190198
https://server:port/cgi-bin/sb.cgi?report=chkcharge&uid=21967002133994&id=31967011342030
191199

192-
Input: uid = patron barcode number
193-
id = item barcode number
200+
Input: uid = patron barcode number
201+
id = item barcode number
194202

195203
Output:
196204
```
197-
<ITEM>
198-
<ITEM_BARCODE>31967011342030</ITEM_BARCODE>
199-
<USER_BARCODE>21967002133994</USER_BARCODE>
200-
<CHARGED>0</CHARGED>
201-
</ITEM>
205+
<ITEM>
206+
<ITEM_BARCODE>31967011342030</ITEM_BARCODE>
207+
<USER_BARCODE>21967002133994</USER_BARCODE>
208+
<CHARGED>0</CHARGED>
209+
</ITEM>
202210
```
203211

204212
`<CHARGED>` has the following possible values:
@@ -210,19 +218,19 @@ Output:
210218

211219
### _chkhold_ – returns item barcode and if item has a hold
212220

213-
https://server:port/cgi-bin/sb.cgi?report=chkhold&id=31967011342030
221+
https://server:port/cgi-bin/sb.cgi?report=chkhold&ikey=1399486:1:2
214222

215223
Input:
216224

217-
id
218-
: item barcode number
225+
ikey
226+
: item key number
219227

220228
Output:
221229
```
222-
<ITEM>
223-
<ITEM_BARCODE>31967011342030</ITEM_BARCODE>
224-
<ONHOLD>0</ONHOLD>
225-
</ITEM>
230+
<ITEM>
231+
<ITEM_KEY>1399486:1:2</ITEM_KEY>
232+
<ONHOLD>0</ONHOLD>
233+
</ITEM>
226234
```
227235

228236
`< ONHOLD>` has the following possible values:
@@ -243,12 +251,12 @@ uid
243251

244252
Output:
245253
```
246-
<USER>
247-
<USER_BARCODE>21967002133994<USER_BARCODE/>
248-
<FEES>
249-
<FEE_TOTAL>30.25</FEE_TOTAL>
250-
</FEES>
251-
</USER>
254+
<USER>
255+
<USER_BARCODE>21967002133994<USER_BARCODE/>
256+
<FEES>
257+
<FEE_TOTAL>30.25</FEE_TOTAL>
258+
</FEES>
259+
</USER>
252260
```
253261

254262
### _noticetype_ – returns patrons that requested notices via sms or voice
@@ -262,16 +270,16 @@ type
262270

263271
Output:
264272
```
265-
<USER>
266-
<USER_INFO>
267-
<USER_BARCODE>21168045392313</USER_BARCODE>
268-
<USER_PHONENUMBER>5552221568</USER_ PHONENUMBER >
269-
</USER_INFO>
270-
<USER_INFO>
271-
<USER_BARCODE>21168045392314</USER_BARCODE>
272-
<USER_PHONENUMBER>5552221578</USER_ PHONENUMBER >
273-
</USER_INFO>
274-
</USER>
273+
<USER>
274+
<USER_INFO>
275+
<USER_BARCODE>21168045392313</USER_BARCODE>
276+
<USER_PHONENUMBER>5552221568</USER_ PHONENUMBER >
277+
</USER_INFO>
278+
<USER_INFO>
279+
<USER_BARCODE>21168045392314</USER_BARCODE>
280+
<USER_PHONENUMBER>5552221578</USER_ PHONENUMBER >
281+
</USER_INFO>
282+
</USER>
275283
```
276284

277285
### _cancel_ – returns success or failure, when attempting to abandon a hold ready for pickup
@@ -287,9 +295,9 @@ dbkey
287295

288296
Output:
289297
```
290-
<ITEM>
291-
<HOLD_CANCEL_STATUS>0</HOLD_CANCEL_STATUS>
292-
</ITEM>
298+
<ITEM>
299+
<HOLD_CANCEL_STATUS>0</HOLD_CANCEL_STATUS>
300+
</ITEM>
293301
```
294302
`< HOLD_CANCEL_STATUS >` has the following possible values
295303
0 – Cancel item hold failed
@@ -306,14 +314,14 @@ date
306314

307315
Output:
308316
```
309-
<USER>
310-
< ITEM_INFO>
311-
<USER_BARCODE>21168045392313</USER_BARCODE>
312-
< ITEM_TITLE>Invisible Man</ITEM_TITLE >
313-
</ITEM_INFO>
314-
<ITEM_INFO>
315-
<USER_BARCODE>21168045392333</USER_BARCODE>
316-
<ITEM_TITLE>Invisible Woman</ITEM_TITLE >
317-
</ITEM_INFO>
318-
</USER>
317+
<USER>
318+
<ITEM_INFO>
319+
<USER_BARCODE>21168045392313</USER_BARCODE>
320+
<ITEM_TITLE>Invisible Man</ITEM_TITLE >
321+
</ITEM_INFO>
322+
<ITEM_INFO>
323+
<USER_BARCODE>21168045392333</USER_BARCODE>
324+
<ITEM_TITLE>Invisible Woman</ITEM_TITLE >
325+
</ITEM_INFO>
326+
</USER>
319327
```

0 commit comments

Comments
 (0)