Update Booking Ex
Combined Booking update function that can be used to update a booking.
UpdateBookingEx combines the functionality of
- Update Booking
- Add Service
- Cancel Service
- Update Passenger
- Add Payment
Request Profile Table
| Element | @Attribute |
Description/Contents |
| UpdateBookingEx / UpdateBookingExRequest |
Root element of message. |
| BookingID |
ProCharter Booking ID of the booking to retrieve |
| Accommodation |
System Code for Accommodation (see Get Sys Codes for more information). Category Code = 'ACC' |
| AccommodationRoom |
Accommodation room number |
| ArrivalNote |
Arrival note |
| @ArrivalDate |
Arrival Date. If not specified returns '0001-01-01T00:00:00' |
| MarketingFields |
Collection of MarketingField objects |
| MarketingField |
Object representing a single MarketingField |
| @Index |
MarketingField index |
| @Value |
System Code for Marketing Field value (see Get Sys Codes for more information). Category Code details are available from Get Marketing Field Config. |
| Pickup |
Object representing the Pickup for this Booking. Note: There is also a Pickup on the Passenger object that this overrides this value if specified. |
| @Code |
Pickup Location Code (see Get Pickups for more information) |
| @PickupTime |
Pickup Time. Note: This is returned as a date/time |
| AddServices |
Collection of AddService requests |
| AddService_RQ |
Object representing a single AddService request (see Add Service for more information) |
| CancelServices |
Collection of CancelService requests |
| CancelService_RQ |
Object representing a single CancelService request (see Cancel Service for more information) |
| UpdatePassengers |
Collection of UpdatePassenger requests |
| UpdatePassenger_RQ |
Object representing a single UpdatePassenger request (see Update Passenger for more information) |
| AddPayments |
Collection of AddPayment requests |
| AddPayment_RQ |
Object representing a single AddPayment request (see Add Payment for more information) |
Example message:
<UpdateBookingEx>
<UpdateBookingExRequest>
<BookingID>78857</BookingID>
<Accommodation>AHO</Accommodation>
<AccommodationRoom>tba</AccommodationRoom>
<ArrivalNote>Arriving night before</ArrivalNote>
<ArrivalDate>2016-01-18</ArrivalDate>
<MarketingFields>
<MarketingField Index="1" Value="SLT"/>
<MarketingField Index="2" Value="NO"/>
<MarketingField Index="3" Value="CAR"/>
<MarketingField Index="4" Value="FRI"/>
<MarketingField Index="5" Value="INT"/>
<MarketingField Index="6"/>
<MarketingField Index="7" Value="YES"/>
<MarketingField Index="8" Value="NO"/>
</MarketingFields>
<Pickup Code="P11" PickupTime="0001-01-01T03:30:00"/>
<AddServices>
<AddService_RQ>
<BookingID>78857</BookingID>
<PassengerID>0</PassengerID>
<ProductCode>TRN</ProductCode>
<Quantity>2</Quantity>
<Note>Test</Note>
</AddService_RQ>
</AddServices>
<CancelServices>
<CancelService_RQ>
<BookingID>78857</BookingID>
<ServiceID>408841</ServiceID>
</CancelService_RQ>
</CancelServices>
<UpdatePassengers>
<UpdatePassenger_RQ>
<BookingID>78857</BookingID>
<PassengerID>169270</PassengerID>
<Title/>
<FirstName>Toni</FirstName>
<LastName>Test</LastName>
<Email>test@cwc.co</Email>
<Phone1>+61 7 3889 8240</Phone1>
<NextOfKin>Bill and Beth Test</NextOfKin>
<NextOfKinPhone>+61 7 7777 7777</NextOfKinPhone>
<NextOfKinRelationShip>Parents</NextOfKinRelationShip>
<Comments>Allergic to Tomatoes</Comments>
<State>QLD</State>
<Country>AUS</Country>
<MedicalDeclaration>true</MedicalDeclaration>
<BookPaxMarketingFields>
<MarketingField Index="1" Value="<30"/>
<MarketingField Index="2" Value="AUS"/>
<MarketingField Index="3" Value="UNS"/>
<MarketingField Index="4" Value="SM"/>
</BookPaxMarketingFields>
<PaxMarketingFields>
<MarketingField Index="1" Value="1al"/>
<MarketingField Index="2" Value="ASM"/>
<MarketingField Index="3" Value="SOK"/>
<MarketingField Index="4" Value="YES"/>
</PaxMarketingFields>
<Pickup Code="P11" PickupTime="0001-01-01T03:30:00"/>
</UpdatePassenger_RQ>
</UpdatePassengers>
<AddPayments>
<AddPayment_RQ>
<BookingID>78857</BookingID>
<PaymentType>CC</PaymentType>
<TotalAmount>102</TotalAmount>
<TransactionFee>2</TransactionFee>
<Note>Test</Note>
</AddPayment_RQ>
</AddPayments>
</UpdateBookingExRequest>
</UpdateBookingEx>
Response Profile Table
| Element | @Attribute |
Description/Contents |
| UpdateBookingResponse / UpdateBookingResult |
Root element of message. |
| Success |
Indicates if the Booking was updated successfully |
| AddServices |
Collection of AddService responses |
| AddService_RS |
Object representing a single AddService response (see Add Service for more information) |
| CancelServices |
Collection of CancelService responses |
| CancelService_RS |
Object representing a single CancelService response (see Cancel Service for more information) |
| UpdatePassengers |
Collection of UpdatePassenger responses |
| UpdatePassenger_RS |
Object representing a single UpdatePassenger response (see Update Passenger for more information) |
| AddPayments |
Collection of AddPayment responses |
| AddPayment_RS |
Object representing a single AddPayment response (see Add Payment for more information) |
Example message:
<UpdateBookingExResponse xmlns="ResLink">
<UpdateBookingExResult>
<TimeStamp>2016-01-15T09:33:28.1960943+10:00</TimeStamp>
<Status Code="0" Message=""/>
<Errors/>
<Warnings/>
<Success>true</Success>
<AddServices>
<AddService_RS>
<TimeStamp>2016-01-15T09:33:21.2552835+10:00</TimeStamp>
<Status Code="0" Message=""/>
<Errors/>
<Warnings/>
<Success>true</Success>
<Service ID="408842" IsMainRequest="false" Quantity="2" Price="10" PriceAlreadyPaid="false" Commission="0.0000" CommissionAlreadyPaid="false" AmountLeftToPay="10" AmountPaidToCompany="0.0000" AmountAfterCommission="10" ReceiptLinesTotal="0.0000" PaxID="169269" PaxName="Test, Tim" Cancelled="false" CanCancel="true">
<Product Code="TRN" Description="Luggage Storage" Category="TRN"/>
</Service>
</AddService_RS>
</AddServices>
<CancelServices>
<CancelService_RS>
<TimeStamp>2016-01-15T09:33:23.2784347+10:00</TimeStamp>
<Status Code="11" Message="Service 408841 cannot be cancelled: Service already cancelled"/>
<Errors/>
<Warnings/>
<Success>false</Success>
</CancelService_RS>
</CancelServices>
<UpdatePassengers>
<UpdatePassenger_RS>
<TimeStamp>2016-01-15T09:33:24.1998699+10:00</TimeStamp>
<Status Code="0" Message=""/>
<Errors/>
<Warnings/>
<Success>true</Success>
</UpdatePassenger_RS>
</UpdatePassengers>
<AddPayments>
<AddPayment_RS>
<TimeStamp>2016-01-15T09:33:24.9209931+10:00</TimeStamp>
<Status Code="0" Message=""/>
<Errors/>
<Warnings/>
<Success>true</Success>
</AddPayment_RS>
</AddPayments>
</UpdateBookingExResult>
</UpdateBookingExResponse>