TravelCaster API - Flights - GetSeatMap operation

Back to Flights home.

After you have confirmed the selected options and the flight fare (ConfirmFlightAvailability or GetFareOptions), you can query for seating options (GetSeatMap). If the operation succeeds, the API will return the seat map for the fare segments and you can add them to a BookFlight call to book the flight and the seats altogether (does not error should the seat booking fail).

The GetSeatMap operation uses the FlightSeatMapRequest which can be created with the results from ConfirmFlightAvailability or GetFareOptions to get seat options for the fare segments.

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

JSON

http://endpoint/api/version/FlightService.json/GetSeatMap [POST]

url-encoded parameter: booking([FlightBookingRequest])

returns: FlightSeatMapResponse

WebService

http://endpoint/api/version/FlightService.asmx

operation: GetSeatMap

parameters: booking ([FlightBookingRequest])

returns: FlightSeatMapResponse

Structure of the FlightBookingRequest object

FlightSeatMapRequest	
 |
 |_ Token (string)
 |_ TransactionID (string)
 |_ TransactionCode (string)
 |_ TransactionMessage (string)
 |
 |_ RecommendationID (string)
 |_ BookingNumber (string - not used for this operation)
 |_ BookingFare (FlightFare object - see [GetFlightAvailability](operation-getflightavailability) for structure)
 |_ Passengers (PaxInformation[])
    |
    |_ Number (int - 1-based index of this passenger in the array)
    |_ LastName (string)
    |_ FirstName (string)
    |_ DateOfBirth (string - ISO 8601 YYYY-MM-DD format)
    |_ Gender (string - MR, MS, MRS)
    |_ RequiredInformations (AdditionalBookingInformation[])
       |_ FieldName (string - code for required information for this passenger, see reference below)
       |_ FieldValue (string)

Response time

Some providers can take up to 30 seconds to respond to a seat map request.

Structure of the FlightSeatMapResponse object

FlightSeatMapResponse (inherits APITransaction)
 |
 |_ Token (string)
 |_ TransactionID (string)
 |_ TransactionMessage (string)
 |_ TransactionCode (string)
 |
 |_ SeatMap (FlightSeatMap)
      |
      |_ Segments (SeatMapSegment[])
             |
             |_ SegmentNumber (int)
             |_ Message (string - provider message for the segment, if applicable)
             |_ Cabins (SeatMapSegmentCabin[])
                    |
                    |_ RowTypes (CabinRowType[])
                    |      |
                    |      |_ FromRow (int)
                    |      |_ ToRow (int)
                    |      |_ WingRowFrom (int - start of rows between wings)
                    |      |_ WingRowTo (int - start of rows between wings)
                    |      |_ SeatTypes (CabinSeatType[])
                    |             |
                    |             |_ SeatColumn (string)
                    |             |_ SeatType (string - Values: W = Window, WA = Window and aisle, A = Aisle, 9 = Middle)
                    |
                    |_ Rows (CabinRow[])
                    |      |
                    |      |_ RowNumber (int)
                    |      |_ Seats (RowSeat[])
                    |             |
                    |             |_ SeatColumn (string)
                    |             |_ SeatStatus (string - Values: F= Free, O = Occupied, Z = For other)
                    |             |_ SeatType (string[] - possibly multiple values, normalized across providers, see below for possible values)
                    |
                    |_ SeatCharges (SeatCharge[] - maps seats to charges)
                           |
                           |_ AppliesToPassengers (string[])
                           |_ RowNumber (int)
                           |_ SeatColumns (string[])
                           |_ SeatAmount (double)
                           |_ SeatCurrency (string)
                           |_ SeatFee (double)

Cabins.RowTypes.SeatTypes.SeatType values

  • W = Window
  • WA = Window and aisle
  • A = Aisle. The map should render the aisle to the left, right, or both, based on the received A or WA code.
  • 9 = Middle

Cabins.Rows.Seats.SeatType values

  • A: Not aplicable to child or infant.
  • L: Extra leg-room.
  • E: Exit row.
  • C: Economy premium.
  • N: Galley/no seat.
  • W: Overwing.
  • B: Bassinet.
  • I: Suitable for infant.
  • NG : Near galley.

Notes

  • Dates sent to and from the API are all string-based and in the YYYY-MM-DD ISO-8061 format.

Transaction status

  • TransactionCode: When a transaction had no errors, a null value will be returned. Any value different than null means something went wrong in the API. See the Transaction Codes page for a list of possible codes.
  • TransactionMessage Depending on the transaction, it could provide you a more granular error description that the one from the TransactionCode by itself.

Back to Flights home.

See change history for this file
Loading...