Authenticate Patron
General Purpose
Authenticate a Patron in Voyager
Requirements
Voyager 7.x and higher
Input URL Syntax
This service expects to receive an XML document via POST method.
http://server:port/vxws/AuthenticatePatronService
XSD
Click here to view the PatronAuthenticationSchema
Click here to view the ServiceParametersSchema
Click here to view the VoyagerXmlSchema
Input XML Example
This service expects to receive a ServiceParametersType document containing a patronIdentifier and the following parameters:
- authFactor type – required parameter indicates the factor used for patron authentication. Valid values are: B(Barcode), I(Institution Id), or S(Social Security Number).
- briefLogon – optional parameter. Set to Y to indicate an authentication attempt with “brief” data. Defaults to N.
- pin – an optional parameter carrying the patron’s pin value.
Example:
<?xml version="1.0" encoding="UTF-8"?> <ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters"> <ser:parameters> <ser:parameter key="pin"> <ser:value>15012</ser:value> </ser:parameter> </ser:parameters> <ser:patronIdentifier lastName="patel"> <ser:authFactor type="B">150</ser:authFactor> </ser:patronIdentifier> </ser:serviceParameters>
Output XML Example
The service returns a VoyagerServiceDataDocument containing a patronAuthentication element which contains data about the authenticated patron. If the authentication failed, then the VoyagerServiceDataDocument contains a messages element with an appropriate error message.
Example:
<?xml version="1.0" encoding="UTF-8" ?> <voyagerServiceData xmlns="http://www.endinfosys.com/Voyager/serviceParameters" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <serviceData xsi:type="pat:patronAuthenticationType" xmlns:pat="http://www.endinfosys.com/Voyager/patronAuthentication"> <pat:patronIdentifier patronId="562" lastName="Patel" patronHomeUbId="1@QA20012DB20020613131313"> <pat:authFactor type="B">150</pat:authFactor> </pat:patronIdentifier> <pat:patronGroups> <pat:groupIds> <pat:id>2</pat:id> </pat:groupIds> <pat:groupCodes> <pat:groupCode> <pat:databaseCode>LOCAL</pat:databaseCode> <pat:group>ST</pat:group> </pat:groupCode> </pat:groupCodes> </pat:patronGroups> <pat:isLocalPatron>Y</pat:isLocalPatron> <pat:barcode>150</pat:barcode> <pat:institutionId>150</pat:institutionId> <pat:fullName>Mr. Mahesh D. Patel</pat:fullName> <pat:lastName>Patel</pat:lastName> </serviceData> </voyagerServiceData>