PersonalInfoService
General Purpose
Retrieve information about a patron.
Requirements
Voyager 7.x and higher.
Input Parameters
Parameter | Description | Value | Default | Required |
---|---|---|---|---|
patronId | Patron ID from Patron table | integer | None | Yes |
patronHomeUbId | Home Database ID | string | None | No |
Parameters are included in the invoking URL.
Input URL Syntax
This web service can be called by GET or POST methods. If it is called by GET method then include these two parameters in the URL.
Substitute XXXX with the patron id and YYYY with the patron home UB id.
http://server:port/vxws/PersonalInfoService?patronId=XXXX&patronHomeUbId=YYYY
Input XML Example
For POST method, this service expects to receive a ServiceParametersDocument containing a patronIdentifier. Within patronIdentifier, the following parameters must be included:
- patronId, an identifier of the patron from whom information is requested
- patronHomeUbId, an identifier of the patron’s home cluster/database
Example:
<?xml version="1.0" encoding="UTF-8"?> <ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters"> <ser:parameters/> <ser:patronIdentifier lastName="Patel" patronHomeUbId="1@QA20012DB20020613131313" patronId="562"> <ser:authFactor type="B">150</ser:authFactor> </ser:patronIdentifier> </ser:serviceParameters>
Output XML Example
This service will return a VoyagerServiceDataDocument wrapping a personalInfoType element, which contains the personal information for a patron.
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="per:personalInfoType" xmlns:per="http://www.endinfosys.com/Voyager/personalInfo"> <per:name> <per:firstName>Mahesh</per:firstName> <per:middleName>D.</per:middleName> <per:lastName>Patel</per:lastName> <per:fullName>Mr. Mahesh D. Patel</per:fullName> </per:name> <per:address> <per:type>Temporary</per:type> <per:addressLine1>1450 Touhy</per:addressLine1> <per:addressLine2/> <per:addressLine3/> <per:addressLine4/> <per:addressLine5/> <per:city>Des Plaines</per:city> <per:stateProvince>IL</per:stateProvince> <per:zipPostal>22222</per:zipPostal> </per:address> <per:permanentAddress> <per:type>Permanent</per:type> <per:addressLine1>1350 Touhy</per:addressLine1> <per:city>Des Plaines</per:city> <per:stateProvince>IL</per:stateProvince> <per:zipPostal>11111</per:zipPostal> <per:telephone> <per:type>Primary</per:type> <per:number>111-1111</per:number> </per:telephone> <per:telephone> <per:type>Mobile</per:type> <per:number>111-1111</per:number> </per:telephone> <per:telephone> <per:type>Fax</per:type> <per:number>111-1111</per:number> </per:telephone> <per:telephone> <per:type>Other</per:type> <per:number>111-1111</per:number> </per:telephone> </per:permanentAddress> <per:emailAddress> <per:type>Permanent</per:type> <per:address>mahesh.patel@endinfosys.com</per:address> </per:emailAddress> </serviceData> </voyagerServiceData>