Hahn Air NDC 2017.2 API – OrderRetrieveRQ

OrderRetrieveRQ definition


Expand all
Collapse all

 

OrderRetrieveRQ

Attributes

ParameterTypeOptionalDescriptionExample
PrimaryLangIDStringY

Primary language. Service response will be returned in this language. Two-letter language code.

Currently only EN is supported.

EN
VersionStringNNDC schema message version. Always use 17.2.17.2

Elements

ParameterTypeOptionalDescriptionExample
PointOfSalePointOfSaleYOptional element for setting the request time stamp.
DocumentDocumentNNDC Message information.-
PartyPartyNNDC Message sender information.-
QueryQueryNContains all mandatory OrderRetrieveRQ information.-
DataListsDataListsNContains the passengers list (type, name, number).-

OrderRetrieveRQ.PointOfSale

Elements

ParameterTypeOptionalDescriptionExample
RequestTimeDate/timeY

Date and time of the request. Date and time are separated by T.

2019-10-12T08:30:57

OrderRetrieveRQ.Document

Elements

ParameterTypeOptionalDescriptionExample
NameStringY

Message name given by sender. Will be overwritten by default name in response.

eeBook NDC 2017.2 API WS Gateway
ReferenceVersionStringYDocument reference version.WS 2017.2

OrderRetrieveRQ.Party

Elements

ParameterTypeOptionalDescriptionExample
SenderSenderN

Information about the request sender.

-
ParticipantsParticipantsYSet this if coming from aggregator.-
RecipientRecipientYContains ORA information.-
OrderRetrieveRQ.Party.Participants

Elements

ParameterTypeOptionalDescriptionExample
ParticipantParticipantY

Set this element if request is coming through an aggregator.

-
OrderRetrieveRQ.Party.Participants.Participant

Elements

ParameterTypeOptionalDescriptionExample
AggregatorParticipantAggregatorParticipantN

Used for aggregator participants.

-

Attributes on element AggregatorParticipant

ParameterTypeOptionalDescriptionExample
SequenceNumberStringN

Unique number for participant.

1
OrderRetrieveRQ.Party.Participants.Participant.AggregatorParticipant

Elements

ParameterTypeOptionalDescriptionExample
AggregatorIDStringN

Aggregator ID.

1241242
OrderRetrieveRQ.Party.Recipient

Elements

ParameterTypeOptionalDescriptionExample
ORA_RecipientStringN

ORA code.

-
OrderRetrieveRQ.Party.Recipient.ORA_Recipient

Elements

ParameterTypeOptionalDescriptionExample
AirlineIDStringN

ORA code.

HR
OrderRetrieveRQ.Party.Sender

Elements

ParameterTypeOptionalDescriptionExample
TravelAgencySenderTravelAgencySenderN

Information about the sending agency.

-
OrderRetrieveRQ.Party.Sender.TravelAgencySender

Elements

ParameterTypeOptionalDescriptionExample
AgencyIDStringN

Agency's ID - IATA or non-IATA number.

IATA agencies - add leading zero(s) if needed to have 8 digits

Non-IATA agencies - the leading character should be N, followed by leading zero(s) if needed to have 8 characters in total

54540040

OrderRetrieveRQ.Query

Elements

ParameterTypeOptionalDescriptionExample
FiltersFiltersN

Contains data needed for booking retrieval

-
OrderRetrieveRQ.Query.Filters

Elements

ParameterTypeOptionalDescriptionExample
OrderIDStringN

Contains Order ID.

Format: HR169{8 alphanumeric}

HR169ABCD1234

Passengers

PassengersN

Contains passenger information (e.g. last name).

-
BookingReferencesBookingReferencesYContains booking reference (e.g. PNR).-

Attributes on element OrderID

ParameterTypeOptionalDescriptionExample
OwnerStringN

Should always be HR.

HR
OrderRetrieveRQ.Query.Filters.Passengers

Elements

ParameterTypeOptionalDescriptionExample
IndividualIndividualN

Contains passenger information needed for retrieval.

-
OrderRetrieveRQ.Query.Filters.Passengers.Individual

Elements

ParameterTypeOptionalDescriptionExample
SurnameStringN

Passenger's last name - must be last name of one of passengers in the booking.

MONTANA
OrderRetrieveRQ.Query.Filters.BookingReferences

Elements

ParameterTypeOptionalDescriptionExample
BookingReferenceBookingReferenceN

Contains booking information needed for retrieval.

-
OrderRetrieveRQ.Query.Filters.BookingReferences.BookingReference

Elements

ParameterTypeOptionalDescriptionExample
IDStringN

Booking's PNR.

TST123
AirlineIDStringNTwo-letter code for the airline.HR

OrderRetrieveRQ samples

1. OrderRetrieveRQ - Passenger with single surname
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Header/>
    <soap-env:Body>
        <OrderRetrieveRQ xmlns="http://www.iata.org/IATA/EDIST/2017.2" Version="2017.2">
            <Document>
                <Name>eeBook NDC 2017.2 API WS Gateway</Name>
                <ReferenceVersion>WS 2017.2</ReferenceVersion>
            </Document>
            <Party>
                <Sender>
                    <TravelAgencySender>
                        <AgencyID>11111111</AgencyID>
                    </TravelAgencySender>
                </Sender>
                <Participants>
                    <Participant>
                        <AggregatorParticipant SequenceNumber="1">
                            <AggregatorID>N9999999</AggregatorID>
                        </AggregatorParticipant>
                    </Participant>
                </Participants>
                <Recipient>
                    <ORA_Recipient>
                        <AirlineID>HR</AirlineID>
                    </ORA_Recipient>
                </Recipient>
            </Party>
            <Query>
                <Filters>
                    <OrderID Owner="HR">HR169P15J587J</OrderID>
                    <Passengers>
                        <Individual>
                            <Surname>Kerr</Surname>
                        </Individual>
                    </Passengers>
                </Filters>
            </Query>
        </OrderRetrieveRQ>
    </soap-env:Body>
</soap-env:Envelope>
2. OrderRetrieveRQ - Passenger with multiple surnames
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Header/>
    <soap-env:Body>
        <OrderRetrieveRQ xmlns="http://www.iata.org/IATA/EDIST/2017.2" Version="2017.2">
            <Document>
                <Name>eeBook NDC 2017.2 API WS Gateway</Name>
                <ReferenceVersion>WS 2017.2</ReferenceVersion>
            </Document>
            <Party>
                <Sender>
                    <TravelAgencySender>
                        <AgencyID>22222222</AgencyID>
                    </TravelAgencySender>
                </Sender>
                <Recipient>
                    <ORA_Recipient>
                        <AirlineID>HR</AirlineID>
                    </ORA_Recipient>
                </Recipient>
            </Party>
            <Query>
                <Filters>
                    <OrderID Owner="HR">HR1697GCBV2OY</OrderID>
                    <Passengers>
                        <Individual>
                            <Surname>Perez Lopez</Surname>
                        </Individual>
                    </Passengers>
                </Filters>
            </Query>
        </OrderRetrieveRQ>
    </soap-env:Body>
</soap-env:Envelope>