Patron Registration

Ex Libris Developer Network Voyager Documentation Voyager APIs RESTful Web Services Patron Registration

General Purpose

The resource may be accessed with a GET method to retrieve a specific patron’s registration.

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/185/patronStatus/registrationStatus?patron_homedb=homedb&institution=InstID

Example

The following is a URL to retrieve the patron’s registration information:

http://10.100.2.37:30314/vxws/patron/212/patronStatus/registrationStatus?patron_homedb=1@DMADB20010103091142

The following is an URL to retrieve the patron’s registration information with institution=LOCAL.

http://10.100.2.37:30314/vxws/patron/212/patronStatus/registrationStatus?patron_homedb=1@DMADB20010103091142&institution=LOCAL

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 an output of a patron’s registration information:

<?xml version="1.0" encoding="UTF-8" ?>
  <response>
  <reply-text>ok</reply-text>
  <reply-code>0</reply-code>
  <registrationStatus>
  <institution id="LOCAL">
  <instName>DEV720DMADB</instName>
  <registrationStatus>
  <barCode>150</barCode>
  <expDate>2008-12-04 11:27:21</expDate>
  <patronGroupName>Faculty</patronGroupName>
  </registrationStatus>
  </institution>
  </registrationStatus>
  </response

The following is an output of a patron’s registration information with institution=LOCAL:

<?xml version="1.0" encoding="UTF-8" ?>
  <response>
  <reply-text>ok</reply-text>
  <reply-code>0</reply-code>
  <registrationStatus>
  <institution id="LOCAL">
  <instName>University Library</instName>
  <registrationStatus>
  <barCode>2620</barCode>
  <expDate>1999-12-17 13:12:52</expDate>
  <patronGroupName>Faculty</patronGroupName>
  </registrationStatus>
  </institution>
  </registrationStatus>
  </response>

With Voyager 9.1, the service is enhanced to include alert information for the patron. The service response includes alerts based upon how the library defines the “Web Services | Login Summary” in Voyager System Administration. Assuming all alerts are enabled, and the patron’s status indicates the alerts are warranted, the following section is added to <patronStatus> in the response:

<alerts>
     <alert type="overdue_alert">You have overdue materials at C1 for dev910, C2 for dev910.<alert>
     <alert type="fines_alert"> You have outstanding fines/fees at C1 for dev910, C2 for dev910.<alert>
     <alert type="blocks_alert">You have circulation blocks at C1 for dev910, C2 for dev910.<alert>
     <alert type="expiry_alert">Your account will expire on 2014-06-30, 37 days from today.<alert>
  </alerts>

Possible Error Codes

51: patron_homedb is a required parameter