Get Operator Voucher Component Availability

Request Profile Table

Element \| @Attribute	Description/Contents
GetOpVoucherComponentAvailability_RQ	Root element of message.
ComponentID	Element indicating ID of Operater Voucher Component.
PaxCount	Element indicating number of people to check availability for.
DateFrom	Start Date of the date range to check availability for.
DateTo	End Date of the date range to check availability for.
Agent	Element representing the agent. To specify an agent you can just provide either the ID, or the GUID. If both are provided ResLink will make a check to see if the GUID and ID match in the database and will error if they don't.
PackageID	Package Id used for pricing. If set to 0 the standalone/addon rates are returned. If an ID is specified then the rates for the component on the specified package are returned.
@ID	(optional) The agent ID to set up commissions and costs.
@GUID	(optional) The agent GUID to set up commissions and costs

Scenario:

You want to retrieve Availability of the Operator Voucher Component with ID 307. The rates to be returned are for TEST_AGENT for a standalone/addon booking.

Example message:

<?xml version="1.0" encoding="utf-8"?>
<GetOpVoucherComponentAvailability_RQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ComponentID xmlns="ResLink">307</ComponentID>
  <PaxCount xmlns="ResLink">1</PaxCount>
  <DateFrom xmlns="ResLink">2013-07-17</DateFrom>
  <DateTo xmlns="ResLink">2013-07-20</DateTo>
  <PackageID xmlns="ResLink">0</PackageID>
  <Agent xmlns="ResLink" ID="" GUID="TEST_AGENT" />
</GetOpVoucherComponentAvailability_RQ>

Response Profile Table

Element | @Attribute

Description/Contents

GetOpVoucherComponentAvailability_RS

Root element of message.

ComponentAvailabilities

Collection of Component Availabilities.

ComponentAvailability

Element indicating a single availability for an Operator Voucher Component.

@ID

The ID of the Component Availability.

@AvailabilityType

The type of availability. Valid values are [NONE, ALLOCATION, LIVE, FREESELL].

@StartDate

The starting date/time of the Component Availability.

@Available

Number of components available.

PricingTable

Collection of PriceItem elements

PriceItem

Element representing a single Pricing value

@PaxCount

The number of pax the price is for

@RackRate

The Rack Rate for the Operator Voucher Component.

@Commission

The Commission for the Operator Voucher Component.

@Currency

Currency Code.

Status

Element indicating the return status of the transaction.

@Code

A numerical code for the status.

@Message

The message of the status. The messages (and corresponding codes) returned are:

Code	Message
0	Get Component Availability request successful.
1	Valid Start Date for availability is required. The Start Date must be greater than the Current Date.
2	Valid Finish Date for availability is required. The Finish Date must be greater than the Current Date.
3	Start Date must be before Finish Date.
4	Invalid Pax Count. The PaxCount specified must be greater than 0.

Example message:

<?xml version="1.0" encoding="utf-16"?>
<GetOpVoucherComponentAvailability_RS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ComponentID xmlns="ResLink">307</ComponentID>
  <PaxCount xmlns="ResLink">1</PaxCount>
  <DateFrom xmlns="ResLink">2013-07-17</DateFrom>
  <DateTo xmlns="ResLink">2013-07-20</DateTo>
  <ComponentAvailabilities xmlns="ResLink">
    <ComponentAvailability ID="41472" AvailabilityType="ALLOCATION" StartDate="2013-07-17T00:00:00" Available="5" />
        <PricingTable>
            <PriceItem PaxCount="1" RackRate="30" Commission="9.0" Currency="AUD" />
        </PricingTable>
    <ComponentAvailability ID="41473" AvailabilityType="ALLOCATION" StartDate="2013-07-18T00:00:00" Available="3" />
        <PricingTable>
            <PriceItem PaxCount="1" RackRate="30" Commission="9.0" Currency="AUD" />
        </PricingTable>
    <ComponentAvailability ID="41474" AvailabilityType="ALLOCATION" StartDate="2013-07-19T00:00:00" Available="9" />
        <PricingTable>
            <PriceItem PaxCount="1" RackRate="33" Commission="9.10" Currency="AUD" />
        </PricingTable>
  </ComponentAvailabilities>
  <Status Code="0" xmlns="ResLink" />
  <TimeStamp xmlns="ResLink">2008-08-22T13:38:30.7035532+10:00</TimeStamp>
  <Errors xmlns="ResLink" />
  <Warnings xmlns="ResLink" />
</GetOpVoucherComponentAvailability_RS>