Patron Export Service
General Purpose
The patron export service will export a group of patron records to an XML file that is suitable for
re-loading into the database with the patron update job and web service.
Requirements
Voyager 8.2 and higher.
XSD
The input is based on the patron schema.
Input Parameters
Either use the id and idType, OR you can use the XML syntax:
Parameter Name | Description |
---|---|
id | The identifier of the patron record you wish to export, note case sensitive if a string is provided. |
idType | The type of idenfier specified in the id, may be Barcode, InstitutionID, or VoyagerID. |
If no idType is listed, then VoyagerID is assumed. Please note case sensitiveness of the id type. | |
help | When help=yes, provide help information in the <pat:help> element of the output XML. |
Input XML Format
The input is based on the patron.xsd schema.
Example:
<exportParams xmlns="http://www.exlibris.com/Voyager/patron"> <idNumber>DUONG1234</idNumber> <idType>Barcode</idType> </exportParams>
Input URL Syntax
http://server:port/vxws/patronExport?id=DUONG1234&idType=Barcode or http://server:port/vxws/patronExport with attached XML file
Output XML Format
The following is an output corresponding to the input XML as above.
Example:
<?xml version="1.0" encoding="UTF-8" ?> <pat:patron xmlns:pat="*http://www.exlibris.com/Voyager/patron*"> <pat:info> <pat:reply> <pat:reply-text>OK</pat:reply-text> <pat:reply-code>00</pat:reply-code> </pat:reply> </pat:info> <pat:action>Add</pat:action> <pat:matchId> <pat:idType>VoyagerID</pat:idType> <pat:idNumber>1000007</pat:idNumber> </pat:matchId> <pat:patronId>1000007</pat:patronId> <pat:patronBarcodeList> <pat:patronBarcode> <pat:barcode>DUONG1234</pat:barcode> <pat:patronGroup>FAC</pat:patronGroup> <pat:barcodeStatus>Active</pat:barcodeStatus> </pat:patronBarcode> </pat:patronBarcodeList> <pat:expirationDate>2013-11-28</pat:expirationDate> <pat:purgeDate>2014-11-28</pat:purgeDate> <pat:voyagerDate>2011-10-10</pat:voyagerDate> <pat:libraryLocationCode>CAT</pat:libraryLocationCode> <pat:institutionID>Duong1234</pat:institutionID> <pat:nameType>Institutional</pat:nameType> <pat:firstName>Chi-Hoi</pat:firstName> <pat:lastName>Duong</pat:lastName> <pat:title>Mr.</pat:title> <pat:smsNumber>1234567890</pat:smsNumber> <pat:transactionCounters> <pat:cancelledBookings>0</pat:cancelledBookings> <pat:claimsReturnedCount>0</pat:claimsReturnedCount> <pat:historicalBookings>0</pat:historicalBookings> <pat:historicalCallslips>7</pat:historicalCallslips> <pat:historicalCharges>24</pat:historicalCharges> <pat:historicalDistributions>0</pat:historicalDistributions> <pat:historicalShortLoans>0</pat:historicalShortLoans> <pat:holdsPlaced>0</pat:holdsPlaced> <pat:itemsRecalled>0</pat:itemsRecalled> <pat:lateMediaReturns>7</pat:lateMediaReturns> <pat:lostItemsCount>6</pat:lostItemsCount> <pat:recallsPlaced>0</pat:recallsPlaced> <pat:selfShelvedCount>2</pat:selfShelvedCount> <pat:unclaimedBookings>22</pat:unclaimedBookings> <pat:unclaimedShortLoans>3</pat:unclaimedShortLoans> </pat:transactionCounters> <pat:permAddress> <pat:addressStatusCode>Normal</pat:addressStatusCode> <pat:line1>555 Elm</pat:line1> <pat:city>Des Plaines</pat:city> <pat:stateProvince>IL</pat:stateProvince> <pat:postalCode>60018</pat:postalCode> <pat:country>US</pat:country> <pat:patronPhoneList> <pat:patronPhone> <pat:phone>(847) 555-1212</pat:phone> <pat:type>Primary</pat:type> </pat:patronPhone> </pat:patronPhoneList> </pat:permAddress> </pat:patron>
Possible Error Codes
Success or error is display in the
<pat:info> <pat:reply> <pat:reply-text>OK</pat:reply-text> <pat:reply-code>00</pat:reply-code> </pat:reply> </pat:info>
The reply text may have the success (OK) or error text.
The reply code may have the success (00) or error code
The error codes and texts are:
Code | Text | Notes |
---|---|---|
00 | OK | |
04 | No expiration date for patron | |
05 | No purge date for patron | |
06 | No last name for patron | |
07 | No email address for patron | |
10 | No patron record found | List also the identification number used to request this patron. |
13 | System error | Please refer to the $VOYAGER/$DATABASE/tomcat/vxws/logs/vxws.log log file for detail error. |
14 | multiple match on identifier <xxx> found. Record not processed. | |
15 | Incomplete barcode information for patron. |
The following example shows missing parameter and display the help message:
<?xml version="1.0" encoding="UTF-8" ?> <pat:help xmlns:pat="\*[http://www.exlibris.com/Voyager/patron\*|http://www.exlibris.com/Voyager/patron*]"> <pat:helpText>Missing parameter: Patron id. This web service exports a patron record in a format compatible with the Ex Libris Voyager patron import/export XML schema. A minimal call looks like this: [http://host:port/vxws/patronExport?id=patronId.|http://host:port/vxws/patronExport?id=patronId.] Other options are available, see the web service documentation on EL Commons ([http://www.exlibrisgroup.org/display/ElCommons]) (login required) for full information. </pat:helpText> </pat:help>