Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Insert excerpt
API Messages with Examples
API Messages with Examples
nameLegend
nopaneltrue

Excerpt
nameFlightSegment

<Response / DataLists / FlightSegmentList / FlightSegment>

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

<DataLists / FlightSegmentList>

FlightSegment

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#DEEBFF

Attribute

FlightSegment@SegmentKeySegmentKey

SegmentKey = ID of the segment

Code Block
languagexml
<FlightSegment SegmentKey="IB340620231106">

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment

Info

Attribute

FlightSegment@SecureFlightSecureFlight

True (If it is a secure flight)

Attribute omitted if not SecureFlight

Alphabetical

True

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS (Fare)

FlightSegment / Departure / AirportCode

IATA 3 character code for the departure city/airport/station

3 Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Departure / Date

Date of departure

Date

yyyy-MM-dd

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Departure / Time

Time of departure

Hour

HH:mm

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Departure / AirportName

Name of the departure city/airport/station

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment Departure / Terminal / Name

Name of the departure terminal at city/airport/station

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Arrival / AirportCode

IATA 3 character code for the arrival city/airport/station

3 Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Arrival / Date

Date of departure

Date

yyyy-MM-dd

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Arrival / Time

Time of arrival

Hour

HH:mm

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Arrival / ChangeOfDay

Change of day between departure and arrival

1 Numeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Arrival / AirportName

Name of the arrival city/airport/station

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Arrival / Terminal / Name

Name of the arrival terminal at city/airport/station

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / MarketingCarrier / AirlineID

ID of the airline that markets the flight

Alphabetical

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / MarketingCarrier / Name

Name of the airline that markets the flight

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / MarketingCarrier / FlightNumber

Number of the flight

Numeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / OperatingCarrier / AirlineID

ID of the airline that operates the flight

Alphabetical

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / OperatingCarrier / Name

Name of the airline that operates the flight

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / OperatingCarrier / FlightNumber

Number of the flight

Numeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / OperatingCarrier / Disclosures / Description / Text

Description of the airline

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Equipment / AircraftCode

Code of the aircraft that operates the flight

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegment / Equipment / Name

Name of the aircraft that operates the flight

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

<DataLists / FlightSegmentList / FlightSegment/FlightDetail / FlightDuration>

Value

Duration of the flight, period of time (PT) indicated in hours and minutes.

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

<DataLists / FlightSegmentList / FlightSegment/FlightDetail / Stops>

StopQuantity

Number of technical stops

Numeric

>= 0

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

StopLocations

List of the technical stops

List

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

<DataLists / FlightSegmentList / FlightSegment/FlightDetail / Stops / StopLocations / StopLocation>

AirportCode

Code of the airport

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

Name

Name of the airport

Alphanumeric

Any

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

ArrivalDate

Arrival date

Date

yyyy-MM-dd

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

ArrivalTime

Arrival time

Time

hh:mm

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

DepartureDate

Departure date

Date

yyyy-MM-dd

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

DepartureTime

Departure time

Time

hh:mm

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

GroundTime

Duration of the stop

Alphanumeric

ISO 8601 duration format (EX: PT2H40M)

AirshoppingRS
OfferPriceRS
ServiceListRS
SeatAvailabilityRS
OrderViewRS
OrderReshopRS

FlightSegmentList examples

Expand
titleExample - FlightSegmentList
Code Block
languagexml
<FlightSegmentList>
	<FlightSegment SegmentKey="IB044220230604MADBIO">
		<Departure>
			<AirportCode>MAD</AirportCode>
			<Date>2023-06-04</Date>
			<Time>22:10</Time>
			<AirportName>Madrid Adolfo Suarez-Barajas</AirportName>
			<Terminal>
				<Name>4</Name>
			</Terminal>
		</Departure>
		<Arrival>
			<AirportCode>BIO</AirportCode>
			<Date>2023-06-04</Date>
			<Time>23:10</Time>
			<ChangeOfDay>0</ChangeOfDay>
			<AirportName>Bilbao</AirportName>
		</Arrival>
		<MarketingCarrier>
			<AirlineID>IB</AirlineID>
			<Name>Iberia</Name>
			<FlightNumber>0442</FlightNumber>
		</MarketingCarrier>
		<OperatingCarrier>
			<AirlineID>IB</AirlineID>
			<Name>Iberia</Name>
			<Disclosures>
				<Description>
					<Text>IB</Text>
				</Description>
			</Disclosures>
		</OperatingCarrier>
		<Equipment>
			<AircraftCode>319</AircraftCode>
			<Name>Airbus A319</Name>
		</Equipment>
		<FlightDetail>
			<FlightDuration>
				<Value>PT1H</Value>
			</FlightDuration>
		</FlightDetail>
	</FlightSegment>
	<FlightSegment SegmentKey="IB044820230604MADBIO">
		<Departure>
			<AirportCode>MAD</AirportCode>
			<Date>2023-06-04</Date>
			<Time>07:25</Time>
			<AirportName>Madrid Adolfo Suarez-Barajas</AirportName>
			<Terminal>
				<Name>4</Name>
			</Terminal>
		</Departure>
		<Arrival>
			<AirportCode>BIO</AirportCode>
			<Date>2023-06-04</Date>
			<Time>08:25</Time>
			<ChangeOfDay>0</ChangeOfDay>
			<AirportName>Bilbao</AirportName>
		</Arrival>
		<MarketingCarrier>
			<AirlineID>IB</AirlineID>
			<Name>Iberia</Name>
			<FlightNumber>0448</FlightNumber>
		</MarketingCarrier>
		<OperatingCarrier>
			<AirlineID>IB</AirlineID>
			<Name>Iberia</Name>
			<Disclosures>
				<Description>
					<Text>IB</Text>
				</Description>
			</Disclosures>
		</OperatingCarrier>
		<Equipment>
			<AircraftCode>321</AircraftCode>
			<Name>Airbus A321</Name>
		</Equipment>
		<FlightDetail>
			<FlightDuration>
				<Value>PT1H</Value>
			</FlightDuration>
		</FlightDetail>
	</FlightSegment>
	<FlightSegment SegmentKey="IB894220230604MADBIO">
		<Departure>
			<AirportCode>MAD</AirportCode>
			<Date>2023-06-04</Date>
			<Time>15:55</Time>
			<AirportName>Madrid Adolfo Suarez-Barajas</AirportName>
			<Terminal>
				<Name>4</Name>
			</Terminal>
		</Departure>
		<Arrival>
			<AirportCode>BIO</AirportCode>
			<Date>2023-06-04</Date>
			<Time>17:00</Time>
			<ChangeOfDay>0</ChangeOfDay>
			<AirportName>Bilbao</AirportName>
		</Arrival>
		<MarketingCarrier>
			<AirlineID>IB</AirlineID>
			<Name>Iberia</Name>
			<FlightNumber>8942</FlightNumber>
		</MarketingCarrier>
		<OperatingCarrier>
			<AirlineID>YW</AirlineID>
			<Name>AIR NOSTRUM</Name>
			<Disclosures>
				<Description>
					<Text>YW</Text>
				</Description>
			</Disclosures>
		</OperatingCarrier>
		<Equipment>
			<AircraftCode>CRK</AircraftCode>
			

...

<Name>Regional Jet 1000</Name>
		</Equipment>
		<FlightDetail>
			<FlightDuration>
				<Value>PT1H5M</Value>
			</FlightDuration>
		</FlightDetail>
	</FlightSegment>
	<FlightSegment SegmentKey="IB899020230604MADBIO">
		<Departure>
			<AirportCode>MAD</AirportCode>
			<Date>2023-06-04</Date>
			<Time>11:45</Time>
			<AirportName>Madrid Adolfo Suarez-Barajas</AirportName>
			<Terminal>
				<Name>4</Name>
			</Terminal>
		</Departure>
		<Arrival>
			<AirportCode>BIO</AirportCode>
			<Date>2023-06-04</Date>
			<Time>12:50</Time>
			<ChangeOfDay>0</ChangeOfDay>
			<AirportName>Bilbao</AirportName>
		</Arrival>
		<MarketingCarrier>
			<AirlineID>IB</AirlineID>
			<Name>Iberia</Name>
			<FlightNumber>8990</FlightNumber>
		</MarketingCarrier>
		<OperatingCarrier>
			<AirlineID>YW</AirlineID>
			<Name>AIR NOSTRUM</Name>
			<Disclosures>
				<Description>
					<Text>YW</Text>
				</Description>
			</Disclosures>
		</OperatingCarrier>
		<Equipment>
			<AircraftCode>CRK</AircraftCode>
			

...

<Name>Regional Jet 1000</Name>
		</Equipment>
		<FlightDetail>
			<FlightDuration>
				<Value>PT1H5M</Value>
			</FlightDuration>
		</FlightDetail>
	</FlightSegment>
</FlightSegmen
Expand
titleExample - FlightSegment withing FlightSegmentList (with Stops)
Code Block
languagexml
<FlightSegment SegmentKey="IB634220240612" SecureFlight="true">
	<Departure>
		<AirportCode>GUA</AirportCode>
		<Date>2024-06-12</Date>
		<Time>17:25</Time>
		<AirportName>Guatemala City La Aurora International</AirportName>
	</Departure>
	<Arrival>
		<AirportCode>MAD</AirportCode>
		<Date>2024-06-13</Date>
		<Time>14:15</Time>
		<ChangeOfDay>1</ChangeOfDay>
		<AirportName>Madrid Adolfo Suarez-Barajas</AirportName>
		<Terminal>
			<Name>4S</Name>
		</Terminal>
	</Arrival>
	<MarketingCarrier>
		<AirlineID>IB</AirlineID>
		<Name>Iberia</Name>
		<FlightNumber>6342</FlightNumber>
	</MarketingCarrier>
	<OperatingCarrier>
		<AirlineID>IB</AirlineID>
		<Name>Iberia</Name>
		<FlightNumber>6342</FlightNumber>
		<Disclosures>
			<Description>
				<Text>IB</Text>
			</Description>
		</Disclosures>
	</OperatingCarrier>
	<Equipment>
		<AircraftCode>332</AircraftCode>
		<Name>Airbus A330-200</Name>
	</Equipment>
	<FlightDetail>
		<FlightDuration>
			<Value>PT12H50M</Value>
		</FlightDuration>
		<Stops>
			<StopQuantity>1</StopQuantity>
			<StopLocations>
				<StopLocation>
					<AirportCode>SAL</AirportCode>
					<Name>San Salvador</Name>
					<ArrivalDate>2024-06-12</ArrivalDate>
					<ArrivalTime>18:20</ArrivalTime>
					<DepartureDate>2024-06-12</DepartureDate>
					<DepartureTime>19:50</DepartureTime>
					<GroundTime>PT1H30M</GroundTime>
				</StopLocation>
			</StopLocations>
		</Stops>
	</FlightDetail>
</FlightSegment>

...