Cancel

General Purpose

Cancel requests for a patron.

Requirements

Voyager 7.x and higher.

Input URL Syntax

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

http://server:port/vxws/CancelService

Input XML Example

This service expects to receive via POST method a ServiceParametersDocument containing a patronIdentifier and a definedParameters of myAccountServiceParametersType containing requestIdentifier contains the required parameters below:

  • patronId, an identifier of the patron from whom information is requested
  • ubId, an identifier of the patron’s home cluster/database
  • one or more request identifiers, each of which includes
    • a dbKey
    • a request ID
    • a request type (called holdType in VACS)

Example:

<?xml version="1.0" encoding="UTF-8"?>
<ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters">
   <ser:parameters/>
   <ser:patronIdentifier lastName="LastName" patronHomeUbId="1@DB" 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:requestIdentifier>
         <myac:itemID>61601</myac:itemID>
         <myac:holdRecallID>1495</myac:holdRecallID>
         <myac:holdType>H</myac:holdType>
         <myac:dbKey>QA20012DB20020613131313</myac:dbKey>
         <myac:ubHoldingsDbKey>0</myac:ubHoldingsDbKey>
      </myac:requestIdentifier>
   </ser:definedParameters>
</ser:serviceParameters>

Output XML Example

This service will return a VoyagerServiceDataDocument wrapping a MyAccountType element, which contains request information, divided into available items and pending requests.

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:availItems>
      <myac:title>Available Items</myac:title>
    </myac:availItems>
    <myac:requests>
      <myac:title>Pending Requests</myac:title>
      <myac:requestItem>
        <myac:itemID>28010</myac:itemID>
        <myac:holdRecallID>832</myac:holdRecallID>
        <myac:replyNote/>
        <myac:callslipStatus>7</myac:callslipStatus>
        <myac:nofillReason/>
        <myac:holdType>C</myac:holdType>
        <myac:itemTitle>Pet show!</myac:itemTitle>
        <myac:expireDate>2008-07-30T17:05:39.000-05:00</myac:expireDate>
        <myac:dbKey>QA20012DB20020613131313</myac:dbKey>
        <myac:dbName>dev65ncdb</myac:dbName>
        <myac:pickuplocation>Juvenile Education Stacks</myac:pickuplocation>
      </myac:requestItem>
    </myac:requests>
  </serviceData>
</voyagerServiceData>