General Purpose

Validates a proposed media item booking.


Voyager 7.x and higher.

Input URL Syntax

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


Input XML Example

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.


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

Output XML Example

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.


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