Patron Address

NAVIGATE CONTENT
Ex Libris Developer Network Voyager Documentation Voyager APIs RESTful Web Services Patron Address

General Purpose

The resource may be accessed with a GET method to retrieve a specific patron’s information.  The patron’s address cannot be updated by the end user in Voyager.

Starting version 9.0.0, depending on SysAdmin -> WebServices -> Service Configuration, a user can allow to edit SMS number, or patron pin.

Product Version Compatibility

Voyager 9.0.0 and later.

Input Parameters

ParameterTypeDescriptionValueDefaultRequired
patron IDpath parameterThe 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.stringNoneYes
patron_homedbquery parameterThe Voyager patron home DB key.stringNoneYes
patron_groupquery parameterThis indicates the Voyager patron group ID. If this parameter is not specified, the server uses its best-guess patron group ID.stringNoneNo

Input XML Format

The following is an input example of input data to update a patron’s pin:

<?xml version="1.0" encoding="UTF-8"?>
<address>
    <patronPin>
        <currentPin>123XYZ</currentPin>
        <newPin>456ABC</newPin>
    </patronPin>
<address>

The following is an example of input data to update a patron’s SMS number:

<?xml version="1.0" encoding="UTF-8"?>
<address>
    <smsNumber>123456789</smsNumber>
</address>

Input URL Syntax

<Base URL>:/patron/185/patronInformation?patron_homedb=homedb

The same URL with HTTP PUT is used to update a patron’s SMS number, or pin.

Example

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

http://10.100.2.37:30114/vxws/patron/185/patronInformation?patron_homedb=1@QA20012DB20020613131313

<Base URL>:/patron/185/patronInformation/address?patron_homedb=homedb

Example

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

http://10.100.2.37:30114/vxws/patron/185/patronInformation/address?patron_homedb=1@QA20012DB20020613131313&patron_group=1

Output XML Format

The following is an output of a patron’s information:

<?xml version="1.0" encoding="UTF-8" ?>
  <response>
  <reply-text>ok</reply-text>
  <reply-code>0</reply-code>
  <patronInformation>
  <info type="Address" href="http://10.100.2.37:30114/vxws/patron/185/patronInformation/address?patron_homedb=1@QA20012DB20020613131313" />
  </patronInformation>
  </response>

The following is an output of a patron’s address information:

<?xml version="1.0" encoding="UTF-8" ?>
  <response>
  <reply-text>ok</reply-text>
  <reply-code>0</reply-code>
  <address>
  <name>
  <firstName>Mahesh</firstName>
  <middleName />
  <lastName>Patel</lastName>
  <fullName>Mahesh Patel</fullName>
  </name>
  <permanentAddress>
  <type>Permanent</type>
  <addressLine1>2200 East Devon</addressLine1>
  <addressLine2>Suite 382</addressLine2>
  <addressLine3 />
  <addressLine4 />
  <addressLine5 />
  <city>Des Plaines</city>
  <stateProvince>IL</stateProvince>
  <zipPostal>60018</zipPostal>
  <telephone>
  <type>Primary</type>
  <number>847 296 2200</number>
  </telephone>
  </permanentAddress>
  </address>
  </response>

The following is an output with Patron Pin and SMS number

  1. If a user is allowed to edit the pin, the current pin and new pin are mandatory.
  2. If a user is allowed to edit the pin, the SMS number is optional because a user may not have the SMS number
<?xml version="1.0" encoding="UTF-8" ?>
<response>
  <reply-text>ok</reply-text>
  <reply-code>0</reply-code>
  <address>
      <name>
           <firstName>Mark</firstName>
           <middleName>Gerard</middleName>
           <lastName>Gobat</lastName>
           <fullName>Mark Gerard Gobat</fullName>
      </name>
      <permanentAddress>
            <type>Permanent</type>
            <addressLine1>1350 E Touhy Ave</addressLine1>
            <addressLine2>Suite 200E</addressLine2>
            <addressLine3 />
            <addressLine4 />
            <addressLine5 />
            <city>Des Plaines</city>
            <stateProvince>IL</stateProvince>
            <zipPostal>60018</zipPostal>
            <telephone>
               <type>Primary</type>
               <number>847 296 2200</number>
            </telephone>
            <telephone>
               <type>Mobile</type>
               <number>773 222 1234</number>
            </telephone>
            <telephone>
               <type>Other</type>
               <number>847 227 9876</number>
            </telephone>
      </permanentAddress>
      <emailAddress>
            <type>Email</type>
            <address>mark.gobat@endinfosys.com</address>
      </emailAddress>
      <smsNumber usage="Optional" max_len="50">12312313</smsNumber>
      <patronPin updateable="Y">
            <currentPin usage="Mandatory" max_len="12" />
            <newPin usage="Mandatory" max_len="12" />
      </patronPin>
  </address>
</response>
  1. If a user is not allowed to edit the pin, the current pin and new pin are not displayed.
  2. If a user is not allowed to edit the SMS number, the SMS number shows read-only
<?xml version="1.0" encoding="UTF-8" ?>
<response>
  <reply-text>ok</reply-text>
  <reply-code>0</reply-code>
  <address>
      <name>
           <firstName>Mark</firstName>
           <middleName>Gerard</middleName>
           <lastName>Gobat</lastName>
           <fullName>Mark Gerard Gobat</fullName>
      </name>
      <permanentAddress>
            <type>Permanent</type>
            <addressLine1>1350 E Touhy Ave</addressLine1>
            <addressLine2>Suite 200E</addressLine2>
            <addressLine3 />
            <addressLine4 />
            <addressLine5 />
            <city>Des Plaines</city>
            <stateProvince>IL</stateProvince>
            <zipPostal>60018</zipPostal>
            <telephone>
               <type>Primary</type>
               <number>847 296 2200</number>
            </telephone>
            <telephone>
               <type>Mobile</type>
               <number>773 222 1234</number>
            </telephone>
            <telephone>
               <type>Other</type>
               <number>847 227 9876</number>
            </telephone>
      </permanentAddress>
      <emailAddress>
            <type>Email</type>
            <address>mark.gobat@endinfosys.com</address>
      </emailAddress>
      <smsNumber usage="Read-Only" max_len="50">12312313</smsNumber> 
      <patronPin updateable="N" />
  </address>
</response>

Possible Error Codes

51: patron_homedb is a required parameter