Create a Charter Booking.
| Element | @Attribute |
Description/Contents |
| MakeCharterBooking / MakeCharterBookingRequest |
Root element of message. |
| BookingAgent (optional) |
Element indicating 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 indicating 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 |
ProCharter Member ID. |
| PaymentToken |
Payment Token issued by a Payment Gateway to store on the booking. |
| Pickup |
Pickup Location code (see GetPickupLocations for more details). |
| PaxList |
Element indicating a list of passengers. |
| Pax |
Element indicating 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 indicating a list of marketing fields for the passenger. See GetMarketingFields for how to retrieve marketing fields. |
| MarketingField |
Element indicating 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 indicating a list of notes. |
| string |
Element indicating a note string value. |
| Services |
Collection of BookingServices. |
| Booking Service |
Element indicating an additional service for the booking. |
| @ProductCode |
Product Code for the service |
| @Quantity |
Quantity of the service |
| @Price |
Total Price for the service |
| @Commission |
Total Commission for the service |
Receipt
(optional) |
Element indicating a payment receipt. The amount receipted in ProCharter is Total - Commission. |
| 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. |
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. |
| BookTrans |
Collection of BookTran objects |
| BookTran |
Object representing the Charter/Hire of a specific resource for a specific date range. |
| @ResourceID |
ID of the Resource. |
| @DateFrom |
Start date of the charter. |
| @DateTo |
End date of the charter. |
| @BookTranSpecialID |
ID of the BookTranSpecial (if applicable), submit 0 if no BookTranSpecial. |
| @InPortAccommodation |
Flag to indicate if the Charter is for inport accommodation (aka sleepaboard/stayaboard) the night before a charter begins. |
| @Price |
Price of the charter calculated using Calculate BookTran Price (will be validated as part of the booking process). |
You want to create a BookTran with ResourceID 170, from 3/4/2020 and 10/4/2020 (with in port accommodation on 3/4/20).
<MakeCharterBooking>
<MakeCharterBookingRequest>
<BookingAgent>
<ID/>
<GUID>TEST</GUID>
<Contact>Test Contact</Contact>
<Email>testagent@example.org</Email>
<Phone>07 3333 3333</Phone>
<OtherRef>TEST123</OtherRef>
<OtherRef2>XYZ987</OtherRef2>
<SupplierNote/>
</BookingAgent>
<SellingAgent>
<ID/>
<GUID>DEV</GUID>
</SellingAgent>
<Booking>
<Name>Test Charter</Name>
<Email>test@example.org</Email>
<Phone>04 4444 4444</Phone>
<MemberID/>
<PaymentToken/>
<Pickup/>
</Booking>
<PaxList>
<Pax>
<FirstName>Al</FirstName>
<LastName>Smith</LastName>
<Email>text@example.org</Email>
<Phone>04 4444 4444</Phone>
<Comments>Test Booking</Comments>
<CommentsInternal>VIP</CommentsInternal>
<OtherRef/>
<OtherRef2/>
<MarketingFields>
<MarketingField Type="Pax" Index="1" Name="Diet" Value="NNU" />
<MarketingField Type="BookPax" Index="3" Name="Dive Status" Value="CER" />
</MarketingFields>
<Address>
<Line1>Unit 1</Line1>
<Line2>1000 Some St</Line2>
<Line3>Brendale</Line3>
<PostCode>4500</PostCode>
<State Code="QLD" Name="Queensland"/>
<Country Code="AUS" Name="Australia"/>
</Address>
</Pax>
</PaxList>
<MarketingFields/>
<Notes>
<string>Test Booking created 2020-01-27</string>
</Notes>
<Receipts>
<Receipt>
<Total>603</Total>
<Commission>0</Commission>
<TransactionFee>3</TransactionFee>
<FTR>TST0001</FTR>
<Currency>AUD</Currency>
<PaymentType>VI</PaymentType>
</Receipt>
</Receipts>
<MakeTestBooking>false</MakeTestBooking>
<SendConfirmationEmail>true</SendConfirmationEmail>
<BookTrans>
<BookTran ResourceID="130" DateFrom="2020-04-03" DateTo="2020-04-04" BookTranSpecialID="0" InPortAccommodation="true" Price="200"/>
<BookTran ResourceID="130" DateFrom="2020-04-04" DateTo="2020-04-10" BookTranSpecialID="2" InPortAccommodation="true" Price="1200"/>
</BookTrans>
<Services/>
</MakeCharterBookingRequest>
</MakeCharterBooking>
<MakeCharterBookingResponse xmlns="ResLink">
<MakeCharterBookingResult>
<ID>WR10029</ID>
<CalculatedPrice>1400</CalculatedPrice>
<CalculatedCommission>350</CalculatedCommission>
</MakeCharterBookingResult>
</MakeCharterBookingResponse>