Retrieve Reservation Detail

This method returns the detailed information of the reservations created through our reservation system in XML format. It covers reservations made from all sales channels.

 

Input

requestHeader

Name Description Type Required

clientUsername

Client Username String Yes

channel

Channel info (WEB/MOBIL) Yes

clientTransactionId

A unique id to identify transaction String Yes

clientCode

Client Code String No

airlineCode

Airline info String (TK,AJ) No

languageCode

Language Code String (TR,EN) No

agencyOfficeCode

Agency Office Code String (ITT) No

extraParameters

The model object which contains key, value Model[] No

requestHeader.extraParameters

Name Description Type Required

key

Key of the extra parameter String Yes

value

Value of the extra parameter String Yes

retrieveReservationOTARequest

Name Description Type Required

UniqueId

Reservation number generated by reservation system. String Yes

Surname

The surname of any passenger in the reservation. String Yes

Output

retrieveReservationOTAResponse.reservationInfoOTAResponse

Name Description Type

isPurged

Indicates that the validity of the PNR has come to an end. Boolean(true,false)

isOriginalITTReservation

Indicates whether PNR has been processed. Boolean(true,false)

isITTReservation

Shows whether PNR is received over the online sales channels. Boolean(true,false)

isCircleItinerary

Is itinerary ending at the beginning point. Boolean(true,false)

retrieveReservationOTAResponse.baggage.baggageItems.baggageItem

Name Description Type

segmentIndexList

Segment index of baggage. String

allowedWeight

The amount of luggage allowed is weight based. Integer

paxIndex

Pax index of baggage. Integer

measureType

Baggage measurement type. String (KG)

retrieveReservationOTAResponse.contact

Name Description Type

emailLanguage

Email language. String

mobilePhone

contact person phone number (mobile). String

name

contact person name. String

email

contact person e-mail address. String

receiveSMS

Shows whether SMS is requested. Boolean(true,false)

passengerIndex

contact passenger index. Integer

receiveSMSLanguage

Language of SMS message. String (EN,TR)

retrieveReservationOTAResponse.OTA_AirBookRS

Name Description Type

Version

Version. String

RetransmissionIndicator

RetransmissionIndicator. Boolean(true,false)

TimeStamp

TimeStamp. String

..OTA_AirBookRS.AirReservation

Name Description Type

CreateDateTime

PNR creation date. String

..AirReservation.Fulfillment.PaymentDetails.PaymentDetail

Name Description Type

PaymentType

Payment type. String

RPH

Relevant segment order. String

...PaymentDetail.PaymentCard

Name Description Type

Email

Email. String

CardCode

CardCode. String

Remark

Remark. String

...PaymentDetail.PaymentAmount

Name Description Type

CurrencyCode

Currency code. String

DecimalPlaces

DecimalPlaces. Integer

Amount

Amount. Double

...PaymentDetail.PaymentCard.CardNumber

Name Description Type

PlainText

Plain text card number. String

...PaymentDetail.PaymentCard.CardType

Name Description Type

Description

Description. String

List_PaymentCardIssuer_Basex

List_PaymentCardIssuer_Basex. String

Code

Code. String

..AirReservation.AirItinerary.OriginDestinationOptions.OriginDestinationOption

Name Description Type

RPH

segment index for the respective passenger. Integer

..OriginDestinationOption.FlightSegment

Name Description Type

Status

segment status. String

Comment

Comment String

ConnectionType

Flight connection type (Domestic/İnternational). String

FareBasisCode

Relevant segment fare basis code value, segment class information(J, Y, D, etc.). String

DepartureDay

DepartureDay. String

NumberInParty

NumberInParty. Integer

ResBookDesigCode

Cabin information code(Economy/Business). String

E_TicketEligibility

Can an E-Ticket be edited?. Boolean(true,false)

RPH

RPH Integer

DepartureDateTime

Departure date. String

ArrivalDateTime

Arrival date. String

FlightNumber

Relevant segment flight number. String

..FlightSegment.DepartureAirport

Name Description Type

CodeContext

port code type. String(IATA)

LocationCode

Departure airport port code . String

..FlightSegment.ArrivalAirport

Name Description Type

CodeContext

port code type. String(IATA)

LocationCode

Arrival airport port code . String

..FlightSegment.BookingClassAvails

Name Description Type

CabinType

Cabin information. String(Economy,Business)

BookingClassAvail

BookingClassAvail. String

..FlightSegment.OperatingAirline

Name Description Type

CompanyShortName

Operating Airline short name. String

Description

Description. String

Code

Flight segment airline code. String

..AirReservation.Ticketing

Name Description Type

MiscTicketingCode

MiscTicketingCode. String

CancelOnExpiryInd

Is ticket number valid? Boolean(true,false)

TravelerRefNumber

passenger order. Integer

FlightSegmentRefNumber

segment number of flight. Integer

TicketType

Is reservation ticketed or not?. String

TicketDocumentNbr

ticket number. String

PseudoCityCode

Ticket office code. String

..AirReservation.PricingOverview.Comment

Name Description Type

Description

Description. String

Value

Value. String

..AirReservation.BookingReferenceID

Name Description Type

Type

related ID type(PNR/REFERENCE/RECORDKEY etc). String

ID

Related ID number. String

..AirReservation.TravelerInfo.SpecialReqDetails.SpecialServiceRequests.SpecialServiceRequest

Name Description Type

FlightRefNumberRPHList

Segment index. Integer

Number

Special service request code. Integer

SSRCode

Special service request information. String

TravelerRefNumberRPHList

passenger order. Integer

Text

explanation about fullfillment. String

..AirReservation.TravelerInfo.AirTraveler

Name Description Type

GroupInd

GroupInd. Boolean(true,false)

AccompaniedByInfantInd

Is infant pax accompanied? Boolean(true,false)

Gender

Gender. String

PassengerTypeCode

pax type code(CHILD, ADULT etc.). String

..AirTraveler.Comment

Name Description Type

Description

Description. String

Value

Value. String

Name

Name. String

..AirTraveler.ProfileRef.UniqueID

Name Description Type

Type

Info of unique code. String

ID

Id value. String

..AirTraveler.PersonName

Name Description Type

NamePrefix

title info(male/female). String

GivenName

Name. String

Surname

Surname. String

..AirTraveler.Email

Name Description Type

Description

Description. String

Value

Email address value. String

Remark

Remark. String

..AirTraveler.Telephone

Name Description Type

PhoneNumber

Phone number. String

PhoneUseType

Phone usage type. String

Remark

Remark. String

..AirTraveler.PassengerTypeQuantity

Name Description Type

Quantity

Quantity of passengers. Integer

..AirTraveler.Document

Name Description Type

DocID

Document ID number. String

DocHolderNationality

DocHolderNationality. String

DocIssueCountry

DocIssueCountry. String

Gender

Gender. String

DocType

DocType. String

BirthDate

BirthDate. String

Remark

Remark. String

..AirTraveler.Document.DocHolderFormattedName

Name Description Type

GivenName

Name. String

Surname

Surname. String

..AirReservation.ArrangerInfo.CompanyInfo

Name Description Type

Description

Description. String

Code

Code. String

..AirReservation.PriceInfo.PTC_FareBreakdowns.GrandTotal

Name Description Type

CurrencyCode

Currency Code. String

DecimalPlaces

Decimal places. Integer

Amount

Amount. Double

..AirReservation.PriceInfo.PTC_FareBreakdowns.GrandTaxTotal

Name Description Type

CurrencyCode

Currency Code. String

DecimalPlaces

Decimal places. Integer

Amount

Amount. Double

..PTC_FareBreakdowns.PTC_FareBreakdown.PassengerTypeQuantity

Name Description Type

Quantity

Quantity. Integer

Code

Code. String

..PTC_FareBreakdowns.PTC_FareBreakdown.PassengerFare.TotalFare

Name Description Type

CurrencyCode

Currency code. String

Amount

Amount. Double

...PassengerFare.Taxes

Name Description Type

Amount

Amount. Double

...PassengerFare.Taxes.Tax

Name Description Type

CurrencyCode

currency of total tax amount for the respective passenger. String

DecimalPlaces

decimal places of total tax amount for the respective passenger. Integer

Description

Description. String

TaxCode

tax code. String

Amount

total tax amount for the respective passenger. Double

RPH

segment index for the respective passenger. Integer

TaxTransactionType

Are taxes paid? String

...PassengerFare.BaseFare

Name Description Type

CurrencyCode

currency of base fare. String

DecimalPlaces

decimal places of base fare. Integer

Amount

total tax amount for base fare. Double

...PassengerFare.Fees.Fee

Name Description Type

CurrencyCode

currency of base fare. String

DecimalPlaces

decimal places of base fare. Integer

Amount

total tax amount for base fare. Double

RPH

index for the respective passenger. Integer

FeeCode

Fee code. String

..OTA_AirBookRS.Warnings.Warning

Name Description Type

Type

Error Type. String

Description

Error Description. String

Value

Error Value. String

Tag

Error Tag. String

Request

			
{
	"requestHeader": {
		"clientUsername": "OPENAPI",
		"channel": "WEB",
		"clientTransactionId": "CLIENT_TEST_1",
		"airlineCode": "TK"
	},
	"retrieveReservationOTARequest": {
		"UniqueId" : "TT8VN8",
		"Surname": "CELIKTAS"
	}
}
			
        

Response

			
{
   "status": "SUCCESS",
   "requestId": "000001683b929326-17b17c5",
   "message":    {
      "code": "TK-0000",
      "description": "Request Processed Successfully."
   },
   "data": {"retrieveReservationOTAResponse":    {
      "svc": "",
      "reservationInfoOTAResponse":       {
         "isVIPIncluded": false,
         "isPurged": true,
         "isOriginalITTReservation": true,
         "isAward": false,
         "pnrOwner": "ITT",
         "isITTReservation": true,
         "isInvoluntary": false,
         "isCircleItinerary": false
      },
      "baggage": "",
      "contact":       {
         "emailLanguage": "EN",
         "mobilePhone": "1111111111",
         "name": "B******",
         "email": "****@*****.***",
         "receiveSMS": true,
         "passengerIndex": "1",
         "receiveSMSLanguage": "EN"
      },
      "WKSC_Info": "",
      "OTA_AirBookRS":       {
         "Version": "0",
         "RetransmissionIndicator": false,
         "AirReservation":          {
            "Fulfillment": {"PaymentDetails": {"PaymentDetail":             [
                              {
                  "PaymentType": "REND",
                  "RPH": "[1]",
                  "PaymentAmount":                   {
                     "DecimalPlaces": "0",
                     "Amount": "0"
                  }
               },
                              {
                  "PaymentCard":                   {
                     "CardNumber": {"PlainText": "561059******8250"},
                     "Email": "",
                     "CardType":                      {
                        "Explanationx": "",
                        "Description": "Master Card",
                        "List_PaymentCardIssuer_Basex": "Other_",
                        "Code": "IS"
                     },
                     "CardCode": "CA",
                     "Remark": "CC"
                  },
                  "PaymentType": "VPOS",
                  "RPH": "[1]",
                  "PaymentAmount":                   {
                     "CurrencyCode": "TRY",
                     "DecimalPlaces": "2",
                     "Amount": "1745.61"
                  }
               }
            ]}},
            "Ticketing":             {
               "MiscTicketingCode": "2352311438683C1 2352311438683C2",
               "CancelOnExpiryInd": false,
               "TravelerRefNumber": "1",
               "FlightSegmentRefNumber": "1 2",
               "TicketType": "eTicket",
               "TicketDocumentNbr": "2352311438683",
               "PseudoCityCode": "ITT"
            },
            "PricingOverview": {"Comment":             [
                              {
                  "Description": "",
                  "Value": ".. LDTP IST(02-05-2017 06:44) ITTITSU28APR"
               },
                              {
                  "Description": "",
                  "Value": ".. 1493385405143TT8VN8E0G51N ITTITSU28APR"
               },
                              {
                  "Description": "",
                  "Value": "CCHEMAIL/****@*****.*** ITTITSU28APR"
               },
                              {
                  "Description": "",
                  "Value": ".. ET/ELECTRONIC COMMERCE ITTITSU28APR"
               },
                              {
                  "Description": "",
                  "Value": ".. 1493385704659TT8VN8E0G51S ITTITSU28APR"
               },
                              {
                  "Description": "",
                  "Value": ".. ET/ELECTRONIC COMMERCE ITTITSU28APR"
               }
            ]},
            "BookingReferenceID":             [
                              {
                  "Type": "PNR",
                  "ID": "TT8VN8"
               },
                              {
                  "Type": "RECORDKEY",
                  "ID": "1493385704659TT8VN8E0G51S"
               },
                              {
                  "Type": "REFERENCE",
                  "ID": "TT8VN8TT8VN8"
               }
            ],
            "CreateDateTime": "28Apr2018",
            "TravelerInfo":             {
               "SpecialReqDetails": {"SpecialServiceRequests": {"SpecialServiceRequest":                [
                                    {
                     "FlightRefNumberRPHList": "1",
                     "Number": "3",
                     "SSRCode": "TKNE",
                     "TravelerRefNumberRPHList": "1",
                     "Text": "2352311438683C1"
                  },
                                    {
                     "FlightRefNumberRPHList": "2",
                     "Number": "3",
                     "SSRCode": "TKNE",
                     "TravelerRefNumberRPHList": "1",
                     "Text": "2352311438683C2"
                  }
               ]}},
               "AirTraveler":                {
                  "Comment":                   {
                     "Description": "",
                     "Value": "VALID_IDENTITY_NUMBER",
                     "Name": "VALIDATION"
                  },
                  "ProfileRef": {"UniqueID":                   {
                     "Type": "ADULT",
                     "ID": "1"
                  }},
                  "PersonName":                   {
                     "NamePrefix": "MR",
                     "GivenName": "B******",
                     "Surname": "C******"
                  },
                  "Email":                   {
                     "Description": "",
                     "Value": "****@*****.***",
                     "Remark": "EN"
                  },
                  "Telephone":                   {
                     "PhoneNumber": "1111111111",
                     "PhoneUseType": "M",
                     "Remark": "SMS:EN"
                  },
                  "PassengerTypeQuantity": {"Quantity": "1"},
                  "GroupInd": false,
                  "AccompaniedByInfantInd": false,
                  "Gender": "MALE",
                  "PassengerTypeCode": "ADULT",
                  "Document":                   [
                                          {
                        "DocID": "0",
                        "Remark": "TCKN"
                     },
                                          {
                        "DocHolderFormattedName":                         {
                           "GivenName": "B******",
                           "Surname": "C******"
                        },
                        "DocID": "",
                        "DocHolderNationality": "",
                        "DocIssueCountry": "",
                        "Gender": "M",
                        "DocType": "P",
                        "BirthDate": "2000-01-01+02:00",
                        "Remark": "DOCS"
                     }
                  ],
                  "CustLoyalty":                   {
                     "MembershipID": "309790080",
                     "ProgramID": "TK"
                  }
               }
            },
            "ArrangerInfo": {"CompanyInfo":             {
               "CompanyShortName": "ITT",
               "Description": "",
               "Code": "ITTTKIT"
            }}
         },
         "Warnings": {"Warning":          {
            "Type": "",
            "Description": "",
            "Value": false,
            "Tag": "REISSUED"
         }},
         "TimeStamp": "2019-01-16T10:34:22.531+03:00"
      }
   }}
}

		

You can find how to test an API in documentation page.