Patron Blocks
General Purpose
The resource may be accessed with a GET method to retrieve a specific patron’s blocks.
Block codes are sent in English and not in code form.
The following is a list of possible patron blocks:
- Patron Expired (15)
- Patron Address Invalid (17)
- Charge Limit (institution-wide) (18)
- Charge Limit for Items of a Specific Type (institution-wide) (54)
- Charge Limit for Items (within the Circulation Policy Group) (53)
- Charge Limit for Items of a Specific Type (within the Circulation Policy Group) (55)
- Fine Limit (19)
- Overdue Limit (20)
- Overdue Recall Limit (21)
- Recall Limit (22)
- Claims Returned Limit (23)
- Lost Limit (24)
- Self-shelved Limit (25)
- Short Loan Limit (41)
- Callslip Limit (42)
- Suspension (51)
- Demerits Limit (52)
- UB Charge Limit (121)
- UB Fine Limit (122)
- UB Demerits (130)
- UB Overdue Limit (123)
- UB Overdue Recall Limit (124)
- UB Claims Returned Limit (125)
- UB Lost Limit (126)
- UB Self-Shelved Limit (127)
- Max UB Requests (119)
Product Version Compatibility
Voyager 7.2.0 and later.
Input Parameters
Parameter | Type | Description | Value | Default | Required |
---|---|---|---|---|---|
patron ID | path parameter | The Voyager patron system ID. The system ID can be retrieved from the Voyager circulation staff client interface or returned from the AuthenticatePatronService Web service with patron barcode and last name. The purpose of this parameter is to retrieve additional information regarding whether this patron can request the specific record. | string | None | Yes |
patron_homedb | query parameter | The Voyager patron home DB key. | string | None | Yes |
institution | query parameter | The database code from SysAdmin -> search -> Database Definitions. This is to retrieve requested items for the patron in a specific database. | string | None | No |
Input URL Syntax
<Base URL>:/patron/185/patronStatus?patron_homedb=homedb
Example
The following is a URL to retrieve the patron’s status:
http://10.100.2.37:30314/vxws/patron/212/patronStatus?patron_homedb=1@DMADB20010103091142
<Base URL>:/patron/212/patronStatus/blocks?patron_homedb=homedb&institution=InstID
Example
The following is a URL to retrieve the patron’s block information:
http://10.100.2.37:30314/vxws/patron/212/patronStatus/blocks?patron_homedb=1@DMADB20010103091142
The following is a URL to retrieve the patron’s block information with institution=GWCC:
http://10.100.2.37:30314/vxws/patron/212/patronStatus/blocks?patron_homedb=1@DMADB20010103091142&institution=GWCC
Output XML Format
The following is an output of a patron’s status:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <patronStatus> <institution id="GWCC"> <instName>ubgwcc720db</instName> <info type="Blocks" href="http://10.100.2.37:30314/vxws/patron/212/patronStatus/blocks?institution=GWCC&patron_homedb=1@DMADB20010103091142" /> </institution> <institution id="LOCAL"> <instName>DEV720DMADB</instName> <info type="Blocks" href="http://10.100.2.37:30314/vxws/patron/212/patronStatus/blocks?institution=LOCAL&patron_homedb=1@DMADB20010103091142" /> <info type="RegistrationStatus" href="http://10.100.2.37:30314/vxws/patron/212/patronStatus/registrationStatus?institution=LOCAL&patron_homedb=1@DMADB20010103091142" /> </institution> </patronStatus> </response>
The following is the output of a patron’s block information:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <blocks> <institution id="GWCC"> <instName>ubgwcc720db</instName> <borrowingBlock> <blockReason>You have 300.00 in fines and fees. The limit for your patron group is 100.00.</blockReason> <blockCount>300.00</blockCount> <blockCode>19</blockCode> <blockLimit>100.00</blockLimit> <itemType /> <patronGroupName>Faculty</patronGroupName> </borrowingBlock> </institution> <institution id="LOCAL"> <instName>DEV720DMADB</instName> <borrowingBlock> <blockReason>You have 300.00 in Universal Borrowing fines. The limit for your patron group is 100.00.</blockReason> <blockCount>300.00</blockCount> <blockCode>122</blockCode> <blockLimit>100.00</blockLimit> <itemType /> <patronGroupName>Faculty</patronGroupName> </borrowingBlock> </institution> </blocks> </response>
The following is the output of patron’s block information with institution=GWCC:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <blocks> <institution id="GWCC"> <instName>ubgwcc720db</instName> <borrowingBlock> <blockReason>You have 300.00 in fines and fees. The limit for your patron group is 100.00.</blockReason> <blockCount>300.00</blockCount> <blockCode>19</blockCode> <blockLimit>100.00</blockLimit> <itemType /> <patronGroupName>Faculty</patronGroupName> </borrowingBlock> </institution> </blocks> </response>
Possible Error Codes
51: patron_homedb is a required parameter