MediaItemService
General Purpose
Retrieves a booking info, pick up locations, and a list of available in-room equipment for a given item.
Requirements
Voyager 7.x and higher.
Input URL Syntax
This service expects to receive an XML document via POST method.
http://server:port/vxws/MediaItemService
XSD
Click here to view the ServiceParametersSchema
Click here to view the VoyagerXmlSchema
Click here to view the ServiceDataSchema
Click here to view the VoyagerRequestsSchema
Input XML Example
This service expects to receive a ServiceParametersDocument containing a patronIdentifier and the following required parameter:
- itemId – the id of the item.
Example:
<?xml version="1.0" encoding="UTF-8"?> <ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters"> <ser:parameters> <ser:parameter key="itemId"> <ser:value>68963</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>
Output XML Example
This service will return a VoyagerServiceDataDocument containing a requestDefinition element which in turn contains a bookingInfo element, a pickUpLocations element and an availableEquipment element. See the VoyagerRequestsSchema for more details on the contents of those elements.
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="req:requestsCollectionType" xmlns:req="http://www.endinfosys.com/Voyager/requests"> <req:requestDefinition> <req:bookingInfo interval="Hour" maxLength="3"/> <req:pickUpLocations> <req:location id="4|Media Department" isDefault="Y">Media Department</req:location> </req:pickUpLocations> <req:availableEquipment> <req:pickup> <req:equipment> <req:copy id="151|AV Cart">AV Cart</req:copy> <req:copy id="156|TV VCR Combination">TV VCR Combination</req:copy> <req:copy id="153|DVD Player">DVD Player</req:copy> <req:copy id="155|TV-DVD AV Cart">TV-DVD AV Cart</req:copy> <req:copy id="149|TV">TV</req:copy> </req:equipment> </req:pickup> </req:availableEquipment> </req:requestDefinition> </serviceData> </voyagerServiceData>