Skip to content

Commit 7e3f152

Browse files
Merge pull request #15 from multnomah-county-it/dev
Dev
2 parents d651430 + d49c702 commit 7e3f152

1 file changed

Lines changed: 16 additions & 13 deletions

File tree

README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,16 @@
44

55
NOTES: custom Information fails on test, LOSFORMAT policy does not exist
66

7-
## These are the SBAPI endpoints
7+
## SBAPI endpoints
88

9-
### Example: userkey – returns user key/user barcode/home library/barcode expiration date when querying a user barcode
9+
### _userkey_ – returns user key/user barcode/home library/barcode expiration date when querying a user barcode
1010

1111
URL: https://server:port/cgi-bin/sb.cgi?report=userkey&uid=21168045392313
1212

13-
Input: uid = patron barcode number
13+
Input:
14+
15+
uid
16+
: patron barcode number
1417

1518
Output:
1619
```
@@ -24,7 +27,7 @@ Output:
2427
</USER>
2528
```
2629

27-
### Example: userbarcode – returns user key/user barcode/home library/barcode expiration date when querying a user key
30+
### _userbarcode_ – returns user key/user barcode/home library/barcode expiration date when querying a user key
2831

2932
URL: https://server:port/cgi-bin/sb.cgi?report=userbarcode&ukey=445800
3033

@@ -45,7 +48,7 @@ Output:
4548
</USER>
4649
```
4750

48-
### Example: holds – returns barcode and item hold available for pickup and not yet filled, when querying a user barcode
51+
### _holds_ – returns barcode and item hold available for pickup and not yet filled, when querying a user barcode
4952

5053
URL: https://server:port/cgi-bin/sb.cgi?report=hold&uid=21967002133994
5154

@@ -91,7 +94,7 @@ Output:
9194

9295
`</HOLD_DB_KEY>` is needed to enable the cancellation of this item hold.
9396

94-
### Example: courtesy– returns barcode and item barcode/title/due date/renew eligibility when querying a user barcode
97+
### _courtesy_ – returns barcode and item barcode/title/due date/renew eligibility when querying a user barcode
9598

9699
https://server:port/cgi-bin/sb.cgi?report=courtesy&uid=21967002133994
97100

@@ -140,7 +143,7 @@ Output:
140143
13 - Item is not eligible for renewal as item is on-hold
141144
14 - Item is not eligible for renewal as maximum number renewals for the item has been reached
142145

143-
### Example: overdue– returns barcode and item barcode/title/due date/renew eligibility when querying a user barcode
146+
### _overdue_ – returns barcode and item barcode/title/due date/renew eligibility when querying a user barcode
144147

145148
https://server:port/cgi-bin/sb.cgi?report=overdue&uid=21967002133994
146149

@@ -178,7 +181,7 @@ Output:
178181
14 - Item is not eligible for renewal as maximum number renewals for the item has been reached
179182
15 - Item is not eligible for renewal due to limit set on how many overdue items a patron can have at one time
180183

181-
### Example: overdue– returns user barcode/item barcode and charge status when querying a user barcode
184+
### _overdue_ – returns user barcode/item barcode and charge status when querying a user barcode
182185

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

@@ -201,7 +204,7 @@ Output:
201204
1
202205
: Item is charged to patron
203206

204-
### Example: chkhold– returns item barcode and if item has a hold
207+
### _chkhold_ – returns item barcode and if item has a hold
205208

206209
https://server:port/cgi-bin/sb.cgi?report=chkhold&id=31967011342030
207210

@@ -225,7 +228,7 @@ Output:
225228
1
226229
: Item has a hold
227230

228-
### Example: fee– returns total fees linked to patron
231+
### _fee_ – returns total fees linked to patron
229232

230233
https://server:port/cgi-bin/sb.cgi?report=fee&uid=21967002133994
231234

@@ -244,7 +247,7 @@ Output:
244247
</USER>
245248
```
246249

247-
### Example: noticetype– returns patrons that requested notices via sms or voice
250+
### _noticetype_ – returns patrons that requested notices via sms or voice
248251

249252
https://server:port/cgi-bin/sb.cgi?report=noticetype&type=sms
250253

@@ -267,7 +270,7 @@ Output:
267270
</USER>
268271
```
269272

270-
### Example: cancel– returns success or failure, when attempting to abandon a hold ready for pickup
273+
### _cancel_ – returns success or failure, when attempting to abandon a hold ready for pickup
271274

272275
https://server:port/cgi-bin/sb.cgi?report=cancel&uid=21967002133994&dbkey=1234566
273276

@@ -288,7 +291,7 @@ Output:
288291
0 – Cancel item hold failed
289292
1 – Cancel item hold succeeded
290293

291-
### Example: holdexpiration– returns list of patron hold items that expired and not fulfilled
294+
### _holdexpiration_ – returns list of patron hold items that expired and not fulfilled
292295

293296
https://server:port/cgi-bin/sb.cgi?report=holdexpiration&date=20200817
294297

0 commit comments

Comments
 (0)