ResLink

Validate Package Booking


Request Profile Table

Element | @Attribute Description/Contents
ValidatePackageBooking_RQ Root element of message.
BookingAgent (optional) Element representing a booking agent. Leave empty to make a direct booking.
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 out if they don't.
  ID ID of the booking agent.
  GUID GUID identifier for booking agent.
  Contact Contact name.
  Email Email address.
  Phone Phone number.
  OtherRef Booking Agent Reference.
  OtherRef2 Second Booking Agent Reference.
SellingAgent (optional) Element representing a selling 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 out if they don't.
  ID ID of the selling agent.
  GUID GUID identifier for selling agent.
Booking Element indicating the booking.
  Name Booking name.
  Email Contact email address for booking.
  Phone Contact phone for booking.
  MemberID (optional) ID of the Member to allocate this booking to
PackageID ID of the Package
PackageTemplateComponents Collection of PackageTemplateComponent elements
PackageTemplateComponent Element representing a single Package Template OR Addon
TemplateID ID of the PackageTemplate (from GetPackageDetails).
For addon components this should be set to 0.
ComponentID ID of the Component selected for the PackageTemplate
ComponentAvailabilityID ID of the Component date (from GetOpVoucherComponentAvailability.
For open dated components this should be set to 0.
ComponentAvailabilityDate Component date(from GetOpVoucherComponentAvailability.
For open dated components this will be ignored.
PaxList Element representing a list of passengers.
  Pax Element representing a passenger.
    Firstname First name.
    LastName Last name.
    Email Email address.
    Phone Phone number.
    Country_GUID Passenger's country as identified by ProCharter System Code GUID
    State_GUID Passenger's state as identified by ProCharter System Code GUID
    Comments Comments.
    OtherRef Passenger Agent Reference.
    OtherRef2 Passenger Second Agent Reference.
    MarketingFields
    (optional)
Element representing a list of marketing fields for the passenger. See GetMarketingFields for how to retrieve marketing fields.
      MarketingField Element representing a marketing field.
      @Type Can be either "Pax", or "BookPax".
      @Index Unique index for the field type.
      @Name Description of the field - this can be left blank.
      @Value Value of the marketing field.
MarketingFields
(optional)
Element indicating a list of marketing fields for the booking.
  MarketingField Element indicating a marketing field.
  @Type Use "Booking".
  @Index Unique index for the field type.
  @Name Description of the field - this can be left blank.
  @Value Value of the marketing field.
Notes (optional) Element representing a list of notes.
  string Element representing a note string value.
Receipts Element representing a list of Receipts
Receipt Element representing a payment receipt.
  Total Payment total.
  Commission The portion of the Total amount that is the Commission passed on to the Agent automatically as part of a Money Direct transaction.
  TransactionFee The portion of the Total amount that is the Transaction fee.
  FTR Financial Transaction Record - a string value used in Money Direct transactions.
  Currency Currency code of receipt
  PaymentType
  (optional)
The 2 character ProCharter PaymentType code for the payment. If omitted the default payment type will be used.
MakeTestBooking Create a test booking. Set to true to create a WebRes booking; the status will automatically be set to cancelled.
SendConfirmationEmail Flag to send a confirmation email from ProCharter when the booking has been created. Default is True.

Scenario:

You want to book Package 2 for John Smith + addon component #195.


Example message:

<?xml version="1.0" encoding="utf-8"?>
<ValidatePackageBooking_RQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <BookingAgent>
    <ID>1</ID>
    <GUID>TEST_GUID</GUID>
    <Contact>Bill</Contact>
    <Email>bill@example.org</Email>
    <Phone>03 3333 3333</Phone>
    <OtherRef>T1234</OtherRef>
  </BookingAgent>
  <SellingAgent>
    <ID>2</ID>
    <GUID>SOME_GUID</GUID>
  </SellingAgent>
  <Booking>
    <Name>Smith</Name>
    <Email>smith@example.org</Email>
    <Phone>07 7777 7777</Phone>
    <MemberID>123456</MemberID>
  </Booking>
  <PackageID>2</PackageID>
  <PackageTemplateComponents>
    <PackageTemplateComponent TemplateID="1" ComponentID="7" ComponentAvailabilityID="5346" ComponentAvailabilityDate="2011-07-05T00:00:00" />
    <PackageTemplateComponent TemplateID="2" ComponentID="67" ComponentAvailabilityID="0" ComponentAvailabilityDate="0001-01-01T00:00:00" />
    <PackageTemplateComponent TemplateID="0" ComponentID="195" ComponentAvailabilityID="0" ComponentAvailabilityDate="2011-07-04T00:00:00" />
  </PackageTemplateComponents>
  <PaxList>
    <Pax>
      <FirstName>John</FirstName>
      <LastName>Smith</LastName>
      <Email>smith@example.org</Email>
      <Phone>07 7777 7777</Phone>
      <MarketingFields />
    </Pax>
    <Pax>
      <FirstName>Jane</FirstName>
      <LastName>Smith</LastName>
      <MarketingFields />
    </Pax>
  </PaxList>
  <MarketingFields />
  <Notes>
    <string>test booking</string>
  </Notes>
  <Receipts>
    <Receipt>
      <Total>1000</Total>
      <Commission>0</Commission>
      <TransactionFee>12.50</TransactionFee>
      <FTR>543543534</FTR>
      <Currency>AUD</Currency>
    </Receipt>
  </Receipts>
  <MakeTestBooking>true</MakeTestBooking>
  <SendConfirmationEmail>true</SendConfirmationEmail>
</ValidatePackageBooking_RQ>


Response Profile Table

Element | @Attribute Description/Contents
ValidatePackageBooking_RS Root element of message.
ID The WebRes Booking ID prefixed with 'WR'.
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 Booking successful.
1 This booking already exists. ResLink will return this booking's data. If the run has already been booked, the booking will be loaded and this message returned with a matching warning message.
2 Booking cannot be processed: Package ID is invalid. The package id  in the request message is not a valid package id.
3 Booking cannot be processed: PaxList not specified. The PaxList in the request message is empty.
4 Booking cannot be processed: Agent's GUID could not be retrieved. The Agent's GUID could not be found that matches with the Agent's ID entered in the request message..
5 Booking cannot be processed: Agent's GUID could not be retrieved. The Agent's ID could not be found that matches with the Agent's GUID entered in the request message..
6 Booking cannot be processed: Booking Agent GUID does not match up with the Booking Agent ID specified.
7 Booking cannot be processed: Selling Agent GUID does not match up with the Selling Agent ID specified.
8 Booking cannot be processed: No pacakage components specified. The package components in the request message is empty.
9 Booking cannot be processed: Insufficient availability for Component : n.
10 Booking cannot be processed: Booking Agent :n does not have permission to book Component Name: n.
11 Booking cannot be processed: Voucher Type is invalid. The voucher type entered is invalid. Valid entries are "OP" and "AC"
8 Booking cannot be processed: Validation failed. See error list for violation.
Valid Indicates if the request would be a valid booking.
CalculatedPrice The calculated price of the booking.
CalculatedCommission The calculated commission of the booking.

Example message:

<?xml version="1.0" encoding="utf-8"?>
<ValidatePackageBooking_RS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ID xmlns="ResLink">WR6699</ID>
  <Status Code="0" Message="Booking successful." xmlns="ResLink" />
  <Valid xmlns="ResLink">true</Valid>
  <CalculatedPrice xmlns="ResLink">599</CalculatedPrice>
  <CalculatedCommission xmlns="ResLink">0</CalculatedCommission>
  <TimeStamp xmlns="ResLink"> 2008-07-07T16:08:35.0274665+10:00</TimeStamp>
  <Errors xmlns="ResLink" />
  <Warnings xmlns="ResLink" />
</ValidatePackageBooking_RS>