BookbagService

General Purpose

Get, clear, or add to a patron’s bookbag/My List content.

Requirements

Voyager 7.x and higher.

Input URL Syntax

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

http://server:port/vxws/BookbagService

Input XML Example

This service expects to receive via POST method a ServiceParametersDocument containing a patronIdentifier and the parameters defined below:

  • action – defines which action the service is to provide. Must be one of “get” or “clear” or “add”.If the action parameter is “add” then the ServiceParametersDocument must also contain a definedParameter of bookbagRecordsType containing the bibId and databaseCode of each bibliographic record to be added to the bookbag.
    If the action parameter is “clear” then there are two possible behaviors:
  • If the ServiceParametersDocument contains a definedParameter of bookbagRecordsType containing the bibId and databaseCode of each bibliographic record to be removed from the patron’s bookbag, then only those records will be removed.
  • If there is no definedParameter, then all records will be removed from the patron’s bookbag.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters">
   <ser:parameters>
      <ser:parameter key="action">
         <ser:value>add</ser:value>
      </ser:parameter>
   </ser:parameters>
   <ser:patronIdentifier lastName="LastName" patronHomeUbId="1@DB" patronId="562">
      <ser:authFactor type="B">150</ser:authFactor>
   </ser:patronIdentifier>
   <ser:definedParameters xsi:type="pat:bookbagRecordsType" xmlns:pat="http://www.endinfosys.com/Voyager/patronPreferences" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <pat:record>
         <pat:bibId>54414</pat:bibId>
         <pat:databaseCode>LOCAL</pat:databaseCode>
      </pat:record>
   </ser:definedParameters>
</ser:serviceParameters>

Output XML Example

This service will return a VoyagerServiceDataDocument wrapping a BookbagType element, which contains the patron’s bookbag contents, and other information necessary to display the patron’s bookbag contents.

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="pat:bookbagType" xmlns:pat="http://www.endinfosys.com/Voyager/patronPreferences">
    <pat:bibHeadings>
      <pat:heading1>author</pat:heading1>
      <pat:heading2>title</pat:heading2>
      <pat:heading3>publisher_date</pat:heading3>
    </pat:bibHeadings>
    <pat:bookbagRecords>
      <pat:record>
        <pat:bibId>81874</pat:bibId>
        <pat:databaseCode>LOCAL</pat:databaseCode>
        <pat:bibText1/>
        <pat:bibText2>Everything for winter : a complete activity book for teachers of young children : activities for December, January, and February / edited by Kathy Charner ; illustrations by Joan Waites.</pat:bibText2>
        <pat:bibText3>c1997.</pat:bibText3>
        <pat:saveDate>2008-07-29 12:43:25</pat:saveDate>
      </pat:record>
      <pat:record>
        <pat:bibId>54414</pat:bibId>
        <pat:databaseCode>LOCAL</pat:databaseCode>
        <pat:bibText1/>
        <pat:bibText2>Advances in petroleum chemistry and refining.</pat:bibText2>
        <pat:bibText3>1958-1965.</pat:bibText3>
        <pat:saveDate>2008-08-11 14:58:23</pat:saveDate>
      </pat:record>
    </pat:bookbagRecords>
  </serviceData>
</voyagerServiceData>