Merge pull request #14 from multnomah-county-it/dev

More README.md updates

Author: john-c-houser

README.md

@@ -1,12 +1,12 @@
 # libsbapi
 
-### Custom API for Integration of Shoutbomb with Symphony ###
+## Custom API for Integration of Shoutbomb with Symphony
 
 NOTES: custom Information fails on test, LOSFORMAT policy does not exist
 
-## These are the SBAPI endpoints ##
+## These are the SBAPI endpoints 
 
-# Example: userkey – returns user key/user barcode/home library/barcode expiration date when querying a user barcode #
+### Example: userkey – returns user key/user barcode/home library/barcode expiration date when querying a user barcode 
 
 URL: https://server:port/cgi-bin/sb.cgi?report=userkey&uid=21168045392313
 
@@ -24,11 +24,14 @@ Output:
 	</USER>
 ```
 
-# Example: userbarcode – returns user key/user barcode/home library/barcode expiration date when querying a user key #
+### Example: userbarcode – returns user key/user barcode/home library/barcode expiration date when querying a user key
 
 URL: https://server:port/cgi-bin/sb.cgi?report=userbarcode&ukey=445800
 
-Input: ukey = user internal key
+Input:
+
+ukey
+: user internal key
 
 Output:
 ```
@@ -42,11 +45,14 @@ Output:
 	</USER>
 ```
 
-# Example: holds – returns barcode and item hold available for pickup and not yet filled, when querying a user barcode #
+### Example: holds – returns barcode and item hold available for pickup and not yet filled, when querying a user barcode
 
 URL: https://server:port/cgi-bin/sb.cgi?report=hold&uid=21967002133994
 
-Input: uid = patron barcode number
+Input: 
+
+uid
+: patron barcode number
 
 Output:
 ```
@@ -85,11 +91,14 @@ Output:
 
 `</HOLD_DB_KEY>` is needed to enable the cancellation of this item hold.
 
-# Example: courtesy– returns barcode and item barcode/title/due date/renew eligibility when querying a user barcode #
+### Example: courtesy– returns barcode and item barcode/title/due date/renew eligibility when querying a user barcode
 
 https://server:port/cgi-bin/sb.cgi?report=courtesy&uid=21967002133994
 
-Input: uid = patron barcode number
+Input:
+
+uid
+: patron barcode number
 
 Output:
 ```
@@ -131,11 +140,14 @@ Output:
 13 - Item is not eligible for renewal as item is on-hold
 14 - Item is not eligible for renewal as maximum number renewals for the item has been reached
 
-# Example: overdue– returns barcode and item barcode/title/due date/renew eligibility when querying a user barcode #
+### Example: overdue– returns barcode and item barcode/title/due date/renew eligibility when querying a user barcode
 
 https://server:port/cgi-bin/sb.cgi?report=overdue&uid=21967002133994
 
-Input: uid = patron barcode number
+Input:
+
+uid
+: patron barcode number
 
 Output:
 ```
@@ -166,7 +178,7 @@ Output:
 14 - Item is not eligible for renewal as maximum number renewals for the item has been reached
 15 - Item is not eligible for renewal due to limit set on how many overdue items a patron can have at one time
 
-# Example: overdue– returns user barcode/item barcode and charge status when querying a user barcode #
+### Example: overdue– returns user barcode/item barcode and charge status when querying a user barcode
 
 https://server:port/cgi-bin/sb.cgi?report=chkcharge&uid=21967002133994&id=31967011342030
 
@@ -182,15 +194,21 @@ Output:
 	</ITEM>
 ```
 
-<CHARGED> has the following possible values
-0 - Item is not charged to patron
-1 - Item is charged to patron
+`<CHARGED>` has the following possible values:
+
+0
+: Item is not charged to patron
+1
+: Item is charged to patron
 
-# Example: chkhold– returns item barcode and if item has a hold #
+### Example: chkhold– returns item barcode and if item has a hold
 
 https://server:port/cgi-bin/sb.cgi?report=chkhold&id=31967011342030
 
-Input: id = item barcode number
+Input:
+
+id
+: item barcode number
 
 Output:
 ```
@@ -200,15 +218,21 @@ Output:
 	</ITEM>
 ```
 
-`< ONHOLD>` has the following possible values
-0 - Item has no hold
-1 - Item has a hold
+`< ONHOLD>` has the following possible values:
+
+0
+: Item has no hold
+1
+: Item has a hold
 
-# Example: fee– returns total fees linked to patron #
+### Example: fee– returns total fees linked to patron
 
 https://server:port/cgi-bin/sb.cgi?report=fee&uid=21967002133994
 
-Input: uid = patron barcode number
+Input: 
+
+uid
+: patron barcode number
 
 Output:
 ```
@@ -220,11 +244,14 @@ Output:
 	</USER>
 ```
 
-# Example: noticetype– returns patrons that requested notices via sms or voice #
+### Example: noticetype– returns patrons that requested notices via sms or voice
 
 https://server:port/cgi-bin/sb.cgi?report=noticetype&type=sms
 
-Input: type = sms or voice
+Input: 
+
+type
+: sms|voice
 
 Output:
 ```
@@ -240,12 +267,16 @@ Output:
 	</USER>
 ```
 
-# Example: cancel– returns success or failure, when attempting to abandon a hold ready for pickup #
+### Example: cancel– returns success or failure, when attempting to abandon a hold ready for pickup
 
 https://server:port/cgi-bin/sb.cgi?report=cancel&uid=21967002133994&dbkey=1234566
 
-Input:	uid = patron barcode number
-	dbkey = hold DB key
+Input:
+
+uid
+: patron barcode number
+dbkey
+: hold DB key
 
 Output:
 ```
@@ -257,11 +288,14 @@ Output:
 0 – Cancel item hold failed
 1 – Cancel item hold succeeded
 
-# Example: holdexpiration– returns list of patron hold items that expired and not fulfilled #
+### Example: holdexpiration– returns list of patron hold items that expired and not fulfilled
 
 https://server:port/cgi-bin/sb.cgi?report=holdexpiration&date=20200817
 
-Input: date = date item hold request expired, YYYYMMDD
+Input: 
+
+date
+: date item hold request expired, YYYYMMDD
 
 Output:
 ```