Renew

General Purpose

Renew an item for a patron.

Requirements

Voyager 7.x and higher.

Prerequisite

Prior to running this web service, the user must issue an AuthenticatePatronService call with the patron ID, last name, and barcode.
Also note that the calling application must maintain a session connection with the web service, preserving and returning the JSESSIONID header returned by the AuthenticatePatronService call.

Example of the AuthenticationPatronService input XML:

<?xml version="1.0" encoding="UTF-8"?>
<ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters">
  <ser:parameters>
    <ser:parameter key="clientIP">
      <ser:value>10.1.7.8</ser:value>
    </ser:parameter>
  </ser:parameters>
  <ser:patronIdentifier lastName="duong" patronHomeUbId="1@DMADB20010103091142">
    <ser:authFactor type="B">duong5678</ser:authFactor>
  </ser:patronIdentifier>
</ser:serviceParameters>

Input URL Syntax

This service expects to receive an XML document via POST method.

http://server:port/vxws/RenewService

Input XML Example

It expects to receive parameters in an XML document.

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:definedParameters xsi:type="myac:myAccountServiceParametersType" xmlns:myac="http://www.endinfosys.com/Voyager/myAccount" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <myac:itemIdentifier>
         <myac:itemId>32437</myac:itemId>
         <myac:ubId>1@QA20012DB20020613131313</myac:ubId>
      </myac:itemIdentifier>
   </ser:definedParameters>
</ser:serviceParameters>

Output XML Example

It returns an XML document with charged items information.

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="myac:myAccountType" xmlns:myac="http://www.endinfosys.com/Voyager/myAccount">
    <myac:chargedItems>
      <myac:title>Charged Items</myac:title>
      <myac:clusterChargedItems>
        <myac:cluster>
          <myac:clusterName>dev65ncdb</myac:clusterName>
          <myac:ubSiteId>1@QA20012DB20020613131313</myac:ubSiteId>
        </myac:cluster>
        <myac:permitRenewal>true</myac:permitRenewal>
        <myac:chargedItem>
          <myac:itemId>17365</myac:itemId>
          <myac:itemBarcode>32608</myac:itemBarcode>
          <myac:dueDate>2008-08-01T23:59:00.000-05:00</myac:dueDate>
          <myac:origDueDate>2008-08-01T23:59:00.000-05:00</myac:origDueDate>
          <myac:todaysDate>2008-07-30T18:33:45.000-05:00</myac:todaysDate>
          <myac:title>Caravan : the assembled tales of John Galsworthy.</myac:title>
          <myac:author>Galsworthy, John, 1867-1933.</myac:author>
          <myac:location>Main Collection à, á, â, ã, ç, é, ê, í, ó, ô, õ, ú, ü.</myac:location>
          <myac:callNumber>PZ3.G139 Car</myac:callNumber>
          <myac:statusCode>2</myac:statusCode>
          <myac:itemtype>BOOK</myac:itemtype>
        </myac:chargedItem>
        <myac:chargedItem>
          <myac:itemId>32437</myac:itemId>
          <myac:itemBarcode>68840</myac:itemBarcode>
          <myac:dueDate>2008-08-01T23:59:00.000-05:00</myac:dueDate>
          <myac:origDueDate>2008-08-01T23:59:00.000-05:00</myac:origDueDate>
          <myac:todaysDate>2008-07-30T18:33:45.000-05:00</myac:todaysDate>
          <myac:title>Care and feeding of animals, illustrated by Hoot von Zitzewitz.</myac:title>
          <myac:author>Small, Mary Cox.</myac:author>
          <myac:location>Main Collection à, á, â, ã, ç, é, ê, í, ó, ô, õ, ú, ü.</myac:location>
          <myac:callNumber>PZ10.S699 Car</myac:callNumber>
          <myac:statusCode>2</myac:statusCode>
          <myac:itemtype>BOOK</myac:itemtype>
        </myac:chargedItem>
      </myac:clusterChargedItems>
    </myac:chargedItems>
  </serviceData>
</voyagerServiceData>