ILL (Blank) Request

Ex Libris Developer Network Voyager Documentation Voyager APIs RESTful Web Services ILL (Blank) Request

General Purpose

A list of available system-defined ILL blank requests for the patron’s home server may be accessed with the GET method.

An ILL blank request may be submitted to the patron’s home server using the PUT method.

Product Version Compatibility

Voyager 9.1 and later.

Input Parameters (GET and PUT)

Parameter	Type	Description	Value	Default	Required
patron ID	path parameter	Voyager patron system ID. The system ID can be retrieved from the Voyager circulation staff client interface or returned from the AuthenticatePatronService Web service with patron barcode and last name.	string	None	Yes
patron_homedb	query parameter	Voyager patron home DB key	string	None	Yes

Input URL Syntax (GET)

The get ILL Blank requests service will be available via GET call at the URL:

http://<server>:<port>/vxws/illblank?patron=<patron_id>&patron_homedb=<patron_home_db_id>

Example:

http://10.100.2.37:30314/vxws/illblank?patron=99&patron_homedb=1@QA20012DB20020613131313

Output XML Format (GET)

If no ILL Blank requests are available for the patron, the following response will be returned:

<?xml version="1.0" encoding="UTF-8"?>
<response>
   <reply-text>ok</reply-text>
   <reply-code>0</reply-code>
   <illblank allowed="N"/>
<response>

Additionally, if there is problem retrieving the available requests for the patron, a <note> element may appear, containing the reason why:

<?xml version="1.0" encoding="UTF-8"?>
<response>
   <reply-text>ok</reply-text>
   <reply-code>0</reply-code>
   <illblank allowed="N">
      <note type="error">Patron is blocked from making requests.</note>
   </illblank>
<response>

If ILL Blank requests are available, the response will contain a <form> element for each available request. Note that the presence of a tag atttribute in a <field> element indicates data that must be sent in the PUT service (unless the usage is Optional and the end user entered no data). Also note that unlike the other request services, the code for the pickup-location is text, not an id. Finally, note that the PUT service does not validate that Mandatory data has been sent – it is the invoker’s responsibility to assert that the end user has entered data for all Mandatory fields.

Example response:

<?xml version="1.0" encoding="UTF-8"?>
<response>
   <reply-text>ok</reply-text>
   <reply-code>0</reply-code>
   <illblank allowed="Y">
      <form>
         <code>ART_ELOAN</code>
         <name>Sample ARTEmail Loan Form</name>
         <field read_only="Y">
            <label>Instructions</label>
            <text>Instructions for the form.</text>
         </field>
         <field tag="FF0" usage="Optional">
            <label>Title</label>
         </field>
         <field tag="FF1" usage="Optional">
            <label>Author</label>
         </field>
         <field tag="FF2" usage="Optional">
            <label>Place of Pub</label>
         </field>
         <field tag="FF3" usage="Optional">
            <label>Publisher</label>
         </field>
         <field tag="FF4" usage="Optional">
            <label>Edition</label>
         </field>
         <field tag="FF5" usage="Optional">
            <label>Year</label>
         </field>
         <field tag="FF6" usage="Optional">
            <label>Volume</label>
         </field>
         <field tag="REQNNA" usage="Mandatory" is_date="Y">
            <label>Not Needed After</label>
            <text>2014-07-08</text>
         </field>
      </form>
      <form>
         <code>ART_EPHOTO</code>
         <name>Sample ARTEmail Photocopy Form</name>
         <field read_only="Y">
            <label>Instructions</label>
            <text>Instructions for the form.</text>
         </field>
         <field tag="FF0" usage="Mandatory">
            <label>Journal Title</label>
         </field>
         <field tag="FF1" usage="Optional">
            <label>Volume</label>
         </field>
         <field tag="FF2" usage="Optional">
            <label>Part</label>
         </field>
         <field tag="FF3" usage="Mandatory">
            <label>Year</label>
         </field>
         <field tag="FF4" usage="Mandatory">
            <label>Article Title</label>
         </field>
         <field tag="FF5" usage="Mandatory">
            <label>Pages</label>
         </field>
         <field tag="REQNNA" usage="Mandatory" is_date="Y">
            <label>Not Needed After</label>
            <text>2014-07-08</text>
         </field>
      </form>
      <form>
         <code>ILL_BLANK_LOAN</code>
         <name>Sample ILL Blank Loan Request</name>
         <pickup-locations usage="Mandatory" label="Pickup Locations">
            <pickup-location code="Cataloging Desk" default="N">Cataloging Desk</pickup-location>
            <pickup-location code="Circulation Desk" default="Y">Circulation Desk</pickup-location>
            <pickup-location code="OPAC Circ Desk" default="N">OPAC Circ Desk</pickup-location>
         </pickup-locations>
         <field read_only="Y">
            <label>Instructions</label>
            <text>Instructions for the form.</text>
         </field>
         <field tag="FF0" usage="Mandatory">
            <label>Title</label>
         </field>
         <field tag="FF1" usage="Optional">
            <label>Author</label>
         </field>
         <field tag="FF2" usage="Mandatory" read_only="Y">
            <label>Patron</label>
            <text>Tom Ulysees Smorch</text>
         </field>
         <field tag="FF3" usage="Optional">
            <label>Address</label>
            <text>2200 East Devon</text>
         </field>
         <field tag="FF4" usage="Optional">
            <label>Phone</label>
            <text>847 296 2200</text>
         </field>
         <field tag="FF5" usage="Optional">
            <label>Email</label>
         </field>
         <field tag="FF6" usage="Optional">
            <label>Comments</label>
         </field>
      </form>
      <form>
         <code>ILL_BLANK_PHOTO</code>
         <name>Sample ILL Blank Photo Request</name>
         <pickup-locations usage="Mandatory" label="Pickup Locations">
            <pickup-location code="Cataloging Desk" default="N">Cataloging Desk</pickup-location>
            <pickup-location code="Circulation Desk" default="Y">Circulation Desk</pickup-location>
            <pickup-location code="OPAC Circ Desk" default="N">OPAC Circ Desk</pickup-location>
         </pickup-locations>
         <field read_only="Y">
            <label>Instructions</label>
            <text>Instructions for the form.</text>
         </field>
         <field tag="FF0" usage="Optional">
            <label>Patron</label>
         </field>
         <field tag="FF1" usage="Optional">
            <label>Title</label>
         </field>
      </form>
   </illblank>
</response>

Input URL Sytnax (PUT)

The submit ILL Blank request service will be available via PUT call at the URL:

http://<server>:<port>/vxws/illblank?patron=<patron_id>&patron_homedb=<patron_home_db_id>

Example:

http://10.100.2.37:30314/vxws/illblank?patron=99&patron_homedb=1@QA20012DB20020613131313

Example additional XML document content (for ART_ELOAN from GET request above):

<?xml version="1.0" encoding="UTF-8"?>
<request-parameters>
   <code>ART_ELOAN</code>
   <field tag="FF0">User input for field FF0</field>
   <field tag="FF1">User input for field FF1</field>
   <field tag="REQNNA">20141019</field>
</request-parameters>

Output XML Format (PUT)

Example response (success):

<?xml version="1.0" encoding="UTF-8"?>
<response>
   <reply-text>ok</reply-text>
   <reply-code>0</reply-code>
   <create-request>
      <note type="">Your request was successful.</note>
   </create-request>
</response>

Example response (failure):

<?xml version="1.0" encoding="UTF-8"?>
<response>
   <reply-text>ok</reply-text>
   <reply-code>0</reply-code>
   <create-request>
      <note type="Error">Request could not be placed.</note>
   </create-request>
</response>