SendPatronRequest

Ex Libris Developer Network Voyager Documentation Voyager APIs XML over HTTP Web Services SendPatronRequest

General Purpose

Submits a patron request.

Requirements

Voyager 7.x and higher.

Input URL Syntax

This service expects to receive an XML document via POST method.

http://server:port/vxws/SendPatronRequestService

XSD

Click here to view the ServiceParametersSchema
Click here to view the VoyagerXmlSchema

Input XML Example

This service expects to receive a ServiceParametersDocument containing a patronIdentifier and the the following parameters:

For HOLD and RECALL requests:

Parameter	Description	Required
Patron Identifier	Credential of patron can be obtained by running the AutnenticatePatronService to get the patron last name, home ID, AuthFactor (Authentication type: could be B for barcode, I for institution ID, and S for Social Security Number)	Y
bibId	BIB ID for the item requested	Y
bibDbCode	The DB Code for the BIB defined in the SysAdmin -> Search -> Database Definition	Y
requestCode	“HOLD” or “RECALL”	Y
requestSitedId	Used to determine OPAC Circ Desk if no pickup location (PICK) is supplied	Y
PICK	pick up location for the item. This numeric ID can be looked up from the database table LOCATION. If a user has defined a default pick up location in the database and wish to use it, the user may want to specify in the requests.pproperties file in VXWS ini directory as follow:: <entry key=”SupplyDefaultPickupLocs”>Y</entry>	N
CVAL	copy selected for this item. Valid values are “thisCopy” (item level), “anyCopyAt” (any copy in request group), or “anyCopy” (title level).	Y
itemId	the ID for the selected item that can be obtained from catalog client by searching for the BIB ID	Y for copy level requests
mfhdId	the ID for the holdings item that can be obtained from catalog client by searching for the BIB ID	Callslip may require it
requestGroupId	the request group id	N
REQNNA	the date after this date the request will be no longer needed	Y
REQCOMMENTS	comment	N

For CALLSLIP requests:

Parameter	Description	Required
Patron Identifier	Credential of patron can be obtained by running the AutnenticatePatronService to get the patron last name, home ID, AuthFactor (Authentication type: could be B for barcode, I for institution ID, and S for Social Security Number)	Y
bibId	BIB ID for the item requested	Y
bibDbCode	The DB Code for the BIB defined in the SysAdmin -> Search -> Database Definition	Y
requestCode	“CALLSLIP”	Y
requestSitedId	Used to determine OPAC Circ Desk if no pickup location (PICK) is supplied	Y
PICK	pick up location for the item. This numeric ID can be looked up from the database table LOCATION. If a user has defined a default pick up location in the database and wish to use it, the user may want to specify in the requests.pproperties file in VXWS ini directory as follow:: <entry key=”SupplyDefaultPickupLocs”>Y</entry>	N
CVAL	copy selected for this item. Valid values are “thisIssue” (title level) or “thisCopy” (copy level).	Y
itemId	the ID for the selected item that can be obtained from catalog client by searching for the BIB ID	Y for copy level requests.
mfhdId	the ID for the holdings item that can be obtained from catalog client by searching for the BIB ID	Y for title level
FFO	enumeration	Y for title level
FF1	chronology	Y for title level
FF2	year	Y for title level

For ARS requests:

Parameter	Description	Required
Patron Identifier	Credential of patron can be obtained by running the AutnenticatePatronService to get the patron last name, home ID, AuthFactor (Authentication type: could be B for barcode, I for institution ID, and S for Social Security Number)	Y
bibId	BIB ID for the item requested	Y
bibDbCode	The DB Code for the BIB defined in the SysAdmin -> Search -> Database Definition	Y
requestCode	“ARS”	Y
PICK	pick up location for the item. This numeric ID can be looked up from the database table LOCATION. If a user has defined a default pick up location in the database and wish to use it, the user may want to specify in the requests.pproperties file in VXWS ini directory as follow:: <entry key=”SupplyDefaultPickupLocs”>Y</entry>	Y
itemId	the ID for the selected item that can be obtained from catalog client by searching for the BIB ID	Y

For SHORTLOAN requests:

Parameter	Description	Required
Patron Identifier	Credential of patron can be obtained by running the AutnenticatePatronService to get the patron last name, home ID, AuthFactor (Authentication type: could be B for barcode, I for institution ID, and S for Social Security Number)	Y
bibId	BIB ID for the item requested	Y
bibDbCode	The DB Code for the BIB defined in the SysAdmin -> Search -> Database Definition	Y
requestCode	“SHORTLOAN”	Y
requestSitedId	Used to determine OPAC Circ Desk if no pickup location (PICK) is supplied	Y
itemId	the ID for the selected item that can be obtained from catalog client by searching for the BIB ID	Y
PICK	pick up location for the item. This numeric ID can be looked up from the database table LOCATION. If a user has defined a default pick up location in the database and wish to use it, the user may want to specify in the requests.pproperties file in VXWS ini directory as follow:: <entry key=”SupplyDefaultPickupLocs”>Y</entry>	Y
SL_Start_Time	start date and 24 hour time. Example: 2014-07-31 11:00:00	Y
endtimes	end date and 24 hour time. Example: 2014-07-31 12:00:00	Y

For UB requests:

Parameter	Description	Required
Patron Identifier	Credential of patron can be obtained by running the AutnenticatePatronService to get the patron last name, home ID, AuthFactor (Authentication type: could be B for barcode, I for institution ID, and S for Social Security Number)	Y
bibId	BIB ID for the item requested	Y
bibDbCode	The DB Code for the BIB defined in the SysAdmin -> Search -> Database Definition	Y
requestCode	“UB”	Y
patronGroupId	patron group id for the patron identifier	Y
itemId	in the format itemId.bibId	Y
Select_Library	in the format of clusterID@DBKey where item is held.	Y
Select_Pickup_Lib	in the format of clusterID@DBKey.	Y
PICK	pickup location id	Y
REQNNA	the date after this date the request will be no longer needed	Y
ubRequestLimit	for the patron group from SysAdmin->Circulation->UB Policy Defintiions	Y

Hold example:

<?xml version="1.0"encoding="UTF-8"?>
<ser:serviceParametersxmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters"> 
<ser:parameters>  
 <ser:parameter key="bibDbName">  
   <ser:value>dev71ncdb - SysAdmin db def name</ser:value> 
  </ser:parameter>  
 <ser:parameter key="REQNNA">  
   <ser:value>2009-05-08</ser:value>  
 </ser:parameter>  
 <ser:parameter key="bibDbCode">   
   <ser:value>LOCAL</ser:value> 
  </ser:parameter> 
   <ser:parameter key="requestCode">  
     <ser:value>HOLD</ser:value>  
  </ser:parameter>  
 <ser:parameter key="CVAL">   
    <ser:value>thisCopy</ser:value>  
  </ser:parameter> 
   <ser:parameter key="requestSiteId">   
    <ser:value>1@QA20012DB20020613131313</ser:value>  
  </ser:parameter>  
  <ser:parameter key="itemId">  
     <ser:value>62560</ser:value> 
   </ser:parameter>
    <ser:parameter key="PICK">     
 <ser:value>12</ser:value>     
</ser:parameter>  
 <ser:parameter key="bibId"> 
     <ser:value>42841</ser:value> 
  </ser:parameter>
 </ser:parameters>
 <ser:patronIdentifier lastName="Duong"patronHomeUbId="1@QA20012DB20020613131313"patronId="1000007">  
 <ser:authFactor type="B">DUONG1234</ser:authFactor>
 </ser:patronIdentifier>
</ser:serviceParameters>

Callslip example:

<?xml version="1.0" encoding="UTF-8"?>
  <ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters">
  <ser:parameters>
    <ser:parameter key="bibDbName">
      <ser:value>dev71ncdb - SysAdmin db def name</ser:value>
    </ser:parameter>
    <ser:parameter key="mfhdId">
      <ser:value>67119</ser:value>
    </ser:parameter>
    <ser:parameter key="bibDbCode">
      <ser:value>LOCAL</ser:value>
    </ser:parameter>
    <ser:parameter key="requestCode">
      <ser:value>CALLSLIP</ser:value>
    </ser:parameter>
    <ser:parameter key="CVAL">
      <ser:value>thisCopy</ser:value>
    </ser:parameter>
    <ser:parameter key="requestSiteId">
      <ser:value>1@QA20012DB20020613131313</ser:value>
    </ser:parameter>
    <ser:parameter key="itemId">
      <ser:value>70622</ser:value>
    </ser:parameter>
    <ser:parameter key="bibId">
      <ser:value>81726</ser:value>
    </ser:parameter>
  </ser:parameters>
  <ser:patronIdentifier lastName="Duong" patronHomeUbId="1@QA20012DB20020613131313" patronId="1000007">
    <ser:authFactor type="B">DUONG1234</ser:authFactor>
  </ser:patronIdentifier>
</ser:serviceParameters>

Recall example:

<?xml version="1.0" encoding="UTF-8"?>
    <ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters">
    <ser:parameters>
      <ser:parameter key="bibDbName">
      <ser:value>dev71ncdb - SysAdmin db def name</ser:value>
    </ser:parameter>
    <ser:parameter key="REQNNA">
      <ser:value>2009-05-08</ser:value>
    </ser:parameter>
    <ser:parameter key="bibDbCode">
      <ser:value>LOCAL</ser:value>
    </ser:parameter>
    <ser:parameter key="requestCode">
      <ser:value>RECALL</ser:value>
    </ser:parameter>
    <ser:parameter key="CVAL">
      <ser:value>thisCopy</ser:value>
    </ser:parameter>
    <ser:parameter key="requestSiteId">
      <ser:value>1@QA20012DB20020613131313</ser:value>
    </ser:parameter>
    <ser:parameter key="itemId">
      <ser:value>14699</ser:value>
    </ser:parameter>
    <ser:parameter key="PICK">
      <ser:value>12</ser:value>
    </ser:parameter>
    <ser:parameter key="bibId">
      <ser:value>13658</ser:value>
    </ser:parameter>
  </ser:parameters>
  <ser:patronIdentifier lastName="Duong" patronHomeUbId="1@QA20012DB20020613131313" patronId="1000007">
    <ser:authFactor type="B">DUONG1234</ser:authFactor>
  </ser:patronIdentifier>
</ser:serviceParameters>

Output XML Example

This service will return a VoyagerServiceDataDocument containing either a messages element containing a success or failure message indicating if the request submission succeeded, or if the request was a successful media booking request, a requestsCollection element containing a requestDefinition element containing a fields element containing confirmation data for the media booking request.

Example:

<?xml version="1.0"encoding="UTF-8"?>
<voyagerServiceData xmlns="http://www.endinfosys.com/Voyager/serviceParameters">
<messages>
<message type="success"/>
</messages>
</voyagerServiceData>