ChangePINService
General Purpose
Change a patron’s PIN.
Requirements
Voyager 7.x and higher.
Input URL Syntax
This service expects to receive an XML document via POST method.
http://server:port/vxws/ChangePINService
XSD
Click here to view the ServiceParametersSchema
Click here to view the VoyagerXmlSchema
Click here to view the ServiceDataSchema
Input XML Example
The service expects to receive a ServiceParametersDocument
containing a patronIdentifier and the following parameters:
- oldPatronPIN – the patron’s current PIN
- newPatronPIN – the patron’s desired new PIN
Example:
<?xml version="1.0" encoding="UTF-8"?> <ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters"> <ser:parameters> <ser:parameter key="oldPatronPIN"> <ser:value>15012</ser:value> </ser:parameter> <ser:parameter key="newPatronPIN"> <ser:value>150123</ser:value> </ser:parameter> </ser:parameters> <ser:patronIdentifier lastName="LastName" patronHomeUbId="1@DB" patronId="562"> <ser:authFactor type="B">150</ser:authFactor> </ser:patronIdentifier> </ser:serviceParameters>
Output XML Example
The service will return a VoyagerServiceDataDocument containing a messages element. If the change succeeded, the messages element will contain a single message element with a type of “success”. Otherwise, the messages element will contain at least one message element with the appropriate error code. Possible error codes are:
- MissingRequiredParameterException – returned if one or more parameters are missing
- ValidateException – returned if the oldPatronPIN is not correct
- ValidateUniqueException – returned if the newPatronPIN is the same as the oldPatronPIN
- ValidateLengthException – returned if the newPatronPIN is not 5 to 12 characters in length
Example:
<?xml version="1.0" encoding="UTF-8" ?> <voyagerServiceData xmlns="http://www.endinfosys.com/Voyager/serviceParameters"> <messages> <message type="error" errorCode="com.endinfosys.voyager.patronpin.PatronPIN.ValidateException">Patron PIN validation failed.</message> </messages> </voyagerServiceData>