PatronRequest
General Purpose
Return a request definition for a given request code.
Requirements
Voyager 7.x and higher.
Input URL Syntax
This service expects to receive an XML document via POST method.
http://server:port/vxws/PatronRequestService
Input XML Example
This service expects to receive a ServiceParametersDocument containing a patronIdentifier and the the following required parameters:
- requestCode – the code of the desired request. See the SendPatronRequest service for valid requestCode values.
- requestSiteId – the request site id of the desired request.
The following ‘optional’ parameters are required if available: - bibId – the bibliographic record id of the item being requested.
Example:
<?xml version="1.0" encoding="UTF-8"?> <ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters"> <ser:parameters> <ser:parameter key="bibId"> <ser:value>81875</ser:value> </ser:parameter> <ser:parameter key="bibDbCode"> <ser:value>LOCAL</ser:value> </ser:parameter> <ser:parameter key="bibDbName"> <ser:value>dev70ncdb - SysAdmin db def name</ser:value> </ser:parameter> <ser:parameter key="requestCode"> <ser:value>BIBLEVEL</ser:value> </ser:parameter> <ser:parameter key="requestSiteId"> <ser:value>1@QA20012DB20020613131313</ser:value> </ser:parameter> </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 containing a requestCollection element containing a requestDefinition element which contains a requestIdentifier element and a fields element containing the request’s field definitions. PatronRequestService may also return a messages element containing a patron block message if the patron is blocked from making the given request.
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="req:requestsCollectionType" xmlns:req="http://www.endinfosys.com/Voyager/requests"> <req:requestDefinition> <req:requestIdentifier requestCode="BIBLEVEL" requestName="BibLevel" requestType="B" requestSiteId="1@QA20012DB20020613131313"/> <req:fields> <req:field hidden="Y" required="Y" tag="requestCode"> <req:text>BIBLEVEL</req:text> </req:field> <req:field hidden="Y" required="Y" tag="requestSiteId"> <req:text>1@QA20012DB20020613131313</req:text> </req:field> <req:field hidden="Y" required="Y" tag="bibId"> <req:text>81875</req:text> </req:field> <req:field hidden="Y" required="Y" tag="bibDbCode"> <req:text>LOCAL</req:text> </req:field> <req:field hidden="Y" required="Y" tag="bibDbName"> <req:text>dev70ncdb - SysAdmin db def name</req:text> </req:field> <req:field readonly="Y" label="Instructions:" labelKey="instructions"> <req:text>This request has no instructions.</req:text> </req:field> <req:field label="Bib Info:" labelKey="bibInfo" readonly="Y" tag="bibInfo"> <req:text>Other Authors:Charner, Kathy. Title:Everything for spring : a complete activity book for teachers of young children : activities for March, April, and May / edited by Kathy Charner ; illustrations by Joan Waites. Variant Title:Complete activity book for teachers of young children Subjects:Early childhood education Activity programs. Early childhood education Curricula. Spring. Publisher:Beltsville, Md. : Gryphon House, c1997. Description:265 p. : ill. ; 28 cm. Notes:"A collection from Gryphon House books." Includes bibliographical references and index. Call Number:LB1139.35.A37 E847 1997</req:text> </req:field> <req:field tag="REQCOMMENTS" label="Comments:" labelKey="comment"/> <req:field label="Pick Up At:" labelKey="pickUpAt"> <req:select tag="PICK"> <req:option id="28">Branch General</req:option> <req:option id="11">Cataloging Desk</req:option> <req:option id="12" isDefault="Y">Circulation Desk</req:option> <req:option id="45">DLC Test</req:option> <req:option id="8">Main</req:option> <req:option id="4">Media Department</req:option> <req:option id="17">Media Stacks</req:option> <req:option id="16">Offsite</req:option> <req:option id="31">Other Branch Circ. Desk</req:option> <req:option id="49">QA ILL Test</req:option> <req:option id="14">Reserve Desk</req:option> </req:select> </req:field> <req:field tag="REQNNA" required="Y" isDate="Y" label="Not Needed After:" labelKey="notNeededAfter"> <req:text>2008-09-17</req:text> </req:field> </req:fields> </req:requestDefinition> </serviceData> </voyagerServiceData>