PNRRetrieve request message

Tabular overview of all nodes, which may occur in this message. See legend below for description of table columns.
Note: Some sibling elements or complete sub-trees of the hierarchy may be defined as mutually exclusive alternative choices. This information cannot be expressed in this tabular overview. Please refer to schema diagram for a graphical representation of the message schema.

NodeDescriptionValuesOccursExample
<PNRRetrieveRQ>
PNR retrieve request root element1
@version
Version number. 0..1 1.0
@PNR
Retreive whole PNR. Values are: Y = Yes, N = No [Y] [N] 0..1 Y
@Itinerary
Retrieve itinerary only. Values are: Y = Yes, N = No [Y] [N] 0..1 Y
@NoFareRetrieval
Setting @NoFareRetrieval to "Y" will prevent the retrieval of stored fares when retrieving PNRs. For those CRS where this attribute is supported it will reduce the number of CRS transactions and save processing time.
Values:
Y = do NOT retrieve fares
N = retrieve fares

Default if left out: N

[Y] [N] 0..1 Y
@AirSegments
Retrieve air segments only. Values are: Y = Yes, N = No [Y] [N] 0..1 Y
@CarSegments
Retrieve car segments only. Values are: Y = Yes, N = No [Y] [N] 0..1 Y
@HotelSegments
Retrieve hotel segments only. Values are: Y = Yes, N = No [Y] [N] 0..1 Y
@FormOfPayment
Retrieve form of payment only. Values are: Y = Yes, N = No [Y] [N] 0..1 Y
@Ticket
Retrieve ticketing only. Values are: Y = Yes, N = No [Y] [N] 0..1 Y
@Names
Retrieve names only. Values are: Y = Yes, N = No [Y] [N] 0..1 Y
@GeneralInformation
Retrieve general information only. Values are: Y = Yes, N = No [Y] [N] 0..1 Y
@GeneralRemarks
Retrieve general remarks only. Values are: Y = Yes, N = No [Y] [N] 0..1 Y
@VendorRecordLocators
Retrieve vendor record locators only. Values are: Y = Yes, N = No [Y] [N] 0..1 Y
@Lang
ISO language code. A two letter code as defined by ISO-639-1. This code specifies the requested language for text content. Default value is 'en'.0..1
@ExtendedTicketInfo
This attribute controls whether additional transaction(s) are performed if provider does not return a complete overview of issued documents by default, Values are:
Y = Yes
N = No
Default: N
[Y] [N] 0..1 Y
<RecordLocator>
Record locator reference of the PNR to retrieve. 1 XDFWSE
@Source
0..1
</RecordLocator>
<Authentication>
Some CRS may require an additional authentication to be provided in addition to the record locator for them to allow the retrieval of an existing record.0..1
<Surname/>
Traveler family (last) name. Mandatory for Mietwagenmarkt.de

0..1 SMITH
<GivenName/>
Traveler given (first) name. 0..1 JANE
<Car>
For El Monte additionally to traveler name data, the pickup date must be specified as authentication data.0..1
<PickUp>
Pick up information group0..1
<Location>
Location group0..1
<CityCode/>
IATA 3-letter city/airport code for location. In case of non-airport location Category need to be present (Number for particular locaction).
Ignored if Category="*".
1 LAX
<Category/>
Car location category.
Values are:
* .. content of Number element contains complete location code (city code is ignored)
1 *
<Number/>
Location number used to identify specific rental location within a location category; exception: for Category="*" the whole location code is contained here.
1 LAX
</Location>
<Date/>
Date in ISO 8601 format (yyyy-mm-dd).
0..1 2012-08-22
</PickUp>
<RateOptions>
Rate options group0..1
@Category
Rate category. Values are:
A .. Association
B .. Business standard
C .. Corporate
G .. Government
I .. Industry (Travel)
K .. Package
L .. Inclusive
P .. Promotional
R .. Credential
S .. Standard
U .. Consortium
V .. Convention
X .. Negotiated
[A] [B] [C] [G] [I] [K] [L] [P] [R] [S] [U] [V] [X] 0..1 G
</RateOptions>
</Car>
<Hotel>
For Pegasus additionally to traveler name data, the data of the booked hotel must be specified as authentication data.0..1
@CheckInDate
Check in date in ISO 8601 format (yyyy-mm-dd). 0..1 2001-12-25
@CheckOutDate
Check out date in ISO 8601 format (yyyy-mm-dd). 0..1 2001-12-25
@ChainCode
Hotel property chain code. 0..1 101
@PropertyCode
Hotel property code in CRS. 0..1 RD
</Hotel>
<CreditCard>
Mandatory for DB.1
<CCNumber/>
Credit card number. 1 4011236654652341 Can be returned encrypted by GDS/CRS. Example: XXXXXXXXXXXXXXXX
</CreditCard>
<MaestroCard>
Maestro bank card.

Mandatory for DB.
1
<BankIdentificationCode/>
Bank identification code1
<AccountNumber/>
Bank account number.1
</MaestroCard>
<IdentityCard>
Identity card.

Mandatory for DB.
1
<CardNumber/>
Document number.1
<ExpirationDate/>
Document expiration date in ISO 8601 format (yyyy-mm-dd).

1 2001-12-25
<DateOfBirth/>
Date of birth specified on identity card in ISO 8601 format (yyyy-mm-dd).

1 2001-12-25
<IssueCountry/>
ISO3166-Alpha2 two letter country code of the country which issued the identity card.

1 DE
</IdentityCard>
<CustomerCard>
1
@Type
[BahnCard] [BahnBonusCard] 1
<CardNumber/>
1
</CustomerCard>
</Authentication>
<NameListReference>
Reference information to an item in a NameListRS response from Sabre (only relevant for Sabre as in other GDS a RecordLocator will be returned).1
<ItemIDRef/>
The Item/Number of the PNR from NameListRS to retrieve (fill with the value /NameListRS/ListRS/Index/Item/Number).1
<ListHeader>
ListHeader and its decendant elements must be copied one to one from the respective NameListRS message which NameListReference is referring to.1
@ActiveOnly
[Y] [N] 0..1
<Surname/>
Traveler family (last) name. 1 SMITH
<GivenName/>
Traveler given (first) name. 0..1 JANE
<Date>
Date in ISO 8601format (yyyy-mm-dd). 0..1 2001-12-15
<Day/>
0..1
<Month/>
1
<Year/>
1
</Date>
<CRS/>
0..1
<OfficeCode/>
0..1
</ListHeader>
</NameListReference>
<PseudoCityCode>
Pseudo city code for branch agreement retrieval. 0..1 1C1K
@Provider
Code of the provider system that owns the PNR. Possibles values are:
1A = Amadeus
1B = Abacus
1V = Apollo
1G = Galileo
1S = Sabre (also 1W)
1P = Worldspan
[1A] [1P] [1S] [1V] [1G] [1B] [1W] 1 1V
</PseudoCityCode>
<Display>
Display group0..1
<History>
Display PNR history. Values are: Y = Yes, N = No. [Y] [N] 0..1 Y
</History>
<HistoricalFares/>
Display history of fares. Values are: Y = Yes, N = No. [Y] [N] 0..1 Y
</Display>
</PNRRetrieveRQ>

Legend

ColumnDescription
NodeName of message node (element or attribute). Nodes in bold type are mandatory, if their parent element occurs in the message. Point mouse cursor at table cell to view complete XPath.
DescriptionDescription of meaning and usage of the node.
ValuesList of predefined values (each in square brackets) or range of values ("[a] to [z]") allowed for the node, if formally defined in the schema.
OccursMinimum and maximum number of times the node must/may occur, if its parent element occurs in the message. Examples:
0..3 Node is optional and may occur up to 3 times.
1..N Node must occur at least one (mandatory) and may occur any number of times.
2 Node must occur exactly twice.
ExampleExample value for the node.

XML Schema documentation generated with XX/1 server