MediaValidateItemService

Validates a proposed media item booking.

Voyager 7.x and higher.

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

http://server:port/vxws/MediaValidateItemService

Click here to view the ServiceParametersSchema
Click here to view the VoyagerXmlSchema
Click here to view the ServiceDataSchema

This service expects to receive a ServiceParametersDocument containing a patronIdentifier and the following required parameters:

• startTime – the booking start time.
• endTime – the booking end time.
• bibId – the bibliographic record id of the item to be booked.
• mfhdId – the mfhd record id of the item to be booked.
• itemId – the item record id of the item to be booked.
• mediaTypeId – the booking end time.
• mediaPickOrDel – the the media pickup or delivery code.
  If mediaPickOrDel == 2 for deliver, then the following parameter is also required:
• deliverLocId – the delivery location id.
  If mediaPickOrDel == 3 for pickup, then the following parameters is also required:
• PICK – the pickup location id.
  The ServiceParametersType document may also contain the following optional parameters:
• equipTypes – one or more equipment type ids.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters">
  <ser:parameters>
    <ser:parameter key="mfhdId">
      <ser:value>62871</ser:value>
    </ser:parameter>
    <ser:parameter key="bibDbCode">
      <ser:value>LOCAL</ser:value>
    </ser:parameter>
    <ser:parameter key="mediaTypeId">
      <ser:value>1</ser:value>
    </ser:parameter>
    <ser:parameter key="recCount">
      <ser:value>10</ser:value>
    </ser:parameter>
    <ser:parameter key="mediaLocation">
      <ser:value>Library-Media Scheduling</ser:value>
    </ser:parameter>
    <ser:parameter key="recPointer">
      <ser:value>1</ser:value>
    </ser:parameter>
    <ser:parameter key="searchId">
      <ser:value>6</ser:value>
    </ser:parameter>
    <ser:parameter key="itemId">
      <ser:value>68963</ser:value>
    </ser:parameter>
    <ser:parameter key="equipTypes">
      <ser:value>151|AV Cart</ser:value>
    </ser:parameter>
    <ser:parameter key="bibId">
      <ser:value>40212</ser:value>
    </ser:parameter>
    <ser:parameter key="endTime">
      <ser:value>2009-01-19 15:00:00</ser:value>
    </ser:parameter>
    <ser:parameter key="PICK">
      <ser:value>4|Media Department</ser:value>
    </ser:parameter>
    <ser:parameter key="bibDbName">
      <ser:value>dev71ncdb - SysAdmin db def name</ser:value>
    </ser:parameter>
    <ser:parameter key="mediaPickOrDel">
      <ser:value>3</ser:value>
    </ser:parameter>
    <ser:parameter key="mediaTypeDesc">
      <ser:value>Videocassette Recording</ser:value>
    </ser:parameter>
    <ser:parameter key="requestCode">
      <ser:value>MEDIAITEM</ser:value>
    </ser:parameter>
    <ser:parameter key="requestSiteId">
      <ser:value>1@QA20012DB20020613131313</ser:value>
    </ser:parameter>
    <ser:parameter key="startTime">
      <ser:value>2009-01-01 15:00:00</ser:value>
    </ser:parameter>
  </ser:parameters>
  <ser:patronIdentifier lastName="Patel" patronHomeUbId="1@QA20012DB20020613131313" patronId="185">
    <ser:authFactor type="B">2620</ser:authFactor>
  </ser:patronIdentifier>
</ser:serviceParameters>

This service will return a VoyagerServiceDataDocument containing a messages element which contains either a success or failure message indicating if the item may be booked at the given time.

Example:

<?xml version="1.0" encoding="UTF-8" ?>
<voyagerServiceData xmlns="http://www.endinfosys.com/Voyager/serviceParameters">
  <messages>
    <message type="blocked" errorCode="com.endinfosys.voyager.requests.PatronRequestsException.RequestBlockedException" blockCode="meditemintervalmax" requestCode="MEDIAITEM"/>
  </messages>
</voyagerServiceData>