TravelCaster API - Flights - UpdateBookingExternalID operation

Back to Flights home.

---

Each booking has an external ID you can use to link the TravelCaster API booking with your own parent system. You can provide that external ID both at the time of the booking, or update the booking with that ID after the booking has been made. That ID can be then retrieved within the RetrieveBooking operation.

By design, you can only add or update the external ID once. If the booking you are trying to update already has an external ID, the operation will not fail, but the original external ID will be returned and the booking will remain unchanged.

The UpdateBookingExternalID operation returns a UpdateBookingExternalIDResponse object, containing the current external ID assigned to the booking. If it was updated, it will reflect the ID you just sent, otherwise it will reply with the existing ID.

This operation is only available on API version 1.6.

To call this operation you will need a valid token, obtained previously with the GetAccessToken operation. If your token is no longer valid, you will receive a 1210 error. See the Transaction Codes page for more information.

Request

http://endpoint/api/version/FlightService.format/UpdateBookingExternalID

(POST) body - UpdateBookingExternalIDRequest

format: json | xml

returns: UpdateBookingExternalIDResponse

Structure of the UpdateBookingExternalIDRequest object

UpdateBookingExternalIDRequest
|_ Token
|
|_ BookingNumber (string)
|_ BookingExternalID (string - max 50 chars)

Structure of the UpdateBookingExternalIDResponse object

UpdateBookingExternalIDResponse 
|_ Token
|_ TransactionID (string)
|_ TransactionCode (string)
|_ TransactionMessage (string)
|
|_ BookingNumber (string)
|_ BookingExternalID (string)

---

Back to Flights home.