XML Service APIs
V1.7
©RR Technologies, Ltd.
October 1st, 2009
Copyright of this document is the property of RRT, without whose written permission, re-production in whole or in part is
prohibited.
TABLE OF CONTENTS
REVISION LOG........................................................................................................................................................................................7
GENERAL INFORMATION...................................................................................................................................................................9
Description..........................................................................................................................................................................................9
WSDL Files.........................................................................................................................................................................................9
Invoking Results APIs Without the WDSL.........................................................................................................................................10
BASE DATA SERVICES........................................................................................................................................................................13
Base Data SetNames.........................................................................................................................................................................13
AVAILABILITY SERVICE...................................................................................................................................................................28
GET VIA AIRPORTS.............................................................................................................................................................................38
PRICING SERVICE...............................................................................................................................................................................40
GET FLIGHT DETAILS........................................................................................................................................................................51
ADVANCE SEAT RESERVATION (ASR) SERVICES.....................................................................................................................57
Seat Map Retrieval............................................................................................................................................................................57
Get All Seats......................................................................................................................................................................................59
Get Seat Attributes............................................................................................................................................................................62
Reserve Seats.....................................................................................................................................................................................68
Get Book Seat Reservations..............................................................................................................................................................70
Release Seats.....................................................................................................................................................................................72
BOOKING SERVICE.............................................................................................................................................................................74
Validate Booking...............................................................................................................................................................................74
Submit Booking Service.....................................................................................................................................................................86
Checking Booking Submit Status.......................................................................................................................................................95
Cancel Booking Request....................................................................................................................................................................98
Booking Retrieval..............................................................................................................................................................................99
Split Booking Service......................................................................................................................................................................117
Cancel Booking Service..................................................................................................................................................................118
Update FQTV service......................................................................................................................................................................120
GENERATE LOCATOR SERVICE...................................................................................................................................................122
FLOATING FARE SERVICES...........................................................................................................................................................125
Lock Fare Service............................................................................................................................................................................125
Assign Fare Service.........................................................................................................................................................................126
AGENCY SERVICES...........................................................................................................................................................................128
Create Agency Service....................................................................................................................................................................128
Retrieve Agency Service..................................................................................................................................................................129
Update Agency Service....................................................................................................................................................................131
Agency Login/Validation Service....................................................................................................................................................132
Validate Agency Locator Service....................................................................................................................................................134
Agency Booking Retrieval Service..................................................................................................................................................135
Agency Booking Statistics Service...................................................................................................................................................138
Agency Voucher Retrieval Service..................................................................................................................................................140
Agency Credit Verification Service.................................................................................................................................................142
VOUCHER SERVICES........................................................................................................................................................................144
Voucher Generation Service...........................................................................................................................................................144
Voucher Retrieval Service...............................................................................................................................................................148
Agency Voucher List Retrieval........................................................................................................................................................152
XML Service APIs Page 2
FLIGHT INFORMATION SERVICES..............................................................................................................................................154
Get Flight Status Service.................................................................................................................................................................154
Set Flight Status Service..................................................................................................................................................................157
CLIENT PROFILE SERVICES..........................................................................................................................................................158
Create Profile..................................................................................................................................................................................158
Get Profile.......................................................................................................................................................................................163
Modify Proflie.................................................................................................................................................................................170
Client Profile Login.........................................................................................................................................................................172
Employee Profile Service................................................................................................................................................................173
SCHEDULE SERVICE.........................................................................................................................................................................181
ASSIGN EXTERNAL LOCATOR SERVICE...................................................................................................................................184
SCHEDULE CHANGE ACKNOWLEDGEMENT SERVICE........................................................................................................187
UPGRADE SERVICE...........................................................................................................................................................................189
Reallocation Service........................................................................................................................................................................189
ACCOUNTING REPORT SERVICE.................................................................................................................................................193
WESTERN UNION SERVICE............................................................................................................................................................197
Authentication Inquiry.....................................................................................................................................................................197
Payment Advice...............................................................................................................................................................................198
WEB CASH PAYMENT SERVICES..................................................................................................................................................199
Payment Request.............................................................................................................................................................................199
Payment Advise...............................................................................................................................................................................201
Cancel Payment...............................................................................................................................................................................202
Get Payment Reference...................................................................................................................................................................204
WEB CREDIT CARD SERVICE........................................................................................................................................................207
VB Codes for Credit Card Service..................................................................................................................................................207
Sample XML Calls and Responses..................................................................................................................................................210
DEPARTURE CONTROL SYSTEM (DCS) SERVICES.................................................................................................................216
Management Summary....................................................................................................................................................................217
GetPassengerList............................................................................................................................................................................219
GetCheckinStatusForPassenger......................................................................................................................................................224
GetPassengerInfo............................................................................................................................................................................226
GetRequestsByCheckin....................................................................................................................................................................228
GetActions.......................................................................................................................................................................................231
UpdateRequestAction......................................................................................................................................................................235
UpdateSelecteeAction......................................................................................................................................................................236
GetPassportInfoFromServiceRequest.............................................................................................................................................237
SaveTravelDocument......................................................................................................................................................................239
UpdatePassengerInfoAction............................................................................................................................................................242
GetBaggage.....................................................................................................................................................................................243
CanPassengerHaveBaggage...........................................................................................................................................................246
SaveBaggage...................................................................................................................................................................................247
RemoveBaggage..............................................................................................................................................................................249
GetFlightDateAllSeats....................................................................................................................................................................250
GetFlightDateSeatAttributes...........................................................................................................................................................255
SeatAttributeRulesAgainstPassenger..............................................................................................................................................257
ReserveSingleSeatNew....................................................................................................................................................................259
ReleaseSeatCalls.............................................................................................................................................................................261
ConfirmAddition..............................................................................................................................................................................262
XML Service APIs Page 3
ValidatePassengerPassPrinting......................................................................................................................................................263
MarkCheckinReadyForBoarding....................................................................................................................................................264
GetPassengersForBoarding............................................................................................................................................................265
GetAirportIdFromAirportCode.......................................................................................................................................................267
GetFlights........................................................................................................................................................................................268
GetFlightDetails..............................................................................................................................................................................270
FindFlightFromId...........................................................................................................................................................................272
GetBookingLegs..............................................................................................................................................................................275
GetFlightDateClassSeatMaps.........................................................................................................................................................277
GetUserId........................................................................................................................................................................................279
GetCurrentUserLocation................................................................................................................................................................280
AddPassengerRequest.....................................................................................................................................................................281
CanPassengerBoard........................................................................................................................................................................283
GetPassengerByBoardingCardNumber..........................................................................................................................................284
BoardPassenger..............................................................................................................................................................................285
GetBoardedPassengers...................................................................................................................................................................286
PrintBagTag....................................................................................................................................................................................288
PrintCloseoutReport........................................................................................................................................................................292
PrintFlightManifest.........................................................................................................................................................................294
UpdateResultsPayments..................................................................................................................................................................295
XML Service APIs Page 4
Revision Log
The following section outlines the version changes of this document and the reason for those changes.
Ver Reason Updater Date
V1.6 Detailed Basedata SetNames Alex Fairchild Jun-15-2009
v1.5 Add information about AltClientPrflNo Zoran Naskov Aug-26-2008
field in the Client Profile API section
v1.4 Update booking retrieval APIs with Zoran Naskov Aug-12-2008
currency rate node information
v1.1 Updated the GetPassengerList service to Susan Levy Jun-12-2008
include new node BarCode
v1.0 Initial draft Susan Levy Jun-05-2008
XML Service APIs Page 5
XML Service APIs Page 6
General Information
Description
XML service APIs are a set of Tuxedo backend services that accepts SOAP requests over the Tuxedo ATMI protocol
and replies with SOAP formatted response messages. Results backend services that can be called with SOAP
formatted requests include Availability, Pricing, Seat Reservation/Seat Maps, Reference/Base Data, Booking
Validation, Booking Submit, Booking Retrieval, Payment Services, etc. The backend services runs on the Results
backend Linux server.
For testing purposes, a test utility called txmlclient is included with the results backend. To use it, enter txmlclient and
the Tuxedo service name defined in the system, and the name of an XML file name containing a properly formatted
SOAP request. Once you run an XML file, the system returns:
Start tuxedo connection...done
Start tuxedo call...done
Followed by the information that is the result of the execution of the XML file.
This document describes the available Results SOAP/XML services. They all require Results 1.6 backend or later (as
denoted in the service description).
WSDL Files
The WSDL (Web Services Description Language) files are the service descriptors that define functions available in
each XML service, their parameters and return values.
Here's a brief description of what the different WSDL files contain:
assignlocator.wsdl - assign a locator to an external locator, not currently used by the web
availability.wsdl - availability service
basedata.wsdl - reference data/base data service, for retrieving things like cities, airports, currencies and other
reference data
bookinfo.wsdl - booking retrieval service, get booking details by booking number or locator
bookingsubmit.wsdl - submit a booking to end transaction
bookingvalidation.wsdl - validate a booking, apply fees etc
flightdetails.wsdl - retrieve flight details for one or several flights
flightdetailsobj.wsdl - same as above but return as deserialized objects (not working because of namespace
issues)
flightinfo.wsdl - flight info service (delays etc)
generatelocator.wsdl - generate a new record locator for a new booking
lockfares.wsdl - lock floating fares
XML Service APIs Page 7
pricing.wsdl - price a booking
scheduleDisplay.wsdl - Retrieves the flight schedule for an origin/destination and date period.
seatres.wsdl - seat map and seat reservation functions
upgrade.wsdl - class upgrade service
viaairports.wsdl - retrieve via airports for a flight (need to be called to retrieve the data needed by the pricing
service)
voucher.wsdl - voucher service
Invoking Results APIs Without the WDSL
Currently some Results APIs do not have the WDSL files. This is typical of all the DCS XML services.
There are methods for invoking Results APIs without the WSDL. Below are the examples of different methods to
POST directly to /resultsservices/services.aspx:
Plain:
POST /resultsservices/services.aspx HTTP/1.1
Host: 82.150.226.157:80
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://rrtechnologies.net/soap/BOOKING_SERVICE"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetBooking xmlns="http://rrtechnologies.net/soap/">
<BookingNumber>1</BookingNumber>
</GetBooking>
</soap:Body>
</soap:Envelope>
VB.NET:
XML Service APIs Page 8
Dim web As New System.Net.WebClient
Dim xmlResponse As New XmlDocument
web.Headers.Add("Content-Type", "text/xml")
web.Headers.Add("SOAPAction", "'http://rrtechnologies.net/soap/BOOKING_SERVICE'")
Dim d As Byte() = System.Text.Encoding.ASCII.GetBytes("<?xml version='1.0' encoding='utf-8'?
><soap:Envelope xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/'
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
xmlns:xsd='http://www.w3.org/2001/XMLSchema'><soap:Body><GetBooking
xmlns='http://rrtechnologies.net/soap/'><BookingNumber>2676003</BookingNumber></GetBooking>
</soap:Body></soap:Envelope>")
Dim res As Byte() = web.UploadData("http://82.150.226.157:80/resultsservices/services.aspx", "POST",
d)
xmlResponse.LoadXml(System.Text.Encoding.ASCII.GetString(res))
Java:
PostMethod post = new PostMethod("http://82.150.226.157:80/resultsservices/services.aspx");
RequestEntity entity;
entity = new StringRequestEntity("<?xml version='1.0' encoding='utf-8'?><soap:Envelope
xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/'
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
xmlns:xsd='http://www.w3.org/2001/XMLSchema'><soap:Body><GetBooking
xmlns='http://rrtechnologies.net/soap/'><BookingNumber>2676003</BookingNumber></GetBooking>
</soap:Body></soap:Envelope>", "text/xml", "charset=ISO-8859-1");
post.setRequestEntity(entity);
HttpClient httpclient = new HttpClient();
try {
int result = httpclient.executeMethod(post);
log.debug("Response status code: " + result);
responseXml = post.getResponseBodyAsString();
}
finally
{
post.releaseConnection();
}
Unix:
cat POST.xml | curl -X POST -H 'Content-type: text/xml' -H 'SOAPAction:
"http://rrtechnologies.net/soap/BOOKING_SERVICE"' -d @- http://
82.150.226.157:80/resultsservices/services.aspx
where POST.xml contains:
XML Service APIs Page 9
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetBooking xmlns="http://rrtechnologies.net/soap/">
<BookingNumber>1</BookingNumber>
</GetBooking>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 10
Base Data Services
The system base data contains data sets such as nations, states, cities, airports, currencies, passenger types, client
documents, etc. Each call to the Base Data service requires the Set Name of the data being retrieved, and required or
optional Parameters depending on the service.
Tuxedo service name: BASEDATASERVICE.
Signature:
[Visual Basic]
GetBaseData(SetName As string, Parameters() As Parameter) As XmlNode
Sample Code:
[Visual Basic]
Dim baseData As New basedataService.basedata
baseData.Url = ConfigurationSettings.AppSettings.GetValues("baseDataURL")(0)
Dim servicedAirports As XmlNode = baseData.GetBaseData("ServicedAirport", Nothing)
Definition of the 'Parameter' input structure:
Public Class Parameter
Public ParameterName As String
Public ParameterValue As String
End Class
Parameters:
SetName
The name of the query set to use for this request.
Parameters
An array of Parameter objects - see Parameter structure definition below. Do not pass or pass a null pointer
(Nothing) if the requested set does not require any parameters.
Remarks:
The WSDL description for this service is in ResultsServices/basedata.wsdl.
Base Data SetNames
The following is a list of all Base Data SetNames, detailing Input Parameters and Output Nodes. One example
Request and Response Pair is provided. All other SetName Requests can be constructed by replacing the SetName and
ParameterName values in the example with the Input Parameters specified.
GetSystemSettingValue
This SetName allows retrieving the current value of any System Setting, given the System Setting Name as an input
parameter.
XML Service APIs Page 11
Input Parameters
SystemSettingCode – The name of the System Setting.
Sample XML/SOAP request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetBaseData xmlns="http://rrtechnologies.net/soap/">
<SetName>GetSystemSettingValue</SetName>
<Parameters>
<Parameter>
<ParameterName>SystemSettingCode</ParameterName>
<ParameterValue xsi:type="xsd:string">CC_MODULE_NAME</ParameterValue>
</Parameter>
</Parameters>
</GetBaseData>
</soap:Body>
</soap:Envelope>
Output Nodes
SettingValue – The value of the System Setting.
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:GetBaseDataReply xmlns:RRT="http://rrtechnologies.net/soap/">
<GetSystemSettingValues>
<GetSystemSettingValue>
<SettingValue>MWEB</SettingValue>
</GetSystemSettingValue>
</GetSystemSettingValues>
</RRT:GetBaseDataReply>
</soap:Body>
</soap:Envelope>
Nation
This SetName allows retrieving all the Nations defined in the system
Input Parameters
(none)
XML Service APIs Page 12
Output Nodes
NationCode
NationName
CurrencyCode
VisaRequirements
InoculationRequirements
DriverLicenseRequirements
GeneralInformation
State
This SetName allows retrieving all the States defined in the system for the Input NationCode. Returns all States for all
Nations if NationCode is left blank.
Input Parameters
NationCode (optional)
Output Nodes
StateCode
StateName
NationCode
SummerStartDate
WinterStartDate
SummerDifferenceToGMT
WinterDifferenceToGMT
City
This SetName allows retrieving all the Cities defined in the system for the Input CityCode, CityName, or StateCode.
Returns all Cities for all States if input is blank.
Input Parameters
CityCode (optional)
CityName (optional)
StateCode (optional)
Output Nodes
CityCode
CityName
StateCode
Airport
This SetName allows retrieving all the Airports defined in the system for the Input AirportCode, AirportName, or CityCode.
Returns all Airports for all States if input is blank.
XML Service APIs Page 13
Input Parameters
AirportCode (optional)
AirportName (optional)
CityCode (optional)
Output Nodes
AirportCode
AirportName
CityCode
CityPair
This SetName allows retrieving all the City Pairs and related data for a given OriginAirport.
Input Parameters
OriginAirport
Output Nodes
OriginCity
DestinationCity
PairIndicator
Distance
DistanceUnitOfMeasure
PointsValue
BaggageAllowance
CityPairRuleNumber
Remarks
OriginAirport
DestinationAirport
DestinationAirportName
DestinationCityName
PassengerType
This SetName allows retrieving all the valid Passenger Types for a given BookingCategory. Gives all if input is blank.
Input Parameters
BookingCategory (optional)
Output Nodes
PassengerCode
Description
OtherServicesRequestFlag
RequestCode
FairQuoteIndicator
CancelIfNotConfirmed
BookingCategory
EmployeeNumberOSIRequiredFlag
BuddyPassPaymentRequiredFlag
PaymentForm
This SetName allows retrieving all the Payment Forms defined in the system for a given DocumentType (Payment Type)
or PaymentKey. Gives all if input is blank.
XML Service APIs Page 14
Input Parameters
DocumentType (optional)
PaymentKey (optional)
Output Nodes
DocumentType
DocumentCategory
DocumentGroup
PaymentKey
TypeDescription
CategoryDescription
FOPFormate
Currency
This SetName allows retrieval of all Currencies defined in the system.
Input Parameters
(none)
Output Nodes
CurrencyCode
Description
DecimalPrecision
RoundingValue
NeutralUnitOfCurrency
SSR
This SetName allows retrieval of all SSR and OSI defined in the system.
Input Parameters
(none)
Output Nodes
RequestCode
Description
RequestType
ActiveFlag
ValidationRegularExpression
ValidationErrorMessage
RemovePermissionFlag
ServicedAirport
This SetName allows retrieval of all Serviced Airports in system.
XML Service APIs Page 15
Input Parameters
(none)
Output Nodes
AirportCode
AirportName
CityCode
CityName
AirportConnection
This SetName allows retrieving all Airport Codes with service from the input FromAirportCode.
Input Parameters
FromAirportCode
Output Nodes
AirportCode
PassengerTitle
This SetName allows retrieving all Passenger Titles in System.
Input Parameters
(none)
Output Nodes
Title
Description
PassengerCode
This SetName allows retrieving all Passenger Codes defined in the System.
Input Parameters
(none)
Output Nodes
PassengerCode
Description
SellingClass
This SetName allows retrieving data on all the Selling Classes defined in the System.
XML Service APIs Page 16
Input Parameters
(none)
Output Nodes
ClassCode
CabinCode
Cabin
ParentClassCode
AgencyBookOnBehalfOf
This SetName allows retrieving all the Travel Agencies that can book ‘on behalf of’ the input Travel Agency.
Input Parameters
AgencyCode
Output Nodes
AgencyCode
AgencyName
OTAAirRules
This SetName allows retrieving Endorsements and Restrictions for OTA specific Fare Codes.
Input Parameters
OriginAirportCode
DestinationAirportCode
FareCode
CompanyCode
NegotiatedFareFlag
Output Nodes
OriginAirportCode
DestinationAirportCode
FareCode
CompanyCode
FareTextType
TicketDescription
Description
ClientDocument
This SetName allows retrieving all Client Document types defined in the system.
XML Service APIs Page 17
Input Parameters
(none)
Output Nodes
DocumentCategory
DocumentType
TypeDescription
Description
ClientFamilyType
This SetName allows retrieving Client Profile Family Member types.
Input Parameters
(none)
Output Nodes
FamilyType
Description
BusinessPassFares
This SetName allows retrieving Fare Codes that are valid for the input Business Pass Id.
Input Parameters
BusinessPassID
Output Nodes
FareCode
BusinessPassClasses
This SetName allows retrieving Class Codes that are valid for the input Business Pass Id.
Input Parameters
BusinessPassID
Output Nodes
ClassCode
BusinessPasses
This SetName allows retrieving all Business Pass definitions in the system.
Input Parameters
(none)
Output Nodes
BusinessPassID
Description
SSRCode
XML Service APIs Page 18
This SetName allows retrieving SSR Codes specifically for Medical related SSRs.
Input Parameters
(none)
Output Nodes
RequestCode
Description
CurrencyCode
This SetName allows retrieving all Currency Codes defined in the System, with their Exchange Rates.
Input Parameters
(none)
Output Nodes
CurrencyCode
NUCRate
FeeDefinition
This SetName allows retrieving all the Fees defined in the system, with their application rules. Takes several optional
input parameters to retrieve only specific Fees that apply to those criteria.
XML Service APIs Page 19
Input Parameters
BranchCode (optional)
SellingClassCodes (optional)
PassengerCodes (optional)
FareCodes (optional)
Output Nodes
FeeID
CompanyCode
FeeTypeRCD
FeeCode
Description
ValidFromDateTime
ValidUntilDateTime
FeeValue
FeeCurrency
FeePercentFlag
TaxValue
TaxPercentFlag
SellingClassCode
DaysBeforeDeparture
UseDaysBeforeDeparture
PerPassengerFlag
PassengerCode
BranchCode
PaymentType
PaymentForm
BookingCategory
FareCode
FlightPath
SSRCode
MinFeeValue
SystemSetting
This SetName allows retrieving System Settings that pertain to the Web.
Input Parameters
(none)
Output Nodes
SystemSettingCode
SystemSettingValue
AirportTimeZone
This SetName allows retrieving the GMT offsets for all the Airports in the System.
XML Service APIs Page 20
Input Parameters
(none)
Output Nodes
AirportCode
CityCode
StateCode
SummerStart
WinterStart
SummerGMTDiff
WinterGMTDiff
DuplicateBooking
This SetName allows retrieving Locators that match the Input of an attempted booking; thus alerting to duplicates.
Input Parameters
FlightNumber
BoardDate
OriginAirport
DestinationAirport
PaymentType
PaymentForm
DocumentNo
AgencyCode
Output Nodes
Locator
AllotmentReportDetails
This SetName allows retrieving a detailed report of existing Allotments in the system, based on input Date Range and
optional Agency, Carrier, or Flight.
Input Parameters
FromDate
ToDate
AgencyCode (optional)
CarrierCode (optional)
FlightNumber (optional)
Output Nodes
FlightNumber
BoardDate
Origin
Destination
SellingClass
AllotmentQuantity
ReportedQuantity
CurrencyCode
Fare
CarrierOrAgency
AllotmentReportSummary
XML Service APIs Page 21
This SetName allows retrieving a summary report of existing Allotments in the system, based on input Date Range and
optional Agency, Carrier, or Flight.
Input Parameters
FromDate
ToDate
AgencyCode (optional)
CarrierCode (optional)
FlightNumber (optional)
Output Nodes
CarrierOrAgency
MonthOfTravel
AllotmentQuantity
ReportedQuantity
Fare
CurrencyCode
SeatAttribute
This SetName allows retrieving all Seat Attributes defined in the System.
Input Parameters
(none)
Output Nodes
Attribute
Description
DescriptionCode
Active
UnacknowledgedSked
This SetName allows retrieving a list of PNRs that have undergone a Schedule Change, and the passenger has yet to
acknowledge the change. Input Parameters are a mandatory Date Range, and optional Flight Number.
XML Service APIs Page 22
Input Parameters
StartDate
EndDate
FlightNumber (optional)
Output Nodes
Locator
FlightNumber
FlightDate
OriginAirport
DestinationAirport
DepartureTime
Passenger
HomePhone
BusinessPhone
OtherPhone
AgentPhone
EmailAddress
FaxNumber
LinkID
FareCodePrivateNet
This SetName allows retrieving all Private and Net Fare Codes defined in the system for the input Promo Code.
Input Parameters
PromoCode
Output Nodes
FareCode
NetFareFlag
PrivateFareFlag
DivideFrom
This SetName allows retrieving the original Locator to a Split Locator.
Input Parameters
Locator
Output Nodes
PrevDivideFrom
PreviousBookNo
PreviousLocator
PreviousCreateDateTime
SkedChangeNotifications
This SetName allows retrieving all notifications for a Schedule Change, both confirmed and un-confirmed. Takes optional
Locator or Flight Number.
XML Service APIs Page 23
Input Parameters
StartDate
EndDate
NoDateFilter
Locator (optional)
FlightNumber (optional)
Output Nodes
Locator
FlightNumber
FlightDate
OriginAirport
DestinationAirport
DepartureTime
Passenger
HomePhone
BusinessPhone
OtherPhone
AgentPhone
EmailAddress
FaxNumber
LinkID
AcknowledgedDateTime
AckInformation
DCSGetSeatZone
This SetName allows retrieving the DCS Seat Zone for an input Seat and Flight.
Input Parameters
DcsFlightId
Seat
Output Nodes
Zone
BookNoFromPaymentNo
This SetName allows retrieving a booking number for a PNR from the input Payment Number.
Input Parameters
PaymentNo
Output Nodes
BookNo
DiscardResidualVouchers
This SetName allows retrieving all Voucher Reason Codes in the System with the flag “Discard Residual Voucher”.
XML Service APIs Page 24
Input Parameters
(none)
Output Nodes
DiscardResidualVoucher
NameMatchRequiredVoucher
This SetName allows retrieving all Voucher Reason Codes in the System with the flag “Name Match Required”.
Input Parameters
(none)
Output Nodes
VoucherReasonCode
OTAAgencyAccreditation
This SetName allows retrieving the Accreditation Entity status of an input Travel Agency.
Input Parameters
AgencyCode
Output Nodes
Accreditation
XML Service APIs Page 25
Availability Service
The availability service retrieves available flights/selling classes for a given origin/destination and date. It can run in
several different modes: with or without fares, all available selling classes or lowest fares only, one-way or roundtrip
etc.
Tuxedo service name: AVAIL_SERVICE
Signature:
[Visual Basic]
Function AVAILABILITY( _
DepartureAirport As String, _
ArrivalAirport As String, _
DepartureCity As String, _
ArrivalCity As String, _
BoardDate As String, _
CompanyCode As String, _
RoundTripFlag As Byte, _
GetFaresFlag As Byte, _
NumberOfSeats As Integer, _
AvailableSeatsFlag As Byte, _
AgencyCode As String, _
BranchCode As String, _
Currency As String, _
ReturnDate As String, _
PassCode As String, _
IgnoreMaxConnTime As Byte, _
FareDesignator As String, _
OnlyDesignatorFares As String, _
DisableTaxes As String, _
DisableFloatingFares As String, _
DaysBefore As Integer, _
DaysAfter As Integer _
) As XmlNode
Parameters:
DepartureAirport/ArrivalAirport
The IATA airport codes for origin and destination airports used for the outbound availability request. If roundtrip
availability is requested these parameters will be switched around for the return part
DepartureCity/ArrivalCity
The IATA city codes for the outbound request. If roundtrip availability is requested these parameters will be switched
around for the return part
BoardDate
Departure date for the outbound availability request, passed as a string in US date format (mm/dd/yyyy). The service
does NOT accept ISO 8601 or XSD dates in this parameter. Depending on branch settings for the branch specified
in the BranchCode parameter, Availability service may also retrieve availability for flights a certain number of days
before and/or after this date
CompanyCode
Two-letter IATA airline code
XML Service APIs Page 26
RoundTripFlag
Boolean (0/1) flag specifying whether to get one-way availability (0) or roundtrip (1). If set to 1, the ReturnDate
parameter must also be set to a valid future date.
GetFaresFlag
Boolean (0/1) flag specifying whether only inventory should be checked to determine availability or if applicable fare
rules should also be applied. If set to 1, the response will contain basic fare and tax information for each available
selling class
NumberOfSeats
Number of seats needed
AvailableSeatsFlag
Boolean (0/1) flag specifying whether the service returns flights and classes with available inventory and applicable
fares (1) or all flights and classes for the requested origin/destination and departure date (0)
AgencyCode
ARC or Results travel agency code if this is a travel agency booking. Used for retrieving agency fares if the
GetFaresFlag is set to 1
BranchCode
Web branch code as defined in Results, e.g. ‘NK TTY 0001’. The branch code is used to determine service
behavior such as number of days before/after the requested departure and return dates, whether to only retrieve the
cheapest available selling class or all classes, branch specific fares etc.
Currency
Specifies the currency code used for fare and tax calculations if the GetFaresFlag parameter is set
ReturnDate
The return date used for roundtrip availability. Mandatory if the roundtrip flag is set, not used if it is not set. This
parameter need to be a string in US date format (MM/dd/yyyy). The service does NOT accept ISO 8601 or XSD
dates in this parameter. Depending on branch settings for the branch specified in the BranchCode parameter,
availability may also retrieve availability for flights a certain number of days before and/or after this date.
PassCode
Passenger code used to determine applicable fares and taxes in the availability response. Default ADULT but if
another passenger code is passed, the fares and taxes returned are for the passenger code passed in this
parameter
IgnoreMaxConnTime
Boolean (0/1) flag specifying whether the service should ignore system and branch settings for maximum time
allowed between connecting flights
FareDesignator
Promotion code, fare designator or ticket designator as defined in the Results fare code/route fare configuration
OnlyDesignatorFares
Flag to indicate is the availability should only return fares labeled with the fare designator provided in the
FareDesignatior parameter/node. Values can be true/false, default value is false.
DisableTaxes
Flag to indicate if availability call should disable tax calculation. This is so that fare grids/calendars can be
composed, without the performance impact of tax calculation logic. Set it to true to exclued tax calculation or set it to
false to include taxes. Detault is false.
XML Service APIs Page 27
DisableFloatingFares
Flag to indicate if availability call should disable the display of floating fares. Similar to the DisableTaxes parameter,
this setting can improve the performance of the availability operation when calendar type requests are done for a
range of days using the DaysBefore/DaysAfter parameters. Values can be true/false, default is false
DaysBefore
Number of days to display before the requested date. This provdes flexibility when doing availability search. Default
is 0.
DaysAfter
Number of days to display after the requested date. This provdes flexibility when doing availability search. Default is
0.
Return values
Parameters ReturnCode and ODNo are reserved fields.
RequestData
This is the node that contains the full XML Availability request information
OriginDestinationOptions
This element is a wrapper for all origin and destination options matching the criteria specified in the availability
requests
OriginDestinationOption
This element is a wrapper for each available origin/destination option. It contains one or several FlightSegment
elements depending on if the option is a direct/through flight or if it is based on connections.
FlightSegment
This element is the wrapper for each segment. It contains all information about the flight, available classes and fares
if requested
SegmentNo
Sequential segment number within the OriginDestinationOption
CityPairNo
This is the sequential number of the city pair defined in the City Pair table in Results
DepartureCity/ArrivalCity
This is the IATA city code for the origination and destination cities
FlightNumber
This is the flight number in concatenated format; the two character IATA airline code plus the numeric flight number
BoardDate
The board date for the flight
DepartureAirport/ArrivalAirport
This is the three-character IATA airport codes for the origination and destination airports
FlightPath
Indicates whether the flight is a domestic flight (D) or international flight (I).
DateChangeIndicator
XML Service APIs Page 28
Indicates whether the arrival date is different from the departure date; difference in number of days. E.g., ‘0’
indicates there is no date change from departure to arrival; ‘1’ means that arrival is the day after departure, ‘-1’
means the arrival is before the day of departure and ‘2’ means the arrival date is two days after the departure. The
latter two may only occur for flights crossing the International Date Line
NoOfStops
This is the number of stopovers between the origin and destination airports. E.g., ‘0’ means no stopovers, ‘1’ means
there is one stop
Distance
Distance between the origin and destination
DistanceUOM
Unit of measurement for the flight distance; indicates whether the distance is in miles or kilometers
FlightNotesFlag
This indicates whether there are any special notes for this flight. If this flag is set, flight notes can be retrieved using
the flight status/flight information service
FlightNotes
Returns certain types of flight notes in clear text (type F only – refer to system documentation for details)
TotalJourneyTime
This is the JourneyTime plus the StopOverHours
NoOfConnections
This indicates number of connections involved in between the origin and destination requested
ReturnFlightFlag
This indicates if this is an outbound or return option. When this element is set to ‘0’ this is an outbound option; if set
to ‘1’ it is a return option
Classes
This element is a wrapper for the selling classes returned for the parent FlightSegment
SellingClass
This element is a wrapper for each individual selling class returned for the parent flight
ClassCode
This is the selling class code for the class e.g., ‘C’, ‘Y’ etc
SeatCount
This is the number of available seats in this selling class, or the maximum number of displayable seats according to
system and branch settings
FareCode
The lowest fare code available for this selling class/flight
FareValue
This is the base fare value for this fare code
TaxValue
This is the sum of taxes flagged as “display in availability” in the tax configuration, applied to the above base fare
XML Service APIs Page 29
RefundableFlag
This indicates whether the fare is refundable (1) or non-refundable (0)
FloatingFareFlag
This indicates whether the fare is a floating fare (1) or a normal fare (0)
FloatingBaseClass
For floating fares, this element indicates the selling class that the floating fare is based on. This parameter is empty
when the fare is not a floating fare
Cabin
This is the cabin class code for this selling class, normally the top level selling class in the selling class hierarchy.
CodeShare
This wrapper node contains the code share rule. Empty if the flight has no code share rule
FlightNumber
This is the other flight number that has a code share rule with the current flight. This element is not present if this is
not a chodeshare flight
Indicator
This indicates the status of the FlightNumber. Its value is either O or M. O means the airline operates the flight; M
means the airline markets the flight. This element is not present if this is not a chodeshare flight
Remarks:
The WSDL description for this service is in ResultsServices/availability.wsdl
Sample Code:
[Visual Basic]
Dim availService As New availabilityService.Availability
availService.Url = ConfigurationSettings.AppSettings.GetValues("availabilityURL")(0)
Dim availResponse As XmlNode = availService.AVAILABILITY(departureAirport, arrivalAirport, _
departureCity, arrivalCity, _
boardDate.ToString("MM/dd/yyyy", GetSystemDateFormatProvider()), _
companyCode, roundtripFlag, getfaresFlag, _
noofSeats, availableSeatsFlag, _
bookAgency, branchCode, currencyCode, _
returnDate.ToString("MM/dd/yyyy", GetSystemDateFormatProvider()), _
passCode, 0, _
fareDesignator)
Sample SOAP/XML request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<AVAILABILITY xmlns="http://rrtechnologies.net/soap/">
<DepartureAirport>FLL</DepartureAirport>
<ArrivalAirport>CUN</ArrivalAirport>
<DepartureCity>FLL</DepartureCity>
XML Service APIs Page 30
<ArrivalCity>CUN</ArrivalCity>
<BoardDate>04/21/2008</BoardDate>
<CompanyCode>RT</CompanyCode>
<RoundTripFlag>0</RoundTripFlag>
<GetFaresFlag>1</GetFaresFlag>
<NumberOfSeats>2</NumberOfSeats>
<AvailableSeatsFlag>1</AvailableSeatsFlag>
<AgencyCode />
<BranchCode>RT FLL 0001</BranchCode>
<Currency>USD</Currency>
<ReturnDate>01/01/0001</ReturnDate>
<PassCode />
<IgnoreMaxConnTime>0</IgnoreMaxConnTime>
<FareDesignator />
<OnlyDesignatorFares>false</OnlyDesignatorFares>
<DisableTaxes>false</DisableTaxes>
<DisableFloatingFares>false</DisableFloatingFares>
<DaysBefore>0</DaysBefore>
<DaysAfter>0</DaysAfter>
</AVAILABILITY>
</soap:Body>
</soap:Envelope>
Sample SOAP response:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:AVAILABILITYReply xmlns:RRT="http://rrtechnologies.net/soap/">
<RequestData>
<AVAILABILITY xmlns="http://rrtechnologies.net/soap/">
<DepartureAirport>FLL</DepartureAirport>
<ArrivalAirport>CUN</ArrivalAirport>
<DepartureCity>FLL</DepartureCity>
<ArrivalCity>CUN</ArrivalCity>
<BoardDate>04/21/2008</BoardDate>
<CompanyCode>RT</CompanyCode>
<RoundTripFlag>0</RoundTripFlag>
<GetFaresFlag>1</GetFaresFlag>
<NumberOfSeats>2</NumberOfSeats>
<AvailableSeatsFlag>1</AvailableSeatsFlag>
<AgencyCode />
<BranchCode>RT FLL 0001</BranchCode>
<Currency>USD</Currency>
<ReturnDate>01/01/0001</ReturnDate>
<PassCode />
<IgnoreMaxConnTime>0</IgnoreMaxConnTime>
<FareDesignator />
<OnlyDesignatorFares>false</OnlyDesignatorFares>
<DisableTaxes>false</DisableTaxes>
<DisableFloatingFares>false</DisableFloatingFares>
<DaysBefore>0</DaysBefore>
<DaysAfter>0</DaysAfter>
</AVAILABILITY>
</RequestData>
<OriginDestinationOptions>
XML Service APIs Page 31
<OriginDestinationOption>
<FlightSegment>
<ReturnCode>0</ReturnCode>
<ODNo>1</ODNo>
<SegmentNo>1</SegmentNo>
<CityPairNo>729</CityPairNo>
<DepartureCity>FLL</DepartureCity>
<ArrivalCity>CUN</ArrivalCity>
<FlightNumber>RT1121</FlightNumber>
<BoardDate>2008-04-21</BoardDate>
<DepartureAirport>FLL</DepartureAirport>
<ArrivalAirport>CUN</ArrivalAirport>
<FlightPathCode>I</FlightPathCode>
<DepartureTime>06:30</DepartureTime>
<ArrivalTime>09:30</ArrivalTime>
<DateChangeIndicator>0</DateChangeIndicator>
<DepartureTerminalNo>3</DepartureTerminalNo>
<ArrivalTerminalNo>1</ArrivalTerminalNo>
<NoOfStops>0</NoOfStops>
<AircraftCode>319</AircraftCode>
<Distance>549</Distance>
<DistanceUOM>MLS</DistanceUOM>
<FlightNotesFlag>0</FlightNotesFlag>
<FlightNotes />
<JourneyTime>240</JourneyTime>
<StopOverHours>0</StopOverHours>
<TotalJourneyTime>240</TotalJourneyTime>
<NoOfConnections>0</NoOfConnections>
<ReturnFlightFlag>0</ReturnFlightFlag>
<Classes>
<SellingClass>
<ClassCode>C</ClassCode>
<SeatCount>7</SeatCount>
<FareCode>CNK</FareCode>
<FareValue>349.00</FareValue>
<TaxValue>23.22</TaxValue>
<RefundableFlag>1</RefundableFlag>
<FloatingFareFlag>0</FloatingFareFlag>
<FloatingBaseClass />
<Cabin>C</Cabin>
</SellingClass>
<SellingClass>
<ClassCode>A</ClassCode>
<SeatCount>2</SeatCount>
<FareCode>ANR</FareCode>
<FareValue>183.04</FareValue>
<TaxValue>23.22</TaxValue>
<RefundableFlag>0</RefundableFlag>
<FloatingFareFlag>1</FloatingFareFlag>
<FloatingBaseClass>Y</FloatingBaseClass>
<Cabin>C</Cabin>
</SellingClass>
<SellingClass>
<ClassCode>Y</ClassCode>
<SeatCount>132</SeatCount>
<FareCode>YNK</FareCode>
<FareValue>173.04</FareValue>
XML Service APIs Page 32
<TaxValue>23.22</TaxValue>
<RefundableFlag>1</RefundableFlag>
<FloatingFareFlag>0</FloatingFareFlag>
<FloatingBaseClass />
<Cabin>Y</Cabin>
</SellingClass>
</Classes>
<CodeShare />
</FlightSegment>
</OriginDestinationOption>
<OriginDestinationOption>
<FlightSegment>
<ReturnCode>0</ReturnCode>
<ODNo>2</ODNo>
<SegmentNo>1</SegmentNo>
<CityPairNo>729</CityPairNo>
<DepartureCity>FLL</DepartureCity>
<ArrivalCity>CUN</ArrivalCity>
<FlightNumber>RT1321</FlightNumber>
<BoardDate>2008-04-21</BoardDate>
<DepartureAirport>FLL</DepartureAirport>
<ArrivalAirport>CUN</ArrivalAirport>
<FlightPathCode>I</FlightPathCode>
<DepartureTime>06:30</DepartureTime>
<ArrivalTime>09:30</ArrivalTime>
<DateChangeIndicator>0</DateChangeIndicator>
<DepartureTerminalNo>3</DepartureTerminalNo>
<ArrivalTerminalNo>1</ArrivalTerminalNo>
<NoOfStops>0</NoOfStops>
<AircraftCode>319</AircraftCode>
<Distance>549</Distance>
<DistanceUOM>MLS</DistanceUOM>
<FlightNotesFlag>0</FlightNotesFlag>
<FlightNotes />
<JourneyTime>240</JourneyTime>
<StopOverHours>0</StopOverHours>
<TotalJourneyTime>240</TotalJourneyTime>
<NoOfConnections>0</NoOfConnections>
<ReturnFlightFlag>0</ReturnFlightFlag>
<Classes>
<SellingClass>
<ClassCode>C</ClassCode>
<SeatCount>8</SeatCount>
<FareCode>CNK</FareCode>
<FareValue>349.00</FareValue>
<TaxValue>23.22</TaxValue>
<RefundableFlag>1</RefundableFlag>
<FloatingFareFlag>0</FloatingFareFlag>
<FloatingBaseClass />
<Cabin>C</Cabin>
</SellingClass>
<SellingClass>
<ClassCode>A</ClassCode>
<SeatCount>3</SeatCount>
<FareCode>ANR</FareCode>
<FareValue>183.04</FareValue>
<TaxValue>23.22</TaxValue>
XML Service APIs Page 33
<RefundableFlag>0</RefundableFlag>
<FloatingFareFlag>1</FloatingFareFlag>
<FloatingBaseClass>Y</FloatingBaseClass>
<Cabin>C</Cabin>
</SellingClass>
<SellingClass>
<ClassCode>Y</ClassCode>
<SeatCount>132</SeatCount>
<FareCode>YNK</FareCode>
<FareValue>173.04</FareValue>
<TaxValue>23.22</TaxValue>
<RefundableFlag>1</RefundableFlag>
<FloatingFareFlag>0</FloatingFareFlag>
<FloatingBaseClass />
<Cabin>Y</Cabin>
</SellingClass>
</Classes>
<CodeShare />
</FlightSegment>
</OriginDestinationOption>
</OriginDestinationOptions>
</RRT:AVAILABILITYReply>
</soap:Body>
</soap:Envelope>
Results web screenshot:
XML Service APIs Page 34
XML Service APIs Page 35
Get via Airports
The via-airports service retrieves via-airports for the specified flight segment.
Tuxedo service name: GETVIAAIRPORTS
Signature
[Visual Basic]
GetViaAirports(FlightNumber As string, BoardDate As string, DepartureAirport As string,
ArrivalAirport As string)
Parameters:
FlightNumber
This is the flight number (airline code + flight number) for which to retrieve via airports, e.g. RT203
BoardDate
Board date for the flight
DepartureAirport
Three character IATA airport code for the origin airport
ArrivalAirport
Three character IATA airport code for the destination airport
Return values:
ViaAirports
This is a wrapper node for the response
ViaAirport
This a wrapper node for each airport returned
SequenceOrder
This is the airport sequential number in the specified flight segment
AirportCode
This is the IATA airport code for the airport
Remarks:
The WSDL description for this service is in ResultsServices/viaairports.wsdl
Sample Code:
Sample SOAP request:
<?xml version="1.0" encoding="utf-8"?>
XML Service APIs Page 36
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetViaAirports xmlns="http://rrtechnologies.net/soap/">
<FlightNumber>RT582</FlightNumber>
<BoardDate>02/28/2005</BoardDate>
<DepartureAirport>FLL</DepartureAirport>
<ArrivalAirport>LGA</ArrivalAirport>
</GetViaAirports>
</soap:Body>
</soap:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RRT:GetViaAirportsReply xmlns:RRT="http://rrtechnologies.net/soap/">
<ViaAirports>
<ViaAirport>
<SequenceOrder>1</SequenceOrder>
<AirportCode>FLL</AirportCode>
</ViaAirport>
<ViaAirport>
<SequenceOrder>2</SequenceOrder>
<AirportCode>MYR</AirportCode>
</ViaAirport>
<ViaAirport>
<SequenceOrder>3</SequenceOrder>
<AirportCode>LGA</AirportCode>
</ViaAirport>
</ViaAirports>
</RRT:GetViaAirportsReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 37
Pricing Service
This service calculates fares, taxes and surcharges for an itinerary/ booking.
The pricing service input includes all information that may affect the pricing of a booking, such as the itinerary, number
of passengers of each type, branch and travel agency code. The service retrieves and returns both a summary and a
detailed calculation of fares, taxes and surcharges that apply to a booking.
Tuxedo service name: PRICING_SERVICE
Signature:
[Visual Basic]
PRICING( _
CompanyCode As String, _
Currency As String, _
ReturnFlag As String, _
Flights() As Flight, _
PassengerInfos() As PassengerInfo, _
AgencyCode As String, _
BranchCode As String, _
NonRevenueFlag As String, _
NotesInReturnFlag As String, _
ForceTotalValue As String, _
ForceBaseFareDiscountInAmount As Decimal, _
ForceBaseFareDiscountInPercent As Decimal, _
ReTaxedPairs() As ReTaxedPair, _
<XmlArrayItemAttribute("LockID")> LockIDs() As String, _
BookNo As Long, _
FareDesignator As String, _
OnlyDesignatorPrices As String) As XmlNode
Parameters
CompanyCode
Two-character airline code
Currency
Currency code
ReturnFlag
This controls how fares are selected for pricing. It can have three values:
Y will force the pricing service to always use roundtrip fares
N will force it to only use one way fares
A means automatic and will cause the pricing service to analyze the itinerary to determine if roundtrip fare can be
used and then will be used if it is cheaper than one way fare. If a combination of one way fares are cheaper then it
will be priced using those
Flights
This is an array containing a Flight object for each flight in the itinerary. See the definition of the flight class below
XML Service APIs Page 38
PassengerInfos
This node contains a summary of passengers in the booking; an array containing pairs of passenger code and
passenger code for each passenger code. See the definition of the PassengerInfo class below
AgencyCode
ARC or Results travel agency code if the booking is an agency booking. Leave blank or pass a null pointer, null or
nothing if the booking is not an agency booking. This value determines whether any agency specific fares are
considered
BranchCode
This is the Results branch code as defined in the system. The branch code parameter must be passed in, even if
there are no branch specific fares
NonRevenueFlag
This indicates if this is non-revenue booking (1) or a normal revenue booking (0)
NotesInReturnFlag
This indicates if pricing notes should be included in the response (Y) or not (N)
ForceTotalValue
This should contain the fare plus tax and surcharge amount for manual pricing. If the parameter value is set to N, it
means no manual pricing is used. If specified, the pricing service will adjust fares so that the total amount equals this
value
ForceBaseFareDiscountInAmount
This should be the amount of base fare discounts. This amount is subtracted from the base fare amounts
ForceBaseFareDiscountInPercent
This indicates the percentage of base fare discount. E.g. if this parameter is 75, the base fares will be ¾ (75%) of
the fare defined in the system
ReTaxedPairs
When manual pricing is used, this parameter contains an array of ReTaxedPair objects indicating the manual fare
amount per passenger type. See the definition of the ReTaxedPair class below
LockIDs
This is an array of floating fare lock ids. When getting a floating fare for the first time (usually from availability), the
caller can ‘lock’ the floating fare so that it stays the same even if the class it is based on is sold out between the
availability request and the pricing request, or when repricing bookings
BookNo
This is the booking number. The booking number is used to look up fare locks that apply to the booking
FareDesignator
This is the fare designator/ticket designator/promotion code as defined in the results fare configuration
OnlyDesignatorPrices
This parameter indicates if pricing service should only take fare designator fares into account (Y) or not (N)
Return values:
PricingResponseVersion
This is the version of the Pricing Service used
XML Service APIs Page 39
TotalAmount
Total fares, taxes and surcharges for this booking
Currency
Currency code used for the total amounts
PassengerCodes
This is a wrapper node for all priced passenger types. It contains an array of PassengerCode elements
PassengerCode
This node exists both as a wrapper for each passenger type in the response, and as a data element indicating the
passenger code, e.g. ADULT, CHD, INF
SeatCount
This is the number of passengers of this type in this booking
FareValuePerSeat/ SurchargePerSeat/TaxValuePerSeat
This is the fare/surcharge/tax amount only for one passenger of this type of passengers
FareLadder
This is the breakdown of the fare total composition, what fares and taxes are applied to each segment
FareCodes
This wrapper node contains an array of FareCode elements for the fare segments applied to the booking
FareCode
This node is a wrapper for each fare segments applied and as a data element indicating the fare basis code
CompanyCode
Two character airline code
Description
This is the textual description of the fare code, from the ResultS fare configuration
ClassCode
The selling class this fare code belongs to
PassengerCode
The passenger code this fare applies to
Refundable
This indicates if the fare is refundable (1) or non-refundable (0)
OneWayReturn
This indicates if the applied fare is a one-way (0) or roundtrip fare (1)
BaseAmount
This is the original fare amount defined in the fare configuration
BaseCurrency
This is the currency code from the fare definition
XML Service APIs Page 40
ChangeType
This indicates if the Final Amount is the result of a sub fare or fare discount. Values can be % (percentage), = (fixed
amount), > (increase), and < (decrease)
ChangeAmount
This is the percentage, decrease/increase amount of the sub fare or discount (if applicable)
FinalAmount
The final fare amount for this segment of the itinerary after the change and after being divided in case of roundtrip
fares
CurrencyCode
Final amount currency code
Endorsement
This is the endorsement text for this fare
Restriction
This is the restriction text for this fare
ValidFrom/ValidTo
Travel dates for which this fare is valid
FareRouteID
This is a unique identifier of the fare, identifying exactly what fare was used for pricing. This can be used for
historical purposes to determine how a fare was calculated
NetFareFlag
This indicates if the fare is an agency net fare (1) or not (0). Net fares are commission free agency fares that should
not be disclosed to the passenger
PrivateFareFlag
This indicates if the fare is private fare (1) or published fare (0). Private fares are negotiated fares or airline internal
fares that should not be disclosed to the passenger
Flights
Wrapper node for all segments that the fare applies to
Flight
Wrapper node for each segment that the fare applies to
TaxCodes
Wrapper node containing an array of TaxCode nodes for all taxes that applies to the parent passenger code
TaxCode
Wrapper node for the tax information
TaxCode
Tax code for the parent TaxCode
CoverageType
This indicates if the tax is airport, state, or national tax. N means National; S means State; A means Airport
XML Service APIs Page 41
CoverageValue
Airport/state/nation code for the airport, state, or nation that the tax code applies to
ShortDescription
A brief text description of the tax from the ResultS tax definition
TaxType
Tax type; fixed amount (=) or percentage (%)
TaxValue
For fixed taxes, this is the tax amount; for percentage taxes, this is the tax percentage of the fare
AppliedAmount
Tax amount applied to the fare
Compounded
This indicates if the tax can be compounded (1) or not (0), as defined in the tax configuration
TaxDetailID
This is a unique identifier of the tax definition. It refers to the tax detail record in the Results tax configuration
PassengerCode
Type of passengers this tax rule applies to. If empty, it means the tax is applicable to any passenger code
Notes
Fare notes, a description of how the price was determined. Normally blank, it will only contain a value if the
NotesInReturnFlag parameter is set
Remarks:
The WSDL description for this service is in ResultsServices/pricing.wsdl
The pricing functionality is already wrapped in the PriceBooking method of the ResultsBooking library. If segments
and passengers exist in the booking, calling the PriceBooking method will populate all parameters, call the pricing
service and then populate the fare, surcharge and tax structures in the booking based on the pricing response.
Sample Code:
[Visual Basic]
'price for one adult passenger
Dim passengerArray(0) As pricingService.PassengerInfo
passengerArray(0) = New pricingService.PassengerInfo
With passengerArray(0)
.PassengerCode = "ADULT"
.NoOfSeats = 1
End With
'add flight info
Dim flightArray(0) As pricingService.Flight
flightArray(flightNo) = New pricingService.Flight
With flightArray(flightNo)
.FlightNumber = "DD8300"
.FlightDate = "06/16/2005"
.ClassCode = "M"
XML Service APIs Page 42
.ArriveDate = "06/16/2005"
.FlightTime = "06:00"
.ArriveTime = "06:45"
.OriginAirport = "BKK"
.DestinationAirport = "CNX"
End With
'retrieve application settings
Dim companyCode As String = ConfigurationSettings.AppSettings.GetValues("companyCode")(0)
Dim currencyCode As String = ConfigurationSettings.AppSettings.GetValues("defaultCurrency")
(0)
Dim branchCode As String = ConfigurationSettings.AppSettings.GetValues("branchCode")(0)
'set one-way/roundtrip flag to 'automagic'
Dim returnFlag As String = "A"
'do pricing request
Dim pricing As New pricingService.pricing
pricing.Url = ConfigurationSettings.AppSettings.GetValues("pricingURL")(0)
Dim priceInformation As XmlNode = pricing.PRICING(companyCode, currencyCode, returnFlag,
_
flightArray, passengerArray, _
AgencyCode, BranchCode, "N", "N", "N", 0, 0, Nothing, Nothing, 0, _
FareDesignator, _
Convert.ToString(IIf(FareDesignator.Length > 0, "Y", "N")))
Definition of parameter structures:
Public Class Flight
Public ClassCode As String
Public FlightNumber As String
Public FlightDate As String
Public FlightTime As String
Public ArriveDate As String
Public ArriveTime As String
Public OriginAirport As String
Public DestinationAirport As String
End Class
Public Class ReTaxedPair
Public PassCode As String
Public FareCode As String
Public Amount As Decimal
End Class
Public Class PassengerInfo
Public PassengerCode As String
Public NoOfSeats As Integer
End Class
Sample SOAP/XML request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
XML Service APIs Page 43
<soap:Body>
<PRICING xmlns="http://rrtechnologies.net/soap/">
<CompanyCode>RT</CompanyCode>
<Currency>USD</Currency>
<ReturnFlag>A</ReturnFlag>
<Flights>
<Flight>
<ClassCode>Y</ClassCode>
<FlightNumber>RT111</FlightNumber>
<FlightDate>01/10/2007</FlightDate>
<FlightTime>06:00</FlightTime>
<ArriveDate>01/10/2007</ArriveDate>
<ArriveTime>07:50</ArriveTime>
<OriginAirport>FLL</OriginAirport>
<DestinationAirport>LGA</DestinationAirport>
</Flight>
<Flight>
<ClassCode>Y</ClassCode>
<FlightNumber>RT960</FlightNumber>
<FlightDate>01/13/2007</FlightDate>
<FlightTime>07:00</FlightTime>
<ArriveDate>01/13/2007</ArriveDate>
<ArriveTime>10:00</ArriveTime>
<OriginAirport>LGA</OriginAirport>
<DestinationAirport>FLL</DestinationAirport>
</Flight>
</Flights>
<PassengerInfos>
<PassengerInfo>
<PassengerCode>ADULT</PassengerCode>
<NoOfSeats>1</NoOfSeats>
</PassengerInfo>
</PassengerInfos>
<AgencyCode />
<BranchCode>RT FLL 0001</BranchCode>
<NonRevenueFlag>N</NonRevenueFlag>
<NotesInReturnFlag>N</NotesInReturnFlag>
<ForceTotalValue>N</ForceTotalValue>
<ForceBaseFareDiscountInAmount>0</ForceBaseFareDiscountInAmount>
<ForceBaseFareDiscountInPercent>0</ForceBaseFareDiscountInPercent>
<BookNo>0</BookNo>
<FareDesignator />
<OnlyDesignatorPrices>N</OnlyDesignatorPrices>
</PRICING>
</soap:Body>
</soap:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:PRICINGReply xmlns:RRT="http://rrtechnologies.net/soap/">
<PricingResponse>
<PricingResponseVersion>V005</PricingResponseVersion>
<TotalAmount>199.95000</TotalAmount>
XML Service APIs Page 44
<SurchargeTotalAmount>15.00000</SurchargeTotalAmount>
<FareTotalAmount>166.50999</FareTotalAmount>
<TaxTotalAmount>18.44000</TaxTotalAmount>
<Currency>USD</Currency>
<PassengerCodes>
<PassengerCode>
<PassengerCode>ADULT</PassengerCode>
<SeatCount>1</SeatCount>
<FareValuePerSeat>166.50999</FareValuePerSeat>
<SurchargePerSeat>15.00000</SurchargePerSeat>
<TaxValuePerSeat>18.44000</TaxValuePerSeat>
<FareLadder>FLL RT LGA82.79YTLLGA RT Q15.00 FLL83.72YTL181.51 END
AYFLL3.00XFFLL5.00AYLGA2.50XFLGA3.00MXLGA4.94</FareLadder>
<FareCodes>
<FareCode>
<CompanyCode>RT</CompanyCode>
<FareCode>YTL</FareCode>
<Description>testing time lmit for fare code</Description>
<ClassCode>Y</ClassCode>
<PassengerCode>ADULT</PassengerCode>
<Refundable>0</Refundable>
<OneWayReturn>0</OneWayReturn>
<BaseAmount>82.79000</BaseAmount>
<BaseCurrency>USD</BaseCurrency>
<ChangeType />
<ChangeAmount>0.00000</ChangeAmount>
<FinalAmount>82.79000</FinalAmount>
<CurrencyCode>USD</CurrencyCode>
<Endorsement />
<Restriction />
<ValidFrom>2001-01-01</ValidFrom>
<ValidTo>2099-12-30</ValidTo>
<FareRouteID>7360950909099002070</FareRouteID>
<NetFareFlag>0</NetFareFlag>
<PrivateFareFlag>0</PrivateFareFlag>
<Flights>
<Flight>
<FlightNo>RT111</FlightNo>
<FlightDate>2007-01-10</FlightDate>
<AirportCodes>
<AirportCode>FLL</AirportCode>
<AirportCode>LGA</AirportCode>
</AirportCodes>
</Flight>
</Flights>
<SurchargeCodes />
</FareCode>
<FareCode>
<CompanyCode>RT</CompanyCode>
<FareCode>YTL</FareCode>
<Description>testing time lmit for fare code</Description>
<ClassCode>Y</ClassCode>
<PassengerCode>ADULT</PassengerCode>
<Refundable>0</Refundable>
<OneWayReturn>0</OneWayReturn>
<BaseAmount>83.72000</BaseAmount>
<BaseCurrency>USD</BaseCurrency>
XML Service APIs Page 45
<ChangeType />
<ChangeAmount>0.00000</ChangeAmount>
<FinalAmount>83.72000</FinalAmount>
<CurrencyCode>USD</CurrencyCode>
<Endorsement />
<Restriction />
<ValidFrom>2001-01-01</ValidFrom>
<ValidTo>2099-12-30</ValidTo>
<FareRouteID>5150511732801948700</FareRouteID>
<NetFareFlag>0</NetFareFlag>
<PrivateFareFlag>0</PrivateFareFlag>
<Flights>
<Flight>
<FlightNo>RT960</FlightNo>
<FlightDate>2007-01-13</FlightDate>
<AirportCodes>
<AirportCode>LGA</AirportCode>
<AirportCode>FLL</AirportCode>
</AirportCodes>
</Flight>
</Flights>
<SurchargeCodes>
<SurchargeCode>
<SurchargeCode>Q</SurchargeCode>
<Amount>15.00000</Amount>
<Description>Fuel Surcharge</Description>
<RouteSurchargeID>-2567289303763301421</RouteSurchargeID>
</SurchargeCode>
</SurchargeCodes>
</FareCode>
</FareCodes>
<TaxCodes>
<TaxCode>
<CompanyCode>RT</CompanyCode>
<TaxCode>AY</TaxCode>
<CoverageType>A</CoverageType>
<CoverageValue>FLL</CoverageValue>
<ShortDescription>Security Tax</ShortDescription>
<TaxType>=</TaxType>
<TaxValue>3.00000</TaxValue>
<TaxCurrency>USD</TaxCurrency>
<AppliedAmount>3.00000</AppliedAmount>
<AppliedCurrency>USD</AppliedCurrency>
<Compounded>0</Compounded>
<PassengerCode />
<TaxDetailID>2</TaxDetailID>
<FlightNumber>RT111</FlightNumber>
<FlightDate>2007-01-10</FlightDate>
<Origin>FLL</Origin>
<Destination>LGA</Destination>
</TaxCode>
<TaxCode>
<CompanyCode>RT</CompanyCode>
<TaxCode>XF</TaxCode>
<CoverageType>A</CoverageType>
<CoverageValue>FLL</CoverageValue>
<ShortDescription>PFC</ShortDescription>
XML Service APIs Page 46
<TaxType>=</TaxType>
<TaxValue>5.00000</TaxValue>
<TaxCurrency>USD</TaxCurrency>
<AppliedAmount>5.00000</AppliedAmount>
<AppliedCurrency>USD</AppliedCurrency>
<Compounded>0</Compounded>
<PassengerCode />
<TaxDetailID>3</TaxDetailID>
<FlightNumber>RT111</FlightNumber>
<FlightDate>2007-01-10</FlightDate>
<Origin>FLL</Origin>
<Destination>LGA</Destination>
</TaxCode>
<TaxCode>
<CompanyCode>RT</CompanyCode>
<TaxCode>AY</TaxCode>
<CoverageType>A</CoverageType>
<CoverageValue>LGA</CoverageValue>
<ShortDescription>Security Tax</ShortDescription>
<TaxType>=</TaxType>
<TaxValue>2.50000</TaxValue>
<TaxCurrency>USD</TaxCurrency>
<AppliedAmount>2.50000</AppliedAmount>
<AppliedCurrency>USD</AppliedCurrency>
<Compounded>0</Compounded>
<PassengerCode />
<TaxDetailID>44</TaxDetailID>
<FlightNumber>RT960</FlightNumber>
<FlightDate>2007-01-13</FlightDate>
<Origin>LGA</Origin>
<Destination>FLL</Destination>
</TaxCode>
<TaxCode>
<CompanyCode>RT</CompanyCode>
<TaxCode>XF</TaxCode>
<CoverageType>A</CoverageType>
<CoverageValue>LGA</CoverageValue>
<ShortDescription>PFC</ShortDescription>
<TaxType>=</TaxType>
<TaxValue>3.00000</TaxValue>
<TaxCurrency>USD</TaxCurrency>
<AppliedAmount>3.00000</AppliedAmount>
<AppliedCurrency>USD</AppliedCurrency>
<Compounded>0</Compounded>
<PassengerCode />
<TaxDetailID>5</TaxDetailID>
<FlightNumber>RT960</FlightNumber>
<FlightDate>2007-01-13</FlightDate>
<Origin>LGA</Origin>
<Destination>FLL</Destination>
</TaxCode>
<TaxCode>
<CompanyCode>RT</CompanyCode>
<TaxCode>MX</TaxCode>
<CoverageType>A</CoverageType>
<CoverageValue>LGA</CoverageValue>
<ShortDescription>Percentage</ShortDescription>
XML Service APIs Page 47
<TaxType>%</TaxType>
<TaxValue>5.00000</TaxValue>
<TaxCurrency>USD</TaxCurrency>
<AppliedAmount>4.94000</AppliedAmount>
<AppliedCurrency>USD</AppliedCurrency>
<Compounded>0</Compounded>
<PassengerCode>ADULT</PassengerCode>
<TaxDetailID>314</TaxDetailID>
<FlightNumber>RT960</FlightNumber>
<FlightDate>2007-01-13</FlightDate>
<Origin>LGA</Origin>
<Destination>FLL</Destination>
</TaxCode>
</TaxCodes>
</PassengerCode>
</PassengerCodes>
<Notes />
</PricingResponse>
</RRT:PRICINGReply>
</soap:Body>
</soap:Envelope>
Results web screen shot:
XML Service APIs Page 48
Get Flight Details
This service retrieves detailed information about one or several flights, including airport/terminal information,
equipment, times/durations and optional information regarding segments, services (meals etc), inventory (no of seats
available in each class), SSR inventory (no of pets allowed onboard etc), flight notes and restrictions.
Tuxedo service name: FLIGHTDETAILS
Signature:
[Visual Basic]
GetFlightDetails(<XmlArrayItemAttribute("Flight")> Flights() As FlightDetailsFlight, SegmentsFlag
As Integer, ServicesFlag As Integer, InventoryFlag As Integer, SSRInventoryFlag As Integer,
NotesFlag As Integer, RestrictionsFlag As Integer) As XmlNode
Parameters:
Flights
Array of Flight objects containing flight number, date, origin and destination. See the definition of the Flight class
below
SegmentFlag
Boolean flag (0/1) controlling whether segment information should be included in the response or not.
ServiceFlag
Boolean flag (0/1) controlling whether service information should be included in the response or not
InventoryFlag
Boolean flag (0/1) controlling whether inventory data for the flight (all classes and available seats in those classes)
should be included in the response or not
SSRInventoryFlag
Boolean flag (0/1) controlling whether SSR inventory information should be retrieved for SSRs that has SSR
inventory levels defined
NotesFlag
Boolean flag (0/1) controlling whether the response contains flight notes
RestrictionsFlag
Boolean flag (0/1) controlling whether the response contains flight restriction information
Return values:
Flights
Wrapper node for all flights in the response
Flight
Wrapper node for each flight, containing the flight details
FlightNumber
Flight number (airline code and flight number) for the flight
XML Service APIs Page 49
BoardDate
Board date for the flight
FlightDate
Flight date for the flight. Usually the same as the BoardDate, unless the flight is a multi leg flight whose first leg
departed before midnight and the current segment was boarded after midnight
DepartureTime
Departure time for the flight
ArrivalTime
Arrival time for the flight, local time at the destination
ArrivalDate
Arrival date for the flight, local time at the destination
JourneyTime
This is the length of the journey in minutes
DateChangeIndicator
This indicates whether the arrival date is the same as the board date (0), before (-1) or after (1, 2). Offset number of
days to the board date. Typical values is 0 or 1; -1 and 2 can only occur for flights crossing the International Date
Line.
DepartureCity
Three character IATA city code for the origin city
DepartureCityName
City name for the origin city
ArrivalCity
Three character IATA city code for the destination city
ArrivalCityName
City name for the destination city
DepartureAirportCode
Three character IATA airport code for the origin airport
DepartureAirportName
Airport name for the origin airport
ArrivalAirportCode
Three character IATA airport code for the destination airport
ArrivalAirportName
Airport name for the destination airport
DepartureTerminalCode
Terminal code for the terminal the flight departs from at the origin airport
DepartureTerminalName
Terminal name for the terminal the flight departs from at the origin airport
XML Service APIs Page 50
ArrivalTerminalCode
Terminal code for the terminal the flight arrives to at the destination airport
ArrivalTerminalName
Terminal name for the terminal the flight arrives to at the destination airport
Distance
Flight distance between the origin and destination, in miles or kilometers
DistanceUnitOfMeasurement
Unit of measurement for the flight distance (miles or kilometers)
NumberOfStops
Number of stopovers that this flight makes between the origin and destination, zero for direct flights
AircraftCode
Aircraft code for the aircraft used
AircraftDescription
Description of the aircraft used
FlightPeriodStartDate/ FlightPeriodEndDate
This is the flight period start and end dates, as defined in the flight schedule
Segments
Wrapper node for segment detail information contains one Segment element for each segment if the SegmentFlag
was set in the request
Services
Wrapper node for service information if the ServiceFlag was set in the request
Inventories
Wrapper node for inventory information if the InventoryFlag was set in the request
SSRInventories
Wrapper node for SSR inventory information if the SSRInventoryFlag was set in the request
Notes
Wrapper node for flight notes if the NotesFlag in the request is set
Restrictions
Wrapper node for flight restrictions if the RestrictionsFlag in the request is set
Remarks:
The call to this service is wrapped in the LoadFlightDetails method of the ResultsBooking.Booking class. The wrapper
method will call the service and populate the FlightDetails member and parts of the segment information based on the
flight details information.
Sample Code:
[Visual Basic]
'get flight details
Dim flightDetailSvc As New flightDetailsService.FlightDetails
XML Service APIs Page 51
flightDetailSvc.Url = ConfigurationSettings.AppSettings.GetValues("flightDetailsURL")(0)
Dim flightDetails As XmlNode = flightDetailSvc.GetFlightDetails(fl, 0, 0, 0, 0, 0, 0)
'Retrieve a specific flight from the response
If Not flightDetails Is Nothing Then
Dim xnFlight As XmlNode = FlightDetails.SelectSingleNode("//Flight[FlightNumber='XX203']" _
& "[BoardDate='2005-06-16']" _
& "[DepartureAirportCode='BRN']" _
& "[ArrivalAirportCode='ZRH']")
End If
Parameter structure definition:
Public Class FlightDetailsFlight
Public FlightNumber As String
Public BoardDate As String
Public DepartureAirport As String
Public ArrivalAirport As String
End Class
Sample SOAP/XML request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetFlightDetails xmlns="http://rrtechnologies.net/soap/">
<Flights>
<Flight>
<FlightNumber>RT2030</FlightNumber>
<BoardDate>07/28/2005</BoardDate>
<DepartureAirport>FLL</DepartureAirport>
<ArrivalAirport>LGA</ArrivalAirport>
</Flight>
<Flight>
<FlightNumber>RT960</FlightNumber>
<BoardDate>07/31/2005</BoardDate>
<DepartureAirport>LGA</DepartureAirport>
<ArrivalAirport>FLL</ArrivalAirport>
</Flight>
</Flights>
<SegmentsFlag>0</SegmentsFlag>
<ServicesFlag>0</ServicesFlag>
<InventoryFlag>0</InventoryFlag>
<SSRInventoryFlag>1</SSRInventoryFlag>
<NotesFlag>0</NotesFlag>
<RestrictionsFlag>0</RestrictionsFlag>
</GetFlightDetails>
</soap:Body>
</soap:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
XML Service APIs Page 52
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetFlightDetailsReply xmlns:RRT="http://rrtechnologies.net/soap/">
<FlightDetails>
<Flights>
<Flight>
<FlightNumber>RT2030</FlightNumber>
<BoardDate>2005-07-28</BoardDate>
<FlightDate>2005-07-28</FlightDate>
<DepartureTime>08:00</DepartureTime>
<ArrivalTime>12:00</ArrivalTime>
<ArrivalDate>2005-07-28</ArrivalDate>
<JourneyTime> 240</JourneyTime>
<DateChangeIndicator>0</DateChangeIndicator>
<DepartureCity>FLL</DepartureCity>
<DepartureCityName>FORT LAUDERDALE</DepartureCityName>
<ArrivalCity>LGA</ArrivalCity>
<ArrivalCityName>NEW YORK</ArrivalCityName>
<DepartureAirportCode>FLL</DepartureAirportCode>
<DepartureAirportName>FT LAUDERDALE/HOLLYWOOD
INTL</DepartureAirportName>
<ArrivalAirportCode>LGA</ArrivalAirportCode>
<ArrivalAirportName>LA GUARDIA INTERNATIONAL</ArrivalAirportName>
<DepartureTerminalCode>4</DepartureTerminalCode>
<DepartureTerminalName>Terminal Four</DepartureTerminalName>
<ArrivalTerminalCode>M</ArrivalTerminalCode>
<ArrivalTerminalName>Main Terminal</ArrivalTerminalName>
<Distance>1078</Distance>
<DistanceUnitOfMeasurement>MLS</DistanceUnitOfMeasurement>
<NumberOfStops>0</NumberOfStops>
<AircraftCode>321</AircraftCode>
<AircraftDescription>Airbus A321</AircraftDescription>
<FlightPeriodStartDate>2005-06-11</FlightPeriodStartDate>
<FlightPeriodEndDate>2005-11-15</FlightPeriodEndDate>
<SSRInventories>
<SSRInventory>
<RequestCode>PASE</RequestCode>
<Description>Pase Abordar Prioritario</Description>
<LimitNumber>65</LimitNumber>
<SSRCount>3</SSRCount>
<DefaultPrice>0.00</DefaultPrice>
</SSRInventory>
</SSRInventories>
</Flight>
</Flights>
</FlightDetails>
</RRT:GetFlightDetailsReply>
</soap:Body>
</soap:Envelope>
Results Web screenshot:
XML Service APIs Page 53
XML Service APIs Page 54
Advance Seat Reservation (ASR) Services
These services are used on the reservation side. The DCS has different XML services.
ASR services are used by the web to retrieve seat maps, seating information, and to make seat reservations.
Tuxedo service name: ASR_SERVICE.
The WSDL description for this service is in ResultsServices/seatres.wsdl.
Seat Map Retrieval
GetFlightDateClassSeatMaps retrieves seat map information (seat map image paths/names, dimensions, etc.) for a
specific flight/board date/origin destination/class.
Signature:
[Visual Basic]
GetFlightDateClassSeatMaps(FlightNumber As String, BoardDate As String, DepartureAirport As
String, ArrivalAirport As String, ClassCode As String) As XmlNode
Parameters:
FlightNumber
Flight number (airline code and flight number) for the flight seat maps are requested for
BoardDate
Board date as a string in US date format (MM/dd/yyyy)
DepartureAirport
Three character IATA airport code for the origin airport
ArrivalAirport
Three character IATA airport code for the destination airport
ClassCode
Selling class code for which the class seat maps are requested. This parameter is used to determine what cabin
seat maps are requested for
Return values:
SeatMapID
This is a numeric identifier of the specific seat map. This value is a required parameter in certain other ASR
operations, for example when requesting seats
Description
This is a textual description of the seat map, typically only used for seat map maintenance
ImageURLPath
URL or UNC path to the seat map background image
XML Service APIs Page 55
ImageWidth
This is the width in pixels of the seatmap background image
ImageHeight
This is the height in pixels of the seatmap background image
BlockImage
URL or UNC path to the blocked seat overlay image
ReserveImage
URL or UNC path to the reserved seat overlay image
VacantImage
URL or UNC path to the vacant seat overlay image
UnavailableImage
URL or UNC path to the unavailable seat overlay image
SeatWidth/SeatHeight
Width of height (in pixels) of a seat in the seat map
Sample Code:
[Visual Basic]
Dim asrService As New seatresService.asrservice
asrService.Url = ConfigurationSettings.AppSettings.GetValues("asrURL")(0)
Dim seatMapInfo As XmlNode = asrService.GetFlightDateClassSeatMaps(flightNumber,
boardDate.ToString("MM/dd/yyyy", GetSystemDateFormatProvider()), originAirport,
destinationAirport, sellingClassCode)
Sample SOAP/XML code:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetFlightDateClassSeatMaps xmlns="http://rrtechnologies.net/soap/">
<FlightNumber>RT582</FlightNumber>
<BoardDate>02/28/2005</BoardDate>
<DepartureAirport>FLL</DepartureAirport>
<ArrivalAirport>LGA</ArrivalAirport>
<ClassCode>Y</ClassCode>
</GetFlightDateClassSeatMaps>
</soap:Body>
</soap:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RRT:GetFlightDateClassSeatMapsReply xmlns:RRT="http://rrtechnologies.net/soap/">
<GetFlightDateClassSeatMaps>
XML Service APIs Page 56
<SeatMapID>9</SeatMapID>
<Description>MD80 Y</Description>
<ImageURLPath>http://win2ktsv/internal/asr/md-80.gif</ImageURLPath>
<ImageWidth>882</ImageWidth>
<ImageHeight>402</ImageHeight>
<BlockImage>http://win2ktsv/internal/asr/block.gif</BlockImage>
<ReserveImage>http://win2ktsv/internal/asr/seatmarker.gif</ReserveImage>
<VacantImage>http://win2ktsv/internal/asr/blank.gif</VacantImage>
<UnavailableImage>http://win2ktsv/internal/asr/block.gif</UnavailableImage>
<SeatWidth>16</SeatWidth>
<SeatHeight>16</SeatHeight>
</GetFlightDateClassSeatMaps>
</RRT:GetFlightDateClassSeatMapsReply>
</soap:Body>
</soap:Envelope>
Screen capture of Results Web:
Get All Seats
Retrieves all seats and seat availability information on a specific flight/board date/origin destination/class/seat map.
Signature:
[Visual Basic]
GetFlightDateAllSeats(ByVal FlightNumber As String, ByVal BoardDate As String, ByVal
XML Service APIs Page 57
DepartureAirport As String, ByVal ArrivalAirport As String, ByVal ClassCode As String, ByVal
SeatMapID As Integer) As XmlNode
Parameters:
FlightNumber
Flight number (airline code and flight number) for the requested flight
BoardDate
Board date in US date format (MM/dd/yyyy)
DepartureAirport
Three character IATA airport code for the origin airport.
ArrivalAirport
Three character IATA airport code for the destination airport.
ClassCode
Selling class code to retrieve seats for
SeatMapID
Seat map ID from the GetFlightDateClassSeatMaps method.
Return values:
Seat
Wrapper node for each seat returned
SeatDefinitionID
Numeric seat identifier from the seat map configuration
SeatNumber
RowNumber and SeatCode concatenated into a seat number, e.g. 14E
PositionX/PositionY
This is the horizontal and vertical location in pixels of the seat in the seat map image
AvailableFlag
Boolean flag (Y/N), indicating whether the seat is available for sale
BlockedFlag
Boolean flag (Y/N) indicating whether the seat is blocked
ForSaleFlag
Boolean flag (Y/N) indicating whether the seat is within the selling period (i.e. after the start selling time and before
the stop selling time)
Note: A seat is available for reservation only if AvailableFlag, BlockedFlag and ForSaleFlag indicates availability;
AvailableFlag=Y, BlockedFlag=N, ForSaleFlag=Y are the only seats available for reservation.
Sample code:
XML Service APIs Page 58
[Visual Basic]
'initiate asr service proxy
Dim asrService As New seatresService.asrservice
asrService.Url = ConfigurationSettings.AppSettings.GetValues("asrURL")(0)
'get seat map information
Dim seatMapInfo As XmlNode = asrService.GetFlightDateClassSeatMaps(flightNumber,
boardDate.ToString("MM/dd/yyyy", GetSystemDateFormatProvider()), originAirport,
destinationAirport, classCode)
'Retrieve seats for the seat map
Dim seatMapSeats As XmlNode
If Not seatMapInfo Is Nothing Then
Dim seatMapID As Integer =
Convert.ToInt32(seatMapInfo.SelectSingleNode("SeatMapID").InnerText)
seatMapSeats = asrService.GetFlightDateAllSeats(flightNumber,
boardDate.ToString("MM/dd/yyyy", GetSystemDateFormatProvider()), originAirport,
destinationAirport, classCode, seatMapID)
End If
Sample SOAP request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetFlightDateAllSeats xmlns="http://rrtechnologies.net/soap/">
<FlightNumber>RT582</FlightNumber>
<BoardDate>02/28/2005</BoardDate>
<DepartureAirport>FLL</DepartureAirport>
<ArrivalAirport>LGA</ArrivalAirport>
<ClassCode>Y</ClassCode>
<SeatMapID>9</SeatMapID>
</GetFlightDateAllSeats>
</soap:Body>
</soap:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RRT:GetFlightDateAllSeatsReply xmlns:RRT="http://rrtechnologies.net/soap/">
<GetFlightDateAllSeats>
<Seat>
<SeatMapID>9</SeatMapID>
<SeatDefinitionID>376</SeatDefinitionID>
<RowNumber>5</RowNumber>
<SeatCode>A</SeatCode>
<SeatNumber>5A</SeatNumber>
<PositionX>194</PositionX>
<PositionY>128</PositionY>
<AvailableFlag>N</AvailableFlag>
<BlockedFlag>Y</BlockedFlag>
<BlockedFlagXSD>1</BlockedFlagXSD>
XML Service APIs Page 59
<ForSaleFlag>Y</ForSaleFlag>
<ForSaleFlagXSD>1</ForSaleFlagXSD>
<ReserveLocator />
<ReserveBookNo />
</Seat>
<Seat>
<SeatMapID>9</SeatMapID>
<SeatDefinitionID>377</SeatDefinitionID>
<RowNumber>5</RowNumber>
<SeatCode>C</SeatCode>
<SeatNumber>5C</SeatNumber>
<PositionX>194</PositionX>
<PositionY>105</PositionY>
<AvailableFlag>N</AvailableFlag>
<BlockedFlag>Y</BlockedFlag>
<BlockedFlagXSD>1</BlockedFlagXSD>
<ForSaleFlag>Y</ForSaleFlag>
<ForSaleFlagXSD>1</ForSaleFlagXSD>
<ReserveLocator />
<ReserveBookNo />
</Seat>
...sample truncated for readability...
</GetFlightDateAllSeats>
</RRT:GetFlightDateAllSeatsReply>
</soap:Body>
</soap:Envelope>
Get Seat Attributes
Retrieves seat attributes on a specific flight/board date/origin destination/class.
Parameters:
FlightNumber
The airline code plus the numeric flight number
BoardDate
Boarding date
DepartureAirport
Departure airport code
ArrivalAirport
Arrival airport code
ClassCode
Selling class code
Return Values
SeatAttribute
The node that contains the seat information of a specific seat number
SeatMapID
Seat map ID from the GetFlightDateClassSeatMaps method.
XML Service APIs Page 60
SeatDefinitionID
Numeric seat identifier from the seat map configuration
RowNumber
SeatCode
Values can be A, B, C, D, etc. depending on how your airline configures the seating on the seat map
SeatNumber
Row number plus the seat code
PositionX, PositionY
This is the horizontal and vertical location in pixels of the seat in the seat map image
SeatAttribute
It can be aisle, window, non-smoke, etc.
Description
A text description of the SeatAttribute in the Seat Attribute Reference table
DescriptionCode
A code of the SeatAttribute in the Seat Attribute Reference table
Sample SOAP request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetFlightDateSeatAttributes xmlns:RRT="RRT">
<FlightNumber>RT111</FlightNumber>
<BoardDate>11/15/2006</BoardDate>
<DepartureAirport>FLL</DepartureAirport>
<ArrivalAirport>LGA</ArrivalAirport>
<ClassCode>Y</ClassCode>
</RRT:GetFlightDateSeatAttributes>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?> <soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetFlightDateSeatAttributesReply xmlns:RRT="http://rrtechnologies.net/soap/">
<GetFlightDateSeatAttributes>
<SeatAttribute>
<SeatMapID>7</SeatMapID>
<SeatDefinitionID>244</SeatDefinitionID>
<RowNumber>5</RowNumber>
<SeatCode>C</SeatCode>
XML Service APIs Page 61
<SeatNumber>5C</SeatNumber>
<PositionX>308</PositionX>
<PositionY>121</PositionY>
<SeatAttribute>AISL</SeatAttribute>
<Description>Aisle</Description>
<DescriptionCode>AISLE</DescriptionCode>
</SeatAttribute>
<SeatAttribute>
<SeatMapID>7</SeatMapID>
<SeatDefinitionID>245</SeatDefinitionID>
<RowNumber>5</RowNumber>
<SeatCode>D</SeatCode>
<SeatNumber>5D</SeatNumber>
<PositionX>312</PositionX>
<PositionY>88</PositionY>
<SeatAttribute>AISL</SeatAttribute>
<Description>Aisle</Description>
<DescriptionCode>AISLE</DescriptionCode>
</SeatAttribute>
<SeatAttribute>
<SeatMapID>7</SeatMapID>
<SeatDefinitionID>246</SeatDefinitionID>
<RowNumber>5</RowNumber>
<SeatCode>E</SeatCode>
<SeatNumber>5E</SeatNumber>
<PositionX>311</PositionX>
<PositionY>73</PositionY>
<SeatAttribute>CNTR</SeatAttribute>
<Description>Center</Description>
<DescriptionCode>CNTR</DescriptionCode>
</SeatAttribute>
<SeatAttribute>
<SeatMapID>7</SeatMapID>
<SeatDefinitionID>247</SeatDefinitionID>
<RowNumber>5</RowNumber>
<SeatCode>F</SeatCode>
<SeatNumber>5F</SeatNumber>
<PositionX>312</PositionX>
<PositionY>56</PositionY>
<SeatAttribute>WIND</SeatAttribute>
<Description>Window</Description>
<DescriptionCode>WIN</DescriptionCode>
</SeatAttribute>
<SeatAttribute>
<SeatMapID>7</SeatMapID>
<SeatDefinitionID>252</SeatDefinitionID>
<RowNumber>6</RowNumber>
<SeatCode>E</SeatCode>
<SeatNumber>6E</SeatNumber>
<PositionX>336</PositionX>
<PositionY>70</PositionY>
<SeatAttribute>CNTR</SeatAttribute>
<Description>Center</Description>
<DescriptionCode>CNTR</DescriptionCode>
</SeatAttribute>
<SeatAttribute>
<SeatMapID>7</SeatMapID>
XML Service APIs Page 62
<SeatDefinitionID>253</SeatDefinitionID>
<RowNumber>6</RowNumber>
<SeatCode>F</SeatCode>
<SeatNumber>6F</SeatNumber>
<PositionX>335</PositionX>
<PositionY>56</PositionY>
<SeatAttribute>WIND</SeatAttribute>
<Description>Window</Description>
<DescriptionCode>WIN</DescriptionCode>
</SeatAttribute>
<SeatAttribute>
<SeatMapID>7</SeatMapID>
<SeatDefinitionID>254</SeatDefinitionID>
<RowNumber>7</RowNumber>
<SeatCode>A</SeatCode>
<SeatNumber>7A</SeatNumber>
<PositionX>358</PositionX>
<PositionY>159</PositionY>
<SeatAttribute>WIND</SeatAttribute>
<Description>Window</Description>
<DescriptionCode>WIN</DescriptionCode>
</SeatAttribute>
<SeatAttribute>
<SeatMapID>7</SeatMapID>
<SeatDefinitionID>256</SeatDefinitionID>
<RowNumber>7</RowNumber>
<SeatCode>C</SeatCode>
<SeatNumber>7C</SeatNumber>
<PositionX>358</PositionX>
<PositionY>121</PositionY>
<SeatAttribute>AISL</SeatAttribute>
<Description>Aisle</Description>
<DescriptionCode>AISLE</DescriptionCode>
</SeatAttribute>
<SeatAttribute>
<SeatMapID>7</SeatMapID>
<SeatDefinitionID>258</SeatDefinitionID>
<RowNumber>7</RowNumber>
<SeatCode>E</SeatCode>
<SeatNumber>7E</SeatNumber>
<PositionX>365</PositionX>
<PositionY>71</PositionY>
<SeatAttribute>CNTR</SeatAttribute>
<Description>Center</Description>
<DescriptionCode>CNTR</DescriptionCode>
</SeatAttribute>
<SeatAttribute>
<SeatMapID>7</SeatMapID>
<SeatDefinitionID>259</SeatDefinitionID>
<RowNumber>7</RowNumber>
<SeatCode>F</SeatCode>
<SeatNumber>7F</SeatNumber>
<PositionX>360</PositionX>
<PositionY>58</PositionY>
<SeatAttribute>WIND</SeatAttribute>
<Description>Window</Description>
<DescriptionCode>WIN</DescriptionCode>
XML Service APIs Page 63
</SeatAttribute>
<SeatAttribute>
<SeatMapID>7</SeatMapID>
<SeatDefinitionID>260</SeatDefinitionID>
<RowNumber>8</RowNumber>
<SeatCode>A</SeatCode>
<SeatNumber>8A</SeatNumber>
<PositionX>383</PositionX>
<PositionY>159</PositionY>
<SeatAttribute>BEST</SeatAttribute>
<Description>Best available i.e. do not seat two passengers acrossed a blocked
seat</Description>
<DescriptionCode>BEST</DescriptionCode>
</SeatAttribute>
<SeatAttribute>
<SeatMapID>7</SeatMapID>
<SeatDefinitionID>262</SeatDefinitionID>
<RowNumber>8</RowNumber>
<SeatCode>C</SeatCode>
<SeatNumber>8C</SeatNumber>
<PositionX>383</PositionX>
<PositionY>121</PositionY>
<SeatAttribute>BEST</SeatAttribute>
<Description>Best available i.e. do not seat two passengers acrossed a blocked
seat</Description>
<DescriptionCode>BEST</DescriptionCode>
</SeatAttribute>
<SeatAttribute>
<SeatMapID>7</SeatMapID>
<SeatDefinitionID>264</SeatDefinitionID>
<RowNumber>8</RowNumber>
<SeatCode>E</SeatCode>
<SeatNumber>8E</SeatNumber>
<PositionX>386</PositionX>
<PositionY>73</PositionY>
<SeatAttribute>CNTR</SeatAttribute>
<Description>Center</Description>
<DescriptionCode>CNTR</DescriptionCode>
</SeatAttribute>
<SeatAttribute>
<SeatMapID>7</SeatMapID>
<SeatDefinitionID>265</SeatDefinitionID>
<RowNumber>8</RowNumber>
<SeatCode>F</SeatCode>
<SeatNumber>8F</SeatNumber>
<PositionX>388</PositionX>
<PositionY>56</PositionY>
<SeatAttribute>OXYG</SeatAttribute>
<Description>Single Oxygen Mask</Description>
<DescriptionCode>OXYG</DescriptionCode>
</SeatAttribute>
<SeatAttribute>
<SeatMapID>7</SeatMapID>
<SeatDefinitionID>272</SeatDefinitionID>
<RowNumber>10</RowNumber>
<SeatCode>B</SeatCode>
<SeatNumber>10B</SeatNumber>
XML Service APIs Page 64
<PositionX>434</PositionX>
<PositionY>143</PositionY>
<SeatAttribute>EXIT</SeatAttribute>
<Description>Exit Row</Description>
<DescriptionCode>EXIT</DescriptionCode>
</SeatAttribute>
<SeatAttribute>
<SeatMapID>7</SeatMapID>
<SeatDefinitionID>273</SeatDefinitionID>
<RowNumber>10</RowNumber>
<SeatCode>C</SeatCode>
<SeatNumber>10C</SeatNumber>
<PositionX>434</PositionX>
<PositionY>121</PositionY>
<SeatAttribute>EXIT</SeatAttribute>
<Description>Exit Row</Description>
<DescriptionCode>EXIT</DescriptionCode>
</SeatAttribute>
<SeatAttribute>
<SeatMapID>7</SeatMapID>
<SeatDefinitionID>274</SeatDefinitionID>
<RowNumber>10</RowNumber>
<SeatCode>D</SeatCode>
<SeatNumber>10D</SeatNumber>
<PositionX>437</PositionX>
<PositionY>88</PositionY>
<SeatAttribute>EXIT</SeatAttribute>
<Description>Exit Row</Description>
<DescriptionCode>EXIT</DescriptionCode>
</SeatAttribute>
<SeatAttribute>
<SeatMapID>7</SeatMapID>
<SeatDefinitionID>275</SeatDefinitionID>
<RowNumber>10</RowNumber>
<SeatCode>E</SeatCode>
<SeatNumber>10E</SeatNumber>
<PositionX>434</PositionX>
<PositionY>77</PositionY>
<SeatAttribute>EXIT</SeatAttribute>
<Description>Exit Row</Description>
<DescriptionCode>EXIT</DescriptionCode>
</SeatAttribute>
<SeatAttribute>
<SeatMapID>7</SeatMapID>
<SeatDefinitionID>284</SeatDefinitionID>
<RowNumber>12</RowNumber>
<SeatCode>C</SeatCode>
<SeatNumber>12C</SeatNumber>
<PositionX>486</PositionX>
<PositionY>121</PositionY>
<SeatAttribute>AISL</SeatAttribute>
<Description>Aisle</Description>
<DescriptionCode>AISLE</DescriptionCode>
</SeatAttribute>
</GetFlightDateSeatAttributes>
</RRT:GetFlightDateSeatAttributesReply>
</soap:Body>
XML Service APIs Page 65
</soap:Envelope>
Reserve Seats
The ReserveSeats method makes temporary reservations of one or several seats on a flight for use on a booking.
The reservations will be made permanent when the booking is submitted for processing with the corresponding SEAT
SSRs.
Signature:
[Visual Basic]
ReserveSeats(FlightNumber As String, BoardDate As String, DepartureAirport As String,
ArrivalAirport As String, ClassCode As String, ReserveReason As String, BookNumber As
Integer, BlockFlag As String, <XmlArrayItemAttribute("SeatNumber")> SeatNumbers() As String)
As <XmlArrayItemAttribute("FlightSeatReservationGroupID", IsNullable:=false)> Integer()
Parameters:
FlightNumber
The airline code plus the numeric flight number
BoardDate
The date to board the flight, in the format of mm/dd/yyyy
DepartureAirport/ArrivalAirport
The three-character departure/arrival airport code
ClassCode
The selling class code of the itinerary segment.
BookNumber
Numeric booking number if known or 0 if unknown.
BlockFlag
Boolean flag (Y/N) indicating whether the seat is being reserved (N) or blocked from reservations (Y).
SeatNumbers/SeatNumber
A string array containing one or more seat numbers to be reserved, concatenated row numbers and seat codes e.g.,
‘14B’.
Return Values
FlightSeatReservationGroupID
An array of unique numeric seat reservation identifiers. Each reservation has its’ own unique
FlightSeatReservationGroupID.
Sample Code:
[Visual Basic]
'initiate the asr service proxy
Dim asrService As New seatresService.asrservice
asrService.Url = ConfigurationSettings.AppSettings.GetValues("asrURL")(0)
XML Service APIs Page 66
'reserve seat
Dim seatNumbers(0) As String
seatNumbers(0) = seatNumber
Dim seatResIDs() As Integer _
= asrService.ReserveSeats(flightNumber, _
boardDate, _
originAirportCode, destinationAirportCode, _
classCode, _
Nothing, Nothing, Nothing, _
seatNumbers)
Sample SOAP request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<ReserveSeats xmlns="http://rrtechnologies.net/soap/">
<FlightNumber>RT582</FlightNumber>
<BoardDate>02/28/2005</BoardDate>
<DepartureAirport>FLL</DepartureAirport>
<ArrivalAirport>LGA</ArrivalAirport>
<ClassCode>Y</ClassCode>
<BookNumber>0</BookNumber>
<SeatNumbers>
<SeatNumber>14E</SeatNumber>
</SeatNumbers>
</ReserveSeats>
</soap:Body>
</soap:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:ReserveSeatsReply xmlns:RRT="http://rrtechnologies.net/soap/">
<ReserveSeats>
<FlightSeatReservationGroupID>9918</FlightSeatReservationGroupID>
</ReserveSeats>
</RRT:ReserveSeatsReply>
</soap:Body>
</soap:Envelope>
Get Book Seat Reservations
Retrieves all active seat reservations for a booking.
Signature:
[Visual Basic]
GetBookSeatReservations(ByVal BookNumber As Integer) As XmlNode
XML Service APIs Page 67
Parameters:
BookNumber
Numeric booking number
Return values:
FlightSeatReservationID
Numeric unique identifier for a seat reservation on the reserved flight segment
FlightSeatReservationGroupID
Numeric unique identifier for a seat reservation (for all affected legs)
FlightDateLegID
Numeric unique identifier of a flight/date/origin/destination
SeatMapID
Numeric identifier of the seat map where the reserved seat is visualized
SeatDefinitionID
Numeric identifier of the seat
TemporaryReserveFlag
Boolean flag (Y/N) indicating whether the reservation is confirmed or not
ReleaseDateTime
Expiry date and time for temporary seat reservations. Null or blank for permanent reservations
BoardingControlNumber
Boarding control number – sequential boarding pass number. 0, null or blank if a boarding pass has not yet been
generated
Sample code:
[Visual Basic]
Dim asrService As New seatresService.asrservice
asrService.Url = ConfigurationSettings.AppSettings.GetValues("asrURL")(0)
Dim seatReservations As XmlNode = asrService.GetBookSeatReservations(bookNumber)
Remarks:
This method is wrapped in the RetrieveBooking method of the ResultsBooking.BookingRetrieval class.
Sample SOAP/XML request:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-
ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetBookSeatReservations xmlns:RRT="RRT">
<RecorderLocator>HNPWMY</ RecorderLocator >
</RRT:GetBookSeatReservations>
XML Service APIs Page 68
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Successful response is:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="http://schemas.xmlsoap.org/soap/envelope/">
<RRT:Header/>
<RRT:Body>
<RRT:GetBookSeatReservationsReply>
<GetBookSeatReservations>
<SeatReservation>
<FlightSeatReservationID>297452</FlightSeatReservationID>
<FlightSeatReservationGroupID>91</FlightSeatReservationGroupID>
<FlightDateLegID>20722</FlightDateLegID>
<FlightNumber>RT900</FlightNumber>
<BoardDate>08/25/2004</BoardDate>
<FlightDate>08/25/2004</FlightDate>
<DepartureTime>06:30</DepartureTime>
<DepartureAirportCode>FLL</DepartureAirportCode>
<DestinationAirportCode>DTW</DestinationAirportCode>
<SeatDefinitionID>9</SeatDefinitionID>
<RowNumber>17</RowNumber>
<SeatCode>F</SeatCode>
<SeatNumber>17F</SeatNumber>
<SeatMapID>1</SeatMapID>
<PositionX>300</PositionX>
<PositionY>68</PositionY>
<ReserveReason/>
<TemporaryReserveFlag>N</TemporaryReserveFlag>
<ReleaseDateTime/>
<BoardingControlNumber/>
<PassengerNumber>1</PassengerNumber>
<PassengerName>DOE/JOHN</PassengerName>
<PassengerDescription>UMNR</PassengerDescription>
</SeatReservation>
</GetBookSeatReservations>
</RRT:GetBookSeatReservationsReply>
</RRT:Body>
</RRT:Envelope>
Release Seats
Releases seat reservations. Use only for temporary reservations; permanent reservations should be released by
submitting the booking with the SEAT SSRs cancelled (action code XX) to avoid inconsistencies between SSRs and
seat reservations.
Signature:
[Visual Basic]
ReleaseSeats(FlightNumber As string, BoardDate As string, DepartureAirport As string,
ArrivalAirport As string, SeatNumbers As ArrayOfSeatNumber)
XML Service APIs Page 69
Parameters:
FlightNumber
Flight number (airline code and flight number) for the requested flight
BoardDate
Board date in US date format (MM/dd/yyyy)
DepartureAirport
Three character IATA airport code for the origin airport
ArrivalAirport
Three character IATA airport code for the destination airport
SeatNumbers
Array of seat number(s) to release
Sample SOAP/XML request:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-
ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:ReleaseSeats xmlns:RRT="RRT">
<BookNumber>2637829</BookNumber>
<FlightNumber>RT900</FlightNumber>
<BoardDate>08/25/2004</BoardDate>
<DepartureAirport>FLL</DepartureAirport>
<ArrivalAirport>DTW</ArrivalAirport>
<SeatNumbers>
<SeatNumber>17F</SeatNumber>
</SeatNumbers>
</RRT:ReleaseSeats>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Successful response is:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<RRT:Envelope xmlns:RRT="http://schemas.xmlsoap.org/soap/envelope/">
<RRT:Header/>
<RRT:Body>
<RRT:ReleaseSeatsReply>
<RelesaseSeats>
<FlightSeatReservationGroupID>91</FlightSeatReservationGroupID>
</RelesaseSeats>
</RRT:ReleaseSeatsReply>
</RRT:Body>
</RRT:Envelope>
XML Service APIs Page 70
Booking Service
The booking service exposes methods for validating booking information (passenger information, flight information,
fare information, etc.), calculating fees, and confirming bookings and retrieving bookings.
Tuxedo service name: BOOKING_SERVICE
Validate Booking
This call validates booking data, ensuring that mandatory fields are specified, flight segments are valid and
determines if any fees apply to the booking.
This method is wrapped by the ValidateBooking method of the ResultsBooking.Booking class.
Signature:
[Visual Basic]
ValidateBooking(Booking As XmlNode) As XmlNode
Parameters
The booking is submitted as an XmlNode/XmlDocument containing the entire booking. Some of the main nodes are
described below, refer to samples for details.
BookNo
Numeric booking number, if known
Locator
Alphanumeric record locator, if known
SeatCount
Number of seats requested in the booking
NonSeatTakingPax
Number of non seat taking passengers in the booking e.g. number of infants
OriginAddress
This is the booking origin address
ExternalLocator
Locator generated outside of Results
ReceivedFrom
Textual description of the booking source
PaymentBalanceValidated
Reserved, not used by the booking validation service.
BranchCode
Booking origin branch code, used for pricing
XML Service APIs Page 71
Passengers/Passenger
Array of Passenger nodes containing passenger names, descriptions and contact information
Segments/Segment
Array of Segment nodes containing information on each booked segment
ActionCode
HashValue
You can obtain the HashValue from the Validate Booking reply
Fares/Fare
Array of Fare nodes containing information about fares applied to the booking
SourceReferenceId
You can obtain the HashValue from the Pricing Service
Taxes/Tax
Array of Tax nodes containing information about taxes applied to the booking
Fees
Array of Fee nodes containing information about fees applied to the booking.
SSRData
Array of SSR nodes containing detailed information
Payments/Payment
Array of payments applied to the booking
PaymentNo
A Payment No is the unique ID of each payment in the system, generated by Results when a payment is created.
You can input a zero now.
PaymentForm
Payment Form (along with PaymentType) defines a payment document, i.e. CC/VI for a Visa Credit card.
Return values:
The response from the validation service is the booking, as submitted and completed with validation errors/warnings,
validation ID and any fees that apply.
Version
The version number of the validation service
Id
The validation ID that identifies the booking is ready for final submit
Error
This will be the error code if the execution of the request is unsuccessful
Notes
This will give a description of the error if the execution of the request is unsuccessful
Sample code:
XML Service APIs Page 72
[Visual Basic]
'load sample booking xml
Dim bookingInfo As New XmlDocument
bookingInfo.Load("c:\temp\testbooking.xml")
'Submit to the validation service
Dim bookValidationService As New bookValidationService.bookingValidation
bookValidationService.Url = ConfigurationSettings.AppSettings.GetValues("bookValidationURL")
(0)
Dim validationResponse As XmlNode _
= bookValidationService.ValidateBooking(bookingInfo.DocumentElement)
'loop through validation errors if any and print them in the debug window
For Each validationError As XmlNode In validationResponse.SelectNodes("Errors/ErrorInfo")
Debug.WriteLine(validationError.SelectSingleNode("ErrorCode").InnerText)
Debug.WriteLine(validationError.SelectSingleNode("ErrorDetail").InnerText)
Next
Note: Fees are added through ResultsBooking.dll. Sample code is provided below:
[Visual Basic]
'Instantiate booking object
Dim book As New ResultsBooking.Booking
'Create an instance of fee object
Dim objFee As New ResultsBooking.Fee
With objFee
.FeeCode = "XEF"
.TaxCode = "FTX"
.Description = "New baggage fee"
.Amount = 500
.Tax = 20
.CurrencyCode = "USD"
.SourceReferenceID = 2
.ThisSession = True
End With
'Add fee to the booking object
book.Fees.Add(objFee)
Sample XML Fee node is included in the XML request below.
Sample SOAP/XML request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<ValidateBooking xmlns="http://rrtechnologies.net/soap/">
<Booking xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="">
<BookNo>0</BookNo>
<Locator />
<SeatCount>1</SeatCount>
<NonSeatTakingPax>0</NonSeatTakingPax>
XML Service APIs Page 73
<OriginAddress>HDKWWRT</OriginAddress>
<ExternalLocator />
<ReceivedFrom>192.168.112.64</ReceivedFrom>
<PaymentBalanceValidated>false</PaymentBalanceValidated>
<BranchCode>RT FLL 0001</BranchCode>
<AgencyCode />
<FareDesignator />
<BookCategory>S</BookCategory>
<GroupName />
<CreationDateTime>0001-01-01T00:00:00.0000000-05:00</CreationDateTime>
<Cancelled>false</Cancelled>
<ModificationAllowed>true</ModificationAllowed>
<LastPaymentDateTime />
<Passengers>
<Passenger>
<PassengerNo>1</PassengerNo>
<PassengerCode>ADULT</PassengerCode>
<ContactInformation>
<ContactInformation>
<Address>121 main st.</Address>
<City>miami</City>
<County />
<State>fl</State>
<Nation>us</Nation>
<PostalCode>33333</PostalCode>
<HomePhone>9545551212</HomePhone>
<BusinessPhone />
<AgentPhone />
<OtherPhone />
<Fax />
<Email>JOHN@rrtechnologies.net</Email>
</ContactInformation>
<PassengerAge>0</PassengerAge>
<PassengerAgeUnit />
<ClientProfileCode />
<LastName>DOE</LastName>
<FirstName>JOHN</FirstName>
<MiddleName />
<Title>MR</Title>
<Type>ADULT</Type>
<PassengerName>DOE/JOHN MR</PassengerName>
</Passenger>
</Passengers>
<Segments>
<Segment>
<CarrierCode>RT</CarrierCode>
<FlightNumberNumeric>5050</FlightNumberNumeric>
<OriginAirport>FLL</OriginAirport>
<DestinationAirport>LGA</DestinationAirport>
<ClassCode>Y</ClassCode>
<TravelTime>180</TravelTime>
<SegmentNumber>1</SegmentNumber>
<HashValue>ZEtJy8dL4rVFYT03SINczfLyXAQ=</HashValue>
<BoardDate>2005-06-26T00:00:00.0000000-04:00</BoardDate>
<DepartureTime>0001-01-01T17:00:00.0000000-05:00</DepartureTime>
<ArrivalTime>0001-01-01T20:00:00.0000000-05:00</ArrivalTime>
<DateChangeIndicator>0</DateChangeIndicator>
XML Service APIs Page 74
<ActionCode>SS</ActionCode>
<FlightNumber>RT5050</FlightNumber>
</Segment>
<Segment>
<CarrierCode>RT</CarrierCode>
<FlightNumberNumeric>961</FlightNumberNumeric>
<OriginAirport>LGA</OriginAirport>
<DestinationAirport>FLL</DestinationAirport>
<ClassCode>M</ClassCode>
<TravelTime>180</TravelTime>
<SegmentNumber>2</SegmentNumber>
<HashValue>2bElyQ5VpyzoZedwGrnMZExjdm0=</HashValue>
<BoardDate>2005-06-29T00:00:00.0000000-04:00</BoardDate>
<DepartureTime>0001-01-01T07:55:00.0000000-05:00</DepartureTime>
<ArrivalTime>0001-01-01T10:55:00.0000000-05:00</ArrivalTime>
<DateChangeIndicator>0</DateChangeIndicator>
<ActionCode>SS</ActionCode>
<FlightNumber>RT961</FlightNumber>
</Segment>
</Segments>
<Fares>
<Fare>
<FareNumber>0</FareNumber>
<PassengerType>ADULT</PassengerType>
<ClassCode>Y</ClassCode>
<FareCode>YTEST</FareCode>
<SegmentNumbers>
<int>1</int>
</SegmentNumbers>
<Refundable>false</Refundable>
<Amount>99.00000</Amount>
<CurrencyCode>USD</CurrencyCode>
<SourceReferenceID>-1611485609665673140</SourceReferenceID>
<TotalAmount>0</TotalAmount>
<FareNo>0</FareNo>
<PassengerDescriptionCode>ADULT</PassengerDescriptionCode>
<TotalAmountCurr>USD</TotalAmountCurr>
<FareAmount>99.00000</FareAmount>
</Fare>
<Fare>
<FareNumber>0</FareNumber>
<PassengerType>ADULT</PassengerType>
<ClassCode>M</ClassCode>
<FareCode>MENR</FareCode>
<SegmentNumbers>
<int>2</int>
</SegmentNumbers>
<Refundable>false</Refundable>
<Amount>186.04651</Amount>
<CurrencyCode>USD</CurrencyCode>
<SourceReferenceID>-7972859807617955530</SourceReferenceID>
<TotalAmount>0</TotalAmount>
<FareNo>0</FareNo>
<PassengerDescriptionCode>ADULT</PassengerDescriptionCode>
<TotalAmountCurr>USD</TotalAmountCurr>
<FareAmount>186.04651</FareAmount>
</Fare>
XML Service APIs Page 75
</Fares>
<Surcharges />
<Taxes>
<Tax>
<PassengerType>ADULT</PassengerType>
<Code>AY</Code>
<AppliedTo>FLL</AppliedTo>
<Amount>2.50000</Amount>
<CurrencyCode>USD</CurrencyCode>
<TaxSegments>
<int>1</int>
</TaxSegments>
<SourceReferenceID>2</SourceReferenceID>
</Tax>
<Tax>
<PassengerType>ADULT</PassengerType>
<Code>XF</Code>
<AppliedTo>FLL</AppliedTo>
<Amount>3.00000</Amount>
<CurrencyCode>USD</CurrencyCode>
<TaxSegments>
<int>1</int>
</TaxSegments>
<SourceReferenceID>3</SourceReferenceID>
</Tax>
<Tax>
...sample truncated for readability...
</Tax>
<Tax>
...sample truncated for readability...
</Tax>
<Tax>
...sample truncated for readability...
</Tax>
<Tax>
...sample truncated for readability...
</Tax>
<Tax>
...sample truncated for readability...
</Tax>
</Taxes>
<FEES>
<FEE>
<FeeNumber>0</FeeNumber>
<FeeCode>NM2</FeeCode>
<TaxCode>NM2</TaxCode>
<Description>GUI name change fee</Description>
<Amount>25.00</Amount>
<Tax>0</Tax>
<CurrencyCode>USD</CurrencyCode>
<SourceReferenceID>-5823914343368408810</SourceReferenceID>
<ThisSession>true</ThisSession>
<ManualFee>false</ManualFee>
</FEE>
</FEES>
<SSRData>
<SSR>
XML Service APIs Page 76
<SSRNumber>1</SSRNumber>
<Carrier>RT</Carrier>
<Code>SEAT</Code>
<ActionCode>HK</ActionCode>
<Count>1</Count>
<SSRSegments>
<int>1</int>
</SSRSegments>
<SSRPassengers>
<int>1</int>
</SSRPassengers>
<Text>8F</Text>
</SSR>
<SSR>
<SSRNumber>2</SSRNumber>
<Carrier>RT</Carrier>
<Code>SEAT</Code>
<ActionCode>HK</ActionCode>
<Count>1</Count>
<SSRSegments>
<int>2</int>
</SSRSegments>
<SSRPassengers>
<int>1</int>
</SSRPassengers>
<Text>11F</Text>
</SSR>
</SSRData>
<OSIData>
<OSI>
<Code>CTCE</Code>
<Text>JOHN//RRTECHNOLOGIES.NET E</Text>
<Update>false</Update>
</OSI>
<OSI>
<Code>RT</Code>
<Text>LOCATOR HNTTNW</Text>
<Update>false</Update>
</OSI>
</OSIData>
<FarePayments />
<Payments>
<Payment>
<PaymentNo>0</PaymentNo>
<PaymentForm>VI</PaymentForm>
<PaymentType>CC</PaymentType>
<PaymentAmount>320.43</PaymentAmount>
<PaymentDate>06/22/2005</PaymentDate>
<DocumentNo>4111111111111111</DocumentNo>
<PassengerName>DOE/Z</PassengerName>
<PaidCurrencyCode>USD</PaidCurrencyCode>
<CcExpiryDate>1111</CcExpiryDate>
<CVV>123</CVV>
<Address1 />
<State />
<City />
<PostalCode />
XML Service APIs Page 77
<Country />
<Phone />
</Payment>
</Payments>
</Booking>
</ValidateBooking>
</soap:Body>
</soap:Envelope>
Notes:
1. If you want to waive the fee, the fee node should look like this:
<FEE>
<FeeNumber>0</FeeNumber>
<FeeCode>WF</FeeCode>
<TaxCode>WF</TaxCode>
<Description>Waive name change fee</Description>
<Amount>-25.00</Amount>
<Tax>0</Tax>
<CurrencyCode>USD</CurrencyCode>
<SourceReferenceID>0</SourceReferenceID>
<ThisSession>true</ThisSession>
<ManualFee>false</ManualFee>
</FEE>
Where <FeeCode> and <TaxCode> should get the value from system setting PAYMENT_TYPE_FEE_WAI;
<Amount> represents a negative value equal to the amount to be waived. <PassengerName> is optional.
2. If you want to add time limit to a booking (for absence of payment or for deferred payments lilke cash), you need to
insert an SSR node for it into the SSRData wrapper node. Example:
<SSR>
<SSRNumber>0</SSRNumber>
<Carrier>YY</Carrier>
<Code>RRTL</Code>
<ActionCode>HK</ActionCode>
<Count>1</Count>
<SSRPassengers>
<int>1</int>
</SSRPassengers>
<Text>M1200</Text>
</SSR>
where
Carrier should always have value YY.
Code must use RRTL
In Text element, M indicates minute; the number is the actual time limit in minutes.
3. If the booking is paid with PROSA credit card, you will see an extra node within the PAYMENT wrapper node:
XML Service APIs Page 78
<PRCM>
<OperationNumber>19677 </OperationNumber>
<AuthorizationNo>56 </AuthorizationNo>
</PRCM>
4. For modified bookings, the following elements may be added to the <Passenger> node (after the current name)
and is required if the change involes name(s).
<OldLastName>; <OldFirstName>; <OldMiddleName >; <OldTitle>; and <OldPassengerNane>. Example:
<Passengers>
<Passenger>
<PassengerNo>1</PassengerNo>
<PassengerCode>ADULT</PassengerCode>
<ContactInformation>
<Address />
<City />
<County />
<State />
<Nation />
<PostalCode />
<HomePhone />
<BusinessPhone />
<AgentPhone />
<OtherPhone />
<Fax />
<Email />
</ContactInformation>
<PassengerAge>0</PassengerAge>
<PassengerAgeUnit />
<ClientProfileCode />
<LastName>TEST</LastName>
<FirstName>ZZZ</FirstName>
<MiddleName />
<Title />
<Type>ADULT</Type>
<PassengerName>TEST/ZZZ</PassengerName>
<OldLastName>TEST</OldLastName>
<OldFirstName>JOHN</OldFirstName>
<OldMiddleName />
<OldTitle />
<OldPassengerName>TEST/JOHN</OldPassengerName>
</Passenger>
</Passengers>
Successful response is:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:ValidateBookingReply xmlns:RRT="http://rrtechnologies.net/soap/">
<RRT:ValidateBookingResult>
<Validation>
<Version>1</Version>
<Id>2f443ef0-7c2f-4bc2-b76c-268dbb7122a6</Id>
XML Service APIs Page 79
<Errors />
<Notes />
<Booking xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<BookNo>0</BookNo>
<Locator />
<SeatCount>1</SeatCount>
<NonSeatTakingPax>0</NonSeatTakingPax>
<OriginAddress>HDKWWRT</OriginAddress>
<ExternalLocator />
<ReceivedFrom>192.168.112.64</ReceivedFrom>
<PaymentBalanceValidated>false</PaymentBalanceValidated>
<BranchCode>RT FLL 0001</BranchCode>
<AgencyCode />
<FareDesignator />
<SourceIP>192.168.112.64</SourceIP>
<AdditionalSourceInformation />
<Passengers>
<Passenger>
<PassengerNo>1</PassengerNo>
<PassengerCode>ADULT</PassengerCode>
<ContactInformation>
<Address />
<City />
<County />
<State />
<Nation />
<PostalCode />
<HomePhone />
<BusinessPhone />
<AgentPhone />
<OtherPhone />
<Fax />
<Email>passenger@rrtechnologies.net</Email>
</ContactInformation>
<PassengerAge>0</PassengerAge>
<PassengerAgeUnit />
<ClientProfileCode />
<LastName>DOE</LastName>
<FirstName>JANE</FirstName>
<MiddleName />
<Title>MR</Title>
<Type>ADULT</Type>
<PassengerName>DOE/JOHN MR</PassengerName>
</Passenger>
</Passengers>
<Segments>
<Segment>
<CarrierCode>RT</CarrierCode>
<FlightNumberNumeric>5050</FlightNumberNumeric>
<OriginAirport>FLL</OriginAirport>
<DestinationAirport>LGA</DestinationAirport>
<ClassCode>Y</ClassCode>
<TravelTime>180</TravelTime>
<SegmentNumber>1</SegmentNumber>
<HashValue>ZEtJy8dL4rVFYT03SINczfLyXAQ=</HashValue>
<BoardDate>2005-06-26T00:00:00.0000000-04:00</BoardDate>
XML Service APIs Page 80
<DepartureTime>0001-01-01T17:00:00.0000000-05:00</DepartureTime>
<ArrivalTime>0001-01-01T20:00:00.0000000-05:00</ArrivalTime>
<DateChangeIndicator>0</DateChangeIndicator>
<ActionCode>SS</ActionCode>
<FlightNumber>RT5050</FlightNumber>
</Segment>
<Segment>
...sample truncated for readability...
</Segment>
</Segments>
<Fares>
<Fare>
<FareNumber>0</FareNumber>
<PassengerType>ADULT</PassengerType>
<ClassCode>Y</ClassCode>
<FareCode>YTEST</FareCode>
<SegmentNumbers>
<int>1</int>
</SegmentNumbers>
<Refundable>false</Refundable>
<Amount>99.00000</Amount>
<CurrencyCode>USD</CurrencyCode>
<SourceReferenceID>-1611485609665673140</SourceReferenceID>
<TotalAmount>0</TotalAmount>
<FareNo>0</FareNo>
<PassengerDescriptionCode>ADULT</PassengerDescriptionCode>
<TotalAmountCurr>USD</TotalAmountCurr>
<FareAmount>99.00000</FareAmount>
</Fare>
<Fare>
<FareNumber>0</FareNumber>
<PassengerType>ADULT</PassengerType>
<ClassCode>M</ClassCode>
<FareCode>MENR</FareCode>
<SegmentNumbers>
<int>2</int>
</SegmentNumbers>
<Refundable>false</Refundable>
<Amount>186.04651</Amount>
<CurrencyCode>USD</CurrencyCode>
<SourceReferenceID>-7972859807617955530</SourceReferenceID>
<TotalAmount>0</TotalAmount>
<FareNo>0</FareNo>
<PassengerDescriptionCode>ADULT</PassengerDescriptionCode>
<TotalAmountCurr>USD</TotalAmountCurr>
<FareAmount>186.04651</FareAmount>
</Fare>
</Fares>
<Surcharges />
<Taxes>
<Tax>
<PassengerType>ADULT</PassengerType>
<Code>AY</Code>
<AppliedTo>FLL</AppliedTo>
<Amount>2.50000</Amount>
<CurrencyCode>USD</CurrencyCode>
<TaxSegments>
XML Service APIs Page 81
<int>1</int>
</TaxSegments>
<SourceReferenceID>2</SourceReferenceID>
</Tax>
<Tax>
<PassengerType>ADULT</PassengerType>
<Code>XF</Code>
<AppliedTo>FLL</AppliedTo>
<Amount>3.00000</Amount>
<CurrencyCode>USD</CurrencyCode>
<TaxSegments>
<int>1</int>
</TaxSegments>
<SourceReferenceID>3</SourceReferenceID>
</Tax>
<Tax>
...sample truncated for readability...
</Tax>
<Tax>
...sample truncated for readability...
</Tax>
<Tax>
...sample truncated for readability...
</Tax>
<Tax>
...sample truncated for readability...
</Tax>
<Tax>
...sample truncated for readability...
</Tax>
</Taxes>
<Fees />
<SSRData>
<SSR>
<SSRNumber>1</SSRNumber>
<Carrier>RT</Carrier>
<Code>SEAT</Code>
<ActionCode>HK</ActionCode>
<Count>1</Count>
<SSRSegments>
<int>1</int>
</SSRSegments>
<SSRPassengers>
<int>1</int>
</SSRPassengers>
<Text>8F</Text>
</SSR>
<SSR>
<SSRNumber>2</SSRNumber>
<Carrier>RT</Carrier>
<Code>SEAT</Code>
<ActionCode>HK</ActionCode>
<Count>1</Count>
<SSRSegments>
<int>2</int>
</SSRSegments>
<SSRPassengers>
XML Service APIs Page 82
<int>1</int>
</SSRPassengers>
<Text>11F</Text>
</SSR>
</SSRData>
<FarePayments />
<Payments>
<Payment>
<PaymentNo>0</PaymentNo>
<PaymentForm>VI</PaymentForm>
<PaymentType>CC</PaymentType>
<PaymentAmount>320.43</PaymentAmount>
<PaymentDate>06/22/2005</PaymentDate>
<DocumentNo>4111111111111111</DocumentNo>
<PassengerName>li/z</PassengerName>
<PaidCurrencyCode>USD</PaidCurrencyCode>
<CcExpiryDate>1111</CcExpiryDate>
<CVV>123</CVV>
<Address1 />
<State />
<City />
<PostalCode />
<Country />
<Phone />
</Payment>
</Payments>
<Refunds />
<OldFares />
<OldSurcharges />
<OldTaxes />
<PnrBookNumb />
</Booking>
</Validation>
</RRT:ValidateBookingResult>
</RRT:ValidateBookingReply>
</soap:Body>
</soap:Envelope>
Submit Booking Service
Submits bookings for creation or modification. This method is wrapped in the SubmitBooking method of the
ResultsBooking.Booking class.
Signature
[Visual Basic]
SubmitBooking(Booking As XmlNode) As BookingSubmitDetails
Parameters:
BookNo
Numeric booking number
Locator
Six character alphanumeric booking record locator.
XML Service APIs Page 83
SeatCount
The number of seats requested by the booking.
NonSeatTakingPax
The number of non-seat taking passengers in the booking e.g., number of infants.
OriginAddress
Booking source origin address.
ExternalLocator
This is the locator from the external source
ReceivedFrom
Textual booking source description
BranchCode
Booking branch code, used for pricing
AgencyCode
ARC or Results travel agency code for travel agency bookings. Leave blank or null for non-agency bookings.
FareDesignator
Fare designator/ticket designator/promotion code used by this booking. Leave blank or null if no fare designator was
used.
SourceIP
IP address of the remote system creating or modifying the booking. E.g., the web user’s IP address for web
bookings
Passengers/Passenger
Array of Passenger nodes containing passenger names, descriptions and contact information
Segments/Segment
Array of Segment nodes containing information on each booked segment
Fares/Fare
Array of Fare nodes containing information about fares applied to the booking
Taxes/Tax
Array of Tax nodes containing information about taxes applied to the booking
Fees
Array of Fee nodes containing information about fees applied to the booking
SSRData
Array of SSR nodes containing detailed information about
Payments/Payment
Array of payments applied to the booking. Payment nodes has to have PaymentNo element with value 0 in order for
the payment records to be stored with the booking. Example: <PaymentNo>0</PaymentNo>
Refunds/Refund
Array of refund requests for modified bookings. Each refund will result in a voucher
XML Service APIs Page 84
AdditionalFieldValues
Array of user-created additional data that can be associated with a PNR. See Customizing Booking Additional Data
in the Results Online Help.
OldFares/ OldSurcharges/ OldTaxes
Reserved, populated by the ResultsBooking component when modifying/repricing bookings
WaitForReply
Boolean flag (true/false) indicating whether the service should wait for the system to process the booking before
returning submit status
WaitSeconds
Number of seconds to wait if WaitForReply is set to true
Return value:
SubmitID
A unique identifier of each individual booking submit request. This value is used to query for booking processing
status or cancel booking request through the SubmitBookingStatus method.
Sample code:
[Visual Basic]
'load sample booking xml
Dim bookingInfo As New XmlDocument
bookingInfo.Load("c:\temp\testbooking.xml")
'call the validation service
Dim bookValidationService As New bookValidationService.bookingValidation
bookValidationService.Url = ConfigurationSettings.AppSettings.GetValues("bookValidationURL")
(0)
Dim validationResponse As XmlNode _
= bookValidationService.ValidateBooking(bookingInfo.DocumentElement)
bookValidationService = Nothing
'if there were no validation errors, submit the booking
If validationResponse.SelectNodes("Errors/ErrorInfo") Is Nothing Then
'call the booking submit svc
Dim bookSubmitService As New bookingSubmitService.bookingsubmit
bookSubmitService.Url = ConfigurationSettings.AppSettings.GetValues("bookSubmitURL")(0)
Dim bsDetails As bookingSubmitService.BookingSubmitDetails =
bookSubmitService.SubmitBooking(bookingInfo.DocumentElement)
bookSubmitService = Nothing
'check booking submit status
Dim submitStatus As bookingSubmitStatusService.BookingStatus
Dim bookingStatus As New bookingSubmitStatusService.bookingSubmitStatus
bookingStatus.Url = ConfigurationSettings.AppSettings.GetValues("bookSubmitStatusURL")(0)
submitStatus = bookingStatus.SubmitBookingStatus(bsDetails.SubmitID, "false", 1)
bookingStatus = Nothing
'check submit status
Dim submitStage As String = submitStatus.Stage
Select Case submitStage
Case "INQUEUE"
'Booking is in the TTY-in queue, waiting to be processed
XML Service APIs Page 85
're-query later
Case "ETQUEUE"
'Booking is in the ET queue, waiting to be processed
're-query later
Case "ETDONE"
'End transaction processing completed
're-query later
Case "ETREJECT"
'Booking was rejected
'display an error message
Case "QUEUEREJECT"
'Booking was put on reject queue
'display an error message
Case "OUTQUEUE"
'Booking is in TTY-out queue
're-query later
Case "DONE"
'Booking processing completed
'display success message/retrieve booking
End Select
End If
Return value structure definition:
Public Class BookingSubmitDetails
Public SubmitID As String
End Class
Sample SOAP/XML request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<SubmitBooking xmlns="http://rrtechnologies.net/soap/">
<Booking xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="">
<BookNo>2649524</BookNo>
<Locator>HNRCZW</Locator>
<SeatCount>1</SeatCount>
<NonSeatTakingPax>0</NonSeatTakingPax>
<OriginAddress>HDKWWRT</OriginAddress>
<ExternalLocator>HNRCZW</ExternalLocator>
<BranchCode>RT FLL 0001</BranchCode>
<AgencyCode />
<FareDesignator />
<Passengers>
<Passenger>
<PassengerNo>1</PassengerNo>
<PassengerCode>ADULT</PassengerCode>
<ContactInformation>
<Address />
<City />
<County />
<State/>
XML Service APIs Page 86
<Nation />
<PostalCode />
<HomePhone />
<BusinessPhone />
<AgentPhone />
<OtherPhone />
<Fax />
<Email>JOHN@rrtechnologies.net</Email>
</ContactInformation>
<PassengerAge>0</PassengerAge>
<PassengerAgeUnit />
<ClientProfileCode />
<LastName>DOE</LastName>
<FirstName>JOHN</FirstName>
<MiddleName />
<Title>MR</Title>
<Type>ADULT</Type>
<PassengerName>DOE/JOHN MR</PassengerName>
</Passenger>
</Passengers>
<Segments>
<Segment>
<CarrierCode>RT</CarrierCode>
<FlightNumberNumeric>5050</FlightNumberNumeric>
<OriginAirport>FLL</OriginAirport>
<DestinationAirport>LGA</DestinationAirport>
<ClassCode>Y</ClassCode>
<TravelTime>180</TravelTime>
<SegmentNumber>1</SegmentNumber>
<BoardDate>2005-06-26T00:00:00.0000000-04:00</BoardDate>
<DepartureTime>0001-01-01T17:00:00.0000000-05:00</DepartureTime>
<ArrivalTime>0001-01-01T20:00:00.0000000-05:00</ArrivalTime>
<DateChangeIndicator>0</DateChangeIndicator>
<ActionCode>SS</ActionCode>
<FlightNumber>RT5050</FlightNumber>
</Segment>
</Segments>
<Fares>
<Fare>
<FareNumber>0</FareNumber>
<PassengerType>ADULT</PassengerType>
<ClassCode>Y</ClassCode>
<FareCode>YTEST</FareCode>
<SegmentNumbers>
<int>1</int>
</SegmentNumbers>
<Refundable>false</Refundable>
<Amount>99.00000</Amount>
<CurrencyCode>USD</CurrencyCode>
<SourceReferenceID>-1611485609665673140</SourceReferenceID>
<TotalAmount>0</TotalAmount>
<FareNo>0</FareNo>
<PassengerDescriptionCode>ADULT</PassengerDescriptionCode>
<TotalAmountCurr>USD</TotalAmountCurr>
<FareAmount>99.00000</FareAmount>
</Fare>
<Fare>
XML Service APIs Page 87
...sample truncated for readability...
</Fare>
</Fares>
<Surcharges>
<Surcharge>
<PassengerCode>ADULT</PassengerCode>
<Code>IN</Code>
<SurchargeAmount>8.50000</SurchargeAmount>
<SurchargeCurrency>USD</SurchargeCurrency>
<SurchargeSegments>
<int>1</int>
</SurchargeSegments>
</Surcharge>
</Surcharges>
<Taxes>
<Tax>
<PassengerType>ADULT</PassengerType>
<Code>AY</Code>
<AppliedTo>FLL</AppliedTo>
<Amount>2.50000</Amount>
<CurrencyCode>USD</CurrencyCode>
<TaxSegments>
<int>1</int>
</TaxSegments>
<SourceReferenceID>2</SourceReferenceID>
</Tax>
</Taxes>
<Fees>
<Fee>
<FeeCode>WCO</FeeCode>
<Amount>32.00000</Amount>
<PassengerName>DOE/JOHN MS</PassengerName>
<CurrencyCode>USD</CurrencyCode>
<TaxCode>BT</TaxCode>
<Tax>3.00000</Tax>
<ThisSession>true</ThisSession>
<ManualFee>false</ManualFee>
</Fee>
<Fee>
<FeeNumber>0</FeeNumber>
<FeeCode>MBF</FeeCode>
<Description>ManualBaggageFee</Description>
<Amount>10</Amount>
<Tax>0</Tax>
<CurrencyCode>USD</CurrencyCode>
<ThisSession>true</ThisSession>
<ManualFee>true</ManualFee>
<CommonCurrencyFactor>1.00000</CommonCurrencyFactor>
<AirportCode>ACY</AirportCode>
<BoardDate>15FEB09</BoardDate>
</Fee>
</Fees>
<SSRData>
<SSR>
<SSRNumber>1</SSRNumber>
<Carrier>RT</Carrier>
<Code>SEAT</Code>
XML Service APIs Page 88
<ActionCode>HK</ActionCode>
<Count>1</Count>
<SSRSegments>
<int>1</int>
</SSRSegments>
<SSRPassengers>
<int>1</int>
</SSRPassengers>
<Text>8F</Text>
</SSR>
<SSR>
<SSRNumber>2</SSRNumber>
<Carrier>RT</Carrier>
<Code>DOCA</Code>
<ActionCode>HK</ActionCode>
<Count>1</Count>
<SSRSegments>
<int>1</int>
</SSRSegments>
<SSRPassengers>
<int>1</int>
</SSRPassengers>
<Text>D/USA/301 PARK AVENUE/NEW YORK/NY/10022/S3</Text>
</SSR>
</SSRData>
<FarePayments />
<Payments>
<Payment>
<PaymentNo>0</PaymentNo>
<PaymentForm>VI</PaymentForm>
<PaymentType>CC</PaymentType>
<PaymentAmount>342.43</PaymentAmount>
<PaymentDate>06/22/2005</PaymentDate>
<DocumentNo>4111111111111111</DocumentNo>
<PassengerName>DOE/JOHN</PassengerName>
<PaidCurrencyCode>USD</PaidCurrencyCode>
<PaidFlag>Y</PaidFlag>
<CcApprvCode>12345</CcApprvCode>
<CcApprvType>Y</CcApprvType>
<CcExpiryDate>1111</CcExpiryDate>
<CVV>123</CVV>
<CcTransactionID>12345</CcTransactionID>
<CcApprvBatch>12345</CcApprvBatch>
<Address1 />
<State />
<City />
<PostalCode />
<Country />
<Phone />
</Payment>
</Payments>
<Refunds />
<AdditionalFieldValues>
<AdditionalFieldValue>
<FieldName>BookedByAgency</FieldName>
<FieldValueString>Deluxe Travel</FieldValueString>
<BookAdditionalDataFieldValueId>0</BookAdditionalDataFieldValueId>
XML Service APIs Page 89
<FieldValueInt>1</FieldValueInt>
<SeqNo>0</SeqNo>
</AdditionalFieldValue>
</AdditionalFieldValues>
<OldFares />
<OldSurcharges />
<OldTaxes />
<PnrBookNumb>HNRCZW</PnrBookNumb>
<Transaction>
<WaitForReply>True</WaitForReply>
<WaitSeconds>10</WaitSeconds>
<ValidationID>
</ValidationID>
</Transaction>
</Booking>
</SubmitBooking>
</soap:Body>
</soap:Envelope>
Notes:
1. For the Fee node, parameter <Tax> has to have a value. Enter 0 if there is no <TaxCode> associated with this
<FeeCode>.
2. If the booking is paid with PROSA credit card, you will add an extra node within the PAYMENT wrapper node:
<PRCM>
<OperationNumber>19677 </OperationNumber>
<AuthorizationNo>56 </AuthorizationNo>
</PRCM>
3. Passenger document SSR can have three codes:
DOCS – for primary travel document information (e.g. passport, national ID card)
DOCO – for secondary travel document information (e.g. visa)
DOCA – for passenger address information (either Residence or Destination address depending on the particular
Customs requirement)
If the document type is DOCS, <Text> node should contain:
P/MYS/012345678/MYS/30JUN73/M/14APR09/JOHNSON/SIMON/S3
In which
P = Travel Document Type, i.e. Passenger Passport (Other values can be F=Approved non-standard identity
documents use for travel; AC=Crew Member Certificate; A=Identity Card; C=Identity Card; I=Identity Card;
IP=Passport Card.)
MYS = Travel Document Issuing Country
012345678 = Travel Document Number
MYS = Passenger Nationality
XML Service APIs Page 90
30JUN73 = Date of Birth
M = Gender (M for male and F for Femal)
14APR09 = Document Expiration Date
JOHNSON/SIMON = Passegner Name in the format of LAST/FIRST.
S3 = Segment Association i.e. third segment
If the document type is DOCA, <Text> node should contain:
R/USA/301 PARK AVENUE/NEW YORK/NY/10022/S3
In which
R = Type of Address (R for Residence and D for Destination)
USA = Residence Country Code
301 PARK AVENUE = Residence Detailed Address
NEW YORK = Residence City
NY = Residence State
10022 = Residence Zip Code
S3 = Segment Association
If the document type is DOCO, <Text> node should contain:
SELANGOR MYS/V/11223344/KUALA LUMPUR/12MAY05/USA/S3
In which
SELANGOR MYS = Passenger Place of Birth
V = Travel Document Type i.e Visa
11223344 = Visa Document Number
KUALA LUMPUR = Visa Document Place of Issue
12MAY05 = Visa Document Issue Date
USA = Country for which the visa is applicable
S3 = Segment Association
XML Service APIs Page 91
Successful response is:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:SubmitBookingReply xmlns:RRT="http://rrtechnologies.net/soap/">
<RRT:BookingSubmitDetails>
<RRT:SubmitID>756906</RRT:SubmitID>
</RRT:BookingSubmitDetails>
</RRT:SubmitBookingReply>
</soap:Body>
</soap:Envelope>
Checking Booking Submit Status
Checks the processing status of the new/modified booking submitted into Results, using the SubmitID from the reply
of BookSubmit.
Signature:
[Visual Basic]
SubmitBookingStatus(SubmitID As string, WaitForReply As string, WaitSeconds As int)
Parameters
SubmitID
A submit id returned from the booking service's SubmitBooking method. This parameter a booking submission and is
used to retrieve the processing status for the specified submission
WaitForReply
Boolean flag (true/false) controlling whether the service will wait for the booking to get processed before replying. If
set, the service will wait up to the number of seconds specified in WaitSeconds before replying. This should normally
be set to false to avoid congestion.
WaitSeconds
Maximum number of second to wait if WaitForReply is set to True
Return values:
Locator
This is the Results locator
ExternalLocator
This is the external locator
Completed
Boolean flag (true/false) indicating processing status. As long as this value is “false”, the SubmitBookingStatus API
call needs to be re-issued for the same SubmitID. Make sure that you have a reasonable time and retry limit for the
SubmitBookingStatus API, as conditions in the system may exist where submitted booking messages may be
XML Service APIs Page 92
delayed for an indefinitely long time. When those retry limits are reached the transaction with the particular SubmitID
should be considered as failed and discarded using the CanceBookingReques API. The end user should be directed
to a call center for further handling.
Stage
String indicating the current processing stage for the submission request. The transactions is considered properly
processed only when the Completed reply node is “true”, and the Stage node value has a value of DONE,
OUTQUEUE or ETDONE. Any other value in the Stage node should be treated as a failure in processing the
booking transaction for the particular SubmitID. The end user should be directed to a call center for further handling.
Remarks
This methods WSDL description is in resultsservices/bookingsubmitstatus.wsdl.
Sample Code
[Visual Basic]
'check booking submit status
Dim submitStatus As bookingSubmitStatusService.BookingStatus
Dim bookingStatus As New bookingSubmitStatusService.bookingSubmitStatus
bookingStatus.Url = ConfigurationSettings.AppSettings.GetValues("bookSubmitStatusURL")(0)
submitStatus = bookingStatus.SubmitBookingStatus(SubmitID, "false", 1)
'check submit status
Dim submitStage As String = submitStatus.Stage
Select Case submitStage
Case "INQUEUE"
'Booking is in the TTY-in queue, waiting to be processed
Case "ETQUEUE"
'Booking is in the ET queue, waiting to be processed
Case "ETDONE"
'End transaction processing completed
Case "ETREJECT"
'Booking was rejected
Case "QUEUEREJECT"
'Booking was put on reject queue
Case "OUTQUEUE"
'Booking is in TTY-out queue
Case "DONE"
'Booking processing completed
End Select
Sample SOAP request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<SubmitBookingStatus xmlns="http://rrtechnologies.net/soap/">
<SubmitID>756906</SubmitID>
<WaitForReply>false</WaitForReply>
<WaitSeconds>1</WaitSeconds>
</SubmitBookingStatus>
</soap:Body>
XML Service APIs Page 93
</soap:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:SubmitBookingStatusReply xmlns:RRT="http://rrtechnologies.net/soap/">
<RRT:BookingStatus>
<RRT:SubmitID>756906</RRT:SubmitID>
<RRT:Locator>HNRCZX</RRT:Locator>
<RRT:ExternalLocator>HNRCZW</RRT:ExternalLocator>
<RRT:Completed>true</RRT:Completed>
<RRT:Stage>DONE</RRT:Stage>
<RRT:Info />
</RRT:BookingStatus>
</RRT:SubmitBookingStatusReply>
</soap:Body>
</soap:Envelope>
Alternative response, while the booking is still being processed:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:SubmitBookingStatusReply xmlns:RRT="http://rrtechnologies.net/soap/">
<RRT:BookingStatus>
<RRT:SubmitID>756906</RRT:SubmitID>
<RRT:Locator />
<RRT:ExternalLocator />
<RRT:Completed>false</RRT:Completed>
<RRT:Stage>INQUEUE</RRT:Stage>
<RRT:Info>
<RRT:Queued>
<RRT:Date>
<RRT:Year>2005</RRT:Year>
<RRT:Month>5</RRT:Month>
<RRT:Day>22</RRT:Day>
</RRT:Date>
<RRT:Time>
<RRT:Hours>10</RRT:Hours>
<RRT:Minutes>27</RRT:Minutes>
</RRT:Time>
</RRT:Queued>
<RRT:DelayedUntil>
<RRT:Date>
<RRT:Year>2005</RRT:Year>
<RRT:Month>5</RRT:Month>
<RRT:Day>22</RRT:Day>
</RRT:Date>
<RRT:Time>
<RRT:Hours>10</RRT:Hours>
<RRT:Minutes>27</RRT:Minutes>
</RRT:Time>
XML Service APIs Page 94
</RRT:DelayedUntil>
</RRT:Info>
</RRT:BookingStatus>
</RRT:SubmitBookingStatusReply>
</soap:Body>
</soap:Envelope>
This reply message indicates the booking is queued for processing. No record locator has been generated at this
time.
Cancel Booking Request
Cancel the new/modified booking submitted into Results, if for some reason the processing of the booking is stuck,
using the SubmitID from the reply of BookSubmit.
Parameter
SubmitID
The submit ID number returned from the system after you submit booking request.
Sample SOAP/XML request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
<RRT:Body>
<RRT:CancelBookingRequest timing_in_reply="no">
<SubmitID>751191</SubmitID>
</RRT:CancelBookingRequest>
</RRT:Body>
</RRT:Envelope>
Successful response is:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:CancelBookingRequestReply xmlns:RRT="http://rrtechnologies.net/soap/">
<status>OK</status>
<description>booking request cancelled</description>
</RRT:CancelBookingRequestReply>
</soap:Body>
</soap:Envelope>
Booking Retrieval
Retrieves booking information using booking number or internal record locator or external record locator; or any
combination.
Signature
XML Service APIs Page 95
[Visual Basic]
GetBooking(BookingNumber As Integer, Locator As String, External As String) As XmlNode
Parameters:
BookingNumber
Results numeric booking number. Leave as 0 or blank if Locator or External Locator is used to retrieve the booking
Locator
Results record locator generated after booking confirmation
ExternalLocator
The External Locator of the PNR
Return values:
BookNo
Numeric booking number
PnrBookNumb
The six-character alpha- or alphanumeric record locator
GroupName
Name of a group if it is a group booking
BookAgencyCode
Agency code if it is an agency booking
CreaDateTime
Time the booking is created
BookingStatus
Values can be A (active) and X (cancelled)
NoOfSeats
Number of seats in this booking
BookCategory
Booking category can be S (single), G (group), and N (non revenue)
AgencyTradeName
This is the agency trade name if it is an agency booking
ExternalBookNumber
This is the external locator
PassengerNo
The sequential number of a passenger in the booking
PassengerName
The name of this passenger
XML Service APIs Page 96
ClientPrflNo
The passenger’s number that is stored in Client Profile database
RequestNos
This indicates which SSR/OSI belongs to this passenger. Multiple requests are separated by #
RemarkNos
This indicates which remark is for this passenger
RouteNo
The route identifier defined in Route table for this city pair
FareNos
The sequential number of the fare applicable. If this is the first segment of the booking, the number here is 1
SeatRqstType
Reserved for now
RqstCode
This is the special service code. SEAT means seat request
ActionCode
This is the status of the request. HK for confirmed
RqstSeqnNo
This is the SSR sequential number in this booking
RequestText
SSR free text portion
SsrOsiIndicator
Indicates if this is an SSR or OSI request. S means SSR; O means OSI
AllPassengerFlg
This indicates if the request is for all the passengers in the booking
AllItenaryFlg
This indicates if the request is for the whole itinerary
PASSENGERCONTACT
This wrapper node contains all the passenger contact information, like name, email, phone, etc.
FARE
This wrapper node contains all fare information of the booking, like fare code, fare amount, etc.
PaymentNo
This is the payment identifier that is stored in the Payments table
RemarksText
This is additional payment information stored in the database. If the payment form is credit card, the approval/denial
information will be collected and stored here; if the payment form is voucher, the voucher information (number and
reason code) will be stored here
XML Service APIs Page 97
TIMELIMITS
The wrapper node that contains the time limit element
TIMELIMIT
The node that contained detailed time limit information on the booking
TimeLimitType
Value is T
TimeLimitDate
Format is ddmmyyyy
TimeLimitDateAlt
Format is mm/dd/yyyy
TimeLimitHour
Thime limit in the unit of hours
TimeLimitMinute
The time limit shown in minute if applicable. Not all the time limits have this value
TimeLimitSecond
Currently this is 00 for all bookings
TimeLimitTime
This is the time of the day when the time limit expires. Format is hh:mm:ss
CancelFlag
The flag to indicate if the booking should be canceled if the time limit expires. Value is C (automatic cancellation) or
Q (queuing the booking instead of cancellation)
QueueCode
The queue code (set uo in the Queue Codes table) for bookings on a time limit
DestinationBranch
Branch code for the booking
Remarks
Text description of the time limit. Example: Type B Agency Limit
AllPassengers
Indicator if the time limit applies to all passengers in the booking. Default is Y
SUMMARY
The wrapper node that contains information related with fare and payment, such as total fare, total payment, total
outstanding amount, etc.
InvokingBranch
Optional node for the branch information of the location invoking the booking retrieval request. Used for
implementations that need to have the branch details returned with the booking detail. When this node is provided,
the reply XML will contain the following additional section:
<InvokingBranch>
<BranchCode>RT FLL 0002</BranchCode>
XML Service APIs Page 98
<CityCode>FLL</CityCode>
<CityName>FORT LAUDERDALE</CityName>
<StateCode>FL</StateCode>
<StateName>Florida</StateName>
<NationCode>US</NationCode>
<NationName>USA</NationName>
</InvokingBranch>
CommonCurrencyCode
Optional node indicating the common currency to be used for the calculation of the CommonCurrencyFactor node in
the reply XML. When not provided, the system uses the booking fare currency as the basis for the currency rate
calculation. This parameter is relevant only in cases where mixed currency bookings are enabled.
Sample code:
[Visual Basic]
Dim bookRetrievalService As New bookInfoService.bookinfo
bookRetrievalService.Url = ConfigurationSettings.AppSettings.GetValues("bookInfoURL")(0)
Dim booking As XmlNode = bookRetrievalService.GetBooking(Nothing, bookRecordLocator,
Nothing)
Remarks:
The booking retrieval functionality is wrapped in the RetrieveBooking method of the ResultsBooking.BookingRetrieval
class. This method will call both the booking retrieval service and the ASR service's GetBookSeatReservations, do
the necessary format conversions using a stylesheet as defined in the bookRetrievalTransform application setting
(normally bookretrieval.xslt that comes with the ResultsBooking library) and deserialize into a new booking object.
If the airline allows mixed currency bookings, any calculations performed on financial data needs to be done by
multiplying the amount node with the CommonCurrencyFactor node for each value. This will make sure that the
calculations are done with the proper exchange rate, effective at the time the financial transaction was recorded in the
system. For single currency bookings this multiplication can be avoided.
Sample SOAP/XML request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetBooking xmlns="http://rrtechnologies.net/soap/">
<BookingNumber>0</BookingNumber>
<Locator>HNTTTS</Locator>
<ExternalLocator></ExternalLocator>
</GetBooking>
</soap:Body>
</soap:Envelope>
Successful response is:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?> <soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
XML Service APIs Page 99
<soap:Header/>
<soap:Body>
<RRT:GetBookingReply xmlns:RRT="http://rrtechnologies.net/soap/">
<BOOKING BookNo="2674112">
<BookNo>2674112</BookNo>
<PnrBookNumb>HNTTTS</PnrBookNumb>
<GroupName/>
<BookAgencyCode/>
<CreaDateTime>2007/01/06/15/32/30</CreaDateTime>
<BookingStatus>A</BookingStatus>
<NoOfSeats>1</NoOfSeats>
<BookCategory>S</BookCategory>
<AgencyTradeName/>
<ExternalBookNumber>HNTTTR</ExternalBookNumber>
<OriginAddress>HDKWWRT</OriginAddress>
<TtyRejectIndicator>0</TtyRejectIndicator>
<EtRejectIndicator>0</EtRejectIndicator>
<ScrutinyFlag>N</ScrutinyFlag>
<EtQueueCount>0</EtQueueCount>
<TtyInQueueCount>0</TtyInQueueCount>
<LastPaymentDateTime/>
<FareDesignator/>
<PASSENGERS>
<PASSENGER>
<PassengerNo>1</PassengerNo>
<PassengerName>XECC/TEST</PassengerName>
<ClientPrflNo/>
<PassCode>ADULT</PassCode>
<RequestNos>4</RequestNos>
<RemarkNos/>
</PASSENGER>
</PASSENGERS>
<SEGMENTS>
<SEGMENT>
<RouteNo>1</RouteNo>
<FlightNumber>RT111</FlightNumber>
<SellingClsCode>Y</SellingClsCode>
<FlightDate>10Jan2007</FlightDate>
<DepartureCity>FLL</DepartureCity>
<ArrivalCity>LGA</ArrivalCity>
<ReserveStatus>HK</ReserveStatus>
<FareNos>1</FareNos>
<DepartureTime>06:00</DepartureTime>
<ArrivalTime>07:50</ArrivalTime>
<SeatRqstType>C</SeatRqstType>
<BookNo>2674112</BookNo>
<AltItineraryNo>1</AltItineraryNo>
<ItineraryNo>0</ItineraryNo>
<DepartureAirportCode>FLL</DepartureAirportCode>
<ArrivalAirportCode>LGA</ArrivalAirportCode>
<DepartureAirportName>FT LAUDERDALE/HOLLYWOOD
INTL</DepartureAirportName>
<DepartureCityName>FORT LAUDERDALE</DepartureCityName>
<ArrivalAirportName>LA GUARDIA INTERNATIONAL</ArrivalAirportName>
<ArrivalCityName>NEW YORK</ArrivalCityName>
XML Service APIs Page 100
<ItenaryStatFlag>A</ItenaryStatFlag>
<RequestNos>4</RequestNos>
<DateChangeInd>0</DateChangeInd>
</SEGMENT>
<SEGMENT>
<RouteNo>2</RouteNo>
<FlightNumber>RT960</FlightNumber>
<SellingClsCode>Y</SellingClsCode>
<FlightDate>13Jan2007</FlightDate>
<DepartureCity>LGA</DepartureCity>
<ArrivalCity>FLL</ArrivalCity>
<ReserveStatus>HK</ReserveStatus>
<FareNos>2</FareNos>
<DepartureTime>07:00</DepartureTime>
<ArrivalTime>10:00</ArrivalTime>
<SeatRqstType>C</SeatRqstType>
<BookNo>2674112</BookNo>
<AltItineraryNo>1</AltItineraryNo>
<ItineraryNo>0</ItineraryNo>
<DepartureAirportCode>LGA</DepartureAirportCode>
<ArrivalAirportCode>FLL</ArrivalAirportCode>
<DepartureAirportName>LA GUARDIA INTERNATIONAL</DepartureAirportName>
<DepartureCityName>NEW YORK</DepartureCityName>
<ArrivalAirportName>FT LAUDERDALE/HOLLYWOOD INTL</ArrivalAirportName>
<ArrivalCityName>FORT LAUDERDALE</ArrivalCityName>
<ItenaryStatFlag>A</ItenaryStatFlag>
<RequestNos>4</RequestNos>
<DateChangeInd>0</DateChangeInd>
</SEGMENT>
</SEGMENTS>
<SSROSIS>
<SSROSI>
<SeatRqstType/>
<CarrierCode>RT</CarrierCode>
<RqstCode>CTCE</RqstCode>
<ActionCode/>
<RqstSeqnNo>1</RqstSeqnNo>
<RequestText>TEST//RRTECHNOLOGIES.NET E</RequestText>
<SsrOsiIndicator>O</SsrOsiIndicator>
<AllPassengerFlg>Y</AllPassengerFlg>
<AllItenaryFlg>Y</AllItenaryFlg>
<RequestType>PASS</RequestType>
<RequestDescription>E-Mail address</RequestDescription>
<ItemNo>1</ItemNo>
</SSROSI>
<SSROSI>
<SeatRqstType>C</SeatRqstType>
<CarrierCode>RT</CarrierCode>
<RqstCode>RT</RqstCode>
<ActionCode>HK</ActionCode>
<RqstSeqnNo>2</RqstSeqnNo>
<RequestText>LOCATOR HNTTTS</RequestText>
<SsrOsiIndicator>O</SsrOsiIndicator>
<AllPassengerFlg>Y</AllPassengerFlg>
<AllItenaryFlg>Y</AllItenaryFlg>
<RequestType/>
<RequestDescription/>
XML Service APIs Page 101
<ItemNo>1</ItemNo>
</SSROSI>
<SSROSI>
<SeatRqstType>C</SeatRqstType>
<CarrierCode>RT</CarrierCode>
<RqstCode>OTHS</RqstCode>
<ActionCode>HK</ActionCode>
<RqstSeqnNo>3</RqstSeqnNo>
<RequestText>TKNA 4870010043807</RequestText>
<SsrOsiIndicator>S</SsrOsiIndicator>
<AllPassengerFlg>Y</AllPassengerFlg>
<AllItenaryFlg>Y</AllItenaryFlg>
<RequestType>OTHS</RequestType>
<RequestDescription>Other SSR/OSI, specify details</RequestDescription>
<ItemNo>1</ItemNo>
</SSROSI>
<SSROSI>
<SeatRqstType>C</SeatRqstType>
<CarrierCode>RT</CarrierCode>
<RqstCode>LEG</RqstCode>
<ActionCode>HK</ActionCode>
<RqstSeqnNo>4</RqstSeqnNo>
<RequestText>This is the 2nd leg of an XP booking</RequestText>
<SsrOsiIndicator>O</SsrOsiIndicator>
<AllPassengerFlg>N</AllPassengerFlg>
<AllItenaryFlg>N</AllItenaryFlg>
<RequestType>XP</RequestType>
<RequestDescription>This is for Xp booking</RequestDescription>
<ItemNo>1</ItemNo>
</SSROSI>
<SSROSI>
<SeatRqstType>C</SeatRqstType>
<CarrierCode>RT</CarrierCode>
<RqstCode>ADTK</RqstCode>
<ActionCode>HK</ActionCode>
<RqstSeqnNo>5</RqstSeqnNo>
<RequestText>TO RT BY 01:00PM EST/08JAN OTHERWISE WILL BE
XCLD</RequestText>
<SsrOsiIndicator>S</SsrOsiIndicator>
<AllPassengerFlg>Y</AllPassengerFlg>
<AllItenaryFlg>Y</AllItenaryFlg>
<RequestType>TICK</RequestType>
<RequestDescription>Advice if Ticketed</RequestDescription>
<ItemNo>1</ItemNo>
</SSROSI>
</SSROSIS>
<PASSENGERCONTACTS>
<PASSENGERCONTACT>
<PassengerNo>1</PassengerNo>
<PassengerName>XECC/TEST</PassengerName>
<HomePhoneNo/>
<BussPhoneNo/>
<ContactPhoneNo/>
<AgentPhoneNo/>
<EmailAddress>TEST@RRTECHNOLOGIES.NET</EmailAddress>
<FaxNumber/>
<HomeAddress/>
XML Service APIs Page 102
<HomeCity/>
<HomeState/>
<HomeZip/>
<HomeNation/>
<BussAddress/>
<BussCity/>
<BussState/>
<BussZip/>
<BussNation/>
<ContactAddress/>
<ContactCity/>
<ContactState/>
<ContactZip/>
<ContactNation/>
<AgentAddress/>
<AgentCity/>
<AgentState/>
<AgentZip/>
<AgentNation/>
</PASSENGERCONTACT>
</PASSENGERCONTACTS>
<FARES>
<FARE>
<FareNo>1</FareNo>
<PassengerDescriptionCode>ADULT</PassengerDescriptionCode>
<DepartureCity>FLL</DepartureCity>
<ArrivalCity>LGA</ArrivalCity>
<TotalAmount>82.79</TotalAmount>
<UnroundedTotalAmount>82.79000</UnroundedTotalAmount>
<TotalAmountCurr>USD</TotalAmountCurr>
<FareStatus>A</FareStatus>
<DepartureCityName>FORT LAUDERDALE</DepartureCityName>
<ArrivalCityName>NEW YORK</ArrivalCityName>
<SourceReferenceId>0</SourceReferenceId>
<RefundableFlag>N</RefundableFlag>
<SurchargeAmount>0.00</SurchargeAmount>
<CommonCurrencyFactor>1.00000</CommonCurrencyFactor>
<FareAmount>82.79</FareAmount>
<UnroundedFareAmount>82.79000</UnroundedFareAmount>
</FARE>
<FARE>
<FareNo>2</FareNo>
<PassengerDescriptionCode>ADULT</PassengerDescriptionCode>
<DepartureCity>LGA</DepartureCity>
<ArrivalCity>FLL</ArrivalCity>
<TotalAmount>98.72</TotalAmount>
<UnroundedTotalAmount>98.72000</UnroundedTotalAmount>
<TotalAmountCurr>USD</TotalAmountCurr>
<FareStatus>A</FareStatus>
<DepartureCityName>NEW YORK</DepartureCityName>
<ArrivalCityName>FORT LAUDERDALE</ArrivalCityName>
<SourceReferenceId>0</SourceReferenceId>
<RefundableFlag>N</RefundableFlag>
<SurchargeAmount>15.00</SurchargeAmount>
<CommonCurrencyFactor>1.00000</CommonCurrencyFactor>
<FareAmount>83.72</FareAmount>
<UnroundedFareAmount>83.72000</UnroundedFareAmount>
XML Service APIs Page 103
</FARE>
<FARE>
<FareNo>6</FareNo>
<PassengerDescriptionCode>ADULT</PassengerDescriptionCode>
<DepartureCity>Tax</DepartureCity>
<ArrivalCity>Tax</ArrivalCity>
<TotalAmount>18.44</TotalAmount>
<UnroundedTotalAmount>18.44000</UnroundedTotalAmount>
<TotalAmountCurr>USD</TotalAmountCurr>
<FareStatus>A</FareStatus>
<DepartureCityName/>
<ArrivalCityName/>
<SourceReferenceId>0</SourceReferenceId>
<RefundableFlag>N</RefundableFlag>
<SurchargeAmount>0.00</SurchargeAmount>
<CommonCurrencyFactor>1.00000</CommonCurrencyFactor>
<FareAmount>18.44</FareAmount>
<UnroundedFareAmount>18.44000</UnroundedFareAmount>
</FARE>
</FARES>
<TAXES>
<TAX>
<TaxCode>XF</TaxCode>
<TaxAmount>5.00</TaxAmount>
<UnroundedTaxAmount>5.00000</UnroundedTaxAmount>
<PassengerCode>ADULT</PassengerCode>
<NationCode>FLL</NationCode>
<PaidCurrencyCode>USD</PaidCurrencyCode>
<FlightNumber>RT111</FlightNumber>
<BoardDate>01/10/2007</BoardDate>
<FlightOrigin>FLL</FlightOrigin>
<FlightDestination>LGA</FlightDestination>
<SourceReferenceId>3</SourceReferenceId>
<ShortDescription>PFC</ShortDescription>
<Description>Passenger Facility Charge</Description>
<CommonCurrencyFactor>1.00000</CommonCurrencyFactor>
</TAX>
<TAX>
<TaxCode>MX</TaxCode>
<TaxAmount>4.94</TaxAmount>
<UnroundedTaxAmount>4.94000</UnroundedTaxAmount>
<PassengerCode>ADULT</PassengerCode>
<NationCode>LGA</NationCode>
<PaidCurrencyCode>USD</PaidCurrencyCode>
<FlightNumber>RT960</FlightNumber>
<BoardDate>01/13/2007</BoardDate>
<FlightOrigin>LGA</FlightOrigin>
<FlightDestination>FLL</FlightDestination>
<SourceReferenceId>314</SourceReferenceId>
<ShortDescription>Percentage</ShortDescription>
<Description>Percentage tax</Description>
<CommonCurrencyFactor>1.00000</CommonCurrencyFactor>
</TAX>
<TAX>
<TaxCode>XF</TaxCode>
<TaxAmount>3.00</TaxAmount>
<UnroundedTaxAmount>3.00000</UnroundedTaxAmount>
XML Service APIs Page 104
<PassengerCode>ADULT</PassengerCode>
<NationCode>LGA</NationCode>
<PaidCurrencyCode>USD</PaidCurrencyCode>
<FlightNumber>RT960</FlightNumber>
<BoardDate>01/13/2007</BoardDate>
<FlightOrigin>LGA</FlightOrigin>
<FlightDestination>FLL</FlightDestination>
<SourceReferenceId>5</SourceReferenceId>
<ShortDescription>PFC</ShortDescription>
<Description>Passenger Facility Charge</Description>
<CommonCurrencyFactor>1.00000</CommonCurrencyFactor>
</TAX>
<TAX>
<TaxCode>AY</TaxCode>
<TaxAmount>2.50</TaxAmount>
<UnroundedTaxAmount>2.50000</UnroundedTaxAmount>
<PassengerCode>ADULT</PassengerCode>
<NationCode>LGA</NationCode>
<PaidCurrencyCode>USD</PaidCurrencyCode>
<FlightNumber>RT960</FlightNumber>
<BoardDate>01/13/2007</BoardDate>
<FlightOrigin>LGA</FlightOrigin>
<FlightDestination>FLL</FlightDestination>
<SourceReferenceId>44</SourceReferenceId>
<ShortDescription>Security Tax</ShortDescription>
<Description>Airport Security Tax</Description>
<CommonCurrencyFactor>1.00000</CommonCurrencyFactor>
</TAX>
<TAX>
<TaxCode>AY</TaxCode>
<TaxAmount>3.00</TaxAmount>
<UnroundedTaxAmount>3.00000</UnroundedTaxAmount>
<PassengerCode>ADULT</PassengerCode>
<NationCode>FLL</NationCode>
<PaidCurrencyCode>USD</PaidCurrencyCode>
<FlightNumber>RT111</FlightNumber>
<BoardDate>01/10/2007</BoardDate>
<FlightOrigin>FLL</FlightOrigin>
<FlightDestination>LGA</FlightDestination>
<SourceReferenceId>2</SourceReferenceId>
<ShortDescription>Security Tax</ShortDescription>
<Description>Airport Security Tax</Description>
<CommonCurrencyFactor>1.00000</CommonCurrencyFactor>
</TAX>
</TAXES>
<PASSFARES>
<PASSFARE>
<PassengerDescriptionCode>ADULT</PassengerDescriptionCode>
<TotalAmountCurrency>USD</TotalAmountCurrency>
<TotalAmount>199.95</TotalAmount>
<UnroundedTotalAmount>199.95001</UnroundedTotalAmount>
<FareConstruction>-</FareConstruction>
<EndorsementRestriction>-</EndorsementRestriction>
<FareAmount>199.95</FareAmount>
<UnroundedFareAmount>199.95000</UnroundedFareAmount>
<CommonCurrencyFactor>1.00000</CommonCurrencyFactor>
</PASSFARE>
XML Service APIs Page 105
</PASSFARES>
<FARESEGMENTS>
<FARESEGMENT>
<FareNo>1</FareNo>
<PassengerDescriptionCode>ADULT</PassengerDescriptionCode>
<FlightNumber>RT111</FlightNumber>
<BoardDate>10Jan2007</BoardDate>
<DepartureAirport>FLL</DepartureAirport>
<ArrivalAirport>LGA</ArrivalAirport>
<SellingClsCode>Y</SellingClsCode>
<FareBasis>YTL</FareBasis>
<ValidFromDate>06Jan2007</ValidFromDate>
<ValidToDate>06Jan2007</ValidToDate>
</FARESEGMENT>
<FARESEGMENT>
<FareNo>2</FareNo>
<PassengerDescriptionCode>ADULT</PassengerDescriptionCode>
<FlightNumber>RT960</FlightNumber>
<BoardDate>13Jan2007</BoardDate>
<DepartureAirport>LGA</DepartureAirport>
<ArrivalAirport>FLL</ArrivalAirport>
<SellingClsCode>Y</SellingClsCode>
<FareBasis>YTL</FareBasis>
<ValidFromDate>06Jan2007</ValidFromDate>
<ValidToDate>06Jan2007</ValidToDate>
</FARESEGMENT>
</FARESEGMENTS>
<FAREPAYMENTS>
<FAREPAYMENT>
<FareNo>1</FareNo>
<PassengerDescriptionCode>ADULT</PassengerDescriptionCode>
<PaymentCode>FARE</PaymentCode>
<FareCalcCode>YTL</FareCalcCode>
<Amount>82.79</Amount>
<UnroundedAmount>82.79000</UnroundedAmount>
<CurrencyCode>USD</CurrencyCode>
<TaxCode/>
<NationCode/>
<RefundableFlag>N</RefundableFlag>
<NetFareFlag>N</NetFareFlag>
<PrivateFareFlag>N</PrivateFareFlag>
<SourceRefId>7360950909099002070</SourceRefId>
<CommonCurrencyFactor>1.00000</CommonCurrencyFactor>
</FAREPAYMENT>
<FAREPAYMENT>
<FareNo>2</FareNo>
<PassengerDescriptionCode>ADULT</PassengerDescriptionCode>
<PaymentCode>FARE</PaymentCode>
<FareCalcCode>YTL</FareCalcCode>
<Amount>83.72</Amount>
<UnroundedAmount>83.72000</UnroundedAmount>
<CurrencyCode>USD</CurrencyCode>
<TaxCode/>
<NationCode/>
<RefundableFlag>N</RefundableFlag>
<NetFareFlag>N</NetFareFlag>
<PrivateFareFlag>N</PrivateFareFlag>
XML Service APIs Page 106
<SourceRefId>5150511732801948700</SourceRefId>
<CommonCurrencyFactor>1.00000</CommonCurrencyFactor>
</FAREPAYMENT>
<FAREPAYMENT>
<FareNo>6</FareNo>
<PassengerDescriptionCode>ADULT</PassengerDescriptionCode>
<PaymentCode>TAX</PaymentCode>
<FareCalcCode>TAX1</FareCalcCode>
<Amount>3.00</Amount>
<UnroundedAmount>3.00000</UnroundedAmount>
<CurrencyCode>USD</CurrencyCode>
<TaxCode>AY</TaxCode>
<NationCode>FLL</NationCode>
<RefundableFlag>N</RefundableFlag>
<NetFareFlag>N</NetFareFlag>
<PrivateFareFlag>N</PrivateFareFlag>
<SourceRefId>2</SourceRefId>
<CommonCurrencyFactor>1.00000</CommonCurrencyFactor>
</FAREPAYMENT>
<FAREPAYMENT>
<FareNo>6</FareNo>
<PassengerDescriptionCode>ADULT</PassengerDescriptionCode>
<PaymentCode>TAX</PaymentCode>
<FareCalcCode>TAX2</FareCalcCode>
<Amount>5.00</Amount>
<UnroundedAmount>5.00000</UnroundedAmount>
<CurrencyCode>USD</CurrencyCode>
<TaxCode>XF</TaxCode>
<NationCode>FLL</NationCode>
<RefundableFlag>N</RefundableFlag>
<NetFareFlag>N</NetFareFlag>
<PrivateFareFlag>N</PrivateFareFlag>
<SourceRefId>3</SourceRefId>
<CommonCurrencyFactor>1.00000</CommonCurrencyFactor>
</FAREPAYMENT>
<FAREPAYMENT>
<FareNo>6</FareNo>
<PassengerDescriptionCode>ADULT</PassengerDescriptionCode>
<PaymentCode>TAX</PaymentCode>
<FareCalcCode>TAX3</FareCalcCode>
<Amount>2.50</Amount>
<UnroundedAmount>2.50000</UnroundedAmount>
<CurrencyCode>USD</CurrencyCode>
<TaxCode>AY</TaxCode>
<NationCode>LGA</NationCode>
<RefundableFlag>N</RefundableFlag>
<NetFareFlag>N</NetFareFlag>
<PrivateFareFlag>N</PrivateFareFlag>
<SourceRefId>44</SourceRefId>
<CommonCurrencyFactor>1.00000</CommonCurrencyFactor>
</FAREPAYMENT>
<FAREPAYMENT>
<FareNo>6</FareNo>
<PassengerDescriptionCode>ADULT</PassengerDescriptionCode>
<PaymentCode>TAX</PaymentCode>
<FareCalcCode>TAX4</FareCalcCode>
<Amount>3.00</Amount>
XML Service APIs Page 107
<UnroundedAmount>3.00000</UnroundedAmount>
<CurrencyCode>USD</CurrencyCode>
<TaxCode>XF</TaxCode>
<NationCode>LGA</NationCode>
<RefundableFlag>N</RefundableFlag>
<NetFareFlag>N</NetFareFlag>
<PrivateFareFlag>N</PrivateFareFlag>
<SourceRefId>5</SourceRefId>
<CommonCurrencyFactor>1.00000</CommonCurrencyFactor>
</FAREPAYMENT>
<FAREPAYMENT>
<FareNo>6</FareNo>
<PassengerDescriptionCode>ADULT</PassengerDescriptionCode>
<PaymentCode>TAX</PaymentCode>
<FareCalcCode>TAX5</FareCalcCode>
<Amount>4.94</Amount>
<UnroundedAmount>4.94000</UnroundedAmount>
<CurrencyCode>USD</CurrencyCode>
<TaxCode>MX</TaxCode>
<NationCode>LGA</NationCode>
<RefundableFlag>N</RefundableFlag>
<NetFareFlag>N</NetFareFlag>
<PrivateFareFlag>N</PrivateFareFlag>
<SourceRefId>314</SourceRefId>
<CommonCurrencyFactor>1.00000</CommonCurrencyFactor>
</FAREPAYMENT>
</FAREPAYMENTS>
<SURCHARGES>
<SURCHARGE>
<PassengerCode>ADULT</PassengerCode>
<SurchargeCode>Q</SurchargeCode>
<FlightNumber>RT960</FlightNumber>
<BoardDate>01/13/2007</BoardDate>
<FlightOrigin>LGA</FlightOrigin>
<FlightDestination>FLL</FlightDestination>
<SurchargeAmount>15.00</SurchargeAmount>
<UnroundedSurchargeAmount>15.00000</UnroundedSurchargeAmount>
<SurchargeCurrency>USD</SurchargeCurrency>
<SourceReferenceId>-2567289303763301421</SourceReferenceId>
<FareNo>2</FareNo>
<CommonCurrencyFactor>1.00000</CommonCurrencyFactor>
</SURCHARGE>
</SURCHARGES>
<Vouchers/>
<PAYMENTS>
<PAYMENT>
<PaymentNo>10043807</PaymentNo>
<PaymentForm>VI</PaymentForm>
<PaymentType>CC</PaymentType>
<TypeDescription>Credit Card</TypeDescription>
<Description>Visa Card</Description>
<PaymentAmount>199.95</PaymentAmount>
<UnroundedPaymentAmount>199.95000</UnroundedPaymentAmount>
<PaymentDate>06Jan2007</PaymentDate>
<PaymentDateTime>2007-01-06 15:32:30</PaymentDateTime>
<OriginalDocumentNo>PMMMMMMMMMMMMMMM</OriginalDocumentNo>
<DocumentNo>************1111</DocumentNo>
XML Service APIs Page 108
<PassengerName>XECC/TEST</PassengerName>
<ClientProfileNo/>
<PassengerDescriptionCode>ADULT</PassengerDescriptionCode>
<BookAgencyCode/>
<RemarksText>EXTERNAL APPROVAL</RemarksText>
<ReceivedFrom>HDKWWRT/HDQNK/</ReceivedFrom>
<PaidCurrencyCode>USD</PaidCurrencyCode>
<PaidFlag>Y</PaidFlag>
<PaymentStatusFlg>A</PaymentStatusFlg>
<ContactPhoneNo/>
<ContactAddress/>
<ContactCity/>
<ContactState/>
<ContactZip/>
<ContactNation/>
<CcApprvCode>AUTO</CcApprvCode>
<CcApprvType/>
<CcExpiryDate>1209</CcExpiryDate>
<CommonCurrencyFactor>1.00000</CommonCurrencyFactor>
</PAYMENT>
</PAYMENTS>
<HISTORY>
<HistoryEntry>
<SequenceNo>1</SequenceNo>
<HistoryCode>QPL</HistoryCode>
<ItemSequenceNo>1</ItemSequenceNo>
<ItemText>RT FLL 0001, TTSYS</ItemText>
<ReceivedFrom>HDKWWRT/HDQNK/</ReceivedFrom>
<DutyCode>SYS</DutyCode>
<CreaUserCode>AIRIM</CreaUserCode>
<CreaDateTime>06Jan2007 15:32:30</CreaDateTime>
</HistoryEntry>
<HistoryEntry>
<SequenceNo>2</SequenceNo>
<HistoryCode>NEW</HistoryCode>
<ItemSequenceNo>1</ItemSequenceNo>
<ItemText>NEW BOOKING</ItemText>
<ReceivedFrom>HDKWWRT/HDQNK/</ReceivedFrom>
<DutyCode>GSA99</DutyCode>
<CreaUserCode>AIRIM</CreaUserCode>
<CreaDateTime>06Jan2007 15:32:30</CreaDateTime>
</HistoryEntry>
<HistoryEntry>
<SequenceNo>3</SequenceNo>
<HistoryCode>ITN</HistoryCode>
<ItemSequenceNo>1</ItemSequenceNo>
<ItemText>RT111 Y 10JAN FLL LGA HK/FB 1 0600 0750</ItemText>
<ReceivedFrom>HDKWWRT/HDQNK/</ReceivedFrom>
<DutyCode>GSA99</DutyCode>
<CreaUserCode>AIRIM</CreaUserCode>
<CreaDateTime>06Jan2007 15:32:30</CreaDateTime>
</HistoryEntry>
<HistoryEntry>
<SequenceNo>4</SequenceNo>
<HistoryCode>ITN</HistoryCode>
<ItemSequenceNo>1</ItemSequenceNo>
<ItemText>RT960 Y 13JAN LGA FLL HK/FB 1 0700 1000</ItemText>
XML Service APIs Page 109
<ReceivedFrom>HDKWWRT/HDQNK/</ReceivedFrom>
<DutyCode>GSA99</DutyCode>
<CreaUserCode>AIRIM</CreaUserCode>
<CreaDateTime>06Jan2007 15:32:30</CreaDateTime>
</HistoryEntry>
<HistoryEntry>
<SequenceNo>5</SequenceNo>
<HistoryCode>NAM</HistoryCode>
<ItemSequenceNo>1</ItemSequenceNo>
<ItemText>XECC/TEST</ItemText>
<ReceivedFrom>HDKWWRT/HDQNK/</ReceivedFrom>
<DutyCode>GSA99</DutyCode>
<CreaUserCode>AIRIM</CreaUserCode>
<CreaDateTime>06Jan2007 15:32:30</CreaDateTime>
</HistoryEntry>
<HistoryEntry>
<SequenceNo>6</SequenceNo>
<HistoryCode>TLQ</HistoryCode>
<ItemSequenceNo>1</ItemSequenceNo>
<ItemText>TK C RT FLL 0001 TLT01 08JAN007 13:00@@Fare Time Limit</ItemText>
<ReceivedFrom>HDKWWRT/HDQNK/</ReceivedFrom>
<DutyCode>GSA99</DutyCode>
<CreaUserCode>AIRIM</CreaUserCode>
<CreaDateTime>06Jan2007 15:32:30</CreaDateTime>
</HistoryEntry>
<HistoryEntry>
<SequenceNo>7</SequenceNo>
<HistoryCode>FRE</HistoryCode>
<ItemSequenceNo>1</ItemSequenceNo>
<ItemText>AUTO FLL LGA 82.79 USD</ItemText>
<ReceivedFrom>HDKWWRT/HDQNK/</ReceivedFrom>
<DutyCode>GSA99</DutyCode>
<CreaUserCode>AIRIM</CreaUserCode>
<CreaDateTime>06Jan2007 15:32:30</CreaDateTime>
</HistoryEntry>
<HistoryEntry>
<SequenceNo>8</SequenceNo>
<HistoryCode>FRE</HistoryCode>
<ItemSequenceNo>1</ItemSequenceNo>
<ItemText>AUTO LGA FLL 98.72 USD</ItemText>
<ReceivedFrom>HDKWWRT/HDQNK/</ReceivedFrom>
<DutyCode>GSA99</DutyCode>
<CreaUserCode>AIRIM</CreaUserCode>
<CreaDateTime>06Jan2007 15:32:30</CreaDateTime>
</HistoryEntry>
<HistoryEntry>
<SequenceNo>9</SequenceNo>
<HistoryCode>FRE</HistoryCode>
<ItemSequenceNo>1</ItemSequenceNo>
<ItemText>AUTO Tax Tax 18.44 USD</ItemText>
<ReceivedFrom>HDKWWRT/HDQNK/</ReceivedFrom>
<DutyCode>GSA99</DutyCode>
<CreaUserCode>AIRIM</CreaUserCode>
<CreaDateTime>06Jan2007 15:32:30</CreaDateTime>
</HistoryEntry>
<HistoryEntry>
<SequenceNo>10</SequenceNo>
XML Service APIs Page 110
<HistoryCode>SSR</HistoryCode>
<ItemSequenceNo>1</ItemSequenceNo>
<ItemText>OSI RT CTCE 1 TEST//RRTECHNOLOGIES.NET E</ItemText>
<ReceivedFrom>HDKWWRT/HDQNK/</ReceivedFrom>
<DutyCode>GSA99</DutyCode>
<CreaUserCode>AIRIM</CreaUserCode>
<CreaDateTime>06Jan2007 15:32:30</CreaDateTime>
</HistoryEntry>
<HistoryEntry>
<SequenceNo>11</SequenceNo>
<HistoryCode>SSR</HistoryCode>
<ItemSequenceNo>1</ItemSequenceNo>
<ItemText>OSI RT RT KK LOCATOR HNTTTS</ItemText>
<ReceivedFrom>HDKWWRT/HDQNK/</ReceivedFrom>
<DutyCode>GSA99</DutyCode>
<CreaUserCode>AIRIM</CreaUserCode>
<CreaDateTime>06Jan2007 15:32:30</CreaDateTime>
</HistoryEntry>
</HISTORY>
<AdditionalFieldValueS>
<AdditionalFieldValue>
<BookAdditionalDataFieldId>64</BookAdditionalDataFieldId>
<BookAdditionalDataFieldValueId>6260</BookAdditionalDataFieldValueId>
<FieldValueString/>
<FieldValueInt>0</FieldValueInt>
<ApplicationFieldCode/>
<FieldName>Custom</FieldName>
<FieldCaption>Custom Field</FieldCaption>
<MandatoryFlag>N</MandatoryFlag>
<SeqNo>2</SeqNo>
<FieldControlTypeRcd>TXT</FieldControlTypeRcd>
<DataTypeCode>S</DataTypeCode>
</AdditionalFieldValue>
<AdditionalFieldValue>
<BookAdditionalDataFieldId>15</BookAdditionalDataFieldId>
<BookAdditionalDataFieldValueId>6261</BookAdditionalDataFieldValueId>
<FieldValueString/>
<FieldValueInt>0</FieldValueInt>
<ApplicationFieldCode/>
<FieldName>Costcenter</FieldName>
<FieldCaption>Costcenter</FieldCaption>
<MandatoryFlag>N</MandatoryFlag>
<SeqNo>3</SeqNo>
<FieldControlTypeRcd>TXT</FieldControlTypeRcd>
<DataTypeCode>S</DataTypeCode>
</AdditionalFieldValue>
<AdditionalFieldValue>
<BookAdditionalDataFieldId>16</BookAdditionalDataFieldId>
<BookAdditionalDataFieldValueId>6262</BookAdditionalDataFieldValueId>
<FieldValueString/>
<FieldValueInt>0</FieldValueInt>
<ApplicationFieldCode/>
<FieldName>Account</FieldName>
<FieldCaption>Account</FieldCaption>
<MandatoryFlag>N</MandatoryFlag>
<SeqNo>4</SeqNo>
<FieldControlTypeRcd>TXT</FieldControlTypeRcd>
XML Service APIs Page 111
<DataTypeCode>S</DataTypeCode>
</AdditionalFieldValue>
<AdditionalFieldValue>
<BookAdditionalDataFieldId>17</BookAdditionalDataFieldId>
<BookAdditionalDataFieldValueId>6263</BookAdditionalDataFieldValueId>
<FieldValueString/>
<FieldValueInt>0</FieldValueInt>
<ApplicationFieldCode/>
<FieldName>EmployeeNo</FieldName>
<FieldCaption>EmployeeNo</FieldCaption>
<MandatoryFlag>N</MandatoryFlag>
<SeqNo>5</SeqNo>
<FieldControlTypeRcd>TXT</FieldControlTypeRcd>
<DataTypeCode>S</DataTypeCode>
</AdditionalFieldValue>
<AdditionalFieldValue>
<BookAdditionalDataFieldId>18</BookAdditionalDataFieldId>
<BookAdditionalDataFieldValueId>6264</BookAdditionalDataFieldValueId>
<FieldValueString/>
<FieldValueInt>0</FieldValueInt>
<ApplicationFieldCode/>
<FieldName>Remarks</FieldName>
<FieldCaption>Remarks</FieldCaption>
<MandatoryFlag>N</MandatoryFlag>
<SeqNo>6</SeqNo>
<FieldControlTypeRcd>TXT</FieldControlTypeRcd>
<DataTypeCode>S</DataTypeCode>
</AdditionalFieldValue>
<AdditionalFieldValue>
<BookAdditionalDataFieldId>65</BookAdditionalDataFieldId>
<BookAdditionalDataFieldValueId>6265</BookAdditionalDataFieldValueId>
<FieldValueString/>
<FieldValueInt>0</FieldValueInt>
<ApplicationFieldCode/>
<FieldName>Service</FieldName>
<FieldCaption>Service Station</FieldCaption>
<MandatoryFlag>N</MandatoryFlag>
<SeqNo>7</SeqNo>
<FieldControlTypeRcd>TXT</FieldControlTypeRcd>
<DataTypeCode>S</DataTypeCode>
</AdditionalFieldValue>
</AdditionalFieldValueS>
<TIMELIMITS>
<TIMELIMIT>
<TimeLimitType>T</TimeLimitType>
<TimeLimitDate>08Jan2007</TimeLimitDate>
<TimeLimitDateAlt>01/08/2007</TimeLimitDateAlt>
<TimeLimitHour>13</TimeLimitHour>
<TimeLimitMinute>0</TimeLimitMinute>
<TimeLimitSecond>00</TimeLimitSecond>
<TimeLimitTime>13:00:00</TimeLimitTime>
<CancelFlag>C</CancelFlag>
<QueueCode>TKT01</QueueCode>
<DestinationBranch>RT FLL 0001</DestinationBranch>
<Remarks>Fare Time Limit</Remarks>
<AllPassengers>Y</AllPassengers>
</TIMELIMIT>
XML Service APIs Page 112
</TIMELIMITS>
<SUMMARY>
<TotalPayment>199.95</TotalPayment>
<TotalComm>0.00</TotalComm>
<TotalFare>199.95</TotalFare>
<TotalOutstanding>0.00</TotalOutstanding>
<TotalInsurance>15.00</TotalInsurance>
<TotalFee>0.00</TotalFee>
</SUMMARY>
<CommonCurrencyInfo>
<CurrencyCode>USD</CurrencyCode>
<Description>US Dollar</Description>
<Precision>2</Precision>
<RoundUnits>2</RoundUnits>
<NucRate>1.00000</NucRate>
<NumericCode>840</NumericCode>
<UpdtDateTime>2006/10/27/17/52/10</UpdtDateTime>
</CommonCurrencyInfo>
</BOOKING>
</RRT:GetBookingReply>
</soap:Body>
Note 1: The below are used by the RRT Web Framework for PNR modifications, and can be ignored:
<OLDFARES>; <OLDFARE>; <OLDPASSFARES>; <OLDPASSFARE>; <OLDFARESEGMENTS>;
<OLDFARESEGMENT>; <OLDFAREPAYMENTS>; and <OLDFAREPAYMENT>.
Note 2: If the booking is paid with PROSA credit card, you will see an extra node within the PAYMENT wrapper node:
<PRCM>
<OperationNumber>19677 </OperationNumber>
<AuthorizationNo>56 </AuthorizationNo>
</PRCM>
Split Booking Service
Splits passenger(s) from an existing booking into a new booking. This is typically used when changing itinerary for
one or several, but not all, passengers on a booking.
Signature:
[Visual Basic]
SplitBooking(BookingNumber As Long, ReceivedFrom As String, UserCode As String, DestID As
String, DutyCode As String, BranchCode As String, <XmlArrayItemAttribute("PassengerNo",
IsNullable:=false)> Passengers() As Integer) As XmlNode
Parameters:
BookingNumber
Numeric booking number
ReceivedFrom
Textual description of the requestor, e.g. the IP address of the remote system
XML Service APIs Page 113
UserCode
Up to five-character user code, e.g. ‘WEB’
DestID
Requestor destination ID, e.g. ‘FLLNK001’
DutyCode
Reserved, set to ‘DBA99’
BranchCode
Requesting branch code, e.g. ‘NK FLL 0001’
PassengerNo
Array of passenger numbers to split out from the booking
Sample code:
[Visual Basic]
'numeric booking number
Dim bookNo As Integer = 100
'received from text displayed in booking history
receivedFromUser = "Split Test"
'split out passengers 1 and 3
Dim passengerNos(1) As Integer
passengerNos(0) = 1
passengerNos(1) = 3
'get user/dest id from app settings
Dim userCode As String = ConfigurationSettings.AppSettings.GetValues("webUserCode")(0)
Dim userDestID As String = ConfigurationSettings.AppSettings.GetValues("webUserDestID")(0)
Dim branchCodeApp As String = ConfigurationSettings.AppSettings.GetValues("branchCode")(0)
'call the split booking service
Dim bookSubmitService As New bookingSubmitService.bookingsubmit
bookSubmitService.Url = ConfigurationSettings.AppSettings.GetValues("bookSubmitURL")(0)
Dim splitReply As XmlNode _
= bookSubmitService.SplitBooking(bookNo, receivedFromUser, userCode, userDestID,
"DBA99", branchCodeApp, passengerNos)
Sample SOAP/XML request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
<RRT:Body>
<RRT:SplitBooking>
<BookingNumber>2654083</BookingNumber>
<ReceivedFrom>TEST</ReceivedFrom>
<UserCode>ZLI</UserCode>
<DestID>FLLNK001</DestID>
<DutyCode>AGENT</DutyCode>
<BranchCode>RT FLL 0001</BranchCode>
<Passengers>
<Passenger>
XML Service APIs Page 114
<PassengerNo>3</PassengerNo>
</Passenger>
<Passenger>
<PassengerNo>4</PassengerNo>
</Passenger>
</Passengers>
</RRT:SplitBooking>
</RRT:Body>
</RRT:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:SplitBookingReply xmlns:RRT="http://rrtechnologies.net/soap/">
<NewBookingNumber>2654086</NewBookingNumber>
</RRT:SplitBookingReply>
</soap:Body>
</soap:Envelope>
Cancel Booking Service
Downline cancel a no-show booking at the submission of flight PRL/PFS. If the booking uses refundable fares, a
voucher will be generated. However if the system does not issue vouchers upon cancellation, no voucher will be
generated.
Parameters:
VoucherReasonCode
One of the codes that is setup in the Voucher Reason Code table. Values can be WEB, CP, and CR
BookingNumber
The seven-digit identifier for the booking that you are canceling
ReceivedFrom
The name of the person requesting cancellation
UserCode
The user code of the person that is performing the cancellation
DestID
The destination branch code
DutyCode
The user type of the person performing the cancellation
BranchCode
The branch code of the user
Passengers
The node that wraps the passenger information in the booking
XML Service APIs Page 115
Passenger
Name of the passenger in the booking. Format is LAST/FIRST
PassengerNo
The sequential number of the passenger in the booking if there are multiple passengers in the booking
Return Values
VoucherNumber
The voucher number generated from the booking cancellation. This field will be empty if the booking uses non-
refundable fares or if your system does not issue vouchers at all.
Sample XML Request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
<RRT:Body>
<RRT:CancelBooking>
<VoucherReasonCode>WEB Cancelling</VoucherReasonCode>
<BookingNumber>2667759</BookingNumber>
<ReceivedFrom>LYNN</ReceivedFrom>
<UserCode>ZLI</UserCode>
<DestID>RTFLL01</DestID>
<DutyCode>DBA99</DutyCode>
<BranchCode>RTTTY0001</BranchCode>
<Passengers>
<Passenger>GOLDBERG/RIAN</Passenger>
<PassengerNo>1</PassengerNo>
</Passengers>
</RRT:CancelBooking>
</RRT:Body>
</RRT:Envelope>
Sample Response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:CancelBookingReply xmlns:RRT="http://rrtechnologies.net/soap/">
<VoucherNumber>0017702C<VoucherNumber/>
</RRT:CancelBookingReply>
</soap:Body>
</soap:Envelope>
Update FQTV service
This service will update the Frequent Flyer information for a passenger, in both the Reservation and the DCS; if the
PNR is already in DCS control
Parameters:
Locator
The Airline’s record locator for the PNR.
XML Service APIs Page 116
PassengerName
The passenger whose Frequent Flyer information is being updated.
FQTVtext
The Frequent Flyer ID.
Sample XML Request:
<?xml version="1.0" encoding="Latin-1" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
<RRT:Body>
<RRT:UpdateFQTV>
<Locator>HNWLSG</Locator>
<PassengerName>TEST/FQTV</PassengerName>
<FQTVtext>RNXX68001</FQTVtext>
</RRT:UpdateFQTV>
</RRT:Body>
</RRT:Envelope>
Sample Response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:UpdateFQTVReply xmlns:RRT="http://rrtechnologies.net/soap/">
<completed>true</completed>
</RRT:UpdateFQTVReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 117
Generate Locator Service
Generates an external booking record locator for a booking. When the service call is initiated by the web, only the
locator generated is used by the system. The booking number is of no practical value. When the
GENERATELOCATOR call is used by the GUI/TypeB/internal-RRT-APPS, then both the locator and the booking
number are used by the system.
Tuxedo service name: GENERATELOCATOR.
Signature:
[Visual Basic]
GenerateLocator(UserCode As String, DestinationID As String) As XmlNode
Parameters:
UserCode
An up to five-character user ID, e.g. ‘WEB’.
DestinationID
The destination ID of the caller, e.g. ‘FLLNK0001’
Return values:
BookingNumber
Web generated unique booking number. However this is not the booking number you see in the booking number
field in Results Booking dialog box
Locator
Web generated external record locator. You will see this in the external locator field in Results Booking dialog box
Sample code:
[Visual Basic]
'get config settings
Dim userCode As String = ConfigurationSettings.AppSettings.GetValues("webUserCode")(0)
Dim userDestID As String = ConfigurationSettings.AppSettings.GetValues("webUserDestID")(0)
'call service to create locator
Dim locatorGenerator As New generateLocatorService.generateLocator
locatorGenerator.Url = ConfigurationSettings.AppSettings.GetValues("generateLocatorURL")(0)
Dim locatorInfo As XmlNode _
= locatorGenerator.GenerateLocator(userCode, userDestID)
'print locator information to the debug window
Debug.WriteLine("Numeric Booking Number: " _
& locatorInfo.SelectSingleNode("BookingNumber").InnerText)
Debug.WriteLine("Alphanumeric Locator: " _
& locatorInfo.SelectSingleNode("Locator").InnerText)
Remarks:
The WSDL description for this service is in ResultsServices/generatelocator.wsdl
XML Service APIs Page 118
Sample SOAP/XML request for creating new bookings on the web:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GenerateLocator xmlns="http://rrtechnologies.net/soap/">
<UserCode>WEB</UserCode>
<DestinationID>FLLNK001</DestinationID>
</GenerateLocator>
</soap:Body>
</soap:Envelope>
Successful response for web new booking is:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:GenerateLocatorReply xmlns:RRT="http://rrtechnologies.net/soap/">
<LocatorInfo>
<BookingNumber>2649524</BookingNumber>
<Locator>HNRCZW</Locator>
</LocatorInfo>
</RRT:GenerateLocatorReply>
</soap:Body>
</soap:Envelope>
To retrieve GUI bookings from the web, use the following XML call:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<AssignLocator xmlns="http://rrtechnologies.net/soap/">
<Locator>HNTTNX</Locator>
<ExternalLocator>HNTTNZ</ExternalLocator>
<ExternalAddress>HDKWWRT</ExternalAddress>
</AssignLocator>
</soap:Body>
</soap:Envelope>
For retrieving GUI booking on the web, the response is:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:AssignLocatorReply xmlns:RRT="http://rrtechnologies.net/soap/" />
</soap:Body>
</soap:Envelope>
XML Service APIs Page 119
Floating Fare Services
This service locks a floating fare amount using a base fare and assigns the floating fare to a booking. This is used to
avoid having floating fares repriced at a higher amount if the base class is sold out between the original availability or
pricing request and a reprice-request.
Tuxedo service name: LOCKFARESERVICE.
Lock Fare Service
Locks a floating fare so it will stay even if the original base fare is sold out
Parameters:
ClassCode
Selling class for the floating fare
DepartureDate
Departure date this fare is being locked for
AirportCodes
Array of origin, via and destination airport codes
FlightNumbers
Flight number(s) this fare was retrieved for
FloatingFareCode
Fare code for the floating fare
FloatingFareAmount
The fare amount for the floating fare
Currency
Fare currency code
RefundableFlag
Boolean flag (Y/N) indicating whether the floating fare is a refundable or non-refundable fare.
BaseFareCode
The fare code on which the floating fare is based
BaseFareAmount
The fare amount on which the floating fare is based
Sample SOAP request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
<RRT:Body>
<RRT:LockFare>
<ClassCode>A</ClassCode>
<DepartureDate>09/20/2004</DepartureDate>
XML Service APIs Page 120
<AirportCodes>
<AirportCode>ACY</AirportCode>
<AirportCode>DTW</AirportCode>
</AirportCodes>
<FlightNumbers>
<FlightNumber>RT1148</FlightNumber>
</FlightNumbers>
<FloatingFareCode>ANR</FloatingFareCode>
<FloatingFareAmount>126.51</FloatingFareAmount>
<Currency>USD</Currency>
<RefundableFlag>N</RefundableFlag>
<ReturnFlag>N</ReturnFlag>
<BaseFareCode>LNR</BaseFareCode>
<BaseClass>L</BaseClass>
<BaseFareAmount>84.65</BaseFareAmount>
</RRT:LockFare>
</RRT:Body>
</RRT:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="http://schemas.xmlsoap.org/soap/envelope/">
<RRT:Header/>
<RRT:Body>
<RRT:LockFareReply>
<FloatingFareID>1634</FloatingFareID>
</RRT:LockFareReply>
</RRT:Body>
</RRT:Envelope>
FloatingFareID is the return for executing the XML request. This ID number will be used when you assign the floating
fare to a booking.
Assign Fare Service
To Assign a locked floating fare to a booking.
Parameters:
FloatingFareID
Floating fare ID returned from the lock fare request
BookingNumber
This is the booking number on which you can apply this FloatingFareID
Sample XML code:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
<RRT:Body>
<RRT:AssignFare>
<FloatingFareID>1634</FloatingFareID>
<BookingNumber>1055</BookingNumber>
XML Service APIs Page 121
</RRT:AssignFare>
</RRT:Body>
</RRT:Envelope>
Successful response is:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="http://schemas.xmlsoap.org/soap/envelope/">
<RRT:Header/>
<RRT:Body>
<RRT:AssignFareReply/>
</RRT:Body>
</RRT:Envelope>
If you go to Results to retrieve the booking, you will see the segment is upgraded to A class.
XML Service APIs Page 122
Agency Services
The agency services provides travel agency related functionality such as creating an agency account, agency/agent
validation (login), agency booking statistics, agency booking search, agency voucher search, ‘on behalf of’ booking
privilege validation etc.
Tuxedo service name: AGENCY_SERVICE
Create Agency Service
Create a travel agency from scratch.
Parameters:
AgencyCode
ARC or Results travel agency code
Return Values:
Sample SOAP/XML request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
<RRT:Body>
<RRT:TA_CreateTravelAgency>
<AgencyCode>8386198</AgencyCode>
<TranCode></TranCode>
<IataAgencyCode></IataAgencyCode>
<OfficeType></OfficeType>
<EntityType></EntityType>
<TradeName>GOLDIE</TradeName>
<TradeNameLbl></TradeNameLbl>
<LegalName>GOLDIE</LegalName>
<AgencyPhoneNo>407 894-5000</AgencyPhoneNo>
<AgencyAddress1>8 Bayside Village Place</AgencyAddress1>
<AgencyAddress2>SUITE 150</AgencyAddress2>
<AgencyCity>MANKATO</AgencyCity>
<AgencyState>MN</AgencyState>
<AgencyZip>56001</AgencyZip>
<AgencyFaxNo></AgencyFaxNo>
<EmailAddress>glamworth@au.com</EmailAddress>
<MailName>Golds Travel</MailName>
<MailAddress1></MailAddress1>
<MailAddress2></MailAddress2>
<MailCity>San Francisco</MailCity>
<MailState>CA</MailState>
<MailZip>94107</MailZip>
<ApplicationDate></ApplicationDate>
<InclusionDate></InclusionDate>
<PrevAgencyCode></PrevAgencyCode>
<HoaAgencyCode></HoaAgencyCode>
XML Service APIs Page 123
<HostAgencyCode></HostAgencyCode>
<MailFlg></MailFlg>
<ScrutinyFlg>N</ScrutinyFlg>
<PaymentBannedFlg>Q</PaymentBannedFlg>
<AccreditingEntity></AccreditingEntity>
<AccreditationType></AccreditationType>
<OfficeStatus>0b</OfficeStatus>
<UpdtUserCode>DOUG</UpdtUserCode>
<UpdtDestId></UpdtDestId>
<NationCode></NationCode>
<TimeLimit></TimeLimit>
<MailNationCode>US</MailNationCode>
<TravelAgencyLimitTypeRcd></TravelAgencyLimitTypeRcd>
<AgencyGroupFlag></AgencyGroupFlag>
<DaysBeforeDeparture>7</DaysBeforeDeparture>
<AgencyCreditLimit>1000</AgencyCreditLimit>
<InvoiceSchedule>29</InvoiceSchedule>
<NumberOfDaysDue>10</NumberOfDaysDue>
<ExternalAgencyId>MANK0351</ExternalAgencyId>
</RRT:TA_CreateTravelAgency>
</RRT:Body>
</RRT:Envelope>
Sample Output:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:TA_CreateTravelAgencyReply xmlns:RRT="http://rrtechnologies.net/soap/"/>
</soap:Body>
</soap:Envelope>
Retrieve Agency Service
To retrieve an agency information.
Parameters:
AgencyCode
ARC or Results travel agency code
Return Values:
Sample SOAP/XML request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
XML Service APIs Page 124
<RRT:Body>
<RRT:TA_GetTravelAgency>
<AgencyCode>03542534</AgencyCode>
</RRT:TA_GetTravelAgency>
</RRT:Body>
</RRT:Envelope>
Sample output:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:TA_GetTravelAgencyReply xmlns:RRT="http://rrtechnologies.net/soap/">
<AgencyInfo>
<Child>
<AgencyCode>03542534</AgencyCode>
<TranCode/>
<IataAgencyCode/>
<OfficeType>H</OfficeType>
<EntityType>Y</EntityType>
<TradeName>TRAVEL TO</TradeName>
<TradeNameLbl/>
<LegalName>TRAVEL TO</LegalName>
<AgencyPhoneNo>520 322-9600</AgencyPhoneNo>
<AgencyAddress1>1402 N ALVERNON WAY</AgencyAddress1>
<AgencyAddress2>SUITE</AgencyAddress2>
<AgencyCity>TUCSON</AgencyCity>
<AgencyState>AZ</AgencyState>
<AgencyZip>85712</AgencyZip>
<AgencyFaxNo>520 322-9494</AgencyFaxNo>
<EmailAddress/>
<MailName/>
<MailAddress1/>
<MailAddress2/>
<MailCity/>
<MailState/>
<MailZip/>
<ApplicationDate/>
<InclusionDate>95-09-27</InclusionDate>
<PrevAgencyCode/>
<HoaAgencyCode>03542534</HoaAgencyCode>
<HostAgencyCode/>
<MailFlg>N</MailFlg>
<ScrutinyFlg>N</ScrutinyFlg>
<PaymentBannedFlg>C</PaymentBannedFlg>
<AccreditingEntity/>
<AccreditationType/>
<OfficeStatus>0b</OfficeStatus>
<UpdtUserCode>LYNN</UpdtUserCode>
<UpdtDestId>FLL0001</UpdtDestId>
<UpdtDateTime>2005/09/26/15/37/07</UpdtDateTime>
<NationCode>US</NationCode>
<TimeLimit>5</TimeLimit>
<MailNationCode>US</MailNationCode>
<TravelAgencyLimitTypeRcd>C</TravelAgencyLimitTypeRcd>
<AgencyGroupFlag>Y</AgencyGroupFlag>
XML Service APIs Page 125
<DaysBeforeDeparture>2</DaysBeforeDeparture>
<AgencyCreditLimit>5000</AgencyCreditLimit>
<InvoiceSchedule/>
<NumberOfDaysDue/>
<ExternalAgencyId>2425245</ExternalAgencyId>
<InvoiceFee>0.00</InvoiceFee>
</Child>
</AgencyInfo>
</RRT:TA_GetTravelAgencyReply>
</soap:Body>
</soap:Envelope>
Update Agency Service
To update agency information.
Parameters:
AgencyCode
ARC or Results travel agency code
ScrutinyFlg
Default is N if it is not set in the XML message
Return Values:
Sample SOAP/XML request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
<RRT:Body>
<RRT:TA_UpdateAgency>
<AgencyCode>8386198</AgencyCode>
<TranCode></TranCode>
<IataAgencyCode></IataAgencyCode>
<OfficeType></OfficeType>
<EntityType></EntityType>
<TradeName>ORCITS</TradeName>
<TradeNameLbl></TradeNameLbl>
<LegalName>ORBITZ Travel</LegalName>
<AgencyPhoneNo>312 894-5000</AgencyPhoneNo>
<AgencyAddress1>2484 Mississauga Road</AgencyAddress1>
<AgencyAddress2>SUITE 150</AgencyAddress2>
<AgencyCity>MANKATO</AgencyCity>
<AgencyState>MN</AgencyState>
<AgencyZip>56001</AgencyZip>
<AgencyFaxNo></AgencyFaxNo>
<EmailAddress></EmailAddress>
<MailName></MailName>
<MailAddress1></MailAddress1>
<MailAddress2></MailAddress2>
<MailCity></MailCity>
<MailState></MailState>
XML Service APIs Page 126
<MailZip></MailZip>
<ApplicationDate></ApplicationDate>
<InclusionDate></InclusionDate>
<PrevAgencyCode></PrevAgencyCode>
<HoaAgencyCode></HoaAgencyCode>
<HostAgencyCode></HostAgencyCode>
<MailFlg></MailFlg>
<ScrutinyFlg>N</ScrutinyFlg>
<PaymentBannedFlg>R</PaymentBannedFlg>
<AccreditingEntity></AccreditingEntity>
<AccreditationType></AccreditationType>
<OfficeStatus>0b</OfficeStatus>
<UpdtUserCode>DOUG</UpdtUserCode>
<UpdtDestId>FLLNK001</UpdtDestId>
<NationCode></NationCode>
<TimeLimit></TimeLimit>
<MailNationCode>US</MailNationCode>
<TravelAgencyLimitTypeRcd></TravelAgencyLimitTypeRcd>
<AgencyGroupFlag></AgencyGroupFlag>
<DaysBeforeDeparture></DaysBeforeDeparture>
<AgencyCreditLimit></AgencyCreditLimit>
<InvoiceSchedule>30</InvoiceSchedule>
<NumberOfDaysDue>10</NumberOfDaysDue>
<ExternalAgencyId> MANK0351</ExternalAgencyId>
</RRT:TA_UpdateAgency>
</RRT:Body>
</RRT:Envelope>
This changes the InvoiceSchedule date from the 29th to the 30th of each month.
Sample output:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:TA_UpdateAgencyReply xmlns:RRT="http://rrtechnologies.net/soap/"/>
</soap:Body>
</soap:Envelope>
Agency Login/Validation Service
Validates agency/agent login information.
Signature:
[Visual Basic]
ValidateLogin(AgencyCode As String, AgentCode As String, Password As String) As XmlNode
Parameters:
AgencyCode
ARC or Results travel agency code
XML Service APIs Page 127
AgentCode
The agent’s access code to web that is stored in Results database
Password
MD5 password hash of the agent’s password, in hexadecimal format.
Return values:
AccessGranted
Boolean flag (true/false) indicating whether the agency/agent/password hash is valid and authorized to log in.
AgencyTradeName
Trade name of the logged in travel agency.
Sample code:
[Visual Basic]
'generate MD5 password password hash
Dim md5 As New System.Security.Cryptography.MD5CryptoServiceProvider
Dim enc As New System.Text.ASCIIEncoding
Dim result As Byte() = md5.ComputeHash(enc.GetBytes(agentPassword))
Dim agencyUserPasswordHash As String
For byteNo As Integer = 0 To result.Length - 1
Dim hexNo As String = Hex(result(byteNo))
If hexNo.Length = 1 Then hexNo = "0" & hexNo
agencyUserPasswordHash = agencyUserPasswordHash & hexNo
Next
'call the agency login validation
Dim agencyService As New agencyService.agency
agencyService.Url = ConfigurationSettings.AppSettings.GetValues("agencyServiceURL")(0)
Dim agencyValidation As XmlNode = agencyService.ValidateLogin(agencyCode.ToUpper,
agentCode.ToUpper, agencyUserPasswordHash)
'check result
Dim failedResultCode As String
Dim failedResultText As String
If agencyValidation.SelectSingleNode("AccessGranted").InnerText = "true" Then
'Login successful
Else
'Login not successful
failedResultCode = agencyValidation.SelectSingleNode("ReasonCode").InnerText
failedResultText = agencyValidation.SelectSingleNode("Reason").InnerText
End If
Sample SOAP/XML request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<ValidateLogin xmlns="http://rrtechnologies.net/soap/">
<AgencyCode>03542534</AgencyCode>
<AgentCode>LYNN</AgentCode>
XML Service APIs Page 128
<Password>D686A53FB86A6C31FA6FAA1D9333267E</Password>
</ValidateLogin>
</soap:Body>
</soap:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:ValidateLoginReply xmlns:RRT="http://rrtechnologies.net/soap/">
<ValidateLogin>
<AccessGranted>true</AccessGranted>
<AgencyTradeName>TRAVEL TO</AgencyTradeName>
</ValidateLogin>
</RRT:ValidateLoginReply>
</soap:Body>
</soap:Envelope>
Sample screenshot from the Results web:
Validate Agency Locator Service
This service retrieves a single agency booking.
Parameters:
AgencyCode
The travel agency code you are retrieving the booking for
Locator
The record locator of the booking you are retrieving
Return value:
RetrievalGranted
This indicates if the booking belongs to the agency. You can retrieve the booking when the value is “true”. If the
value is “false”, you are not able to retrieve the booking
Sample SOAP/XML request:
XML Service APIs Page 129
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<ValidateAgencyForLocator xmlns="http://rrtechnologies.net/soap/">
<AgencyCode>03542534</AgencyCode>
<Locator>HNRNRG</Locator>
</ValidateAgencyForLocator>
</soap:Body>
</soap:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:ValidateAgencyForLocatorReply xmlns:RRT="http://rrtechnologies.net/soap/">
<ValidateAgencyForLocator>
<RetrievalGranted>true</RetrievalGranted>
</ValidateAgencyForLocator>
</RRT:ValidateAgencyForLocatorReply>
</soap:Body>
</soap:Envelope>
Agency Booking Retrieval Service
This service retrieves a list of bookings by a particular agency, optional filters are creation period, passenger name,
flight/date/origin/destination or agent.
Signature:
[Visual Basic]
GetAgencyBookingList(PassengerName As String, FlightNumber As String, BoardDate As String,
Origin As String, Destination As String, AgencyCode As String, AgentCode As String,
CreatedDateStart As String, CreatedDateEnd As String) As XmlNode
Parameters:
PassengerName
Passenger name filter
FlightNumber
Flight number filter
BoardDate
Board date filter in US date format (MM/dd/yyyy)
Origin
Origin airport code filter
Destination
Destination airport code filter
XML Service APIs Page 130
AgencyCode
ARC or Results travel agency code (mandatory)
CreatedDateStart/CreatedDateEnd
Creation date range filter for bookings. This is optional but recommended
Return values:
Locator
Record locator
FlightNumber
First segment in the booking
BoardDate
First segment’s board date
Origin/Destination
First segment’s origin/destination airport code
AgencyCode
Travel agency code
AgentCode
Booking agent
CreatedDateTime
Booking creation date time
Passengers/Name
Array of passenger names on the booking
Sample SOAP/XML request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetAgencyBookingList xmlns="http://rrtechnologies.net/soap/">
<PassengerName>PASSENGER/FIRST</PassengerName>
<FlightNumber />
<BoardDate />
<Origin>FLL</Origin>
<Destination>DTW</Destination>
<AgencyCode>03542534</AgencyCode>
<AgentCode />
<CreatedDateStart>05/01/2005</CreatedDateStart>
<CreatedDateEnd>05/03/2005</CreatedDateEnd>
</GetAgencyBookingList>
</soap:Body>
</soap:Envelope>
Sample response:
XML Service APIs Page 131
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:GetAgencyBookingListReply xmlns:RRT="http://rrtechnologies.net/soap/">
<GetAgencyBookingList>
<AgencyLocator>
<Locator>HNQLPD</Locator>
<FlightNumber>RT7112</FlightNumber>
<BoardDate>05/04/2005</BoardDate>
<Origin>FLL</Origin>
<Destination>DTW</Destination>
<AgencyCode>03542534</AgencyCode>
<CreatedDateTime>2005-05-03 05:44:52</CreatedDateTime>
<Passengers>
<Name>PASSENGER/FIRST MR</Name>
</Passengers>
</AgencyLocator>
</GetAgencyBookingList>
</RRT:GetAgencyBookingListReply>
</soap:Body>
</soap:Envelope>
Screenshot from Results Web:
Agency Booking Statistics Service
Retrieves booking statistics for an agency during a specified date range.
Signature:
[Visual Basic]
GetAgencyBookingStatistics(AgencyCode As String, FromDate As String, ToDate As String) As
XmlNode
Parameters:
XML Service APIs Page 132
AgencyCode
ARC or Results travel agency code.
FromDate/ToDate
Date range to retrieve booking statistics for.
Sample code:
[Visual Basic]
Dim agencySvc As New agencyService.agency
agencySvc.Url = ConfigurationSettings.AppSettings.GetValues("agencyServiceURL")(0)
Dim agencyBookingInfo As XmlNode = agencySvc.GetAgencyBookingStatistics(agencyCode, _
Convert.ToString(IIf(fromDate.CompareTo(New Date) = 0, _
"", _
fromDate.ToString("MM/dd/yyyy", GetSystemDateFormatProvider())) _
), _
Convert.ToString(IIf(toDate.CompareTo(New Date) = 0, _
"", _
toDate.ToString("MM/dd/yyyy", GetSystemDateFormatProvider())) _
))
Sample SOAP/XML request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetAgencyBookingStatistics xmlns="http://rrtechnologies.net/soap/">
<AgencyCode>03542534</AgencyCode>
<FromDate>05/12/2005</FromDate>
<ToDate>05/20/2005</ToDate>
</GetAgencyBookingStatistics>
</soap:Body>
</soap:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:GetAgencyBookingStatisticsReply xmlns:RRT="http://rrtechnologies.net/soap/">
<GetAgencyBookingStatistics>
<AgencyLocator>
<Locator>HNQVYZ</Locator>
<NumberOfSeats>1</NumberOfSeats>
<BookingCategory>S</BookingCategory>
<AgentCode>AIRIM</AgentCode>
<AgencyCode>03542534</AgencyCode>
<OriginAddress>HDKWWRT</OriginAddress>
<TotalFares>92.09302</TotalFares>
<TotalSurcharges>0.00000</TotalSurcharges>
<TotalTaxes>15.40698</TotalTaxes>
<TotalFees>0.00000</TotalFees>
XML Service APIs Page 133
<TotalCommissions>0.00000</TotalCommissions>
<TotalPaid>123.10000</TotalPaid>
</AgencyLocator>
<AgencyLocator>
<Locator>HNQVZC</Locator>
<NumberOfSeats>1</NumberOfSeats>
<BookingCategory>S</BookingCategory>
<AgentCode>AIRIM</AgentCode>
<AgencyCode>03542534</AgencyCode>
<OriginAddress>HDKWWRT</OriginAddress>
<TotalFares>100.00000</TotalFares>
<TotalSurcharges>0.00000</TotalSurcharges>
<TotalTaxes>23.10000</TotalTaxes>
<TotalFees>0.00000</TotalFees>
<TotalCommissions>0.00000</TotalCommissions>
<TotalPaid>123.10000</TotalPaid>
</AgencyLocator>
<AgencyLocator>
...sample truncated for readability...
</AgencyLocator>
<AgencyLocator>
...sample truncated for readability...
</AgencyLocator>
<AgencyLocator>
<Locator>HNRCGH</Locator>
<NumberOfSeats>1</NumberOfSeats>
<BookingCategory>S</BookingCategory>
<AgentCode>AIRIM</AgentCode>
<AgencyCode>03542534</AgencyCode>
<OriginAddress>HDKWWRT</OriginAddress>
<TotalFares>100.00000</TotalFares>
<TotalSurcharges>0.00000</TotalSurcharges>
<TotalTaxes>23.00000</TotalTaxes>
<TotalFees>0.00000</TotalFees>
<TotalCommissions>0.00000</TotalCommissions>
<TotalPaid>123.00000</TotalPaid>
</AgencyLocator>
</GetAgencyBookingStatistics>
</RRT:GetAgencyBookingStatisticsReply>
</soap:Body>
</soap:Envelope>
The following screenshot is from Results Web:
XML Service APIs Page 134
Agency Voucher Retrieval Service
Retrieves a list of vouchers for a specific agency.
Signature:
[Visual Basic]
GetVoucherList(AgencyCode As String, Status As String) As XmlNode
Parameters:
AgencyCode
ARC or Results travel agency code
Status
Optional voucher status code, e.g. ‘OPEN’, ‘USED’, or ‘CXLD’. When empty, the service will return vouchers of all
statuses
Return values:
VoucherNumber
Numeric voucher number. For internal use only
Status
Voucher status code
Recipient
Name of the voucher recipient
XML Service APIs Page 135
Locator
Record locator if the voucher was generated from a booking (fare difference or cancellation voucher).
AppliedLocator
Record locator of applied-to booking for used vouchers
OriginalVoucherNumber
Alphanumeric voucher number
AgencyCode
ARC or Results travel agency code
ExpiryDate
The date the voucher expires
ReasonCode
This is the two character voucher reason code stored in Voucher Reason table
ReasonDescription
This is a text description of the voucher type
Sample code:
[Visual Basic]
Dim agencySvc As New agencyService.agency
agencySvc.Url = ConfigurationSettings.AppSettings.GetValues("agencyServiceURL")(0)
Dim agencyVouchersInfo As XmlNode = agencySvc.GetVoucherList(agencyCode,
voucherStatus)
Sample SOAP/XML request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetVoucherList xmlns="http://rrtechnologies.net/soap/">
<AgencyCode>03542534</AgencyCode>
<Status>OPEN</Status>
</GetVoucherList>
</soap:Body>
</soap:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:GetVoucherListReply xmlns:RRT="http://rrtechnologies.net/soap/">
<GetVoucherList>
<AgencyVoucher>
<VoucherNumber>2999888</VoucherNumber>
<Status>OPEN</Status>
XML Service APIs Page 136
<Recipient>TRAVEL/TO</Recipient>
<Currency>USD</Currency>
<Amount>200.00</Amount>
<Locator />
<AppliedLocator />
<OriginalVoucherNumber>9998883T</OriginalVoucherNumber>
<AgencyCode>03542534</AgencyCode>
<ExpiryDate>06/17/2006</ExpiryDate>
<ReasonCode>AC</ReasonCode>
<ReasonDescription>Agency credit voucher</ReasonDescription>
</AgencyVoucher>
</GetVoucherList>
</RRT:GetVoucherListReply>
</soap:Body>
</soap:Envelope>
Screenshot from Results Web:
Agency Credit Verification Service
This service verifies how much credit is left for an agency.
Parameter:
AgencyCode
The ARC agency code for this specific travel agency
Return Value:
RemainingCredit
The amount of credit this agency has with the airline
Sample SOAP/XML request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
XML Service APIs Page 137
<VerifyAgencyCredit xmlns="http://rrtechnologies.net/soap/">
<AgencyCode>10514173</AgencyCode>
</VerifyAgencyCredit>
</soap:Body>
</soap:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:VerifyAgencyCreditReply xmlns:RRT="http://rrtechnologies.net/soap/">
<VerifyAgencyCredit>
<RemainingCredit>2148</RemainingCredit>
</VerifyAgencyCredit>
</RRT:VerifyAgencyCreditReply>
</soap:Body>
</soap:Envelope>
The response indicates the agency has $2148 in credit and will allow the agency to book against this credit.
XML Service APIs Page 138
Voucher Services
Voucher services are responsible for voucher generation and voucher retrieval.
Tuxedo service name: VOUCHER_SERVICE.
Voucher Generation Service
Creates a new voucher, e.g. a gift certificate or promotional voucher.
Signature:
[Visual Basic]
Public Function CreateVoucher( _
VoucherReason As String, _
VoucherStatus As String, _
VoucherAmount As Decimal, _
CurrencyCode As String, _
Notes As String, _
PercentFlag As String, _
CommissionFlag As String, _
UseFee As Decimal, _
RefundableFlag As String, _
FlightNo As String, _
FlightDate As String, _
FlightOrigin As String, _
FlightDestination As String, _
CancelDate As String, _
RecordLocator As String, _
BookNo As Integer, _
CompanyCode As String, _
UserCode As String, _
Recipient As NameAddress, _
Payer As NameAddress, _
Payments As Payment) As XmlNode
Parameters:
VoucherReason
Two-character voucher reason code stored in the Voucher Reason table
VoucherStatus
Value for new vouchers can only be OPEN
VoucherAmount
The amount of the voucher
CurrencyCode
Voucher currency code
Notes
Voucher notes, such as voucher source.
XML Service APIs Page 139
PercentFlag
This indicates if this is a percentage voucher
CommissionFlag
This indicates if any commission should be charged
UseFee
This indicates if any fee applies when using this voucher
RefundableFlag
This indicates if this is a refundable voucher
FlightNo
This is the flight number of the booking this voucher will be used on. This parameter is empty if the voucher is not
used toward a booking
FlightDate
This is the flight date of the booking this voucher will be used on. This parameter is empty if the voucher is not used
toward a booking
FlightOrigin/FlightDestination
This is the origination/destination of the booking this voucher will be used on. This parameter is empty if the voucher
is not used toward a booking
RecordLocator
Record locator of the original booking, if the voucher was created from a booking
BookNo
This is the booking number
CompanyCode
This is the airline code
UserCode
Recipient
Name of the voucher recipient
Payer
The node contains payer information of the gift certificate, like the name, address, and phone number
Payments
This node contains all payment related information for the gift certificate, like type of payment, credit card number,
expiration date, payment flag, etc.
Return values:
Number
This is the Results voucher number
Expiry
This is the expiration date of the voucher. This is the creation date plus number of months specified in the
VOUCHER_EXPIRE_MOS system setting
XML Service APIs Page 140
Sample code:
[Visual Basic]
'Create a gift certificate
Dim voucherSvc As New voucherService.voucherservice
voucherSvc.Url = ConfigurationSettings.AppSettings.GetValues("voucherURL")(0)
giftcertificateInfo = voucherSvc.CreateVoucher(voucherReason, "OPEN", giftAmount,
currencyCode, _
voucherNotes, "N", "N", 0, "Y", "", "", "", "", _
Now.AddDays(validDays).ToString("MM/dd/yyyy", GetSystemDateFormatProvider()), _
"", 0, companyCode, "WEB", recipientInfo, payerInfo, paymentInfo)
'retrieve the new voucher number
Dim voucherNumber As String = giftcertificateInfo.SelectSingleNode("Number").InnerText
Parameter structure definitions:
Public Class NameAddress
Public Name As String
Public Addr1 As String
Public Addr2 As String
Public City As String
Public State As String
Public Zip As String
Public Country As String
Public Phone As String
Public Email As String
End Class
Public Class Payment
Public Form As String
Public Type As String
Public Amount As Decimal
Public CurrencyCode As String
Public DocumentNo As String
Public CCExpiry As String
Public CVV As String
Public [Date] As String
Public BranchCode As String
Public PassengerName As String
Public ReceivedFrom As String
Public PaidFlag As String
Public PaymentIndicator As String
End Class
Sample SOAP/XML request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<CreateVoucher xmlns="http://rrtechnologies.net/soap/">
<VoucherReason>GC</VoucherReason>
<VoucherStatus>OPEN</VoucherStatus>
<VoucherAmount>200</VoucherAmount>
XML Service APIs Page 141
<CurrencyCode>USD</CurrencyCode>
<Notes>WEB Voucher, source IP: 192.168.112.64</Notes>
<PercentFlag>N</PercentFlag>
<CommissionFlag>N</CommissionFlag>
<UseFee>0</UseFee>
<RefundableFlag>Y</RefundableFlag>
<FlightNo />
<FlightDate />
<FlightOrigin />
<FlightDestination />
<CancelDate/>
<RecordLocator />
<BookNo>0</BookNo>
<CompanyCode>RT</CompanyCode>
<UserCode>WEB</UserCode>
<Recipient>
<Name>WU/ZHONG</Name>
<Addr1/>
<City/>
<State />
<Zip/>
<Country/>
<Phone/>
<Email/>
</Recipient>
<Payer>
<Name>GE/YIHONG</Name>
<Addr1/>
<City/>
<State />
<Zip/>
<Country/>
<Phone/>
<Email>YIHONGGE@HOTMAIL.COM</Email>
</Payer>
<Payments>
<Form>VI</Form>
<Type>CC</Type>
<Amount>200</Amount>
<CurrencyCode>USD</CurrencyCode>
<DocumentNo>4111111111111111</DocumentNo>
<CCExpiry>1212</CCExpiry>
<CVV>123</CVV>
<Date>06/16/2005</Date>
<BranchCode>RT FLL 0001</BranchCode>
<PassengerName>GE/YIHONG</PassengerName>
<ReceivedFrom>YIHONG GE</ReceivedFrom>
<PaidFlag>Y</PaidFlag>
<PaymentIndicator>Y</PaymentIndicator>
</Payments>
</CreateVoucher>
</soap:Body>
</soap:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
XML Service APIs Page 142
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:CreateVoucherReply xmlns:RRT="http://rrtechnologies.net/soap/">
<Voucher>
<Number>9998986W</Number>
<Expiry>06/24/2006</Expiry>
</Voucher>
</RRT:CreateVoucherReply>
</soap:Body>
</soap:Envelope>
Screenshot from Results Web:
Voucher Retrieval Service
Retrieves an existing voucher.
Signature:
[Visual Basic]
GetVoucher(VoucherNumber As String, Locator As String) As XmlNode
Parameters:
VoucherNumber
Alphanumeric voucher number
Locator
[Optional] Source record locator if voucher number is unknown.
Return values:
XML Service APIs Page 143
VoucherExpiry
The date the voucher expires
AppliedBookNo
This indicates the booking number the was used on
BookNo
This is the booking number from which the voucher is generated
FlightNo
This is the flight number this voucher was used on
FlightDate
This is the flight date for this voucher
Recipient
Name of the voucher recipient
Payer
Payer information for purchased vouchers
CancelDate
Cancellation date, if the voucher is cancelled.
PaymentMethod
The payment method for purchased vouchers
VoucherAmount
This is the amount of voucher
CreaUserCode
Creating user code for the voucher
CreaDestID
Destination id of the voucher creator
CreaDateTime
The date and time the voucher was created
UpdtUserCode
User code of the user that last modified this voucher
UpdtDestID
Destination id of the user that last modified this voucher
UpdtDateTime
Date and time of the last modification
VoucherNumber
Voucher number
UseFee
If a usage fee applies to this voucher, this is the usage fee amount.
XML Service APIs Page 144
RefundableFlag
This indicates if this is a refundable voucher, or if it was generated from a refundable fare.
FlightOrigin/FlightDestination
The origin and destination for the future flight
AgencyCode
Agency code, if this is an agency voucher
OriginVoucher
This is the original voucher number if this is a residual voucher
ClientProfileNo
This indicates if the passenger is in our client profile database
BusinessPassID
This indicates the Business Pass Rule Number if the voucher is a business pass voucher. If the value here is in
negative, then this is not a business pass voucher
Sample code:
[Visual Basic]
'retrieve voucher
Dim voucherService As New voucherService.voucherservice
voucherService.Url = ConfigurationSettings.AppSettings.GetValues("voucherURL")(0)
Dim voucherInfo As XmlNode = voucherService.GetVoucher(voucherNumber, Nothing)
Sample SOAP/XML request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
<RRT:Body>
<RRT:GetVoucher>
<VoucherNumber>0014552T</VoucherNumber>
</RRT:GetVoucher>
</RRT:Body>
</RRT:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetVoucherReply xmlns:RRT="http://rrtechnologies.net/soap/">
<Voucher VoucherNumber="0014552T">
<VoucherReason>GC</VoucherReason>
<VoucherExpiry>02/17/2007</VoucherExpiry>
<VoucherStatus>OPEN</VoucherStatus>
<BookNo>2664721</BookNo>
<AppliedBookNo/>
<Book_BookNo>2664721</Book_BookNo>
<Book_AppliedBookNo/>
<FlightNo/>
XML Service APIs Page 145
<FlightDate/>
<Recipient>
<Name>DOE/JOHN</Name>
<Addr1/>
<Addr2/>
<City/>
<State/>
<Zip/>
<Country/>
</Recipient>
<Payer>
<Name/>
<Addr1/>
<Addr2/>
<City/>
<State/>
<Zip/>
<Country/>
</Payer>
<CancelDate/>
<PaymentMethod/>
<VoucherAmount>111.96</VoucherAmount>
<CurrencyCode>USD</CurrencyCode>
<CCNumber/>
<CCExpiry/>
<VoucherNotes/>
<CreaUserCode>AIRIM</CreaUserCode>
<CreaDestID>RTFLL001</CreaDestID>
<CreaDateTime>2006/02/23/17/45/25</CreaDateTime>
<UpdtUserCode>AIRIM</UpdtUserCode>
<UpdtDestID>RTFLL001</UpdtDestID>
<UpdtDateTime>2006/02/23/17/45/25</UpdtDateTime>
<CommissionFlag>N</CommissionFlag>
<PercentFlag>N</PercentFlag>
<VoucherNumber>0014552T</VoucherNumber>
<Book_PnrBookNum>HNSTMN</Book_PnrBookNum>
<RecordLocator>HNSTMN</RecordLocator>
<AppliedRecordLocator/>
<UseFee/>
<RefundableFlag>Y</RefundableFlag>
<FlightOrigin/>
<FlightDestination/>
<AgencyCode>03542534</AgencyCode>
<OriginVoucher>0014342Z</OriginVoucher>
<ClientProfileNo/>
<BusinessPassID/>
</Voucher>
</RRT:GetVoucherReply>
</soap:Body>
</soap:Envelope>
This voucher is the residual voucher of 0014342Z which has an agency code 03542534 associated with it.
Agency Voucher List Retrieval
This is to get a list of agency vouchers.
XML Service APIs Page 146
Parameters:
AgencyCode
This is the agency for whom you want to retrieve the voucher list
Status
This is the status of the list of vouchers to retrieve. Options are OPEN, USED, EXPD, and CXLD.
Return Values:
All the return values are the same as in single voucher retrieval except
ReasonCode
This is the two-character voucher reason code
ReasonDescription
This is text description of the voucher reason code
Sample XML request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetVoucherList xmlns="http://rrtechnologies.net/soap/">
<AgencyCode>03542534</AgencyCode>
<Status>OPEN</Status>
</GetVoucherList>
</soap:Body>
</soap:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:GetVoucherListReply xmlns:RRT="http://rrtechnologies.net/soap/">
<GetVoucherList>
<AgencyVoucher>
<VoucherNumber>2999907</VoucherNumber>
<Status>OPEN</Status>
<Recipient>LYNN/VCHR</Recipient>
<Currency>USD</Currency>
<Amount>100.00</Amount>
<Locator />
<AppliedLocator />
<OriginalVoucherNumber>9999071V</OriginalVoucherNumber>
<AgencyCode>03542534</AgencyCode>
<ExpiryDate>07/09/2006</ExpiryDate>
<ReasonCode>AC</ReasonCode>
<ReasonDescription>Agency credit voucher</ReasonDescription>
<BusinessPassID>-2147483648</BusinessPassID>
</AgencyVoucher>
XML Service APIs Page 147
<AgencyVoucher>
...trunkated for readability...
</AgencyVoucher>
<AgencyVoucher>
<VoucherNumber>3000020</VoucherNumber>
...trunkated for readability...
</AgencyVoucher>
<AgencyVoucher>
<VoucherNumber>3000021</VoucherNumber>
<Status>OPEN</Status>
<Recipient>DOE/JOHN</Recipient>
<Currency>USD</Currency>
<Amount>500.00</Amount>
<Locator />
<AppliedLocator />
<OriginalVoucherNumber>0000213Z</OriginalVoucherNumber>
<AgencyCode>03542534</AgencyCode>
<ExpiryDate>08/24/2006</ExpiryDate>
<ReasonCode>RP</ReasonCode>
<ReasonDescription>test voucher</ReasonDescription>
<BusinessPassID>2</BusinessPassID>
</AgencyVoucher>
<AgencyVoucher>
...trunkated for readability...
</AgencyVoucher>
<AgencyVoucher>
...trunkated for readability...
</AgencyVoucher>
<AgencyVoucher>
...trunkated for readability...
</AgencyVoucher>
<AgencyVoucher>
<VoucherNumber>3001455</VoucherNumber>
<Status>OPEN</Status>
<Recipient>DOE/JOHN</Recipient>
<Currency>USD</Currency>
<Amount>111.96</Amount>
<Locator>HNSTMN</Locator>
<AppliedLocator />
<OriginalVoucherNumber>0014552T</OriginalVoucherNumber>
<AgencyCode>03542534</AgencyCode>
<ExpiryDate>02/17/2007</ExpiryDate>
<ReasonCode>GC</ReasonCode>
<ReasonDescription>Gift Certificate</ReasonDescription>
<BusinessPassID>-2147483648</BusinessPassID>
</AgencyVoucher>
</GetVoucherList>
</RRT:GetVoucherListReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 148
Flight Information Services
These services retrieve current flight status as well as update flight information.
Tuxedo service name: FLIFO_SERVICE.
Get Flight Status Service
Retrieves the current flight status information, such as scheduled/estimated/actual departure and arrival, delay
information etc.
Signature:
[Visual Basic]
GetFlightInformation(FlightNumber As String, FlightDate As String, DepartureAirport As String,
ArrivalAirport As String) As XmlNode
Parameters:
FlightNumber
Flight number (concatenated airline code and flight number)
FlightDate
Board date is US date format (MM/dd/yyyy)
DepartureAirport
Origin airport code
ArrivalAirport
Destination airport code
UpdtUserCode
User code of the last updating user
UpdtUserName
Last updating user name
Return values:
FlightNumber
Flight number (concatenated airline code and flight number).
BoardDate
Board date in US date format (MM/dd/yyyy)
DepartureAirport/ArrivalAirport
Origin and destination airport codes
SequenceNumber
TODO
XML Service APIs Page 149
ScheduledTimeOfDeparture
Scheduled departure time
EstimatedTimeOfDeparture
Estimated departure time or blank if no estimate has been specified
ActualTimeOfDeparture
Actual departure time or blank of the flight has not departed
ScheduledTimeOfArrival
Scheduled arrival time
EstimatedTimeOfArrival
Estimated arrival time or blank if no estimate has been specified
ActualTimeOfArrival
Actual arrival time or blank if the flight has not arrived
DelayTimeForDeparture
Departure delay in minutes
DelayTimeForArrival
Arrival delay in minutes
DelayCode
Delay code describing the delay reason
DelayCodeDescription
Textual description of the delay code
DelayDescription
Textual delay description
Remarks
Flight remarks
SupplementaryComment
Additional comments
UpdtUserCode
User code of the last updating user
UpdtUserName
Last updating user name
UpdtDestID
Last updating destination id
UpdtDateTime
Last updated date and time
Sample code:
[Visual Basic]
XML Service APIs Page 150
Dim flifo As New flightInfoService.flifoservice
flifo.Url = ConfigurationSettings.AppSettings.GetValues("flightStatusURL")(0)
Dim flightStatusInfo As XmlNode = flifo.GetFlightInformation(flightNumber,
boardDate.ToString("MM/dd/yyyy", GetSystemDateFormatProvider()), originAirport,
destinationAirport)
Sample SOAP/XML request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
<RRT:Body>
<RRT:GetFlightInformation>
<FlightNumber>RT900</FlightNumber>
<FlightDate>08/22/2004</FlightDate>
<DepartureAirport>FLL</DepartureAirport>
<ArrivalAirport>DTW</ArrivalAirport>
<UpdtUserCode/>
<UpdtUserName/>
</RRT:GetFlightInformation>
</RRT:Body>
</RRT:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="http://schemas.xmlsoap.org/soap/envelope/">
<RRT:Header/>
<RRT:Body>
<RRT:GetFlightInformationReply>
<FlightInformation>
<FlightNumber>RT900</FlightNumber>
<BoardDate>08/22/2004</BoardDate>
<DepartureAirprot>FLL</DepartureAirprot>
<ArrivalAirport>DTW</ArrivalAirport>
<SequenceNumber/>
<ScheduledTimeOfDeparture>06:30</ScheduledTimeOfDeparture>
<EstimatedTimeOfDeparture/>
<ActualTimeOfDeparture/>
<ScheduledTimeOfArrival>09:25</ScheduledTimeOfArrival>
<EstimatedTimeOfArrival/>
<ActualTimeOfArrival/>
<DelayTimeForDeparture>0</DelayTimeForDeparture>
<DelayTimeForArrival>0</DelayTimeForArrival>
<DelayCode/>
<DelayCodeDescription/>
<DelayDescription/>
<Remarks/>
<SupplementaryComment/>
<UpdtUserCode/>
<UpdtUserName/>
<UpdtDestID/>
<UpdtDateTime/>
</FlightInformation>
</RRT:GetFlightInformationReply>
</RRT:Body>
</RRT:Envelope>
XML Service APIs Page 151
Set Flight Status Service
Sets or updates flight status information for a flight.
Signature:
Parameters:
FlightNumber
FlightDate
DepartureAirport/ ArrivalAirport
EstimatedTimeOfDeparture
EstimatedTimeOfArrival
Sample code:
Sample SOAP/XML request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
<RRT:Body>
<RRT:SetFlightInformation>
<FlightNumber>RT001</FlightNumber>
<FlightDate>05/05/2005</FlightDate>
<DepartureAirport>FLL</DepartureAirport>
<ArrivalAirport>DTW</ArrivalAirport>
<EstimatedTimeOfDeparture>1350</EstimatedTimeOfDeparture>
<EstimatedTimeOfArrival>1550</EstimatedTimeOfArrival>
</RRT:SetFlightInformation>
</RRT:Body>
</RRT:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:SetFlightInformationReply xmlns:RRT="http://rrtechnologies.net/soap/"/>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 152
Client Profile Services
To create, retrieve, and modify client/employee profile related information.
The RRT application generates an automatic value for the ClientPrflNo field. If the system using the RRT client profile
API needs to generate it’s own profile ID, the AltClientPrflNo field should be used. Once it is set to a value using the
CreateProfile or ModifyProfile APIs, It can be used instead of the ClientPrflNo node in the GetProfile and
ClientProfileLoing API calls.
When creating bookings with the SubmitBooking API, you still have to use the system generated ClientPrflNo value
for the client profile id of the passenger. So if the system using the RRT API is using the AltClientPrflNo for client profile
operations, before creating bookings that belong to a particular profile, the GetProfile API should be used to retrieve the
system generated ClientPrflNo value for a particular AltClientPrflNo value.
Tuxedo service name: PROFILE_SERVICE.
Create Profile
Parameters:
ClientName
This should be the client’s last name. This is required
PassCode
The client’s passenger type code. Example: ADULT; INF
ProfileType
Type of clients. Values can be I (Individual) or C (Company)
CompanyPrflNo
Company profile number if the ProfileType is Company. Empty if ProfileType is not Company
CompanyName
Name of the company if ProfileType is Company. Empty if ProfileType is not Company
ClientTitle
Title of the client. Example: Mr.; Mrs.
FirstName
Client’s first name. This is required
BranchCode
The branch code where this profile is created
BusinessTitle
Client’s business title
SecretaryName
Client’s secretary name
FileExpryDate
Date this profile expires. Default is one year from creation date
XML Service APIs Page 153
ScrutinyFlag
Flag to indicate if the client is one on the list. Values can be Y or N
UserCode
This should indicate from where the profile is created. If value is WEB, it is created on the Web; if value is a Results
user code, then it is created by that user
CompanyCode
Airline code the profile belongs to
ContactDetails
This is the wrapper node for all contact information
ContactDetail
This is the wrapper node for each ContactType
ContactType
This indicates the type of contact. Values can be H (Home) or B (Business)
Address
City
State
Zip
Nation
PhoneNo
MobileNo
FaxNo
EmailAddress
Client’s Email address. This is required
Action
Action that is taken on the contact information. Default is Insert
Documents
This is the wrapper node for all the document nodes
Document
This is the wrapper node for this specific document
DocumentCategory
Document category. Values can be DL (Driver License); Passport; and Social Security Card
DocumentType
Type of document this document category belongs to. Values can be OT (Other)
DocumentNo
Number of this specific document. It can be driver license number; passport number; or social security number
DocmExpiryDate
Date this document expires
LastUsedDate
Last date the document was used with the airline
XML Service APIs Page 154
DocmIssueDate
Date the document was issued
Action
Action to be taken on this document. Default is Insert
SeqnNo
Sequential number of this document in the Document node
Remarks
This is the wrapper node for all the Remark nodes
Remark
This is the wrapper node for this Remark
RemarkType
Remark Type. Default values is T (Text)
RemarkText
Contents of the Remark text. Default is client’s computer IP address. Example: Source IP: 192.168.112.64
SeqnNo
Sequential number of this remark in the Remark node
Requests
This is the wrapper node for all Request nodes
Request
This is the wrapper node for this Request
Indicator
This indicates if the Request is SSR (S) or OSI (O)
RequestCode
The code for this SSR/OSI. Example: WCOB (Wheel Chair on Board)
CarrierCode
Airline code that uses this RequestCode. Default is YY (All Airlines)
ActionCode
Action code (or Status Code) for this Request. Example: HK (Confirmed)
ActionNumber
Sequential number of action code applied on this Request
RequestText
Text message that goes with the Request
Action
Action to be taken on this Request. Default is Insert
SeqnNo
Sequential number of action to be taken on this Request
XML Service APIs Page 155
Return Values:
CreateProfile
This is the wrapper node for the response
ClientPrflNo
This is the Client Profile Number generated. It is a 15-character string
Sample SOAP/XML request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<CreateProfile xmlns="http://rrtechnologies.net/soap/">
<ClientName>DOE</ClientName>
<PassCode>ADULT</PassCode>
<ProfileType>I</ProfileType>
<CompanyPrflNo />
<CompanyName />
<ClientTitle>MS</ClientTitle>
<FirstName>JOHN</FirstName>
<BranchCode>RT FLL 0001</BranchCode>
<BusinessTitle />
<SecretaryName />
<FileExpryDate>07/27/2006</FileExpryDate>
<ScrutinyFlag>N</ScrutinyFlag>
<UserCode>WEB</UserCode>
<CompanyCode>RT</CompanyCode>
<PasswordHash>67588486396CA454C5F7F1C470A1074D</PasswordHash>
<ContactDetails>
<ContactDetail>
<ContactType>H</ContactType>
<Address />
<City />
<State />
<Zip />
<Nation />
<PhoneNo />
<MobileNo />
<FaxNo />
<EmailAddress>JOHN@RRTECHNOLOGIES.NET</EmailAddress>
<Action>Insert</Action>
</ContactDetail>
<ContactDetail>
<ContactType>B</ContactType>
<Address />
<City />
<State />
<Zip />
<Nation />
<PhoneNo />
<MobileNo />
<FaxNo />
<EmailAddress />
XML Service APIs Page 156
<Action>Insert</Action>
</ContactDetail>
</ContactDetails>
<Documents>
<Document>
<DocumentCategory>DL</DocumentCategory>
<DocumentType>OT</DocumentType>
<DocumentNo>L01324326345346</DocumentNo>
<DocmExpiryDate>01/01/0001</DocmExpiryDate>
<LastUsedDate>01/01/0001</LastUsedDate>
<DocmIssueDate>01/01/0001</DocmIssueDate>
<Action>Insert</Action>
<SeqnNo>1</SeqnNo>
</Document>
</Documents>
<Remarks>
<Remark>
<RemarkType>T</RemarkType>
<RemarkText>Source IP: 192.168.112.64</RemarkText>
<SeqnNo>0</SeqnNo>
</Remark>
</Remarks>
<Requests>
<Request>
<Indicator>S</Indicator>
<RequestCode>WCOB</RequestCode>
<CarrierCode>YY</CarrierCode>
<ActionCode>HK</ActionCode>
<AtionNumber>1</AtionNumber>
<RequestText>ONE</RequestText>
<Action>Insert</Action>
<SeqnNo>1</SeqnNo>
</Request>
</Requests>
</CreateProfile>
</soap:Body>
</soap:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:CreateProfileReply xmlns:RRT="http://rrtechnologies.net/soap/">
<CreateProfile>
<ClientPrflNo>LXXZ00000000069</ClientPrflNo>
</CreateProfile>
</RRT:CreateProfileReply>
</soap:Body>
</soap:Envelope>
Get Profile
Parameters:
XML Service APIs Page 157
ClienPrflNo
This is the number of the client/employee to retrieve
UserCode
This is from where the retrieval request is initiated. Example: WEB
CompanyCode
This is the airline code this profile belongs. In most cases, this is your airline code
BranchCode
This is the branch code where this profile is created
IncludePastBookings
Values can be true or false. This allows retrieval of past bookings with the client profile. Default is false
Return values:
ClientName
This should be the client’s last name
PassCode
The client’s passenger type code. Example: ADULT; INF
ProfileType
Type of clients. Values can be I (Individual) or C (Company)
CompanyPrflNo
Company profile number if the ProfileType is Company. Empty if ProfileType is not Company
CompanyName
Name of the company if ProfileType is Company. Empty if ProfileType is not Company
ClientTitle
Title of the client. Example: Mr.; Mrs.
FirstName
Client’s first name
BranchCode
The branch code where this profile is created
BusinessTitle
Client’s business title
SecretaryName
Client’s secretary name
TravTotalMiles
Total miles traveled. This is used in Frequent Flyer Program
TravExpenses
Total travel expenses
XML Service APIs Page 158
StartDate
Date the client starts the Frequent Flyer Program
BirthDate
Client’s birth date
AnniversaryDate
Client’s anniversary date
FileExpryDate
Date this profile expires. Default is one year from creation date
ScrutinyFlag
Flag to indicate if the client is one on the list. Values can be Y or N
UserCode
This should indicate from where the profile is created. If value is WEB, it is created on the Web
CompanyCode
Airline code the profile belongs to
ContactDetails
This is the wrapper node for all contact information
ContactDetail
This is the wrapper node for each ContactType
ContactType
This indicates the type of contact. Values can be C (Company), H (Home), or B (Business)
Address
City
State
Zip
Nation
PhoneNo
MobileNo
FaxNo
EmailAddress
Client’s Email address
ClientFamilyDetails
This is the wrapper node for all ClientFamilyDetail nodes
ClientFamilyDetail
This is the wrapper node for this ClientFamilyDetail
SeqnNo
This is the sequential number for this ClientFamilyDetail in this node
XML Service APIs Page 159
FamilyType
FamilyName
Client family member’s last name
FirstName
Client family member’s first name
Title
Initial
BirthDate
AnniversaryDate
ClientPreferenceDetails
This is the wrapper node for all the ClientPreferenceDetails nodes
ClientRemarkDetails
This is the wrapper node for all the ClientRemarkDetail nodes
ClientRemarkDetail
This is the wrapper node for this ClientRemarkDetail
SeqnNo
This is the sequential number of this ClientRemarkDetail
RemarkType
Remark Type. Default values is T (Text)
RemarkText
Contents of the RemarkText. Default is client’s computer IP address. Example: Source IP: 192.168.112.64
SeqnNo
Sequential number of this remark in the Remark node
Requests
This is the wrapper node for all Request nodes
Request
This is the wrapper node for this Request
Indicator
This indicates if the Request is SSR (S) or OSI (O)
RequestCode
The code for this SSR/OSI. Example: WCOB (Wheel Chair on Board)
CarrierCode
Airline code that uses this RequestCode. Default is YY (All Airlines)
ActionCode
Action code (or Status Code) for this Request. Example: HK (Confirmed)
XML Service APIs Page 160
ActionNumber
Sequential number of action code applied on this Request
RequestText
Text message that goes with the Request
Action
Action to be taken on this Request. Default is Insert
SeqnNo
Sequential number of action to be taken on this Request
ClientBookingDetails
The wrapper node that contains all of the client’s bookings, past and future
ClientBookingDetail
The wrapper node that contains the information of a specific booking
BookNo
Locator
FlightNumber
FlightDate
DeprAirport
Arrvairport
DeprTime
ArrivalTime
SellingClass
FareAmount
CurrencyCode
ClientTravelDetail
XML Service APIs Page 161
ClientVoucherDetails
This is the wrapper node for all ClientVoucherDetail nodes. This is present when there are vouchers (of all status) in
the client profile
ClientVoucherDetail
This is the wrapper node for this ClientVoucherDetail
VoucherNumber
Voucher Number
VoucherReason
Voucher reason code as defined in Results Voucher Reason Code Table
VoucherExpiry
Voucher expiration date
VoucherStatus
Voucher Status. Values can be OPEN, USED, EXPD, and CXLD
RecipientName
Voucher recipient’s name
CancelDate
Date the voucher is canceled
VoucherAmount
Voucher Amount
CurrencyCode
Voucher currency code
Notes
This field contains notes that apply to this voucher. Example: Remainder of :9990284L, meaning this voucher is the
residual of a previous voucher. 9990284L is the previous voucher number
Sample SOAP/XML request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetProfile xmlns="http://rrtechnologies.net/soap/">
<ClientPrflNo>WNGM00000085</ClientPrflNo>
<UserCode>WEB</UserCode>
<CompanyCode>RT</CompanyCode>
<BranchCode>RT FLL 0001</BranchCode>
<IncludePastBookings>true</IncludePastBookings>
</GetProfile>
</soap:Body>
</soap:Envelope>
Sample response:
XML Service APIs Page 162
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetProfileReply xmlns:RRT="http://rrtechnologies.net/soap/">
<ClientProfile AltClientPrflNo="WANG" ClientPrflNo="WNGM00000085">
<ClientName>WANG</ClientName>
<PassCode>ADULT</PassCode>
<ProfileType>I</ProfileType>
<CompanyPrflNo/>
<CompanyName/>
<ClientTitle/>
<ClientInitial/>
<FirstName>MEIHUA</FirstName>
<BranchCode>RT FLL 0001</BranchCode>
<BusinessTitle>DBA</BusinessTitle>
<SecretaryName/>
<TravTotalMiles>-9999</TravTotalMiles>
<TravExpenses>-9999.00</TravExpenses>
<StartDate>05/25/2007</StartDate>
<BirthDate>12/30/1899</BirthDate>
<AnniversaryDate>12/30/1899</AnniversaryDate>
<FileExpryDate>05/25/2007</FileExpryDate>
<ScrutinyFlag>N</ScrutinyFlag>
<PasswordHash>AE2B1FCA515949E5D54FB22B8ED95575</PasswordHash>
<ClientContactDetails>
<ClientContactDetail>
<ContactType>B</ContactType>
<Address/>
<City/>
<State/>
<Zip/>
<Nation/>
<PhoneNo/>
<MobileNo/>
<FaxNo/>
<EmailAddress/>
</ClientContactDetail>
<ClientContactDetail>
<ContactType>C</ContactType>
<Address/>
<City/>
<State/>
<Zip/>
<Nation/>
<PhoneNo/>
<MobileNo/>
<FaxNo/>
<EmailAddress/>
</ClientContactDetail>
<ClientContactDetail>
<ContactType>H</ContactType>
<Address/>
<City/>
<State/>
XML Service APIs Page 163
<Zip/>
<Nation/>
<PhoneNo/>
<MobileNo/>
<FaxNo/>
<EmailAddress/>
</ClientContactDetail>
</ClientContactDetails>
<ClientDocumentDetails/>
<ClientFamilyDetails/>
<ClientPreferenceDetails/>
<ClientRemarkDetails/>
<ClientRequestDetails>
<ClientRequestDetail>
<SeqnNo>1</SeqnNo>
<Indicator>S</Indicator>
<RequestCode>WCOB</RequestCode>
<CarrierCode>YY</CarrierCode>
<ActionCode>HK</ActionCode>
<ActionNumber />
<RequestText />
</ClientRequestDetail>
</ClientRequestDetails>
<ClientBookingDetails>
<ClientBookingDetail>
<BookNo>2678006</BookNo>
<Locator>HNVFQD</Locator>
<FlightNumber>RT675</FlightNumber>
<FlightDate>05/26/2007</FlightDate>
<DeprAirport>FLL</DeprAirport>
<ArrvAirport>LGA</ArrvAirport>
<DepartureTime>15:32</DepartureTime>
<ArrivalTime>17:50</ArrivalTime>
<SellingClass>C</SellingClass>
<FareAmount>166.51</FareAmount>
<CurrencyCode>USD</CurrencyCode>
</ClientBookingDetail>
</ClientBookingDetails>
<ClientTravelDetails/>
<ClientVoucherDetails>
<ClientVoucherDetail>
<VoucherNumber>9999340L</VoucherNumber>
<VoucherReason>BA</VoucherReason>
<VoucherExpiry>08/24/2008</VoucherExpiry>
<VoucherStatus>USED</VoucherStatus>
<RecipientName>WANG/MEIHUA</RecipientName>
<CancelDate />
<VoucherAmount>807.98</VoucherAmount>
<CurrencyCode>USD</CurrencyCode>
<Notes>Remainder of :9990284L</Notes>
</ClientVoucherDetail>
</ClientVoucherDetails>
<ClientEmployeeDetails/>
<ClientEmployeeFamily/>
<ClientEmployeeBuddyPasses/>
</ClientProfile>
</RRT:GetProfileReply>
XML Service APIs Page 164
</soap:Body>
</soap:Envelope>
Modify Proflie
Parameters:
Action
The action to take on a node. Values can be Insert, Update, and Delete
Return value:
ClientPrflNo
Client’s profile number
Sample SOAP/XML request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<ModifyProfile xmlns="http://rrtechnologies.net/soap/">
<ClientPrflNo>WNGM00000085</ClientPrflNo>
<ClientName>WANG</ClientName>
<PassCode>ADULT</PassCode>
<ProfileType>I</ProfileType>
<CompanyName />
<ClientTitle />
<FirstName>MEIHUA</FirstName>
<BranchCode>RT FLL 0001</BranchCode>
<BusinessTitle>ORACLE DB PROGRAMMER</BusinessTitle>
<SecretaryName />
<BirthDate>12/30/1978</BirthDate>
<FileExpryDate>05/28/2008</FileExpryDate>
<ScrutinyFlag>N</ScrutinyFlag>
<UserCode>WEB</UserCode>
<CompanyCode>RT</CompanyCode>
<ContactDetails>
<ContactDetail>
<ContactType>H</ContactType>
<Address />
<City />
<State />
<Zip />
<Nation />
<PhoneNo>9545551212</PhoneNo>
<MobileNo />
<FaxNo />
<EmailAddress>MEIHUA@YAHOO.COM</EmailAddress>
<Action>Update</Action>
</ContactDetail>
<ContactDetail>
<ContactType>B</ContactType>
XML Service APIs Page 165
<Address />
<City />
<State />
<Zip />
<Nation />
<PhoneNo />
<MobileNo />
<FaxNo />
<EmailAddress />
<Action>Update</Action>
</ContactDetail>
</ContactDetails>
<Documents>
<Document>
<DocumentCategory>PP</DocumentCategory>
<DocumentType>OT</DocumentType>
<DocumentNo>WM12345678</DocumentNo>
<DocmExpiryDate>01/01/0001</DocmExpiryDate>
<LastUsedDate>01/01/0001</LastUsedDate>
<DocmIssueDate>01/01/0001</DocmIssueDate>
<Action>Insert</Action>
<SeqnNo>1</SeqnNo>
</Document>
</Documents>
<FamilyDetails>
<FamilyDetail>
<FamilyType>C</FamilyType>
<FamilyName>WANG</FamilyName>
<FirstName>TIM</FirstName>
<Title />
<Initial />
<BirthDate>06/01/1998</BirthDate>
<Action>Insert</Action>
<SeqnNo>1</SeqnNo>
</FamilyDetail>
<FamilyDetail>
<FamilyType>S</FamilyType>
<FamilyName>WANG</FamilyName>
<FirstName>CAROL</FirstName>
<Title />
<Initial />
<BirthDate>05/01/1972</BirthDate>
<Action>Insert</Action>
<SeqnNo>2</SeqnNo>
</FamilyDetail>
</FamilyDetails>
<Remarks>
<Remark>
<RemarkType>T</RemarkType>
<RemarkText>Source IP: 192.168.112.3 (127.0.0.1)</RemarkText>
<SeqnNo>0</SeqnNo>
</Remark>
</Remarks>
<Requests>
<Request>
<Indicator>S</Indicator>
<RequestCode>WCOB</RequestCode>
XML Service APIs Page 166
<CarrierCode>RT</CarrierCode>
<ActionCode>HK</ActionCode>
<ActionNumber>1</ActionNumber>
<RequestText>NEED ONE</RequestText>
<Action>Insert</Action>
<SeqnNo>1</SeqnNo>
</Request>
</Requests>
</ModifyProfile>
</soap:Body>
</soap:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:ModifyProfileReply xmlns:RRT="http://rrtechnologies.net/soap/">
<UpdateProfile>
<ClientPrflNo>WNGM00000085</ClientPrflNo>
<AltClientPrflNo />
</UpdateProfile>
</RRT:ModifyProfileReply>
</soap:Body>
</soap:Envelope>
Client Profile Login
Parameters:
ClientPrflNo
Return values:
LoginResult
This is the wrapper node for the response
AccessGranted
Values can be “true” (for granted) or “false” (for login failure)
ClientPrflNo
Sample SOAP/XML request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<ClientProfileLogin xmlns="http://rrtechnologies.net/soap/">
<ClientPrflNo>LSNL00000000064</ClientPrflNo>
<PasswordHash>AF1D1E4690898BF89AB8CCFF29F66AEF</PasswordHash>
</ClientProfileLogin>
XML Service APIs Page 167
</soap:Body>
</soap:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:ClientProfileLoginReply xmlns:RRT="http://rrtechnologies.net/soap/">
<LoginResult>
<AccessGranted>true</AccessGranted>
<ClientPrflNo>LSNL00000000064</ClientPrflNo>
</LoginResult>
</RRT:ClientProfileLoginReply>
</soap:Body>
</soap:Envelope>
Employee Profile Service
Client Profile Service is enhanced to handle employee profile update. The following is a list of tasks this service can
handle:
1. Retrieve employee information by making GetProfile call. You will see in the response a different PassCode than
that of a normal client profile. Also in addition to all other client profile nodes a ClientEmployeeDetails node is in the
response. These indicate this client is also an employee.
XML input:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetProfile xmlns="http://rrtechnologies.net/soap/">
<ClientPrflNo>RTSA1107</ClientPrflNo>
<UserCode>WEB</UserCode>
<CompanyCode>RT</CompanyCode>
<BranchCode>RT FLL 0001</BranchCode>
<IncludePastBookings>true</IncludePastBookings>
</GetProfile>
</soap:Body>
</soap:Envelope>
Response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetProfileReply xmlns:RRT="http://rrtechnologies.net/soap/">
<ClientProfile AltClientPrflNo="" ClientPrflNo="NKSA1107">
XML Service APIs Page 168
<ClientName>EVENCHEKE</ClientName>
<PassCode>SA4</PassCode>
<ProfileType>I</ProfileType>
<CompanyPrflNo/>
<CompanyName/>
<ClientTitle/>
<ClientInitial>L</ClientInitial>
<FirstName>LYNN</FirstName>
<BranchCode>RT FLL 0001</BranchCode>
<BusinessTitle/>
<HomeAddress>123 main</HomeAddress>
<HomeCity>miami</HomeCity>
<HomeState>fl</HomeState>
<HomeZip>33178</HomeZip>
<HomeNation>usa</HomeNation>
<BussAddress/>
<BussCity/>
<BussState/>
<BussZip/>
<BussNation/>
<ContactAddress/>
<ContactCity/>
<ContactState/>
<ContactZip/>
<ContactNation/>
<AgentAddress/>
<AgentCity/>
<AgentState/>
<AgentZip/>
<AgentNation/>
<MailAddress/>
<MailCity/>
<MailState/>
<MailZip/>
<MailNation/>
<HomePhoneNo>9545551212</HomePhoneNo>
<BussPhoneNo/>
<ContactPhoneNo/>
<AgentPhoneNo/>
<ClientFaxNo/>
<CarrierCodes/>
<HotelCodes/>
<CarRentalCodes/>
<SeatTypes/>
<SportHobbies/>
<HolidayDests/>
<HolidayTypes/>
<SecretaryName/>
<TravTotalMiles>-2147483648</TravTotalMiles>
<TravExpenses>nan</TravExpenses>
<StartDate/>
<BirthDate>11/01/1966</BirthDate>
<AnniversaryDate/>
<FileExpryDate>11/01/2107</FileExpryDate>
<ScrutinyFlag>N</ScrutinyFlag>
<PasswordHash/>
<ClientContactDetails/>
XML Service APIs Page 169
<ClientDocumentDetails/>
<ClientFamilyDetails/>
<ClientPreferenceDetails/>
<ClientRemarkDetails/>
<ClientRequestDetails/>
<ClientBookingDetails>
<ClientBookingDetail>
<BookNo>2683785</BookNo>
<Locator>HNVVSJ</Locator>
<FlightNumber>RT1121</FlightNumber>
<FlightDate>11/12/2007</FlightDate>
<DeprAirport>FLL</DeprAirport>
<ArrvAirport>CUN</ArrvAirport>
<DepartureTime>06:30</DepartureTime>
<ArrivalTime>09:30</ArrivalTime>
<SellingClass>Y</SellingClass>
<FareAmount>0.00</FareAmount>
<CurrencyCode>USD</CurrencyCode>
</ClientBookingDetail>
</ClientBookingDetails>
<ClientTravelDetails/>
<ClientVoucherDetails/>
<ClientEmployeeDetails>
<ClientEmployeeDetail>
<EmployeeNumber>RTSA1107</EmployeeNumber>
<DepartmentID>-2147483648</DepartmentID>
<HireDate>11/01/1999</HireDate>
<TerminationDate/>
<EmploymentStatus>A</EmploymentStatus>
<FullTimeFlag>Y</FullTimeFlag>
<ReturnToWorkDate/>
<NationalIdentityNo>TSA0000001</NationalIdentityNo>
<JobTitle/>
<Remarks/>
<JumpSeatCode/>
<SuspensionDate/>
<TravelStartDate>11/01/2000</TravelStartDate>
<TravelEndDate/>
<DepartmentName>Administration</DepartmentName>
<BuddyPassCode>SA7</BuddyPassCode>
</ClientEmployeeDetail>
</ClientEmployeeDetails>
<ClientEmployeeFamily>
<EmployeeFamilyMember>
<LastName>EVENCHEKE</LastName>
<FirstName>SARA</FirstName>
<Relationship>Spouse</Relationship>
<PassCode>SA5</PassCode>
<BirthDate>12/11/1971</BirthDate>
</EmployeeFamilyMember>
<EmployeeFamilyMember>
<LastName>EVENCHEKE</LastName>
<FirstName>GIRL</FirstName>
<Relationship>Child</Relationship>
<PassCode>SA5</PassCode>
<BirthDate>12/11/1998</BirthDate>
</EmployeeFamilyMember>
XML Service APIs Page 170
</ClientEmployeeFamily>
<ClientEmployeeBuddyPasses>
<ClientEmployeeBuddyPass>
<EmployeeNumber>RTSA1107_4B7C7</EmployeeNumber>
<ActiveFlag>A</ActiveFlag>
<BookNumber/>
<ValidFromDate>11/01/2007</ValidFromDate>
<ValidUntilDate>11/01/2008</ValidUntilDate>
<Remarks/>
</ClientEmployeeBuddyPass>
</ClientEmployeeBuddyPasses>
</ClientProfile>
</RRT:GetProfileReply>
</soap:Body>
</soap:Envelope>
2. Adding/Modifying employee personal information by making the ModifyEmployeeProfile call.
XML input:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
<RRT:Body>
<RRT:ModifyEmployeeProfile timing_in_reply="yes">
<ClientProfile>
<UserCode>WEB</UserCode>
<CompanyCode>RT</CompanyCode>
<ClientPrflNo>RTSA1234</ClientPrflNo>
<BranchCode>RT FLL 0001</BranchCode>
<ClientName>DOE</ClientName>
<PassCode>SA4</PassCode>
<ProfileType>I</ProfileType>
<CompanyPrflNo/>
<CompanyName/>
<ClientTitle/>
<ClientInitial>C</ClientInitial>
<FirstName>ZHIGUO</FirstName>
<BranchCode>RT FLL 0001</BranchCode>
<BusinessTitle/>
<SecretaryName/>
<TravTotalMiles>-2147483648</TravTotalMiles>
<TravExpenses>nan</TravExpenses>
<StartDate/>
<BirthDate>10/22/1950</BirthDate>
<AnniversaryDate/>
<FileExpryDate>10/17/2107</FileExpryDate>
<ScrutinyFlag>N</ScrutinyFlag>
<PasswordHash/>
<ClientContactDetails>
<ClientContactDetail>
<ContactType>B</ContactType>
<Address/>
<City/>
<State/>
<Zip/>
XML Service APIs Page 171
<Nation/>
<PhoneNo/>
<MobileNo/>
<FaxNo/>
<EmailAddress/>
</ClientContactDetail>
<ClientContactDetail>
<ContactType>C</ContactType>
<Address/>
<City/>
<State/>
<Zip/>
<Nation/>
<PhoneNo/>
<MobileNo/>
<FaxNo/>
<EmailAddress/>
</ClientContactDetail>
<ClientContactDetail>
<ContactType>H</ContactType>
<Address/>
<City/>
<State/>
<Zip/>
<Nation/>
<PhoneNo/>
<MobileNo/>
<FaxNo/>
<EmailAddress/>
</ClientContactDetail>
</ClientContactDetails>
<ClientDocumentDetails/>
<ClientFamilyDetails/>
<ClientPreferenceDetails/>
<ClientDocumentDetails/>
<ClientFamilyDetails/>
<ClientPreferenceDetails/>
<ClientRemarkDetails/>
<ClientRequestDetails/>
<ClientBookingDetails/>
<ClientTravelDetails/>
<ClientVoucherDetails/>
<ClientEmployeeDetails>
<ClientEmployeeDetail>
<EmployeeNumber>RTSA1234</EmployeeNumber>
<DepartmentID>-2147483648</DepartmentID>
<HireDate>10/22/1988</HireDate>
<TerminationDate/>
<EmploymentStatus>A</EmploymentStatus>
<FullTimeFlag>Y</FullTimeFlag>
<ReturnToWorkDate/>
<NationalIdentityNo/>
<JobTitle/>
<Remarks/>
<JumpSeatCode/>
<SuspensionDate/>
<TravelStartDate>10/22/1989</TravelStartDate>
XML Service APIs Page 172
<TravelEndDate/>
<DepartmentName/>
<BuddyPassCode>SA7</BuddyPassCode>
</ClientEmployeeDetail>
</ClientEmployeeDetails>
<ClientEmployeeFamily/>
<ClientEmployeeBuddyPasses/>
</ClientProfile>
</RRT:ModifyEmployeeProfile>
</RRT:Body>
</RRT:Envelope>
Response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:ModifyEmployeeProfileReply xmlns:RRT="http://rrtechnologies.net/soap/">
<UpdateProfile>
<ClientPrflNo>RTSA1234</ClientPrflNo>
<AltClientPrflNo/>
</UpdateProfile>
<timing>
<start>2007-10-22 16:03:05</start>
<end>2007-10-22 16:03:05</end>
<duration>1278.33 </duration>
<overall>1358.20 </overall>
</timing>
</RRT:ModifyEmployeeProfileReply>
</soap:Body>
</soap:Envelope>
3. Adding/Modifying employee family members information by the ModifyEmployeeProfile call.
Sample XML input:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<RRT:ModifyEmployeeProfile timing_in_reply="yes">
<UserCode>WEB</UserCode>
<CompanyCode>RT</CompanyCode>
<ClientPrflNo>RTSA1127</ClientPrflNo>
<BranchCode>RT FLL 0001</BranchCode>
<ClientEmployeeFamily>
<EmployeeFamilyMember>
<LastName>BLACK</LastName>
<FirstName>WIFEE</FirstName>
<Relationship>Spouse</Relationship>
<BirthDate>11/28/1971</BirthDate>
XML Service APIs Page 173
<PassCode>SA5</PassCode>
<ClientPrflNo>RTSA1127_1</ClientPrflNo>
<Action>Insert</Action>
</EmployeeFamilyMember>
<EmployeeFamilyMember>
<LastName>BLACK</LastName>
<FirstName>GIRLIE</FirstName>
<Relationship>Child</Relationship>
<BirthDate>11/28/1991</BirthDate>
<PassCode>SA5</PassCode>
<ClientPrflNo>RTSA1127_2</ClientPrflNo>
<Action>Insert</Action>
</EmployeeFamilyMember>
</ClientEmployeeFamily>
</RRT:ModifyEmployeeProfile>
</soap:Body>
</soap:Envelope>
This is to insert two family members (Spouse and Child) for employee RTSA1127. Other actions are Update (which is
to update existing family member information) and Delete (which is to delete an existing family member).
After execution of the request, system retursn:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:ModifyEmployeeProfileReply xmlns:RRT="http://rrtechnologies.net/soap/">
<UpdateProfile>
<ClientPrflNo>RTSA1127</ClientPrflNo>
<AltClientPrflNo/>
</UpdateProfile>
<timing>
<start>2007-11-27 14:44:07</start>
<end>2007-11-27 14:44:08</end>
<duration>1278.33 ms</duration>
<overall>1288.67 ms</overall>
</timing>
</RRT:ModifyEmployeeProfileReply>
</soap:Body>
</soap:Envelope>
If you retrieve the employee profile from Results GUI, you will see the new family members.
4. Modify a single field of the employee information by making UpdateEmployeeEntry call.
Input XML:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
<RRT:Body>
<RRT:UpdateEmployeeEntry timing_in_reply="yes">
XML Service APIs Page 174
<ClientPrflNo>SEC12345</ClientPrflNo>
<TblFieldName>department_name</TblFieldName>
<TblFieldType>string</TblFieldType>
<FieldValue>Administration</FieldValue>
</RRT:UpdateEmployeeEntry>
</RRT:Body>
</RRT:Envelope>
This request is to update the department name for the employee from whatever value to Administration.
Response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:UpdateEmployeeEntryReply xmlns:RRT="http://rrtechnologies.net/soap/">
<timing>
<start>2007-10-23 11:27:20</start>
<end>2007-10-23 11:27:21</end>
<duration>178.85 ms</duration>
<overall>280.97 ms</overall>
</timing>
</RRT:UpdateEmployeeEntryReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 175
Schedule Service
To retrieve flight schedules between two airports on a specific date.
Tuxedo service name: SCHEDULE_SVC.
Signature:
[Visual Basic]
GetSchedule(StartCity As String, EndCity As String, FlightNumber As String, StartDate As String,
EndDate As String) As XmlElement
Parameters:
StartCity
Three character city code for the origin city
EndCity
Three character city code for the destination city
FlightNumber
Flight number filter (airline code and number). This is optional
StartDate
First travel date in US date format (mm/dd/yyyy). This is optional
EndDate
Last travel date in US date format (mm/dd/yyyy). This is optional
Return values:
Schedule
This is a wrapper node for the response
Flight FlightNum
This a wrapper node for each flight schedule returned
Departure
Arrival
StartDate
This is the start date of the flight operational period. It may or may not correspond to the input StartDate in the input
file
EndDate
This is the end date of the flight operational period. It may or may not correspond to the input EndDate in the input
file
XML Service APIs Page 176
DepartureTime
ArrivalTime
FrequencyCode
FlightNumber
AircraftCode
ViaCities
SellingClassCode
CodeShare
This is the wrapper node that contains the code share rule. Empty if the flight has no code share rule
FlightNumber
This is the other flight number that has a code share rule with the current flight
Indicator
This indicates the status of the FlightNumber. Its value is either O or M. O means the airline operates the flight; M
means the airline markets the flight
Remarks:
The WSDL description for this service is in scheduleDisplay.wsdl.
Sample SOAP/XML request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
<RRT:Body>
<RRT:GetSchedule>
<StartCity>FLL</StartCity>
<EndCity>LAX</EndCity>
<FlightNumber></FlightNumber>
<StartDate>7/28/2005</StartDate>
<EndDate></EndDate>
</RRT:GetSchedule>
</RRT:Body>
</RRT:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetScheduleReply xmlns:RRT="http://rrtechnologies.net/soap/">
<SchedFlight FlightNum="1">
<Departure>FLL</Departure>
<Arrival>LAX</Arrival>
<StartDate>10/15/2004</StartDate>
<EndDate>10/15/2006</EndDate>
<DepartureTime>08:00</DepartureTime>
<ArrivalTime>16:00</ArrivalTime>
<FrequencyCode>1234567</FrequencyCode>
<FlightNumber>RT2550</FlightNumber>
<AircraftCode>M80</AircraftCode>
<ViaCities>FLL#LAS#LAX</ViaCities>
<SellingClassCode>A B C H K L M Q T V Y Z Z1 Z2</SellingClassCode>
XML Service APIs Page 177
</SchedFlight>
<SchedFlight FlightNum="2">
...sample truncated for readability...
</SchedFlight>
<SchedFlight FlightNum="3">
...sample truncated for readability...
</SchedFlight>
<SchedFlight FlightNum="4">
<Departure>FLL</Departure>
<Arrival>LGA</Arrival>
<StartDate>08/11/2005</StartDate>
<EndDate>09/19/2005</EndDate>
<DepartureTime>14:25</DepartureTime>
<ArrivalTime>18:00</ArrivalTime>
<FrequencyCode>1234567</FrequencyCode>
<FlightNumber>RT2025</FlightNumber>
<AircraftCode>321</AircraftCode>
<ViaCities>FLL#LGA</ViaCities>
<SellingClassCode>A B C H K L M Q Y</SellingClassCode>
<CodeShare>
<FlightNumber>AA111</FlightNumber>
<Indicator>O</Indicator>
</CodeShare>
</SchedFlight>
</RRT: GetScheduleReply>
</soap:Body>
</soap:Envelope>
The response matches exactly what is shown in Results Schedule Display GUI:
XML Service APIs Page 178
Assign External Locator Service
Assigns an external locator to a Results booking so that it becomes an external booking and updateable from external
sources. For example, a customer can call in to make a booking and later is able to pull it out from the web.
Tuxedo service name: ASSIGNLOCATOR.
Signature:
[Visual Basic]
AssignLocator(Locator As String, ExternalLocator As String, ExternalAddress As String)
Parameters:
Locator
This is Results record locator
ExternalLocator
This is the external locator to be assigned to the booking
ExternalAddress
Origin address of the external source that will be updating the booking
Sample code:
If book.OriginAddress = "" Then
With book
.ExternalLocator = .Locator
.OriginAddress = ConfigurationSettings.AppSettings.GetValues("BookOriginAddress")(0)
End With
Dim assignExternalSvc As New assignExternalLocator.assignlocator
assignExternalSvc.Url = ConfigurationSettings.AppSettings.GetValues("assignLocatorURL")(0)
assignExternalSvc.AssignLocator(book.Locator, book.ExternalLocator, book.OriginAddress)
End If
Sample SOAP/XML request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
<RRT:Body>
<RRT:AssignLocator>
<Locator>HNRDCP</Locator>
<ExternalLocator>JUNE24</ExternalLocator>
<ExternalAddress>HDKWWRT</ExternalAddress>
</RRT:AssignLocator>
</RRT:Body>
</RRT:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="http://schemas.xmlsoap.org/soap/envelope/">
<RRT:Header/>
XML Service APIs Page 179
<RRT:Body>
<RRT:AssignLocatorReply/>
</RRT:Body>
</RRT:Envelope>
If you go to Results and retrieve the booking, you will see an external locator is created for this booking:
Screen shot from Results Web:
XML Service APIs Page 180
XML Service APIs Page 181
Schedule Change Acknowledgement Service
Acknowledges the receipt of a schedule change notification
Service name defined in Results: SCHEDULE_CHANGE
Signature:
[Visual Basic]
AcknowledgeChange(LinkID As String, AckInformation As String) As XmlNode
Parameters:
LinkID
The unique identifier of an acknowledgement link
AckInformation
Remarks or details on the acknowledgement, e.g. IP address of the remote system acknowledging the schedule
change
Return values:
BookNo
The booking number of the acknowledged booking
RecordLocator
The record locator of the acknowledge booking
Sample code:
[Visual Basic]
'call the schedule change acknowledgement service
Dim schedChangeAckSvc As New scheduleChangeAck.ScheduleChangeAck
schedChangeAckSvc.Url =
ConfigurationSettings.AppSettings.GetValues("schedChangeAckURL")(0)
Dim ackResponse As XmlNode =
schedChangeAckSvc.AcknowledgeChange(schedChangeLinkID, ackInformation)
'get locator
Dim recordLocator As String = ackResponse.SelectSingleNode("RecordLocator").InnerText
Sample SOAP/XML request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<AcknowledgeChange xmlns="http://rrtechnologies.net/soap/">
<LinkID>5</LinkID>
<AckInformation>192.168.112.81</AckInformation>
</AcknowledgeChange>
XML Service APIs Page 182
</soap:Body>
</soap:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:AcknowledgeChangeReply xmlns:RRT="http://rrtechnologies.net/soap/">
<AcknowledgeChangeBooking>
<BookNo>2653164</BookNo>
<RecordLocator>HNRNHF</RecordLocator>
</AcknowledgeChangeBooking>
</RRT:AcknowledgeChangeReply>
</soap:Body>
</soap:Envelope>
The following is a screenshot from Results Web that indicates the booking is affected by schedule change and need
the passenger to click the link to acknowledge the receipt of this notification:
XML Service APIs Page 183
Upgrade Service
This service groups together multiple XML SOAP calls.
Service name defined in Results: UPGRADE_SERVICE.
Reallocation Service
This function allows Reallocating passengers in bulk from one Flight to another.
Parameters:
ForceReallocation
Flag to indicate if to force reallocation in the case of bad connection. Value can be true/false
OldFlightInfos
The wrapper for source flight information
FlightNumber
The source flight number
SchedPerdNo
Source flight operational period number that you can find in the inventry_realloc table
PerdSeqnNo
Source flight sequential period number that you can find in the inventry_realloc table
CityPairNo
City pair number involved in reallocation
NumOfConns
Number of connection in the source flight?
NoAltFlightFlg
Number of targeting flights
NewFlightInfo
The wrapper for target flight information
T1OffsetDays
Offset days for the 1st target flight
T1ActionType
T1FlightNumber
Flight number of the 1st target flight
T1CityPairNo
City pair number of the 1st target flight
XML Service APIs Page 184
QueuePrty
The flag to indicate if the reallocation record should be inserted into the queue table. Any value means yes. Leaving
it empty means no. So do not leave this field empty?
<DutyCodeLevel>
The duty code of the person that performs the service call
<BranchCode>
<CompanyCode>
<UpdtUserCode>
<UpdtDestId>
<UpdtDateTime>
<ReallocationType>
<ReallocationInfo>
<PaxBookNos>
The wrapper that contains booking numbers that are involved in the reallocation
<PaxBookNo>
The wrapper for a specific booking number
<BookNo>
The specific booking number
Return values:
StatusCode
The status of this reallocation. 200 means successful. Any other value indicates a problem.
DBErrorCode
The database error code. 0 means no error. Any other value indicates a problem.
RecordCounts
Number of bookings that were processed in this reallocation
ReturnCode
timing
The wrapper that contains the reallocation time stamps
start
The time that the reallocation process starts for this reallocation
XML Service APIs Page 185
end
The time that the reallocation process stops for this reallocation
duration
The time (in ms) this reallocation process lasts
Overall
The overall time (in ms) this reallocation process lasts
Sample SOAP/XML request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
<RRT:Body>
<RRT:PassengerRealloc timing_in_reply="yes">
<ForceReallocation>true</ForceReallocation>
<OldFlightInfos>
<OldFlightInfo>
<FlightNumber>RT200</FlightNumber>
<SchdPerdNo>30</SchdPerdNo>
<PerdSeqnNo>1</PerdSeqnNo>
<CityPairNo>10</CityPairNo>
<NumOfConns>1</NumOfConns>
<NoAltFlightFlg></NoAltFlightFlg>
</OldFlightInfo>
</OldFlightInfos>
<PassRetainFlg>Y</PassRetainFlg>
<NewFlightInfos>
<NewFlightInfo>
<T1OffsetDays>1</T1OffsetDays>
<T1ActionType>G</T1ActionType>
<T1FlightNumber>RT200</T1FlightNumber>
<T1CityPairNo>10</T1CityPairNo>
</NewFlightInfo>
</NewFlightInfos>
<QueuePrty>0</QueuePrty>
<DutyCodeLevel>DBA99</DutyCodeLevel>
<BranchCode>RTFLL0001</BranchCode>
<CompanyCode>RT</CompanyCode>
<UpdtUserCode>ZLI</UpdtUserCode>
<UpdtDestId>FLL0001</UpdtDestId>
<UpdtDateTime>2006/06/16/11/04/32</UpdtDateTime>
<ReallocationType>S</ReallocationType>
<ReallocationInfo></ReallocationInfo>
<PaxBookNos>
<PaxBookNo>
<BookNo>2669073</BookNo>
</PaxBookNo>
</PaxBookNos>
<OthFlt>N</OthFlt>
XML Service APIs Page 186
<ODeprAirport></ODeprAirport>
<OArrvAirport></OArrvAirport>
<ODeprCity></ODeprCity>
<OArrvCity></OArrvCity>
<ODeprTime></ODeprTime>
<OArrvTime></OArrvTime>
<OSellClsCode></OSellClsCode>
<WaitListFlg>N</WaitListFlg>
</RRT:PassengerRealloc>
</RRT:Body>
</RRT:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:PassengerReallocReply xmlns:RRT="http://rrtechnologies.net/soap/">
<StatusCode>200</StatusCode>
<DBErrorCode>0</DBErrorCode>
<RecordCounts>001</RecordCounts>
<ReturnCode>0</ReturnCode>
<timing>
<start>2006-06-16 11:05:30</start>
<end>2006-06-16 11:05:34</end>
<duration>3643.82 ms</duration>
<overall>3645.02 ms</overall>
</timing>
</RRT:PassengerReallocReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 187
Accounting Report Service
Generate Revenue per Passenger Boarded (RPB) report.
Service name defined in Results: ACCREP_SERVICE.
Parameters:
EndDate
Board date and end date of the flight
Return values:
HeaderRecord
Wrapper for Header Node
RecordCode
The indicator record type. H is for Header; R is for Record; and T is for Trailer
GMTDate
The GMT date for the report
GMTTime
The GMT time for the report
Origin
The company that generates this report
ReportRecord
Wrapper for Record Node (can have multiple)
FullFlightNo
This is the airline carrier code plus the flight number
OperatingFlightNo
This is the flight number of the operating flight
MarketingFlightNo
This is the flight number of the marketing flight (can have multiple)
MarketedProvider
The carrier code for the marketing flight
OperatingProvider
The carrier code for the operating flight
PNR
PNR record locator
Origin
The origination airport code
XML Service APIs Page 188
Destination
The destination airport code
PassengerNo
The sequential number of the passenger in the locator
PassengerName
Passenger’s full name (last/first) plus title
DepartureDate
Boarding date
Class
The cabin class printed on the boarding pass
PaxCode
Passenger type, i.e. e. ADULT, CHD, etc.
NonRevenuePax
Y for non revenue passenger; otherwise blank (INF is also a non revenue. So if parameter Infant is Y then
NonRevenuePax should also have a Y)
Infant
Y for infants; otherwise blank
DistributionChnl
This is the origin of the PNR. Values can be WWW (web) or 1A (Amadeus)
TrailerRecord
Wrapper of the Trailer Node. There is one Trailer per report
Count
Total number of records in the report
Terminator
End of report indicator
Sample SOAP/XML request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
<RRT:Body>
<RRT:LF_RPBReport>
<EndDate>11/21/2005</EndDate>
</RRT:LF_RPBReport>
</RRT:Body>
</RRT:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
XML Service APIs Page 189
<RRT:LF_RPBReportReply xmlns:RRT="http://rrtechnologies.net/soap/">
<HeaderRecord>
<RecordCode>H</RecordCode>
<GMTDate>21NOV05</GMTDate>
<GMTTime>1310</GMTTime>
<Origin>RRT</Origin>
</HeaderRecord>
<ReportRecord>
<RecordCode>R</RecordCode>
<FullFlightNo>LF4803 </FullFlightNo>
<OperatingFlightNo>803</OperatingFlightNo>
<MarketingFlightNo>4803</MarketingFlightNo>
<MarketedProvider>LF</MarketedProvider>
<OperatingProvider>DY</OperatingProvider>
<PNR>HCMTMT</PNR>
<Origin>OSL</Origin>
<Destination>LRN</Destination>
<PassengerNo>1 </PassengerNo>
<PassengerName>ACKEMA/EVELYN MS </PassengerName>
<DepartureDate>21NOV05</DepartureDate>
<Class>L</Class>
<PaxCode>ADULT</PaxCode>
<NonRevenuePax> </NonRevenuePax>
<Infant> </Infant>
<DistributionChnl>WWW</DistributionChnl>
</ReportRecord>
<ReportRecord>
<RecordCode>R</RecordCode>
<FullFlightNo>LF4803 </FullFlightNo>
<OperatingFlightNo>803</OperatingFlightNo>
<MarketingFlightNo>4803</MarketingFlightNo>
<MarketedProvider>LF</MarketedProvider>
<OperatingProvider>DY</OperatingProvider>
<PNR>BFRRXK</PNR>
<Origin>OSL</Origin>
<Destination>LRN</Destination>
<PassengerNo>1 </PassengerNo>
<PassengerName>CARLGREN/DANIEL MR </PassengerName>
<DepartureDate>21NOV05</DepartureDate>
<Class>K</Class>
<PaxCode>CHD </PaxCode>
<NonRevenuePax> </NonRevenuePax>
<Infant> </Infant>
<DistributionChnl>WWW</DistributionChnl>
</ReportRecord>
... Thunkated for readability...
<TrailerRecord>
<RecordCode>T</RecordCode>
<Count>237</Count>
<Terminator>FFFFFFFF</Terminator>
</TrailerRecord>
</RRT:LF_RPBReportReply>
</soap:Body>
</soap:Envelope>
The text format of the report looks like the following:
XML Service APIs Page 190
H10JAN061700RRT
...
R LF 240 HDPYBVUMEARN1 AHLQVIST/MATHIAS MR 09JAN06VADULT WWW
R LF 240 HDRSKVUMEARN1 ALENSKAER/CATHRIN MR09JAN06VADULT WWW
RDY LF 7401401 HDHLMMARNOSL1 KANGUR/ROGER MR 09JAN06XADULT WWW
RDY LF 7401401 HDRDTRARNOSL1 KARLSSON/HAAKAN MR 09JAN06VADULT WWW
RDY LF 7414414 HDTWNXOSLARN1 TIMELIUS/CHRISTOFFER09JAN06MADULT DY
RDY LF 7414414 HDTWNYOSLARN1 TRAAHOLT/HENRIK MR 09JAN06MADULT DY
RDY LF 7414414 HDKSKJOSLARN2 WAGNERT/NIKLAS MR 09JAN06TADULT WWW
RDY LF 7414414 HDVFYLOSLARN1 WANG/WEI MRS 09JAN06VADULT WWW
RDY LF 7414414 HCHMKXOSLARN3 WELINDER/EVA MISS 09JAN06XADULT WWW
RDY LF 7414414 HDNQPROSLARN2 WIKLANDER/MAGNUS MR 09JAN06TADULT WWW
RDY LF 7414414 HDTGMSOSLARN1 WILLIAMSON/JONAS MR 09JAN06VADULT WWW
RDY LF 7414414 HDTDHXOSLARN1 WULLUM/ANNE MS 09JAN06VADULT 1A
RDY LF 7414414 HCXTSBOSLARN1 YOUNG/STEPHEN MR 09JAN06NADULT WWW
R LF 501 BBTKPVARNLLA1 AABERG/DANIEL MR 09JAN06VADULT WWW
R LF 501 HDMLSCARNLLA1 AIDANPAEAE/CAROLA MR09JAN06MADULT WWW
R LF 510 HDTTTVLLAARN1 GAELLDIN/KARIN MISS 09JAN06VADULT WWW
R LF 510 HCRHLJLLAARN1 GOTTHOLD/EMELIE MISS09JAN06VADULT WWW
R LF 510 HCPJRNLLAARN2 GRANHOLM THOREN/ANNA09JAN06NADULT WWW
R LF 662 HDPNGZGOTARN1 LIPPENS/HANS MR 09JAN06VADULT WWW
R LF 662 HDHTHRGOTARN1 LISTE/MATS MR 09JAN06TADULT WWW
R LF 662 HDTMQNGOTARN1 LITZEN/PETER MR 09JAN06VADULT WWW
RNB LF 4289889 HDSKTTARNTXL1 WASS/PATRIK MR 09JAN06VADULT WWW
RNB LF 4290890 HDFRKTTXLARN2 ALPERMANN/GOTTFRIED 09JAN06IADULT WWW
RNB LF 4290890 HDTMDJTXLARN2 AMAYA/ADAM 09JAN06YADULT NB
RNB LF 4292892 HCQLQCMUCARN1 WEBER/MICHAEL MR 09JAN06NADULT WWW
RNB LF 4292892 HDKQQCMUCARN1 WEBER/THOMAS MR 09JAN06MADULT WWW
RNB LF 4292892 HCJXBRMUCARN1 WESTER/ULLA MRS 09JAN06NADULT WWW
RNB LF 4292892 BCQYXYMUCARN2 WINTHERSEN/LISELOTTE09JAN06VADULT WWW
RNB LF 4292892 HDKQDTMUCARN2 ZETHELIUS/DANIELA MR09JAN06MADULT WWW
...
T2944FFFFFFFF
XML Service APIs Page 191
Western Union Service
Areo California accepts Western Union as a payment type. A customer can book with Results and then goes to a
Western Union branch to pay for the booking. There is an interface at Results backend to settle those payments with
Western Union.
Service name defined in Results: WU_SERVICE.
Authentication Inquiry
This is requesting authentication of payment.
Sample SOAP/XML request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
<RRT:Body>
<RRT:WUISService>
<payment_request>{##001HNSYHB
0000000041734 NOWHERETOWN USAUSDWHOEVER
321745##}</payment_request>
</RRT:WUISService>
</RRT:Body>
</RRT:Envelope>
Where
{## = Message buffer start
001 = Request Type (Authentication Inquiry)
HNSYHB = Record Locator
41734 = Payment Amount (1417.34)
Note: The format of the input file should strictly follow that defined in Airline Interface Guide by the Western Union
Financial Services, Inc.
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:WUISServiceReply xmlns:RRT="http://rrtechnologies.net/soap/">
<payment_response>{##101000 0000000041734USDUSA
(000) 123-4567
321745##}</payment_response>
</RRT:WUISServiceReply>
</soap:Body>
</soap:Envelope>
Payment Advice
This is the submission of payment, which updates the Payment Status to ‘Paid’ in Results.
XML Service APIs Page 192
Sample SOAP/XML request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<RRT:Envelope xmlns:RRT="RRT">
<RRT:Body>
<RRT:WUISService>
<payment_request>{##002HNSYHB
MTCNNUMBER04 00000000417342006/03/24 09:16:38 EST 327810025NOWHERETOWN
US USD 321745##}</payment_request>
</RRT:WUISService>
</RRT:Body>
</RRT:Envelope>
Where
{## = Message buffer start
002 = Request Type (Payment Advice)
HNSYHB = Record Locator
MTCNNUMBER04 = Western Union’s unique transaction identifier. (MTCN equals Money Transfer Control
Number)
41734 = Payment Amount
2006/03/24 09:16:38 = Transaction date and time
Note: The format of the input file should strictly follow that defined in Airline Interface Guide by the Western Union
Financial Services, Inc.. not one space more, nor one space less.
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:WUISServiceReply xmlns:RRT="http://rrtechnologies.net/soap/">
<payment_response>{##102000
321745##}</payment_response>
</RRT:WUISServiceReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 193
Web Cash Payment Services
In addition to specific cash payment interfaces, Results also supports cash payment interfaces in general.
Service name defined in Results: CASH_SERVICE.
Note 1: For cash service to work, booking payment form and payment type should match those set in the system
setting parameter CASHPAY_FM_TPS. For example, if the value for that setting is HS/PE, your booking must have
the payment type as PE, and payment form as HS. Otherwise you will get error response from the service.
Note 2: If you changed the value for the setting mentioned above, you need to restart cash service for the new value
to take effect.
Payment Request
When a cash payment is accepted the customer gets a payment number generated Results. The customer then takes
this number and makes real payment in the bank. The bank sends a payment request to Results.
Parameters:
payment_number
A numeric string that is generated by the system automatically when a payment of any type is received
external_system_id
This is a value that identifies who is sending the cash payment. For example, say you are working with two
banks, 'Chase' and 'First National', You would use this field to identify from which bank the transaction comes,
this could be useful for accounting reports. The value can be 'made up' by the airline, or maybe the sender has
an existing ID that they need you to store and reference
dot_net_wrapper
This indicates if the service call is being made by the Results Web Framework, and if 'yes', it will include values
in the reply required by the Results Web. If you are not calling it using the Web, but your own application, set it
to 'no'
Sample XML/SOAP request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetPaymentInformation xmlns="http://rrtechnologies.net/soap/">
<payment_number>10050780</payment_number>
<external_system_id>AAGT001</external_system_id>
</GetPaymentInformation>
</soap:Body>
</soap:Envelope>
Sample XML reply:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
XML Service APIs Page 194
<soap:Header/>
<soap:Body>
<RRT:GetPaymentInformationReply xmlns:RRT="http://rrtechnologies.net/soap/">
<external_system_id>AAGT001</external_system_id>
<payment_number>10050780</payment_number>
<booking_information>
<flight_segment>
<flight_number>RT1120</flight_number>
<flight_date>08/21/2007</flight_date>
<departure_airport>FLL</departure_airport>
<arrival_airport>CUN</arrival_airport>
<departure_airport_name>FLL FT LAUDERDALE/HOLLYWOOD
INTL</departure_airport_name>
<arrival_airport_name>CUN CANCUN INTERNATIONAL</arrival_airport_name>
<departure_time>06:30</departure_time>
<arrival_time>09:30</arrival_time>
</flight_segment>
</booking_information>
<created_time_stamp>2007/08/13/15/38/01</created_time_stamp>
<original_currency_code>USD</original_currency_code>
<original_amount>247.46</original_amount>
<currency>USD</currency>
<amount>247.46</amount>
<name_on_payment>CASH/THREE</name_on_payment>
<paid>false</paid>
<error_code>00</error_code>
</RRT:GetPaymentInformationReply>
</soap:Body>
</soap:Envelope>
Results web screen shot:
XML Service APIs Page 195
Payment Advise
When the bank receives the payment it sends a notification message to Results advising that a payment has been
successfully received.
Sample XML/SOAP request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<PaymentNotification xmlns="http://rrtechnologies.net/soap/">
<payment_number>10050780</payment_number>
<external_system_id>AAGT001</external_system_id>
<ext_sys_conf_num />
<paid_currency_code>USD</paid_currency_code>
<paid_amount>247.46</paid_amount>
<dot_net_wrapper>yes</dot_net_wrapper>
</PaymentNotification>
</soap:Body>
</soap:Envelope>
Results replies with a payment confirmation (or an error message in cases of errors) .
Sample XML reply:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
XML Service APIs Page 196
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:PaymentNotificationReply xmlns:RRT="http://rrtechnologies.net/soap/">
<payment_number>10050780</payment_number>
<external_system_id>AAGT001</external_system_id>
<ext_sys_conf_num />
<payment_conf_num>182</payment_conf_num>
<error_code>00</error_code>
<paid_amount>247.46</paid_amount>
</RRT:PaymentNotificationReply>
</soap:Body>
</soap:Envelope>
Results web screen shot:
At this point the paid status flag changes from N to Y.
If you receive an error message, the payment status remains in N (not paid) status.
Cancel Payment
If the bank does not receive the PaymentNotificationReply within a given time period or receives an error from Results
on the notification, the bank must send a CancelNotification message that will leave the payment in the same status
as prior to the notification.
Sample XML/SOAP request:
<?xml version="1.0" encoding="utf-8"?>
XML Service APIs Page 197
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<CancelNotification xmlns="http://rrtechnologies.net/soap/">
<payment_number>10050780</payment_number>
<external_system_id>AAGT001</external_system_id>
<ext_sys_conf_num />
<reason_code>CXL</reason_code>
<note>CANCELED</note>
<dot_net_wrapper>yes</dot_net_wrapper>
</CancelNotification>
</soap:Body>
</soap:Envelope>
Results replies with a cancellation confirmation (or an error message in cases of errors).
Sample XML reply:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:CancelNotificationReply xmlns:RRT="http://rrtechnologies.net/soap/">
<payment_number>10050780</payment_number>
<external_system_id>AAGT001</external_system_id>
<ext_sys_conf_num />
<payment_conf_num>183</payment_conf_num>
<error_code>00</error_code>
</RRT:CancelNotificationReply>
</soap:Body>
</soap:Envelope>
Results web screen shot:
XML Service APIs Page 198
Get Payment Reference
This service is different from the CASH_SERVICE.
Function description: To generate cash Payment Reference Number from Web. A time limit is generated as well.
Service name: PRICING_SERVICE.
Note: The system setting that affects the functionality of PRICING_SERVICE is paymenttype_paymentform_CONST.
For example, if you have payment type AT and payment form WWW, you need to have Results Support team to
insert the following setting into your system settings table: AT_WWW_CONST.
Results web screen capture:
Parameters
XML Service APIs Page 199
PaymentForm
The cash payment form as defined in System Settings parameter. In this instance it is HS (HS_BC_CONST)
PaymentType
The cash payment type defined for HSBC. In this instance it is PE
Year
The year of the flight date
Month
The month of the flight date
Day
The day of the flight date
Time
This is the flight departure time
Amount
This is the booking fare amount
BranchCode
This is your web booking branch code. It should match the setting in the web.config file in resultsservices folder
Return Value
ReferenceNUmber
This is the reference number generated by the service. The customer takes this number to the bank and makes
cash payment accordingly
TimeLimitYear
This is the year of the Time Limit
TimeLimitMonth
This is the month of the Time Limit
TimeLimitDay
This is the day of the Time limit
Sample XML request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetCashPaymentReference xmlns="http://rrtechnologies.net/soap/">
<PaymentForm>HS</PaymentForm>
<PaymentType>DP</PaymentType>
<Year>2006</Year>
<Month>10</Month>
<Day>28</Day>
<Time>13:30</Time>
<Amount>308.50</Amount>
XML Service APIs Page 200
<BranchCode>RT TTY 0001</BranchCode>
<dot_net_wrapper>yes</dot_net_wrapper>
</GetCashPaymentReference>
</soap:Body>
</soap:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:GetCashPaymentReferenceReply xmlns:RRT="http://rrtechnologies.net/soap/"
dot_net_wrapper="yes">
<GetCashPaymentReferenceReplyStruct>
<GetCashPaymentReferenceXML>
<ReferenceNumber>004153169962023</ReferenceNumber>
<TimeLimitYear>2006</TimeLimitYear>
<TimeLimitMonth>10</TimeLimitMonth>
<TimeLimitDay>22</TimeLimitDay>
</GetCashPaymentReferenceXML>
</GetCashPaymentReferenceReplyStruct>
</RRT:GetCashPaymentReferenceReply>
</soap:Body>
</soap:Envelope>
Results Web screen capture:
XML Service APIs Page 201
Web Credit Card Service
Function description: To process the credit card requests directly on the Web, without going through Results. This
service is applicable, but not limited to, selling Gift Certificates online in the form of vouchers.
Service name: XXX_CC_SERVICE
Note: XXX is the credit card service provider code. This parameter is dynamic. It changes depending on the CC
processor code.
The credit card payment authorization and settlement functionality is already wrapped in the AuthorizePayments and
SettlePayments methods of the Booking class of the ResultsBooking library.
The first section below provides the VB codes for this service, and the second section lists the corresponding XML
calls.
VB Codes for Credit Card Service
The codes are given in their logical order.
1. Authorize
This section of codes sends authorization request to the CC provider.
[Visual Basic]
'Instantiate booking object
Dim book As New ResultsBooking.Booking
'Add a visa card payment that covers the booking value
Dim payment As New ResultsBooking.Payment
With payment
.PaymentType = "CC"
.PaymentForm = "VI"
.DocumentNo = "4111111111111111"
.CCExpiryDate = "0506"
.CVV = "123"
.PassengerName = "John/Doe"
.Amount = 500
.CurrencyCode = "USD"
End With
'Add credit card payment to the booking object
book.Payments.Add(payment)
'Authorize credit card payments
book.AuthorizePayments()
For the corresponding XML file, please reference 1. XML Call for Authorize.
Note: PaymentType property of ResultsBooking.Payment class must be set to "CC" for the payment to be authorized
and/or settled.
Definition of ‘parameter’ structures:
XML Service APIs Page 202
Public Class Payment
Public PaymentNo As Integer
Public PaymentForm As String
Public PaymentType As String
Public TypeDescription As String
Public Description As String
<XmlElement("PaymentAmount")> _
Public Amount As Decimal
Public PaymentDate As String
Public DocumentNo As String
Public PassengerName As String
Public RemarksText As String
Public ReceivedFrom As String
<XmlElement("PaidCurrencyCode")> _
Public CurrencyCode As String
Public PaidFlag As String
<XmlElement("CcApprvCode")> _
Public CCApprovalCode As String
<XmlElement("CcApprvType")> _
Public CCApprovalType As String
<XmlElement("CcExpiryDate")> _
Public CCExpiryDate As String
Public CVV As String
<XmlElement("CcTransactionID")> _
Public CCTransactionID As String
<XmlElement("CcApprvBatch")> _
Public CCApprovalBatch As String
Public Address1 As String
Public Address2 As String
Public State As String
Public City As String
Public PostalCode As String
Public Country As String
Public Phone As String
End Class
2. CreateVoucher
For details on voucher creation service please reference Voucher Generation Service.
Sample Code:
[Visual Basic]
Dim voucherSvc As New voucherService.voucherservice
Dim recipientInfo As New voucherService.NameAddress
Dim payerInfo As New voucherService.NameAddress
Dim paymentInfo As New voucherService.Payment
Dim giftcertificateInfo As XmlNode
Dim voucherInfo As XmlNode
For Each payment In book.Payments
With payment
If .PaidFlag = "Y" Then
paymentInfo.DocumentNo = .DocumentNo
XML Service APIs Page 203
paymentInfo.CCExpiry = .CCExpiryDate
paymentInfo.CCCVV = .CVV
paymentInfo.PassengerName = .PassengerName
paymentInfo.ReceivedFrom = .PassengerName
paymentInfo.Amount = .Amount
paymentInfo.Type = .PaymentType
paymentInfo.Form = .PaymentForm
paymentInfo.Date = Now.ToString("MM/dd/yyyy", GetSystemDateFormatProvider())
paymentInfo.PaidFlag = "Y"
paymentInfo.PaymentIndicator = "Y"
recipientInfo.Name = .PassengerName
payerInfo.Name = .PassengerName
giftcertificateInfo = voucherSvc.CreateVoucher("GC", "OPEN", .Amount,
.CurrencyCode, _
"", "N", "N", 0, "Y", _
Nothing, Nothing, Nothing, Nothing, Nothing, _
"", 0, "XX", Nothing, Nothing, Nothing, "WEB",
recipientInfo, payerInfo, paymentInfo)
End If
End With
Next
For the corresponding XML file, please reference 2. XML Call for CreateVoucher.
3. GetVoucher
For details on voucher retrieval service please reference Voucher Retrieval Service.
Sample code:
If Not giftcertificateInfo.SelectSingleNode("Number") Is Nothing Then
voucherInfo =
voucherSvc.GetVoucher(giftcertificateInfo.SelectSingleNode("Number").InnerText, Nothing)
End If
For the corresponding XML file, please reference 3. XML Call for GetVoucher.
4. Settle
This call sends settlement request to CC provider for Payment Number.
Sample code:
'Settle credit card payments
book.SettlePayments()
For the corresponding XML file, please reference XML Call for Settle.
XML Service APIs Page 204
Sample XML Calls and Responses
This section lists the corresponding XML calls to the credit card service using online gift certificate purchase as an
example.
1. XML Call for Authorize
Before sending authorization request, you need first obtain the credit card processor code. For the sample XML input,
please reference Base Data .
Note: This is a dynamic call. If the CC processor code from Base Data Retrieval call was ABC instead of RRT, the
authorization request file below would use ABCAuthorize instead of RRTAuthorize, and the response would be
ABCAuthorizeReply instead of RRTAuthorizeReply.
Sample SOAP request for RRT authorization with card and card holder information:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<RRTAuthorize xmlns="http://rrtechnologies.net/soap/">
<card_type>VI</card_type>
<card_number>4111111111111111</card_number>
<cvv_code>123</cvv_code>
<expire_year>07</expire_year>
<expire_month>12</expire_month>
<last_name>WANG</last_name>
<first_name>MAY</first_name>
<middle_name />
<address>123 MAIN</address>
<city>CORAL SPRINGS</city>
<province>FL</province>
<nation>US</nation>
<postal_code>33076</postal_code>
<amount>800</amount>
<dot_net_wrapper>yes</dot_net_wrapper>
</RRTAuthorize>
</soap:Body>
</soap:Envelope>
Response gives CC transaction ID:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:RRTAuthorizeReply xmlns:RRT="http://rrtechnologies.net/soap/"
dot_net_wrapper="yes">
<RRTAuthorizeReplyStruct>
<approved>true</approved>
<transaction_id>655</transaction_id>
<test_mode>ALL REQUESTS APPROVED IN TEST MODE. See
RRT_OPERATION_MODE system parameter</test_mode>
</RRTAuthorizeReplyStruct>
XML Service APIs Page 205
</RRT:RRTAuthorizeReply>
</soap:Body>
</soap:Envelope>
2. XML Call for CreateVoucher
SOAP request to create a voucher:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<CreateVoucher xmlns="http://rrtechnologies.net/soap/">
<VoucherReason>GC</VoucherReason>
<VoucherStatus>OPEN</VoucherStatus>
<VoucherAmount>800</VoucherAmount>
<CurrencyCode>USD</CurrencyCode>
<Notes>WEB Voucher, source IP: 192.168.112.3 (forwarded for 127.0.0.1)</Notes>
<PercentFlag>N</PercentFlag>
<CommissionFlag>N</CommissionFlag>
<UseFee>0</UseFee>
<RefundableFlag>Y</RefundableFlag>
<RecordLocator />
<BookNo>0</BookNo>
<CompanyCode>RT</CompanyCode>
<UserCode>WEB</UserCode>
<Recipient>
<Name>DOE/JOHN</Name>
<Addr1>345 MAIN</Addr1>
<City>MIAMI</City>
<State>FL</State>
<Zip>33178</Zip>
<Country>US</Country>
<Phone>95475512127</Phone>
<Email>JOHN@RRTECHNOLOGIES.NET</Email>
</Recipient>
<Payer>
<Name>WANG/MAY</Name>
<Addr1>123 MAIN</Addr1>
<City>CORAL SPRINGS</City>
<State>FL</State>
<Zip>33076</Zip>
<Country>US</Country>
<Phone>9545551212</Phone>
<Email>MEIHUAW@YAHOO.COM</Email>
</Payer>
<Payments>
<Form>VI</Form>
<Type>CC</Type>
<Amount>800</Amount>
<CurrencyCode>USD</CurrencyCode>
<DocumentNo>4111111111111111</DocumentNo>
<CCExpiry>1207</CCExpiry>
<CCCVV>123</CCCVV>
<Date>10/18/2006</Date>
XML Service APIs Page 206
<BranchCode>RT FLL 0001</BranchCode>
<PassengerName>WANG/MAY</PassengerName>
<ReceivedFrom>M WANG</ReceivedFrom>
<PaidFlag>Y</PaidFlag>
<PaymentIndicator>Y</PaymentIndicator>
</Payments>
</CreateVoucher>
</soap:Body>
</soap:Envelope>
Response gives the voucher number and expiration date:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:CreateVoucherReply xmlns:RRT="http://rrtechnologies.net/soap/">
<Voucher>
<Number>0024164L</Number>
<Expiry>10/18/2007</Expiry>
</Voucher>
</RRT:CreateVoucherReply>
</soap:Body>
</soap:Envelope>
3. XML Call for GetVoucher
SOAP requests retrieval of the voucher generated:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetVoucher xmlns="http://rrtechnologies.net/soap/">
<VoucherNumber>0024164L</VoucherNumber>
</GetVoucher>
</soap:Body>
</soap:Envelope>
Response gives detailed voucher information including the Payment Number:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:GetVoucherReply xmlns:RRT="http://rrtechnologies.net/soap/">
<Voucher VoucherNumber="0024164L">
<VoucherReason>GC</VoucherReason>
<VoucherExpiry>10/18/2007</VoucherExpiry>
<VoucherStatus>OPEN</VoucherStatus>
<BookNo>0</BookNo>
<AppliedBookNo />
<Book_BookNo />
<Book_AppliedBookNo />
XML Service APIs Page 207
<FlightNo />
<FlightDate />
<Recipient>
<Name>DOE/JOHN</Name>
<Addr1>345 MAIN</Addr1>
<City>MIAMI</City>
<State>FL</State>
<Zip>33178</Zip>
<Country>US</Country>
<Phone>95475512127</Phone>
<Email>JOHN@RRTECHNOLOGIES.NET</Email>
</Recipient>
<Payer>
<Name>WANG/MAY</Name>
<Addr1>123 MAIN</Addr1>
<City>CORAL SPRINGS</City>
<State>FL</State>
<Zip>33076</Zip>
<Country>US</Country>
<Phone>9545551212</Phone>
<Email>MEIHUAW@YAHOO.COM</Email>
</Payer>
<CancelDate />
<PaymentMethod />
<VoucherAmount>800.00</VoucherAmount>
<CurrencyCode>USD</CurrencyCode>
<CCNumber />
<CCExpiry>1207 </CCExpiry>
<VoucherNotes>WEB Voucher, source IP: 192.168.112.3 (forwarded for
127.0.0.1)</VoucherNotes>
<CreaUserCode>WEB </CreaUserCode>
<CreaDestID>FLLNK001</CreaDestID>
<CreaDateTime>2006/10/18/15/37/22</CreaDateTime>
<UpdtUserCode>WEB </UpdtUserCode>
<UpdtDestID>FLLNK001</UpdtDestID>
<UpdtDateTime>2006/10/18/15/37/22</UpdtDateTime>
<CommissionFlag>N</CommissionFlag>
<PercentFlag>N</PercentFlag>
<VoucherNumber>0024186L</VoucherNumber>
<Book_PnrBookNum />
<RecordLocator />
<AppliedRecordLocator />
<UseFee>0.00</UseFee>
<RefundableFlag>Y</RefundableFlag>
<FlightOrigin />
<FlightDestination />
<AgencyCode />
<OriginVoucher />
<ClientProfileNo />
<BusinessPassID />
<PaymentNo>10041529</PaymentNo>
</Voucher>
</RRT:GetVoucherReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 208
4. XML Call for Settle
Before sending settlement request, you need first obtain the credit card processor code. For the sample XML input,
please reference Base Data .
Note: This is a dynamic call. If the CC processor code from Base Data Retrieval call was ABC instead of RRT, the
settlement request file below would use ABCSettle instead of RRTSettle, and the response would be ABCSettleReply
instead of RRTSettleReply.
SOAP settlement request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<RRTSettle xmlns="http://rrtechnologies.net/soap/">
<payment_no>10041529</payment_no>
<dot_net_wrapper>yes</dot_net_wrapper>
</RRTSettle>
</soap:Body>
</soap:Envelope>
Response confirms the RRT settlement:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header />
<soap:Body>
<RRT:RRTSettleReply xmlns:RRT="http://rrtechnologies.net/soap/" dot_net_wrapper="yes">
<RRTSettleReplyStruct>
<settled>true</settled>
</RRTSettleReplyStruct>
</RRT:RRTSettleReply>
</soap:Body>
</soap:Envelope>
Screen capture for RRT Web input:
XML Service APIs Page 209
Screen capture for the RRT Web output:
XML Service APIs Page 210
Departure Control System (DCS) Services
These services perform all kinds of DCS related tasks.
Note: Currently all the DCS services are without the WSDL files. However there are other methods to invoke the
services. Please reference section Invoking Results APIs Without the WDSL.
The service calls are listed in the sequence of passenger check-in. That is:
1. Locate passenger
2. Input passenger information
3. Bagage checkin
4. Assign/release seats
5. Print boarding pass
XML Service APIs Page 211
Management Summary
Background:
WSDL files for DCS does not exists.
Below are examples of different methods to POST directly to /resultsservices/services.aspx:
1. Plain
2. VB.NET
3. Java
4. Unix
Plain:
POST /resultsservices/services.aspx HTTP/1.1
Host: 82.150.226.157:80
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://rrtechnologies.net/soap/BOOKING_SERVICE"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetBooking xmlns="http://rrtechnologies.net/soap/">
<BookingNumber>1</BookingNumber>
</GetBooking>
</soap:Body>
</soap:Envelope>
VB.NET:
Dim web As New System.Net.WebClient
Dim xmlResponse As New XmlDocument
web.Headers.Add("Content-Type", "text/xml")
web.Headers.Add("SOAPAction", "'http://rrtechnologies.net/soap/BOOKING_SERVICE'")
Dim d As Byte() = System.Text.Encoding.ASCII.GetBytes("<?xml version='1.0' encoding='utf-8'?
><soap:Envelope xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/'
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
xmlns:xsd='http://www.w3.org/2001/XMLSchema'><soap:Body><GetBooking
xmlns='http://rrtechnologies.net/soap/'><BookingNumber>2676003</BookingNumber></GetBooking
></soap:Body></soap:Envelope>")
Dim res As Byte() = web.UploadData("http://82.150.226.157:80/resultsservices/services.aspx", "POST",
d)
xmlResponse.LoadXml(System.Text.Encoding.ASCII.GetString(res))
XML Service APIs Page 212
Java:
PostMethod post = new PostMethod("http://82.150.226.157:80/resultsservices/services.aspx");
RequestEntity entity;
entity = new StringRequestEntity("<?xml version='1.0' encoding='utf-8'?><soap:Envelope
xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/'
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
xmlns:xsd='http://www.w3.org/2001/XMLSchema'><soap:Body><GetBooking
xmlns='http://rrtechnologies.net/soap/'><BookingNumber>2676003</BookingNumber></GetBooking
></soap:Body></soap:Envelope>", "text/xml", "charset=ISO-8859-1");
post.setRequestEntity(entity);
HttpClient httpclient = new HttpClient();
try {
int result = httpclient.executeMethod(post);
log.debug("Response status code: " + result);
responseXml = post.getResponseBodyAsString();
}
finally
{
post.releaseConnection();
}
Unix:
cat POST.xml | curl -X POST -H 'Content-type: text/xml' -H 'SOAPAction:
"http://rrtechnologies.net/soap/BOOKING_SERVICE"' -d @- http://
82.150.226.157:80/resultsservices/services.aspx
where POST.xml contains:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetBooking xmlns="http://rrtechnologies.net/soap/">
<BookingNumber>1</BookingNumber>
</GetBooking>
</soap:Body>
</soap:Envelope>
Additionally, the service name to be used to execute the calls for the DCS services is called DcsWorker.
DcsPeripherals is to be used to execute calls for all printing services e.g. printing boarding pass; printing bag tag; printing
DCS reports.
XML Service APIs Page 213
GetPassengerList
This service fetches the passenger based on look-up by passenger name; locator; flight, boarding date and bar code
and populates the Check-in passenger list. The mandatory fields are DcsCarrierRcd and DepartureDate.
Parameters:
DcsCarrierRcd
The operating airline code. Required
FlightNumber
Required if flight number serves as one of the filters
DepartureDate
Departure date. Required
DcsAirportId
This information is in the dcs_airport table. This is required
Locator
Not required unless it is used as one of the filters
FirstName
Not required unless it is used as one of the filters
LastName
Not required unless it is used as one of the filters
BarCode
Not required unless it is used as one of the filters
Return values:
ReplyFormat
Wrapper node that determines the format of all the parameters in the response message
PassengerList
Wrapper node that contain all the passengers in the list
Child
Wrapper node that contains individual passenger information
FlightNumber
Flight number
DepartureDateTime
Flight departure date and time
DcsBookingId
DCS booking ID
BookingNumber
Booking number in Results
XML Service APIs Page 214
Locator
Locator reference in Results
ExternalLocator
This is not required.
OriginName
This indicates the booking origin. Values can be Native (Results booking), web (airline website), and GDS
DcsPassengerTitleRcd
Title of the passenger shown in DCS, like Mr., or Mrs.
DcsPassengerCodeRcd
Passenger code shown in DCS. For example, ADULT
DcsPassengerTypeRcd
Genger of the passenger. For example, MALE
LastName
Passenger’s last name
FirstName
Passenger’s first name
DcsClassRcd
This is the selling class of the booking
DcsCompartmentRcd
This is the cabin class of the aircraft according to the booking selling class
SeatNumber
Seat number assigned
DcsPassengerId
Unique ID assigned to each passenger
DcsCheckinStatusRcd
Passenger’s checkin status
Description
Text description of the checkin status
DcsCheckinId
Unique ID assigned to each itinerary marked as part of ‘This Checkin’
DcsPriorityRcd
DCS Priority record
FromCarrierFlightNumber
This is the previous flight number
ToCarrierFlightNumber
This is the current flight number
XML Service APIs Page 215
DcsFlightId
Flight ID
SortOrder
Sort Order
OriginAirportCode
Origin airport of the this passenger
DestinationAirportCode
Destination airport of this passenger, but may not be that of this flight in the case of a through flight
FinalDestination
This is the final destination airport of a through flight, going from point A to C, via B
CreatedDateTime
Timestamp
ThruFlag
Flag to indicate if this leg/segment of booking is a through flight. 0 means No; 1 means Yes. Usually the first leg of a
through booking has a 0; the second/third/forth leg has a 1
InvalidatedDcsGatewayActionId
Invalidated DCS check-in ID
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetPassengerList xmlns:RRT="RRT">
<DcsCarrierRcd>RT</DcsCarrierRcd>
<FlightNumber>1111</FlightNumber>
<DepartureDate>6/12/0008</DepartureDate>
<DcsAirportId></DcsAirportId>
<Locator></Locator>
<FirstName></FirstName>
<LastName></LastName>
<BarCode>rHx122oXSp00</BarCode>
</RRT:GetPassengerList>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<soap:Header/>
XML Service APIs Page 216
<soap:Body>
<RRT:GetPassengerListReply xmlns:RRT="http://rrtechnologies.net/soap/">
<ReplyFormat>
<FlightNumber>varchar(20)</FlightNumber>
<DepartureDateTime>date</DepartureDateTime>
<DcsBookingId>bigint</DcsBookingId>
<BookingNumber>integer</BookingNumber>
<Locator>varchar(20)</Locator>
<ExternalLocator>varchar(20)</ExternalLocator>
<OriginName>varchar(240)</OriginName>
<DcsPassengerCodeRcd>varchar(20)</DcsPassengerCodeRcd>
<DcsPassengerTypeRcd>varchar(20)</DcsPassengerTypeRcd>
<PassengerName>varchar(240)</PassengerName>
<DcsPassengerTitleRcd>varchar(20)</DcsPassengerTitleRcd>
<LastName>varchar(50)</LastName>
<FirstName>varchar(50)</FirstName>
<DcsClassRcd>varchar(20)</DcsClassRcd>
<DcsCompartmentRcd>varchar(20)</DcsCompartmentRcd>
<SeatNumber>varchar(20)</SeatNumber>
<DcsPassengerId>bigint</DcsPassengerId>
<DcsCheckinStatusRcd>varchar(20)</DcsCheckinStatusRcd>
<Description>varchar(200)</Description>
<DcsCheckinId>bigint</DcsCheckinId>
<DcsPriorityRcd>varchar(20)</DcsPriorityRcd>
<FromCarrierFlightNumber>varchar(20)</FromCarrierFlightNumber>
<ToCarrierFlightNumber>varchar(20)</ToCarrierFlightNumber>
<DcsFlightId>bigint</DcsFlightId>
<SortOrder>integer</SortOrder>
<OriginAirportCode>varchar(20)</OriginAirportCode>
<DestinationAirportCode>varchar(20)</DestinationAirportCode>
<FinalDestination>varchar(20)</FinalDestination>
<CreatedDateTime>date</CreatedDateTime>
<ThruFlag>integer</ThruFlag>
<InvalidatedDcsGatewayActionId>bigint</InvalidatedDcsGatewayActionId>
</ReplyFormat>
<PassengerList>
<Child>
<FlightNumber>RT1111</FlightNumber>
<DepartureDateTime>2008-06-12 22:35:00</DepartureDateTime>
<DcsBookingId>592985192096183427</DcsBookingId>
<BookingNumber>2686547</BookingNumber>
<Locator>HNWCYW</Locator>
<ExternalLocator/>
<OriginName>Native</OriginName>
<DcsPassengerCodeRcd>ADULT</DcsPassengerCodeRcd>
<DcsPassengerTypeRcd>Male</DcsPassengerTypeRcd>
<PassengerName>TEST/SELECTEE</PassengerName>
<DcsPassengerTitleRcd/>
<LastName>TEST</LastName>
<FirstName>SELECTEE</FirstName>
<DcsClassRcd>C</DcsClassRcd>
<DcsCompartmentRcd>C</DcsCompartmentRcd>
<SeatNumber/>
<DcsPassengerId>841946572474553349</DcsPassengerId>
<DcsCheckinStatusRcd>ConfRev</DcsCheckinStatusRcd>
<Description>Confirmed Revenue</Description>
<DcsCheckinId>926764197021725813</DcsCheckinId>
XML Service APIs Page 217
<DcsPriorityRcd>Normal</DcsPriorityRcd>
<FromCarrierFlightNumber/>
<ToCarrierFlightNumber/>
<DcsFlightId>42516784968418499</DcsFlightId>
<SortOrder>80</SortOrder>
<OriginAirportCode>FLL</OriginAirportCode>
<DestinationAirportCode>LGA</DestinationAirportCode>
<FinalDestination>LGA</FinalDestination>
<CreatedDateTime>2008-06-12 11:12:46</CreatedDateTime>
<ThruFlag>0</ThruFlag>
<InvalidatedDcsGatewayActionId/>
</Child>
</PassengerList>
</RRT:GetPassengerListReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 218
GetCheckinStatusForPassenger
This service returns the check-in status for a specific passenger using the DCS_Checkin_Id, which is a unique
identifier for the passenger’s check-in.
Parameters:
DcsCheckinId
18-digit string from the GetPassengerList call
ReplyFormat
The wrapper node that contains all the return values
CheckinStatus
The wrapper node that contains the passenger’s checkin status information
PassengerName
Format is LAST/FIRST
LastName
Passenger’s last name
FirstName
Passenger’s first name
MiddleName
Passenger’s middle name
DcsPassengerTitleRcd
Title of the passenger shown in DCS, like Mr or Mrs
DcsPassengerCodeRcd
Passenger code shown in DCS. For example, ADULT
DcsPassengerTypeRcd
Genger of the passenger. For example, MALE
DcsCheckinStatusRcd
Valid values are Init (initialization); Partially Checked-in; Confirmed Revenue (i.e. boarding pass is printed)
Return values:
Init
Initialization
XML Service APIs Page 219
Partially Checked-in
For example, a seat assigned or baggage has been checked in
Confirmed Revenue
That is, boarding pass printed
Sample request:
<?xml version=”1.0” encoding=”UTF-8” standalone=”no” ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1=”http://www.w3.org/2001/XMLSchema”
xmlns:SOAPSDK2=”http://www.w3.org/2001/XMLSchema-instance”
xmlns:SOAPSDK3=”http://schemas.xmlsoap.org/soap/encoding/”
xmlns:SOAP-ENV=”http://schemas.xmlsoap.org/soap/envelope/”>
<SOAP-ENV:Body>
<RRT:GetCheckinStatusForPassenger xmlns:RRT=”RRT”>
<DcsCheckinId>359991372911998058</DcsCheckinId>
</RRT:GetCheckinStatusForPassenger>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version=”1.0” encoding=”UTF-8” standalone=”no” ?>
<soap:Envelope xmlns:soap=”http://schemas.xmlsoap.org/soap/envelope/”>
<soap:Header/>
<soap:Body>
<RRT:GetCheckinStatusForPassengerReply xmlns:RRT=”http://rrtechnologies.net/soap/”
ADMIN_DATA_DUMP=”true”>
<ReplyFormat>
<PassengerName>varchar(240)</PassengerName>
<LastName>varchar(50)</LastName>
<FirstName>varchar(50)</FirstName>
<MiddleName>varchar(50)</MiddleName>
<DcsPassengerTitleRcd>varchar(20)</DcsPassengerTitleRcd>
<DcsPassengerCodeRcd>varchar(20)</DcsPassengerCodeRcd>
<DcsPassengerTypeRcd>varchar(20)</DcsPassengerTypeRcd>
<DcsCheckinStatusRcd>varchar(20)</DcsCheckinStatusRcd>
</ReplyFormat>
<CheckinStatus>
<Child>
<PassengerName>SMITH/ANGELA</PassengerName>
<LastName>SMITH</LastName>
<FirstName>ANGELA</FirstName>
<MiddleName/>
<DcsPassengerTitleRcd/>
<DcsPassengerCodeRcd>ADULT</DcsPassengerCodeRcd>
<DcsPassengerTypeRcd>Male</DcsPassengerTypeRcd>
<DcsCheckinStatusRcd>Init</DcsCheckinStatusRcd>
</Child>
</CheckinStatus>
</RRT:GetCheckinStatusForPassengerReply>
</soap:Body>
XML Service APIs Page 220
</soap:Envelope>
GetPassengerInfo
This service takes the passenger id and returns the passenger’s name; type and code. For example,
SMITH/ANGELINA; Female; Adult.
Parameters:
DcsPassengerId
Otained from GetPassengerList call
Return values:
PassengerStatus
The wrapper node that contains information on all the passengers in a passenger list
Child
The wrapper node that contains information on each individual passenger
PassengerName
Format is LAST/FIRST
LastName
Passenger’s last name
FirstName
Passenger’s first name
MiddleName
Passenger’s middle name
DcsPassengerTitleRcd
Passenger’s title
DcsPassengerCodeRcd
Passenger code e.g. Adult, Infant, etc
DcsPassengerTypeRcd
Passenger type e.g. Male, Female, etc
XML Service APIs Page 221
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetPassengerInfo xmlns:RRT="RRT">
<DcsPassengerId>400657278934737994</DcsPassengerId>
</RRT:GetPassengerInfo>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetPassengerInfoReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<PassengerName>varchar(240)</PassengerName>
<LastName>varchar(50)</LastName>
<FirstName>varchar(50)</FirstName>
<MiddleName>varchar(50)</MiddleName>
<DcsPassengerTitleRcd>varchar(20)</DcsPassengerTitleRcd>
<DcsPassengerCodeRcd>varchar(20)</DcsPassengerCodeRcd>
<DcsPassengerTypeRcd>varchar(20)</DcsPassengerTypeRcd>
</ReplyFormat>
<PassengerStatus>
<Child>
<PassengerName>SMITH/ANGELA</PassengerName>
<LastName>SMITH</LastName>
<FirstName>ANGELA</FirstName>
<MiddleName/>
<DcsPassengerTitleRcd/>
<DcsPassengerCodeRcd>ADULT</DcsPassengerCodeRcd>
<DcsPassengerTypeRcd>Male</DcsPassengerTypeRcd>
</Child>
</PassengerStatus>
</RRT:GetPassengerInfoReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 222
GetRequestsByCheckin
This service retrieves the passenger’s service requests (SSR) for the Check-in.
Parameters:
DcsPassengerId
Obtained from GetPassengerList call
DcsCheckinId
Obtained from GetPassengerList call
Return values:
Requests
Wrapper node that contains all the service requests of the passenger
DcsPassengerRequestId
Passenger Request ID
DcsServiceRequestRid
The service type (example:seat) ID in DCS. This ID remains the same for different passenger if the service type
does not change
RequestedCount
Number of request of the same type for a passenger
ServiceRequestDescription
Text description of the service request. For exampole: Seat Requested
RequiresActionDescription
Text to describe if action is needed for this type of service request
ActionTakenFlag
Flag to indicate if action has been taken for this request. 0 means not taken; 1 means the opposite
AddedFromDcsFlag
Flag to indicate if this request is iniated from DCS. 0 means not from DCS; 1 means the opposite
PaidFlag
Flag to indicate if this request has been paid by the passenger. 0 means not paid; 1 means the opposite
PassengerRequestComment
Text that comes with the request. For example, if the request is seat, the text here should be the seat number (2A)
XML Service APIs Page 223
Sample request:
<?xml version=”1.0” encoding=”UTF-8” standalone=”no” ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema”
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance”
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetRequestsByCheckin xmlns:RRT="RRT">
<DcsPassengerId>634179250061530141</DcsPassengerId>
<DcsCheckinId>1042824714171827352</DcsCheckinId>
</RRT:GetRequestsByCheckin>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetRequestsByCheckinReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<DcsPassengerRequestId>bigint</DcsPassengerRequestId>
<DcsServiceRequestRid>varchar(40)</DcsServiceRequestRid>
<RequestedCount>integer</RequestedCount>
<ServiceRequestDescription>varchar(240)</ServiceRequestDescription>
<RequiresActionDescription>varchar(240)</RequiresActionDescription>
<ActionTakenFlag>integer</ActionTakenFlag>
<AddedFromDcsFlag>integer</AddedFromDcsFlag>
<PaidFlag>integer</PaidFlag>
<PassengerRequestComment>varchar(240)</PassengerRequestComment>
</ReplyFormat>
<Requests>
<Child>
<DcsPassengerRequestId>23453092823704749</DcsPassengerRequestId>
<DcsServiceRequestRid>436158869850915945</DcsServiceRequestRid>
<RequestedCount>1</RequestedCount>
<ServiceRequestDescription>Seat Requested</ServiceRequestDescription>
<RequiresActionDescription>No action required</RequiresActionDescription>
<ActionTakenFlag>0</ActionTakenFlag>
<AddedFromDcsFlag>1</AddedFromDcsFlag>
<PaidFlag>0</PaidFlag>
<PassengerRequestComment>2A</PassengerRequestComment>
</Child>
<Child>
<DcsPassengerRequestId>337987476265456736</DcsPassengerRequestId>
<DcsServiceRequestRid>436158869850915945</DcsServiceRequestRid>
<RequestedCount>1</RequestedCount>
<ServiceRequestDescription>Seat Requested</ServiceRequestDescription>
<RequiresActionDescription>No action required</RequiresActionDescription>
<ActionTakenFlag>0</ActionTakenFlag>
<AddedFromDcsFlag>1</AddedFromDcsFlag>
XML Service APIs Page 224
<PaidFlag>0</PaidFlag>
<PassengerRequestComment>1A</PassengerRequestComment>
</Child>
<Child>
<DcsPassengerRequestId>953007719094793248</DcsPassengerRequestId>
<DcsServiceRequestRid>222423905972233252</DcsServiceRequestRid>
<RequestedCount>0</RequestedCount>
<ServiceRequestDescription>Child description</ServiceRequestDescription>
<RequiresActionDescription>No action required</RequiresActionDescription>
<ActionTakenFlag>0</ActionTakenFlag>
<AddedFromDcsFlag>0</AddedFromDcsFlag>
<PaidFlag>0</PaidFlag>
<PassengerRequestComment>3YRS</PassengerRequestComment>
</Child>
</Requests>
</RRT:GetRequestsByCheckinReply>
</soap:Body>
</soap:Envelope>
</soap:Envelope>
XML Service APIs Page 225
GetActions
This service populates the Actions tab in the Check-in form for the actions that need to be addressed before a
passenger check-in can be completed and before the boarding pass can be printed.
Parameters:
DcsCheckinId
Obtained from GetPassengerList call
Actions
The wrapper node that contains all the actions needed in DCS
DcsPassengerRequestId
Passenger request ID
DcsSelecteeId
Selectee ID
DcsPassengerInfoRequestId
Passenger Info Request ID
DcsNoFlyId
No-Fly ID
DcsCheckinActionId
Check-in Action ID
DcsGatewayDiscrepancyId
Gateway ID
Description
The actual action required. Example: APIS
RequiresActionDescription
Text to describe the action
ActionTakenDescription
Text to describe the action taken
ActionTakenFlag
Flag to indicate of the action has been completed. 0 means not completed; 1 means completed
ActionComment
Not required
DcsActionSecurityRcd
This is the action value (Apis; Nofly; Selectee; Unpaid Balance )
Return values:
XML Service APIs Page 226
APIS
Advanced Passenger Information System
Nofly
TSA Government No-Fly watch list
Selectee
TSA Government Selectee watch list
Unpaid
Un-paid booking
APIS
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetActions xmlns:RRT="RRT">
<DcsCheckinId>359991372911998058</DcsCheckinId>
</RRT:GetActions>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetActionsReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<DcsPassengerRequestId>bigint</DcsPassengerRequestId>
<DcsSelecteeId>bigint</DcsSelecteeId>
<DcsPassengerInfoRequestId>bigint</DcsPassengerInfoRequestId>
<DcsNoFlyId>bigint</DcsNoFlyId>
<DcsCheckinActionId>bigint</DcsCheckinActionId>
<DcsGatewayDiscrepancyId>bigint</DcsGatewayDiscrepancyId>
<Description>varchar(240)</Description>
<RequiresActionDescription>varchar(240)</RequiresActionDescription>
<ActionTakenDescription>varchar(240)</ActionTakenDescription>
<ActionTakenFlag>integer</ActionTakenFlag>
<ActionComment>varchar(240)</ActionComment>
<DcsActionSecurityRcd>varchar(240)</DcsActionSecurityRcd>
</ReplyFormat>
<Actions>
<Child>
<DcsPassengerRequestId>0</DcsPassengerRequestId>
XML Service APIs Page 227
<DcsSelecteeId>0</DcsSelecteeId>
<DcsPassengerInfoRequestId>481273126373057786</DcsPassengerInfoRequestId>
<DcsNoFlyId>0</DcsNoFlyId>
<DcsCheckinActionId>0</DcsCheckinActionId>
<DcsGatewayDiscrepancyId>0</DcsGatewayDiscrepancyId>
<Description>APIS</Description>
<RequiresActionDescription>Enter Document Information</RequiresActionDescription>
<ActionTakenDescription/>
<ActionTakenFlag>1</ActionTakenFlag>
<ActionComment/>
<DcsActionSecurityRcd>Apis</DcsActionSecurityRcd>
</Child>
</Actions>
</RRT:GetActionsReply>
</soap:Body>
</soap:Envelope>
Selectee
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetActions xmlns:RRT="RRT">
<DcsCheckinId>303439896325039185</DcsCheckinId>
</RRT:GetActions>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample reponse:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetActionsReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<DcsPassengerRequestId>bigint</DcsPassengerRequestId>
<DcsSelecteeId>bigint</DcsSelecteeId>
<DcsPassengerInfoRequestId>bigint</DcsPassengerInfoRequestId>
<DcsNoFlyId>bigint</DcsNoFlyId>
<DcsCheckinActionId>bigint</DcsCheckinActionId>
<DcsGatewayDiscrepancyId>bigint</DcsGatewayDiscrepancyId>
<Description>varchar(240)</Description>
<RequiresActionDescription>varchar(240)</RequiresActionDescription>
<ActionTakenDescription>varchar(240)</ActionTakenDescription>
<ActionTakenFlag>integer</ActionTakenFlag>
XML Service APIs Page 228
<ActionComment>varchar(240)</ActionComment>
<DcsActionSecurityRcd>varchar(240)</DcsActionSecurityRcd>
</ReplyFormat>
<Actions>
<Child>
<DcsPassengerRequestId>0</DcsPassengerRequestId>
<DcsSelecteeId>53495603926283304</DcsSelecteeId>
<DcsPassengerInfoRequestId>0</DcsPassengerInfoRequestId>
<DcsNoFlyId>0</DcsNoFlyId>
<DcsCheckinActionId>0</DcsCheckinActionId>
<DcsGatewayDiscrepancyId>0</DcsGatewayDiscrepancyId>
<Description>Selectee</Description>
<RequiresActionDescription>ResultS Gateway</RequiresActionDescription>
<ActionTakenDescription>Not cleared</ActionTakenDescription>
<ActionTakenFlag>0</ActionTakenFlag>
<ActionComment/>
<DcsActionSecurityRcd>Selectee</DcsActionSecurityRcd>
</Child>
</Actions>
</RRT:GetActionsReply>
</soap:Body>
</soap:Envelope>
UpdateRequestAction
This service call is used to update the action item.
Sample request:
XML Service APIs Page 229
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:UpdateRequestAction xmlns:RRT="RRT">
<DcsPassengerRequestId>358220247733040348</DcsPassengerRequestId>
<Comment></Comment>
<DcsServiceRequestRid></DcsServiceRequestRid>
<ActionComment></ActionComment>
<RequestedCount></RequestedCount>
<ActionTakenFlag>1</ActionTakenFlag>
<DcsUserId>671884342155244708</DcsUserId>
</RRT:UpdateRequestAction>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample reponse:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:UpdateRequestActionReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<DcsPassengerRequestId>bigint</DcsPassengerRequestId>
</ReplyFormat>
</RRT:UpdateRequestActionReply>
</soap:Body>
</soap:Envelope>
Note: The reply does not have an OK indicator, so the error conditions will be general SOAP errors and not the typical
error codes. To validate that the action update took place; re-retrieve the passenger’s action codes and make sure the
action was marked as checked i.e. ActionTakenFlag value is 1.
UpdateSelecteeAction
This service call is used to clear a selectee to enable checkin to proceed.
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
XML Service APIs Page 230
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:UpdateSelecteeAction xmlns:RRT="RRT">
<DcsSelecteeId>150421371246232747</DcsSelecteeId>
<DcsSelecteeClearingReasonCodeRcd>ANC</DcsSelecteeClearingReasonCodeRcd>
<ActionTakenFlag>0</ActionTakenFlag>
<ActionComment>Passenger to be cleared by TSA</ActionComment>
<DcsLocationRcd>Susan</DcsLocationRcd>
<Witness>TEST</Witness>
<Comment>Passenger to be cleared by TSA</Comment>
<DcsUserId>659664309577364680</DcsUserId>
</RRT:UpdateSelecteeAction>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?> <soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:UpdateSelecteeActionReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<DcsSelecteeId>bigint</DcsSelecteeId>
</ReplyFormat>
<Child>
<DcsSelecteeId>916369454150169665</DcsSelecteeId>
</Child>
</RRT:UpdateSelecteeActionReply>
</soap:Body>
</soap:Envelope>
GetPassportInfoFromServiceRequest
This service fetches any passport passenger information for a specific passenger from the service request i.e.
PSPT SSR.
Parameters:
DcsPassengerId
Otained from GetPassengerList call
XML Service APIs Page 231
Child
The wrapper node that contains all the document information parameters
DocumentType
Travel document type e.g. passport
DocumentNumber
Travel document number
CountryCode
Country code where document was issued
BirthDate
Passenger’s date of birth
Gender
Passenger’s gender e.g. male; female
Return values:
Document type values include:
Code Description
A Alien Registration Card
C Permanent Resident Card
F Facilitation Document (e.g. deportee or consular letter)
G US Merchant Mariner Document
I NEXUS or SENTRI Card
M US Military ID
P Passport
T Re-entry or Refugee Permit
V Visa
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetPassportInfoFromServiceRequest xmlns:RRT="RRT">
<DcsPassengerId>783323375479411882</DcsPassengerId>
</RRT:GetPassportInfoFromServiceRequest>
XML Service APIs Page 232
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetPassportInfoFromServiceRequestReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<DocumentType>varchar(20)</DocumentType>
<DocumentNumber>varchar(20)</DocumentNumber>
<CountryCode>varchar(20)</CountryCode>
<BirthDate>varchar(20)</BirthDate>
<Gender>varchar(20)</Gender>
</ReplyFormat>
<Child>
<DocumentType>P</DocumentType>
<DocumentNumber>1234567</DocumentNumber>
<CountryCode>UK</CountryCode>
<BirthDate>20JAN06</BirthDate>
<Gender>M</Gender>
</Child>
</RRT:GetPassportInfoFromServiceRequestReply>
</soap:Body>
</soap:Envelope>
SaveTravelDocument
This service saves the passenger passport information for local government requirement.
Parameters:
DcsPassengerId
Obtained from getPassengerList call
DcsCountryOfResidence
Passenger’s country of residence according to the document collected
XML Service APIs Page 233
DcsCitizenCountryCode
Passenger Country of Citizenship
DcsGenderType
Gender of the passenger
BirthDate
Passenger’s date of birth
TelephoneNumber
Telephone number
Address
Address
AddressCity
City
AddressProvince
State
AddressPostCode
Zip Code
EmergencyContactName
Emergency contact name
EmergencyPhoneNumber
Emergency phone number
DcsPassengerDocumentType
Type of document collected
DocumentNumber
Travel document number
IssuingCountryCode
Country code that issues the document
ExpirationDate
Document expiration date
DcsUserId
Obtained from dcs_user table
DcsPassengerDocumentId
Document ID
Return values:
Document type values include:
Code Description
XML Service APIs Page 234
A Alien Registration Card
C Permanent Resident Card
F Facilitation Document (e.g. deportee or consular letter)
G US Merchant Mariner Document
I NEXUS or SENTRI Card
M US Military ID
P Passport
T Re-entry or Refugee Permit
V Visa
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:SaveTravelDocument xmlns:RRT="RRT">
<DcsPassengerId>500431214337184799</DcsPassengerId>
<DcsCountryOfResidence>PR</DcsCountryOfResidence>
<DcsCitizenCountryCode>PR</DcsCitizenCountryCode>
<DcsGenderType>F</DcsGenderType>
<BirthDate>10/27/2006</BirthDate>
<TelephoneNumber></TelephoneNumber>
<Address></Address>
<AddressCity></AddressCity>
<AddressProvince></AddressProvince>
<AddressPostCode></AddressPostCode>
<EmergencyContactName></EmergencyContactName>
<EmergencyPhoneNumber></EmergencyPhoneNumber>
<DcsPassengerDocumentType>V</DcsPassengerDocumentType>
<DocumentNumber>a43526</DocumentNumber>
<IssuingCountryCode>PR</IssuingCountryCode>
<ExpirationDate>2006-10-27 22:19:51</ExpirationDate>
<DcsUserId>659664309577364680</DcsUserId>
</RRT:SaveTravelDocument>
</SOAP-ENV:Body>
Sample response:
</SOAP-ENV:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:SaveTravelDocumentReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<DcsPassengerInfoId>bigint</DcsPassengerInfoId>
</ReplyFormat>
<Child>
<DcsPassengerDocumentId>801446767694255222</DcsPassengerDocumentId>
XML Service APIs Page 235
</Child>
</RRT:SaveTravelDocumentReply>
</soap:Body>
</soap:Envelope>
UpdatePassengerInfoAction
This service marks the action item as being completed.
Paremeters:
DcsPassengerInfoRequestId
Passenger Info Request ID
ActionTakenFlag
Action taken flag; 1 for true i.e. action cleared
DcsUserId
Obtained from dcs_user table
XML Service APIs Page 236
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:UpdatePassengerInfoAction xmlns:RRT="RRT">
<DcsPassengerInfoRequestId>122475823348065523</DcsPassengerInfoRequestId>
<ActionTakenFlag>1</ActionTakenFlag>
<DcsUserId>659664309577364680</DcsUserId>
</RRT:UpdatePassengerInfoAction>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:UpdatePassengerInfoActionReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<DcsPassengerInfoRequestId>bigint</DcsPassengerInfoRequestId>
</ReplyFormat>
</RRT:UpdatePassengerInfoActionReply>
</soap:Body>
</soap:Envelope>
GetBaggage
This service retrieves the baggage detail for the passenger Check-in. Values include baggage description, weight
and charge
Parameters:
DcsCheckinId
Obtained from getPassengerList call
Return values:
DcsBaggageId
Baggage ID
TagNumber
Baggage tag number
XML Service APIs Page 237
DcsBaggageColorRcd
Baggage color code
DcsBaggageCodeRcd
Baggage code
RuleTypeDescription
Baggage rule description
Weight
Baggage weight
WeightDescription
Text description of the baggage weight UOM. Example: Pounds
DcsWeightTypeRcd
Code of the baggage weight UOM. Example: Lb
DamagedFlag
Flag to indicate if the bag is damaged. 0 means not damanaged; 1 means the opposite
Amount
Amount charged for this baggage if it applies
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetBaggage xmlns:RRT="RRT">
<DcsCheckinId>359991372911998058</DcsCheckinId>
</RRT:GetBaggage>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetBaggageReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<DcsBaggageId>bigint</DcsBaggageId>
<TagNumber>varchar(20)</TagNumber>
<DcsBaggageColorRcd>varchar(20)</DcsBaggageColorRcd>
<DcsBaggageCodeRcd>varchar(20)</DcsBaggageCodeRcd>
<RuleTypeDescription>varchar(240)</RuleTypeDescription>
<Description>varchar(240)</Description>
XML Service APIs Page 238
<Weight>currency</Weight>
<WeightDescription>varchar(240)</WeightDescription>
<DcsWeightTypeRcd>varchar(20)</DcsWeightTypeRcd>
<DamagedFlag>integer</DamagedFlag>
<Amount>currency</Amount>
<TotalWeight>currency</TotalWeight>
<DcsWeightTypeRcdDefault>varchar(20)</DcsWeightTypeRcdDefault>
</ReplyFormat>
<GetBaggage>
<Child>
<DcsBaggageId>478324683596629039</DcsBaggageId>
<TagNumber>529</TagNumber>
<DcsBaggageColorRcd>NA</DcsBaggageColorRcd>
<DcsBaggageCodeRcd>Normal</DcsBaggageCodeRcd>
<RuleTypeDescription>Baggage free when between two
weights</RuleTypeDescription>
<Description/>
<Weight>10.0000</Weight>
<WeightDescription>Pounds</WeightDescription>
<DcsWeightTypeRcd>Lb</DcsWeightTypeRcd>
<DamagedFlag>0</DamagedFlag>
<Amount/>
<TotalWeight>35.0000000000000000</TotalWeight>
<DcsWeightTypeRcdDefault>Lb</DcsWeightTypeRcdDefault>
</Child>
<Child>
<DcsBaggageId>1132348223977853958</DcsBaggageId>
<TagNumber>530</TagNumber>
<DcsBaggageColorRcd>NA</DcsBaggageColorRcd>
<DcsBaggageCodeRcd>Normal</DcsBaggageCodeRcd>
<RuleTypeDescription>Percentage of amount between two
weights</RuleTypeDescription>
<Description/>
<Weight>25.0000</Weight>
<WeightDescription>Pounds</WeightDescription>
<DcsWeightTypeRcd>Lb</DcsWeightTypeRcd>
<DamagedFlag>0</DamagedFlag>
<Amount>311.2507</Amount>
</Child>
</GetBaggage>
</RRT:GetBaggageReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 239
CanPassengerHaveBaggage
This service checks whether a passenger is allowed to have checked baggage and is controlled by system setting
DCS_NOBAG_PAX_TYPE
Parameters:
DcsPassengerId
Obtained from getPassengerList call
Return values:
AllowedFlag
0 - means no baggage allowed;
1 - means true i.e. baggage allowed
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
XML Service APIs Page 240
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:CanPassengerHaveBaggage xmlns:RRT="RRT">
<DcsPassengerId>27104934735008786</DcsPassengerId>
</RRT:CanPassengerHaveBaggage>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:CanPassengerHaveBaggageReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<AllowedFlag>integer</AllowedFlag>
</ReplyFormat>
<Child>
<AllowedFlag>0</AllowedFlag>
</Child>
</RRT:CanPassengerHaveBaggageReply>
</soap:Body>
</soap:Envelope>
SaveBaggage
This service saves the passenger’s baggage check-in information.
Parameters:
DcsBaggageId
Empty if the bag is not checked in yet
DcsCheckinId
Obtained from the getpassengerList call
Return values:
DcsBaggageId
A digit string generated by system when the bag is checked in
Indocator
To indicate if the baggage is acceptable for transportation
DcsBaggageCodeRcd
Baggage code e.g. Normal; Excess; Overweight
XML Service APIs Page 241
Description
Remark e.g. heavy bag
DamagedFlag
Damage flag indicator
Weight
Baggage weight
DcsWeightTypeRcd
Baggage weight type e.g. pounds;kilos; etc
CreatedUserId
Agent who checked in the bag
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:SaveBaggage xmlns:RRT="RRT">
<DcsBaggageId></DcsBaggageId>
<DcsCheckinId>196639496704463970</DcsCheckinId>
<DcsBaggageCodeRcd>Normal</DcsBaggageCodeRcd>
<TagNumber></TagNumber>
<ManualTagNumber></ManualTagNumber>
<Weight>5</Weight>
<DcsBaggageColorRcd>NA</DcsBaggageColorRcd>
<Description></Description>
<DamagedFlag>0</DamagedFlag>
<Weight>5</Weight>
<DcsWeightTypeRcd>Lb</DcsWeightTypeRcd>
<CreatedUserId>659664309577364680</CreatedUserId>
</RRT:SaveBaggage>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
XML Service APIs Page 242
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:SaveBaggageReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<DcsBaggageId>bigint</DcsBaggageId>
<Indicator>varchar(20)</Indicator>
</ReplyFormat>
<Child>
<DcsBaggageId>306067550197994641</DcsBaggageId>
<Indicator>Ok</Indicator>
</Child>
</RRT:SaveBaggageReply>
</soap:Body>
</soap:Envelope>
RemoveBaggage
This service removes the passenger’s baggage check-in information.
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:RemoveBaggage xmlns:RRT="RRT">
<DcsBaggageId>1082546617798673452</DcsBaggageId>
<DcsUserId>671884342155244708</DcsUserId>
</RRT:RemoveBaggage>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
XML Service APIs Page 243
<RRT:RemoveBaggageReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<ReturnCode>varchar(20)</ReturnCode>
</ReplyFormat>
<Child>
<ReturnCode>Ok</ReturnCode>
</Child>
</RRT:RemoveBaggageReply>
</soap:Body>
</soap:Envelope>
GetFlightDateAllSeats
This service retrieves the seat definition for all flights including any blocked seats and pre-assigned seats as well
as seat attributes e.g. exit row. The service can also be used to get seat assignments for all legs of a multi-leg
flight using DcsFlightId.
Parameters:
DcsFlightId
Obtained from getpassegerList call. Not required here
DcsFlightSegmentId
Obtained from GetBookingLegs call. Required here
SellingClassCode
Required here
Return values:
SeatMapId
This is the same for all the selling classes that belong to the same cabin
SeatDefinitionId
A unique number that is
RowNumber
Seat row number
SeatCode
Code assigned to this row of seats. Examples: A, C, etc.
XML Service APIs Page 244
SeatNumber
This is RowNumber plus the SeatCode
PositionX/PositionY
This is the horizontal and vertical location in pixels of the seat in the seat map image
AvailableFlag
Boolean flag (Y/N), indicating whether the seat is available for sale
BlockedFlag
Boolean flag (Y/N) indicating whether the seat is blocked
ForSaleFlag
Boolean flag (Y/N) indicating whether the seat is within the selling period (i.e. after the start selling time and before
the stop selling time). In DCS, this flag for all seats is going to be marked by N since the checkin time is normally
beyond the stop selling time. You can reserve a seat as long as its AvailableFlag is Y.
Locator
This indicates to which locator this seat is assgined to. If empty, the seat is available for assignment
BookNo
Booking reference number
FlightSeatReservationId
Reserved Seat ID
ReservationDescription
PNR Remark
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetFlightDateAllSeats xmlns:RRT="RRT">
<DcsFlightId></DcsFlightId>
<DcsFlightSegmentId>327902220545913942</DcsFlightSegmentId>
<SellingClassCode>C</SellingClassCode>
</RRT:GetFlightDateAllSeats>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
XML Service APIs Page 245
<RRT:GetFlightDateAllSeatsReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<SeatMapId>integer</SeatMapId>
<SeatDefinitionId>bigint</SeatDefinitionId>
<RowNumber>smallint</RowNumber>
<SeatCode>varchar(2)</SeatCode>
<SeatNumber>varchar(5)</SeatNumber>
<PositionX>integer</PositionX>
<PositionY>integer</PositionY>
<next_seat_right_id>integer</next_seat_right_id>
<next_seat_left_id>integer</next_seat_left_id>
<AvailableFlag>char(1)</AvailableFlag>
<BlockedFlag>char(1)</BlockedFlag>
<ForSaleFlag>char(1)</ForSaleFlag>
<Locator>char(6)</Locator>
<BookNo>bigint</BookNo>
<FlightSeatReservationId>bigint</FlightSeatReservationId>
<ReserveDescription>varchar(250)</ReserveDescription>
</ReplyFormat>
<SeatAttributes>
<Child>
<SeatMapId>5</SeatMapId>
<SeatDefinitionId>180</SeatDefinitionId>
<RowNumber>1</RowNumber>
<SeatCode>A</SeatCode>
<SeatNumber>1A</SeatNumber>
<PositionX>198</PositionX>
<PositionY>151</PositionY>
<NextSeatRightId/>
<NextSeatLeftId/>
<AvailableFlag>Y</AvailableFlag>
<BlockedFlag>N</BlockedFlag>
<ForSaleFlag>N</ForSaleFlag>
<Locator/>
<BookNo/>
<FlightSeatReservationId/>
<ReserveDescription/>
</Child>
<Child>
<SeatMapId>5</SeatMapId>
<SeatDefinitionId>181</SeatDefinitionId>
<RowNumber>1</RowNumber>
<SeatCode>C</SeatCode>
<SeatNumber>1C</SeatNumber>
<PositionX>199</PositionX>
<PositionY>126</PositionY>
<NextSeatRightId/>
<NextSeatLeftId/>
<AvailableFlag>Y</AvailableFlag>
<BlockedFlag>N</BlockedFlag>
<ForSaleFlag>N</ForSaleFlag>
<Locator/>
<BookNo/>
<FlightSeatReservationId/>
<ReserveDescription/>
</Child>
XML Service APIs Page 246
<Child>
<SeatMapId>5</SeatMapId>
<SeatDefinitionId>182</SeatDefinitionId>
<RowNumber>1</RowNumber>
<SeatCode>D</SeatCode>
<SeatNumber>1D</SeatNumber>
<PositionX>200</PositionX>
<PositionY>85</PositionY>
<NextSeatRightId/>
<NextSeatLeftId/>
<AvailableFlag>Y</AvailableFlag>
<BlockedFlag>N</BlockedFlag>
<ForSaleFlag>N</ForSaleFlag>
<Locator/>
<BookNo/>
<FlightSeatReservationId/>
<ReserveDescription/>
</Child>
<Child>
<SeatMapId>5</SeatMapId>
<SeatDefinitionId>183</SeatDefinitionId>
<RowNumber>1</RowNumber>
<SeatCode>F</SeatCode>
<SeatNumber>1F</SeatNumber>
<PositionX>198</PositionX>
<PositionY>58</PositionY>
<NextSeatRightId/>
<NextSeatLeftId/>
<AvailableFlag>Y</AvailableFlag>
<BlockedFlag>N</BlockedFlag>
<ForSaleFlag>N</ForSaleFlag>
<Locator/>
<BookNo/>
<FlightSeatReservationId/>
<ReserveDescription/>
</Child>
<Child>
<SeatMapId>5</SeatMapId>
<SeatDefinitionId>184</SeatDefinitionId>
<RowNumber>2</RowNumber>
<SeatCode>A</SeatCode>
<SeatNumber>2A</SeatNumber>
<PositionX>227</PositionX>
<PositionY>149</PositionY>
<NextSeatRightId/>
<NextSeatLeftId/>
<AvailableFlag>Y</AvailableFlag>
<BlockedFlag>N</BlockedFlag>
<ForSaleFlag>N</ForSaleFlag>
<Locator/>
<BookNo/>
<FlightSeatReservationId/>
<ReserveDescription/>
</Child>
<Child>
<SeatMapId>5</SeatMapId>
<SeatDefinitionId>185</SeatDefinitionId>
XML Service APIs Page 247
<RowNumber>2</RowNumber>
<SeatCode>C</SeatCode>
<SeatNumber>2C</SeatNumber>
<PositionX>228</PositionX>
<PositionY>123</PositionY>
<NextSeatRightId/>
<NextSeatLeftId/>
<AvailableFlag>Y</AvailableFlag>
<BlockedFlag>N</BlockedFlag>
<ForSaleFlag>N</ForSaleFlag>
<Locator/>
<BookNo/>
<FlightSeatReservationId/>
<ReserveDescription>Blocked</ReserveDescription>
</Child>
<Child>
<SeatMapId>5</SeatMapId>
<SeatDefinitionId>186</SeatDefinitionId>
<RowNumber>2</RowNumber>
<SeatCode>D</SeatCode>
<SeatNumber>2D</SeatNumber>
<PositionX>229</PositionX>
<PositionY>82</PositionY>
<NextSeatRightId/>
<NextSeatLeftId/>
<AvailableFlag>N</AvailableFlag>
<BlockedFlag>Y</BlockedFlag>
<ForSaleFlag>N</ForSaleFlag>
<Locator/>
<BookNo/>
<FlightSeatReservationId>9421434</FlightSeatReservationId>
<ReserveDescription>Blocked</ReserveDescription>
</Child>
<Child>
<SeatMapId>5</SeatMapId>
<SeatDefinitionId>187</SeatDefinitionId>
<RowNumber>2</RowNumber>
<SeatCode>F</SeatCode>
<SeatNumber>2F</SeatNumber>
<PositionX>229</PositionX>
<PositionY>60</PositionY>
<NextSeatRightId/>
<NextSeatLeftId/>
<AvailableFlag>Y</AvailableFlag>
<BlockedFlag>N</BlockedFlag>
<ForSaleFlag>N</ForSaleFlag>
<Locator/>
<BookNo/>
<FlightSeatReservationId/>
<ReserveDescription/>
</Child>
</SeatAttributes>
</RRT:GetFlightDateAllSeatsReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 248
GetFlightDateSeatAttributes
This services describes the seat attributes e.g. aisle; window or passenger seat assignments.
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetFlightDateSeatAttributes xmlns:RRT="RRT">
<DcsFlightId></DcsFlightId>
<DcsFlightSegmentId>327902220545913942</DcsFlightSegmentId>
<SellingClassCode>C</SellingClassCode>
</RRT:GetFlightDateSeatAttributes>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetFlightDateSeatAttributesReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<SeatMapId>integer</SeatMapId>
<SeatDefinitionId>bigint</SeatDefinitionId>
<RowNumber>smallint</RowNumber>
<SeatCode>varchar(2)</SeatCode>
<SeatNumber>varchar(5)</SeatNumber>
<PositionX>integer</PositionX>
<PositionY>integer</PositionY>
XML Service APIs Page 249
<SeatAttributeRcd>varchar(5)</SeatAttributeRcd>
<Description>varchar(250)</Description>
<DescriptionCode>varchar(5)</DescriptionCode>
<ServiceRequestCode>varchar(5)</ServiceRequestCode>
<DcsPassengerCodeRcd>varchar(20)</DcsPassengerCodeRcd>
<Remark>varchar(240)</Remark>
</ReplyFormat>
<SeatAttributes>
<Child>
<SeatMapId>5</SeatMapId>
<SeatDefinitionId>180</SeatDefinitionId>
<RowNumber>1</RowNumber>
<SeatCode>A</SeatCode>
<SeatNumber>1A</SeatNumber>
<PositionX>198</PositionX>
<PositionY>151</PositionY>
<SeatAttribute>WIND</SeatAttribute>
<Description>Window</Description>
<DescriptionCode>WIN</DescriptionCode>
<ServiceRequestCode/>
<DcsPassengerCodeRcd>INF</DcsPassengerCodeRcd>
<Remark/>
</Child>
<Child>
<SeatMapId>5</SeatMapId>
<SeatDefinitionId>185</SeatDefinitionId>
<RowNumber>2</RowNumber>
<SeatCode>C</SeatCode>
<SeatNumber>2C</SeatNumber>
<PositionX>228</PositionX>
<PositionY>123</PositionY>
<SeatAttribute>AISL</SeatAttribute>
<Description>Aisle</Description>
<DescriptionCode>AISLE</DescriptionCode>
<ServiceRequestCode/>
<DcsPassengerCodeRcd>COMP</DcsPassengerCodeRcd>
<Remark>3</Remark>
</Child>
<Child>
<SeatMapId>5</SeatMapId>
<SeatDefinitionId>185</SeatDefinitionId>
<RowNumber>2</RowNumber>
<SeatCode>C</SeatCode>
<SeatNumber>2C</SeatNumber>
<PositionX>228</PositionX>
<PositionY>123</PositionY>
<SeatAttribute>AISL</SeatAttribute>
<Description>Aisle</Description>
<DescriptionCode>AISLE</DescriptionCode>
<ServiceRequestCode>CBBG</ServiceRequestCode>
<DcsPassengerCodeRcd/>
<Remark/>
</Child>
<Child>
<SeatMapId>5</SeatMapId>
<SeatDefinitionId>185</SeatDefinitionId>
<RowNumber>2</RowNumber>
XML Service APIs Page 250
<SeatCode>C</SeatCode>
<SeatNumber>2C</SeatNumber>
<PositionX>228</PositionX>
<PositionY>123</PositionY>
<SeatAttribute>AISL</SeatAttribute>
<Description>Aisle</Description>
<DescriptionCode>AISLE</DescriptionCode>
<ServiceRequestCode>CHD</ServiceRequestCode>
<DcsPassengerCodeRcd>CHD</DcsPassengerCodeRcd>
<Remark>bla bla bla</Remark>
</Child>
<Child>
<SeatMapId>5</SeatMapId>
<SeatDefinitionId>187</SeatDefinitionId>
<RowNumber>2</RowNumber>
<SeatCode>F</SeatCode>
<SeatNumber>2F</SeatNumber>
<PositionX>229</PositionX>
<PositionY>60</PositionY>
<SeatAttribute>WIND</SeatAttribute>
<Description>Window</Description>
<DescriptionCode>WIN</DescriptionCode>
<ServiceRequestCode/>
<DcsPassengerCodeRcd>INF</DcsPassengerCodeRcd>
<Remark/>
</Child>
</SeatAttributes>
</RRT:GetFlightDateSeatAttributesReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 251
SeatAttributeRulesAgainstPassenger
This service checks for any seat attribute rules that have been defined for example, wheelchair passenger cannot
be seated in an exit row. If the passenger has a wheelchair SSR e.g. WCHR then this service will prevent any
seat assignment to an exit row.
Parameter:
DcsPassengerId
Required. This is obtained from the getPassengerList call
SeatDefinitionId
Required. This is obtained from the GetFlightDateSeatAttributes call
DcdFlightId
Not required here. This is obtained from the getPassengerList call
Return values:
ServiceRequestCode
Example: WCHR
DcsPassengerCodeRcd
Example: ADULT
SeatAttributeRcd
Example: EXIT
AllowFlag
This checks passenger SSR against ServiceRequestCode. If the passenger’s SSR code matches that of
ServiceRequestCode, then the passenger cannot have this seat assigned. Values for this field can be 0 or 1. 0
means not allowed; 1 means the opposite
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:SeatAttributeRulesAgainstPassenger xmlns:RRT="RRT">
<DcsPassengerId>1076558471373542505</DcsPassengerId>
<SeatDefinitionId>185</SeatDefinitionId>
<DcsFlightId></DcsFlightId>
</RRT:SeatAttributeRulesAgainstPassenger>
XML Service APIs Page 252
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:SeatAttributeRulesAgainstPassengerReply
xmlns:RRT="http://rrtechnologies.net/soap/" ADMIN_DATA_DUMP="true">
<ReplyFormat>
<ServiceRequestCode>varchar(20)</ServiceRequestCode>
<DcsPassengerCodeRcd>varchar(20)</DcsPassengerCodeRcd>
<SeatAttributeRcd>varchar(5)</SeatAttributeRcd>
<AllowFlag>integer</AllowFlag>
<ServiceRequestDescription>varchar(240)</ServiceRequestDescription>
<DcsPassengerCodeDescription>varchar(240)</DcsPassengerCodeDescription>
<SeatAttributeRuleDescription>varchar(240)</SeatAttributeRuleDescription>
</ReplyFormat>
<SeatRules>
<Child>
<ServiceRequestCode/>
<DcsPassengerCodeRcd>CHD</DcsPassengerCodeRcd>
<SeatAttributeRcd>AISL</SeatAttributeRcd>
<AllowFlag>0</AllowFlag>
<ServiceRequestDescription/>
<DcsPassengerCodeDescription>Child</DcsPassengerCodeDescription>
<SeatAttributeRuleDescription>Aisle</SeatAttributeRuleDescription>
</Child>
</SeatRules>
</RRT:SeatAttributeRulesAgainstPassengerReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 253
ReserveSingleSeatNew
This service reserves a seat assignment and returns a seat confirmation id.
Parameters:
SeatDefinitionId
Otained from GetFlightDateSeatAttributes call
FlightDateLegId
Obatined from GetFlightDateClassSeatMaps call
BookingNumber
DcsUserId
Return values:
FlightSeatReservationId
This is the seat confirmation ID
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:ReserveSingleSeatNew xmlns:RRT="RRT">
<SeatDefinitionId>181</SeatDefinitionId>
<FlightDateLegId>406532</FlightDateLegId>
<BookingNumber>2672651</BookingNumber>
<DcsUserId>659664309577364680</DcsUserId>
</RRT:ReserveSingleSeatNew>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:ReserveSingleSeatNewReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
XML Service APIs Page 254
<FlightSeatReservationGroupId>bigint</FlightSeatReservationGroupId>
</ReplyFormat>
<Child>
<FlightSeatReservationId>9457147</FlightSeatReservationId>
</Child>
</RRT:ReserveSingleSeatNewReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 255
ReleaseSeatCalls
This service is responsible for releasing previously assigned seats.
Return values:
Indicator
Indicate if the call goes through or not. Values can be OK or NOTOK
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:ConfirmRelease xmlns:RRT="RRT">
<FlightSeatReservationId>9457153</FlightSeatReservationId>
<DcsPassengerId>500431214337184799</DcsPassengerId>
<DcsFlightId>836286976835073167</DcsFlightId>
<DcsFlightSegmentId>327902220545913942</DcsFlightSegmentId>
<DcsUserId>659664309577364680</DcsUserId>
</RRT:ConfirmRelease>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:ConfirmReleaseReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<Indicator>varchar(5)</Indicator>
</ReplyFormat>
<Child>
<Indicator>OK</Indicator>
</Child>
</RRT:ConfirmReleaseReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 256
ConfirmAddition
This service confirms the actual seat assignment. The first call is to reserve the seat temporarily, but this call
actually confirms it.
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:ConfirmAddition xmlns:RRT="RRT">
<FlightSeatReservationId>9457153</FlightSeatReservationId>
<DcsPassengerId>500431214337184799</DcsPassengerId>
<DcsCheckinId>196639496704463970</DcsCheckinId>
<DcsFlightId></DcsFlightId>
<DcsFlightSegmentId>327902220545913942</DcsFlightSegmentId>
<DcsUserId>659664309577364680</DcsUserId>
</RRT:ConfirmAddition>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:ConfirmAdditionReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<Indicator>varchar(5)</Indicator>
</ReplyFormat>
<Child>
<Indicator>OK</Indicator>
</Child>
</RRT:ConfirmAdditionReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 257
ValidatePassengerPassPrinting
This service is initiated when the boarding pass is printed.
Return values:
OK
Ok
previous
That is, call previously executed
missing seat
No seat assignment
unpaid charges
Booking has an outstanding balance
No adult printed
This is for an infant passenger. That is, the adult’s boarding pass must be printed before the infant’s
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:ValidatePassengerPassPrinting xmlns:RRT="RRT">
<DcsCheckinId>861769645535114419</DcsCheckinId>
<DcsUserId>659664309577364680</DcsUserId>
</RRT:ValidatePassengerPassPrinting>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:ValidatePassengerPassPrintingReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<Indicator>varchar(20)</Indicator>
</ReplyFormat>
<Child>
<Indicator>OK</Indicator>
</Child>
</RRT:ValidatePassengerPassPrintingReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 258
MarkCheckinReadyForBoarding
The return value for this service is OK; unless a system error is indicated in the SOAP fault nodes.
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:MarkCheckinReadyForBoarding xmlns:RRT="RRT">
<DcsCheckinId>861769645535114419</DcsCheckinId>
<DcsUserId>659664309577364680</DcsUserId>
<DcsBoardingPrintReasonRcd>Original</DcsBoardingPrintReasonRcd>
<Remark/>
</RRT:MarkCheckinReadyForBoarding>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:MarkCheckinReadyForBoardingReply xmlns:RRT="http://rrtechnologies.net/soap/">
<ReplyFormat>
<Indicator>varchar(20)</Indicator>
</ReplyFormat>
<Child>
<Indicator>OK</Indicator>
</Child>
</RRT:MarkCheckinReadyForBoardingReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 259
GetPassengersForBoarding
This service call retrieves the boarding information for the passenger; such as the system generated check-in
sequence identifier, which is stored in the BoardingCardNumber node.
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetPassengersForBoarding xmlns:RRT="RRT">
<DcsCarrierRcd>RT</DcsCarrierRcd>
<FlightNumber>1120</FlightNumber>
<DepartureDate>11/03/2006</DepartureDate>
<DcsOriginAirportId>1</DcsOriginAirportId>
<DcsDestinationAirportId>675623999401555002</DcsDestinationAirportId>
<Locator>HNTQRK</Locator>
<FirstName>SELECTEE</FirstName>
<LastName>PAX</LastName>
</RRT:GetPassengersForBoarding>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetPassengersForBoardingReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<FlightNumber>varchar(20)</FlightNumber>
<DepartureDateTime>date</DepartureDateTime>
<DcsCheckinId>bigint</DcsCheckinId>
<DcsPassengerId>bigint</DcsPassengerId>
<DcsBookingId>bigint</DcsBookingId>
<DcsBoardingId>bigint</DcsBoardingId>
<BookingNumber>integer</BookingNumber>
<Locator>varchar(20)</Locator>
<SeatNumber>varchar(20)</SeatNumber>
<BoardingCardNumber>varchar(20)</BoardingCardNumber>
<PassengerName>varchar(240)</PassengerName>
<LastName>varchar(50)</LastName>
<FirstName>varchar(50)</FirstName>
<MiddleName>varchar(50)</MiddleName>
<DcsPassengerTitleRcd>varchar(20)</DcsPassengerTitleRcd>
<DcsBoardingStatusRcd>varchar(20)</DcsBoardingStatusRcd>
<DcsFlightId>bigint</DcsFlightId>
<OriginAirportCode>varchar(20)</OriginAirportCode>
<DestinationAirportCode>varchar(20)</DestinationAirportCode>
<FinalDestination>varchar(20)</FinalDestination>
XML Service APIs Page 260
<SortOrder>integer</SortOrder>
<DcsPriorityRcd>varchar(20)</DcsPriorityRcd>
<DcsPassengerTypeRcd>varchar(20)</DcsPassengerTypeRcd>
<FromCarrierFlightNumber>varchar(20)</FromCarrierFlightNumber>
<ToCarrierFlightNumber>varchar(20)</ToCarrierFlightNumber>
<DcsCheckinStatusRcd>varchar(20)</DcsCheckinStatusRcd>
<CreatedDateTime>date</CreatedDateTime>
<ThruFlightFlag>integer</ThruFlightFlag>
</ReplyFormat>
<PassengersForBoarding>
<Child>
<FlightNumber>RT1120</FlightNumber>
<DepartureDateTime>2006-11-03 06:30:00</DepartureDateTime>
<DcsCheckinId>1131318543157011508</DcsCheckinId>
<DcsPassengerId>405720241091765359</DcsPassengerId>
<DcsBookingId>801099235251831938</DcsBookingId>
<DcsBoardingId>1063479678800860251</DcsBoardingId>
<BookingNumber>2672740</BookingNumber>
<Locator>HNTQRK</Locator>
<SeatNumber>1A</SeatNumber>
<BoardingCardNumber>1</BoardingCardNumber>
<PassengerName>PAX/SELECTEE</PassengerName>
<LastName>PAX</LastName>
<FirstName>SELECTEE</FirstName>
<MiddleName/>
<DcsPassengerTitleRcd/>
<DcsBoardingStatusRcd/>
<DcsFlightId>3380023105696907</DcsFlightId>
<OriginAirportCode>FLL</OriginAirportCode>
<DestinationAirportCode>CUN</DestinationAirportCode>
<FinalDestination>CUN</FinalDestination>
<SortOrder>80</SortOrder>
<DcsPriorityRcd>Normal</DcsPriorityRcd>
<DcsPassengerTypeRcd>Male</DcsPassengerTypeRcd>
<FromCarrierFlightNumber/>
<ToCarrierFlightNumber/>
<DcsCheckinStatusRcd>ConfRev</DcsCheckinStatusRcd>
<CreatedDateTime>2006-11-02 21:27:10</CreatedDateTime>
<ThruFlag>0</ThruFlag>
</Child>
</PassengersForBoarding>
</RRT:GetPassengersForBoardingReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 261
GetAirportIdFromAirportCode
This service retrieves the system id for a particular airport code.
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetAirportIdFromAirportCode xmlns:RRT="RRT">
<AirportCode>CUN</AirportCode>
</RRT:GetAirportIdFromAirportCode>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetAirportIdFromAirportCodeReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<DcsAirportId>bigint</DcsAirportId>
</ReplyFormat>
<Child>
<DcsAirportId>675623999401555002</DcsAirportId>
</Child>
</RRT:GetAirportIdFromAirportCodeReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 262
GetFlights
This service retrieves the system flight id for a particular flight. All parameters are mandatory.
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetFlights xmlns:RRT="RRT">
<DcsCarrierRcd>RT</DcsCarrierRcd>
<FlightNumber>1120</FlightNumber>
<OriginAirportId>1</OriginAirportId>
<DestinationAirportId>675623999401555002</DestinationAirportId>
<DepartureDate>11/03/2006</DepartureDate>
</RRT:GetFlights>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetFlightsReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<DcsFlightId>bigint</DcsFlightId>
<DcsFlightStatusId>bigint</DcsFlightStatusId>
<FlightStatusDescription>varchar(240)</FlightStatusDescription>
<FlightStatusRcd>varchar(20)</FlightStatusRcd>
<FlightNumberString>varchar(10)</FlightNumberString>
<DepartureDateTime>date</DepartureDateTime>
<OriginAirportCode>varchar(5)</OriginAirportCode>
<DestinationAirportCode>varchar(5)</DestinationAirportCode>
<AircraftType>varchar(20)</AircraftType>
<Capacity>integer</Capacity>
<PassengerCount>integer</PassengerCount>
<CheckinCount>integer</CheckinCount>
<DepartureGateNumber>varchar(20)</DepartureGateNumber>
<UserName>varchar(240)</UserName>
<Remarks>varchar(240)</Remarks>
<DcsCarrierRcd>varchar(20)</DcsCarrierRcd>
<FlightNumber>varchar(5)</FlightNumber>
<DelayedFlag>integer</DelayedFlag>
<InternationalFlag>integer</InternationalFlag>
<DcsOriginAirportId>bigint</DcsOriginAirportId>
<DcsDestinationAirportId>bigint</DcsDestinationAirportId>
</ReplyFormat>
<Flights>
XML Service APIs Page 263
<Child>
<DcsFlightId>3380023105696907</DcsFlightId>
<DcsFlightStatusId>1113380291738371196</DcsFlightStatusId>
<FlightStatusDescription>Open</FlightStatusDescription>
<FlightStatusRcd>Open</FlightStatusRcd>
<FlightNumberString>RT1120</FlightNumberString>
<DepartureDateTime>2006-11-03 06:30:00</DepartureDateTime>
<OriginAirportCode>FLL</OriginAirportCode>
<DestinationAirportCode>CUN</DestinationAirportCode>
<AircraftType>319</AircraftType>
<Capacity>141</Capacity>
<PassengerCount>4</PassengerCount>
<CheckinCount>1</CheckinCount>
<DepartureGateNumber>H8</DepartureGateNumber>
<UserName>Auto</UserName>
<Remarks/>
<DcsCarrierRcd>RT</DcsCarrierRcd>
<FlightNumber>1120</FlightNumber>
<DelayedFlag>0</DelayedFlag>
<InternationalFlag>0</InternationalFlag>
<DcsOriginAirportId>1</DcsOriginAirportId>
<DcsDestinationAirportId>675623999401555002</DcsDestinationAirportId>
</Child>
</Flights>
</RRT:GetFlightsReply>
</soap:Body>
</soap:Envelope>
GetFlightDetails
This service is used to return the flight details for a CheckinId. It can also be used to get seat assignments for all
legs of a multi-leg flight using DcsFlightSegmentId or for a single leg using DcsFlightId.
XML Service APIs Page 264
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetFlightDetails xmlns:RRT="RRT">
<DcsGroupId></DcsGroupId>
<DcsCheckinId>551619656694215920</DcsCheckinId>
</RRT:GetFlightDetails>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetFlightDetailsReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<DcsFlightId>bigint</DcsFlightId>
<DcsCarrierRcd>varchar(20)</DcsCarrierRcd>
<FlightNumber>varchar(20)</FlightNumber>
<DepartureDateTime>date</DepartureDateTime>
<OriginAirport>varchar(20)</OriginAirport>
<DestinationAirport>varchar(20)</DestinationAirport>
<LegNumber>integer</LegNumber>
<DcsClassRcd>varchar(20)</DcsClassRcd>
<DcsFlightSegmentId>bigint</DcsFlightSegmentId>
</ReplyFormat>
<FlightDetails>
<Child>
<DcsFlightId>788704968748250146</DcsFlightId>
<DcsCarrierRcd>RT</DcsCarrierRcd>
<FlightNumber>961</FlightNumber>
<DepartureDateTime>2006-11-21 07:55:00</DepartureDateTime>
<OriginAirport>LGA</OriginAirport>
<DestinationAirport>FLL</DestinationAirport>
<LegNumber>1</LegNumber>
<DcsClassRcd>C</DcsClassRcd>
<DcsFlightSegmentId>15268208960218247</DcsFlightSegmentId>
</Child>
<Child>
<DcsFlightId>1017867870058406938</DcsFlightId>
<DcsCarrierRcd>RT</DcsCarrierRcd>
<FlightNumber>961</FlightNumber>
<DepartureDateTime>2006-11-21 12:15:00</DepartureDateTime>
<OriginAirport>FLL</OriginAirport>
<DestinationAirport>SJU</DestinationAirport>
<LegNumber>2</LegNumber>
XML Service APIs Page 265
<DcsClassRcd>C</DcsClassRcd>
<DcsFlightSegmentId>15268208960218247</DcsFlightSegmentId>
</Child>
</FlightDetails>
</RRT:GetFlightDetailsReply>
</soap:Body>
</soap:Envelope>
FindFlightFromId
This service retrieves all the flight details for a particular flight. Records with the InvalidatedUserId node
populated are for historical purposes only to and do not contain any current flight information.
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
XML Service APIs Page 266
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:FindFlightFromId xmlns:RRT="RRT">
<DcsFlightId>3380023105696907</DcsFlightId>
</RRT:FindFlightFromId>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:FindFlightFromIdReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<DcsFlightId>bigint</DcsFlightId>
<FlightNumber>char(5)</FlightNumber>
<OriginAirportCode>char(5)</OriginAirportCode>
<ScheduledDepartureTime>date</ScheduledDepartureTime>
<EstimatedDepartureTime>date</EstimatedDepartureTime>
<DestinationDelay>date</DestinationDelay>
<DestinationAirportCode>char(5)</DestinationAirportCode>
<ScheduledArrivalTime>date</ScheduledArrivalTime>
<EstimatedArrivalTime>date</EstimatedArrivalTime>
<ArrivalDelay>date</ArrivalDelay>
<DelayReasonCode>varchar(20)</DelayReasonCode>
<DelayReasonDescription>varchar(240)</DelayReasonDescription>
<Supplements>varchar(240)</Supplements>
<Remarks>varchar(240)</Remarks>
<CreatedUserName>varchar(240)</CreatedUserName>
<CreatedDateTime>date</CreatedDateTime>
<InvalidatedUserId>bigint</InvalidatedUserId>
<OutOfGateTime>date</OutOfGateTime>
<OffGroundTime>date</OffGroundTime>
<OnGroundTime>date</OnGroundTime>
<InGateTime>date</InGateTime>
<DepartureFuelOnBoard>integer</DepartureFuelOnBoard>
<ArrivalFuelOnBoard>integer</ArrivalFuelOnBoard>
<WhoLanded>varchar(20)</WhoLanded>
<TailNumber>varchar(20)</TailNumber>
<AircraftType>varchar(20)</AircraftType>
<DepartureGateNumber>varchar(20)</DepartureGateNumber>
<ArrivalGateNumber>varchar(20)</ArrivalGateNumber>
</ReplyFormat>
<FindFlightFromId>
<Child>
<DcsFlightId>3380023105696907</DcsFlightId>
<FlightNumber>1120</FlightNumber>
<OriginAirportCode>FLL</OriginAirportCode>
<ScheduledDepartureTime>06:30</ScheduledDepartureTime>
<EstimatedDepartureTime>06:30</EstimatedDepartureTime>
<DestinationDelay/>
XML Service APIs Page 267
<DestinationAirportCode>CUN</DestinationAirportCode>
<ScheduledArrivalTime>09:30</ScheduledArrivalTime>
<EstimatedArrivalTime>09:30</EstimatedArrivalTime>
<ArrivalDelay/>
<DelayReasonCode>On Time</DelayReasonCode>
<DelayReasonDescription/>
<Supplements/>
<Remarks/>
<CreatedUserName>SUSAN LEVY</CreatedUserName>
<CreatedDateTime>2006-11-03 02:27:24</CreatedDateTime>
<InvalidatedUserId/>
<OutOfGateTime>06:43</OutOfGateTime>
<OffGroundTime>07:00</OffGroundTime>
<OnGroundTime>09:45</OnGroundTime>
<InGateTime>10:00</InGateTime>
<DepartureFuelOnBoard/>
<ArrivalFuelOnBoard/>
<WhoLanded>Not landed</WhoLanded>
<TailNumber/>
<AircraftType>319</AircraftType>
<DepartureGateNumber>H8</DepartureGateNumber>
<ArrivalGateNumber/>
</Child>
<Child>
<DcsFlightId>3380023105696907</DcsFlightId>
<FlightNumber>1120</FlightNumber>
<OriginAirportCode>FLL</OriginAirportCode>
<ScheduledDepartureTime>06:30</ScheduledDepartureTime>
<EstimatedDepartureTime>06:30</EstimatedDepartureTime>
<DestinationDelay/>
<DestinationAirportCode>CUN</DestinationAirportCode>
<ScheduledArrivalTime>09:30</ScheduledArrivalTime>
<EstimatedArrivalTime>09:30</EstimatedArrivalTime>
<ArrivalDelay/>
<DelayReasonCode>On Time</DelayReasonCode>
<DelayReasonDescription/>
<Supplements/>
<Remarks/>
<CreatedUserName>Auto</CreatedUserName>
<CreatedDateTime>2006-10-30 15:02:20</CreatedDateTime>
<InvalidatedUserId>659664309577364680</InvalidatedUserId>
<OutOfGateTime/>
<OffGroundTime/>
<OnGroundTime/>
<InGateTime/>
<DepartureFuelOnBoard/>
<ArrivalFuelOnBoard/>
<WhoLanded>Not landed</WhoLanded>
<TailNumber/>
<AircraftType>319</AircraftType>
<DepartureGateNumber/>
<ArrivalGateNumber/>
</Child>
</FindFlightFromId>
</RRT:FindFlightFromIdReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 268
GetBookingLegs
This is needed to retrieve the value of the DcsFlightSegmentId. Only the records with ThisCheckinFlag set to 1
are a part of the checkin id.
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetBookingLegs xmlns:RRT="RRT">
<DcsBookingId>84956577372959964</DcsBookingId>
<DcsCheckinId>75382166804862064</DcsCheckinId>
</RRT:GetBookingLegs>
XML Service APIs Page 269
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetBookingLegsReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<DcsItineraryId>bigint</DcsItineraryId>
<DcsCarrierRcd>varchar(20)</DcsCarrierRcd>
<FlightNumber>varchar(20)</FlightNumber>
<OriginAirportCode>varchar(20)</OriginAirportCode>
<DestinationAirportCode>varchar(20)</DestinationAirportCode>
<DepartureDateTime>date</DepartureDateTime>
<ArrivalDateTime>date</ArrivalDateTime>
<ThisCheckinFlag>integer</ThisCheckinFlag>
<AircraftType>varchar(20)</AircraftType>
<SeatNumber>varchar(20)</SeatNumber>
<OriginAirportName>varchar(240)</OriginAirportName>
<DestinationAirportName>varchar(240)</DestinationAirportName>
<DcsOriginAirportId>bigint</DcsOriginAirportId>
<DcsDestinationAirportId>bigint</DcsDestinationAirportId>
<DcsCheckinItineraryMappingId>bigint</DcsCheckinItineraryMappingId>
<DcsFlightSegmentId>bigint</DcsFlightSegmentId>
</ReplyFormat>
<GetBookingLegs>
<Child>
<DcsItineraryId>1099963760180675742</DcsItineraryId>
<DcsCarrierRcd>RT</DcsCarrierRcd>
<FlightNumber>111</FlightNumber>
<OriginAirportCode>FLL</OriginAirportCode>
<DestinationAirportCode>LGA</DestinationAirportCode>
<DepartureDateTime>2006-11-13 06:00:00</DepartureDateTime>
<ArrivalDateTime>2006-11-13 07:50:00</ArrivalDateTime>
<ThisCheckinFlag>1</ThisCheckinFlag>
<AircraftType>319</AircraftType>
<SeatNumber>2F</SeatNumber>
<OriginAirportName>FT LAUDERDALE/HOLLYWOOD INTL</OriginAirportName>
<DestinationAirportName>LA GUARDIA INTERNATIONAL</DestinationAirportName>
<DcsOriginAirportId>1</DcsOriginAirportId>
<DcsDestinationAirportId>2</DcsDestinationAirportId>
<DcsCheckinItineraryMappingId>878421273876407397</DcsCheckinItineraryMappingId>
<DcsFlightSegmentId/>
</Child>
</GetBookingLegs>
</RRT:GetBookingLegsReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 270
GetFlightDateClassSeatMaps
This is needed to retrieve the value of the FlightDateLegId.
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetFlightDateClassSeatMaps xmlns:RRT="RRT">
<DcsFlightId>735406459167839315</DcsFlightId>
<DcsFlightSegmentId></DcsFlightSegmentId>
<SellingClassCode>C</SellingClassCode>
</RRT:GetFlightDateClassSeatMaps>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
XML Service APIs Page 271
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetFlightDateClassSeatMapsReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<SeatMapId>integer</SeatMapId>
<Description>varchar(250)</Description>
<ImageUrlPath>varchar(250)</ImageUrlPath>
<ImageWidth>integer</ImageWidth>
<ImageHeight>integer</ImageHeight>
<BlockImage>varchar(250)</BlockImage>
<ReserveImage>varchar(250)</ReserveImage>
<VacantImage>varchar(250)</VacantImage>
<UnavailableImage>varchar(250)</UnavailableImage>
<SeatWidth>integer</SeatWidth>
<SeatHeight>integer</SeatHeight>
<FlightDateLegId>integer</FlightDateLegId>
</ReplyFormat>
<GetFlightDateClassSeatMaps>
<Child>
<SeatMapId>5</SeatMapId>
<Description>A319 C</Description>
<ImageUrlPath>http://www.rrtechnologies.net/internal/asr/a319.gif</ImageUrlPath>
<ImageWidth>911</ImageWidth>
<ImageHeight>402</ImageHeight>
<BlockImage>http://www.rrtechnologies.net/internal/asr/block.gif</BlockImage>
<ReserveImage>http://www.rrtechnologies.net/internal/asr/seatmarker.gif</ReserveImage>
<VacantImage>http://www.rrtechnologies.net/internal/asr/blank.gif</VacantImage>
<UnavailableImage>http://www.rrtechnologies.net/internal/asr/block.gif</UnavailableImage>
<SeatWidth>16</SeatWidth>
<SeatHeight>16</SeatHeight>
<FlightDateLegId>280544</FlightDateLegId>
</Child>
</GetFlightDateClassSeatMaps>
</RRT:GetFlightDateClassSeatMapsReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 272
GetUserId
This service retrieves the numeric ID of a user in the system.
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetUserId xmlns:RRT="RRT">
<UserCode>AUTO</UserCode>
</RRT:GetUserId>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetUserIdReply xmlns:RRT="http://rrtechnologies.net/soap/">
<ReplyFormat>
<DcsUserId>bigint</DcsUserId>
XML Service APIs Page 273
<UserName>varchar(240)</UserName>
</ReplyFormat>
<UserId>
<Child>
<DcsUserId>60</DcsUserId>
<UserName>Auto</UserName>
</Child>
</UserId>
</RRT:GetUserIdReply>
</soap:Body>
</soap:Envelope>
GetCurrentUserLocation
This service is used to get the location id for the selectee clearance.
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetCurrentUserLocation xmlns:RRT="RRT"> <LocationArea></LocationArea>
<DcsUserId>659664309577364680</DcsUserId>
</RRT:GetCurrentUserLocation>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?> <soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetCurrentUserLocationReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<DcsLocationRcd>varchar(20)</DcsLocationRcd>
<LocationDescription>varchar(240)</LocationDescription>
</ReplyFormat>
XML Service APIs Page 274
<Location>
<Child>
<DcsLocationRcd>Susan</DcsLocationRcd>
<LocationDescription>Susan's Desk</LocationDescription>
</Child>
</Location>
</RRT:GetCurrentUserLocationReply>
</soap:Body>
</soap:Envelope>
AddPassengerRequest
This service was created to support the WEB checkin and uses SSR WEBC.
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:AddPassengerRequest xmlns:RRT="RRT">
<DcsItineraryId>1038442991293228165,</DcsItineraryId>
<DcsPassengerId>287539504831329528</DcsPassengerId>
<ServiceRequestCode>WEBC</ServiceRequestCode>
<RequestText>Web Checkin</RequestText>
<DcsUserId>732963972619306124</DcsUserId>
<DcsCheckinId>282886087898469620</DcsCheckinId>
</RRT:AddPassengerRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
NB
The DcsItineraryId field MUST contain a comma at the end like this:
<DcsItineraryId>422498530183304294,</DcsItineraryId>
In cases where there are multiple itineraries associated with a single checkin id, then the XML node needs to have all
itinerary IDs for the checkin comma separated like this:
XML Service APIs Page 275
<DcsItineraryId>422498530183304294,34523453423423442,123432423464346,</DcsItineraryId>
Sample (successful) response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:AddPassengerRequestReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<DcsPassengerRequestId>bigint</DcsPassengerRequestId>
<ReturnCode>varchar(20)</ReturnCode>
</ReplyFormat>
<Child>
<DcsPassengerRequestId>636880067152860199</DcsPassengerRequestId>
<ReturnCode>OK</ReturnCode>
</Child>
</RRT:AddPassengerRequestReply>
</soap:Body>
</soap:Envelope>
Sample (unsuccessful) response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:AddPassengerRequestReply xmlns:RRT="http://rrtechnologies.net/soap/">
<ReplyFormat>
<DcsPassengerRequestId>bigint</DcsPassengerRequestId>
<ReturnCode>varchar(20)</ReturnCode>
</ReplyFormat>
<Child>
<DcsPassengerRequestId>0</DcsPassengerRequestId>
<ReturnCode>NOINVENTORY</ReturnCode>
</Child>
</RRT:AddPassengerRequestReply>
XML Service APIs Page 276
</soap:Body>
</soap:Envelope>
CanPassengerBoard
This service is used to identify if the passenger is applicable for boarding by verifying whether or not the
passenger is on this flight and has a BCN.
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:CanPassengerBoard xmlns:RRT="RRT">
<DcsCheckinId>865734555585410078</DcsCheckinId>
</RRT:CanPassengerBoard>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:CanPassengerBoardReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<Indicator>varchar(20)</Indicator>
</ReplyFormat>
<Child>
<Indicator>OK</Indicator>
</Child>
</RRT:CanPassengerBoardReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 277
GetPassengerByBoardingCardNumber
This service is used to get the BCN, which will be used to board the passenger.
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetPassengerByBoardingCardNumber xmlns:RRT="RRT">
<BoardingCardNumber>UGlSFtFj3m00</BoardingCardNumber>
<DcsFlightId>1107581071879238779</DcsFlightId>
</RRT:GetPassengerByBoardingCardNumber>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetPassengerByBoardingCardNumberReply
xmlns:RRT="http://rrtechnologies.net/soap/" ADMIN_DATA_DUMP="true">
<ReplyFormat>
<DcsCheckinId>bigint</DcsCheckinId>
<DcsItineraryId>bigint</DcsItineraryId>
<DcsBoardingStatusRcd>varchar(20)</DcsBoardingStatusRcd>
<DcsBoardingId>bigint</DcsBoardingId>
<SeatNumber>varchar(20)</SeatNumber>
</ReplyFormat>
<PassengerByBCN>
<Child>
<DcsCheckinId>865734555585410078</DcsCheckinId>
<DcsItineraryId>838462610154320915</DcsItineraryId>
<DcsBoardingStatusRcd/>
<DcsBoardingId>39527841796805737</DcsBoardingId>
<SeatNumber>2F</SeatNumber>
</Child>
</PassengerByBCN>
</RRT:GetPassengerByBoardingCardNumberReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 278
BoardPassenger
This service is used to board the passengers.
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:BoardPassenger xmlns:RRT="RRT">
<DcsBoardingId>39527841796805737</DcsBoardingId>
<DcsBoardingStatusRcd>Boarded</DcsBoardingStatusRcd>
<DcsUserId>732963972619306124</DcsUserId>
</RRT:BoardPassenger>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:BoardPassengerReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<Indicator>varchar(20)</Indicator>
</ReplyFormat>
<Child>
<Indicator>OK</Indicator>
</Child>
</RRT:BoardPassengerReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 279
GetBoardedPassengers
This service returns the boarding status via the DcsBoardingStatusRcd node.
Return values:
Boarded
Boarded
NoShow
No show
VDenied
Voluntarily Denied Boarding
IDenied
Involuntarily Denied Boarding
UnBoarded
Un-Boarded
Sample request:
<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetBoardedPassengers xmlns="http://rrtechnologies.net/soap/">
<DcsFlightId>450764700546335808</DcsFlightId>
</GetBoardedPassengers>
</soap:Body>
</soap:Envelope>
Sample response:
<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetBoardedPassengersReply xmlns:RRT="http://rrtechnologies.net/soap/">
<ReplyFormat>
<DcsCheckinId>bigint</DcsCheckinId>
<DcsPassengerId>bigint</DcsPassengerId>
<DcsBookingId>bigint</DcsBookingId>
<DcsBoardingId>bigint</DcsBoardingId>
<BookingNumber>integer</BookingNumber>
<Locator>varchar(20)</Locator>
XML Service APIs Page 280
<SeatNumber>varchar(20)</SeatNumber>
<BoardingCardNumber>varchar(20)</BoardingCardNumber>
<PassengerName>varchar(240)</PassengerName>
<LastName>varchar(50)</LastName>
<FirstName>varchar(50)</FirstName>
<MiddleName>varchar(50)</MiddleName>
<DcsPassengerTitleRcd>varchar(20)</DcsPassengerTitleRcd>
<DcsBoardingStatusRcd>varchar(20)</DcsBoardingStatusRcd>
</ReplyFormat>
<Boarded>
<Child>
<DcsCheckinId>991678843307869186</DcsCheckinId>
<DcsPassengerId>227366237040374916</DcsPassengerId>
<DcsBookingId>580304289701774356</DcsBookingId>
<DcsBoardingId>232312158191768664</DcsBoardingId>
<BookingNumber>9976</BookingNumber>
<Locator>GXCCRC</Locator>
<SeatNumber/>
<BoardingCardNumber>32</BoardingCardNumber>
<PassengerName>ZINICOLA/ZAIN</PassengerName>
<LastName>ZINICOLA</LastName>
<FirstName>ZAIN</FirstName>
<MiddleName/>
<DcsPassengerTitleRcd/>
<DcsBoardingStatusRcd>Boarded</DcsBoardingStatusRcd>
</Child>
</Boarded>
</RRT:GetBoardedPassengersReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 281
PrintBagTag
This service enables a passenger that was checked in at a kiosk to print a bag tag.
Pre-requisites:
The GetUserId API will need to be used with the assigned RRT application user code so that the DcsUserId node
can be provided to the printing API calls.
The user code provided to the application using the API will have to be setup with bag tag printers at the
appropriate locations.
o Alternatively, step 1 can be skipped, and the system using the API can provide the location code without
using the GetCurrentUserLocation API.
o This method can be useful when the external system (kiosk, web) uses a single RRT application user id.
The DcsBaggageId value is needed for printing. This value is returned by our API call SaveBaggage.
The API call request/reply pairs:
1. Get the location for the user id. If the system using the API uses the same user code for all connections, then
skip to step 2, and provide the location directly
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetCurrentUserLocation xmlns:RRT="RRT">
<LocationArea></LocationArea>
<DcsUserId>671884342155244708</DcsUserId>
</RRT:GetCurrentUserLocation>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetCurrentUserLocationReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<ReplyFormat>
<DcsLocationRcd>varchar(20)</DcsLocationRcd>
<LocationDescription>varchar(240)</LocationDescription>
</ReplyFormat>
<Location>
<Child>
<DcsLocationRcd>Test</DcsLocationRcd>
<LocationDescription>Test</LocationDescription>
XML Service APIs Page 282
</Child>
</Location>
</RRT:GetCurrentUserLocationReply>
</soap:Body>
</soap:Envelope>
2. Get the bag tag printer for that location:
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:GetDeviceForLocation xmlns:RRT="RRT">
<DcsLocationRcd>Test</DcsLocationRcd>
<DcsDeviceTypeRcd>BagTag</DcsDeviceTypeRcd>
<DcsUserId>671884342155244708</DcsUserId>
</RRT:GetDeviceForLocation>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:GetDeviceForLocationReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<Device>
<Child>
<DcsDeviceId>457351263046784041</DcsDeviceId>
<DcsDeviceTypeRcd>BagTag</DcsDeviceTypeRcd>
<DcsDeviceExecutionLocationRcd>DCSMT</DcsDeviceExecutionLocationRcd>
<DeviceName>IER 411 Bag Tag Printer</DeviceName>
<DeviceAddress>192.168.112.80 3004</DeviceAddress>
</Child>
</Device>
<ReplyFormat>
<DcsDeviceId>bigint</DcsDeviceId>
<DcsDeviceTypeRcd>varchar(20)</DcsDeviceTypeRcd>
<DcsDeviceExecutionLocationRcd>varchar(20)</DcsDeviceExecutionLocationRcd>
<DeviceName>varchar(240)</DeviceName>
<DeviceAddress>varchar(240)</DeviceAddress>
</ReplyFormat>
</RRT:GetDeviceForLocationReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 283
3. Print to the printer using the DeviceAddress value: The important reply node is <Indicator> and it
should contain the value “Printed” on success.
Sample request:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:PrintBagTag xmlns:RRT="RRT">
<PrinterAddress>192.168.112.80 3004</PrinterAddress>
<DcsBaggageId>648253417750545493</DcsBaggageId>
<DcsUserId>671884342155244708</DcsUserId>
<Print>Print</Print>
</RRT:PrintBagTag>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample response:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:PrintBagTagReply xmlns:RRT="http://rrtechnologies.net/soap/"
ADMIN_DATA_DUMP="true">
<Print>
<DcsBaggageId>648253417750545493</DcsBaggageId>
<PassengerName>TEST/BAG</PassengerName>
<Locator>HNVMMG</Locator>
<BagTagNumber>000834</BagTagNumber>
<DamagedFlag>0</DamagedFlag>
<HeavyFlag>0</HeavyFlag>
<BaggageWeight>35</BaggageWeight>
<SelecteeFlag>1</SelecteeFlag>
<AgentId>TEST</AgentId>
<FinalDestinationCity>NEW YORK</FinalDestinationCity>
<DestinationCityName>NEW YORK</DestinationCityName>
<DestinationState>NY</DestinationState>
<IataCode>487</IataCode>
<CurrentTime>1558</CurrentTime>
<CurrentDate>02AUGUST</CurrentDate>
<JRBTBagTag>834</JRBTBagTag>
<OriginCity>FLL</OriginCity>
<DepartureDate>02Aug07</DepartureDate>
<AirportCode3>LGA</AirportCode3>
<CarrierCode3>RT</CarrierCode3>
<FlightNumber3>4321</FlightNumber3>
<BoardingCard3>1</BoardingCard3>
<AirportCode2/>
<CarrierCode2/>
<FlightNumber2/>
<BoardingCard2/>
XML Service APIs Page 284
<AirportCode1/>
<CarrierCode1/>
<FlightNumber1/>
<BoardingCard1/>
</Print>
<ReplyFormat>
<Indicator>varchar(240)</Indicator>
<Id>varchar(240)</Id>
</ReplyFormat>
<Child>
<Indicator>Printed</Indicator>
<Id/>
</Child>
</RRT:PrintBagTagReply>
</soap:Body>
</soap:Envelope>
Return codes:
Here is a list of return codes:
1. Printed - successful print of the bag tag
2. Print Bag Tag First - requires that a boarding pass be printed before bagtag printing is allowed. This is controlled by
an application configuration parameter
3. No city information - indicates that the baggage record is not properly associated with flights for the passenger. It will
require agent assistance to resolve.
4. NothingToPrint - indicates an invalid baggage record, agent assistance will be needed for resolution.
5. <error conditions outside the application> - besides the above conditions, the printing subsystems can fail with
network/device/other issues, those errors will be returned in the status field
XML Service APIs Page 285
PrintCloseoutReport
This service generates flight Closeout Report after the flight is closed.
Service name for all the reports is DcsPeripheral.
Parameters:
DcsFlightId
Obtained from getPassengerList call. Note: Different cabin class has different flight ID
Sample request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PrintCloseoutReport xmlns="http://rrtechnologies.net/soap/">
<DcsFlightId>1003462334101963792</DcsFlightId>
<Print>Display</Print>
</PrintCloseoutReport>
</soap:Body>
</soap:Envelope>
Sample repsonse:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:PrintCloseoutReportReply xmlns:RRT="http://rrtechnologies.net/soap/">
<ReplyFormat>
<ReturnCode>varchar(240)</ReturnCode>
<PassengerCount>integer</PassengerCount>
</ReplyFormat>
<SpecialRequestPassenger>
<RequestCode>None</RequestCode>
<Count>3</Count>
</SpecialRequestPassenger>
<PassengerCount>
<ManifestedPlus>2</ManifestedPlus>
<ManifestedCoach>1</ManifestedCoach>
<CheckedInPlus>0</CheckedInPlus>
<CheckedInCoach>0</CheckedInCoach>
<ThruCheckedInCoach>1</ThruCheckedInCoach>
<ThruCheckedInPlus>2</ThruCheckedInPlus>
<StandByCoach>0</StandByCoach>
<StandByPlus>0</StandByPlus>
<ClearStandByCoach>0</ClearStandByCoach>
<ClearStandByPlus>0</ClearStandByPlus>
<ClearThruStandByCoach>0</ClearThruStandByCoach>
<ClearThruStandByPlus>0</ClearThruStandByPlus>
<JumpSeatCockpit>0</JumpSeatCockpit>
<JumpSeatFlightAttendant>0</JumpSeatFlightAttendant>
<BoardedPlus>2</BoardedPlus>
<BoardedCoach>1</BoardedCoach>
XML Service APIs Page 286
<HoldsPlus>16</HoldsPlus>
<HoldsCoach>134</HoldsCoach>
<NotCheckedInPlus>2</NotCheckedInPlus>
<NotCheckedInCoach>1</NotCheckedInCoach>
<TotalCheckedInCoach>0</TotalCheckedInCoach>
<TotalCheckedInPlus>0</TotalCheckedInPlus>
</PassengerCount>
<DownlineCount>
<OriginAirportCode>LGA</OriginAirportCode>
<DestinationAirportCode>FLL</DestinationAirportCode>
<CoachCount>1</CoachCount>
<PlusCount>2</PlusCount>
<TotalCount>3</TotalCount>
</DownlineCount>
<DownlineCount>
<OriginAirportCode>FLL</OriginAirportCode>
<DestinationAirportCode>SJU</DestinationAirportCode>
<CoachCount>1</CoachCount>
<PlusCount>2</PlusCount>
<TotalCount>3</TotalCount>
</DownlineCount>
<Child>
<ReturnCode>Hello</ReturnCode>
</Child>
</RRT:PrintCloseoutReportReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 287
PrintFlightManifest
This service generates the flight manifest report.
Parameters:
DcsFlightId
Sample request:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<PrintFlightManifest xmlns="http://rrtechnologies.net/soap/">
<PrinterAddress></PrinterAddress>
<DcsFlightId>1003462334101963792</DcsFlightId>
<DcsCheckinStatusRcd></DcsCheckinStatusRcd>
<DcsBoardingStatusRcd>Boarded</DcsBoardingStatusRcd>
<RequestFilter></RequestFilter>
<SortOrder>ascending</SortOrder>
<SortCriteria>LastName</SortCriteria>
<Mode>Display</Mode>
</PrintFlightManifest>
</soap:Body>
</soap:Envelope>
Sample repsonse:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:PrintFlightManifestReply xmlns:RRT="http://rrtechnologies.net/soap/">
<ReplyFormat>
<ReturnCode>varchar(240)</ReturnCode>
</ReplyFormat>
<Carrier>RT</Carrier>
<FlightNumber>961</FlightNumber>
<LegNumber>1</LegNumber>
<FlightDate>19Mar07</FlightDate>
<Routing>LGAFLL</Routing>
<InternationalFlag>0</InternationalFlag>
<SortOrder>ascending</SortOrder>
<SortCriteria>LastName</SortCriteria>
<SortSubCriteria>FirstName</SortSubCriteria>
<FlightManifest>
<ReturnCode>Displayed</ReturnCode>
</FlightManifest>
</RRT:PrintFlightManifestReply>
</soap:Body>
</soap:Envelope>
XML Service APIs Page 288
UpdateResultsPayments
This service will synchronize all the payments made in DCS into Results. As soon as a flight is closed, the system
makes a call to this service. Then the payments from DCS checkin are sent to Results bookings and are shown on the
Booking Payment screen:
Sample request:
XML Service APIs Page 289
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<SOAP-ENV:Envelope xmlns:SOAPSDK1="http://www.w3.org/2001/XMLSchema"
xmlns:SOAPSDK2="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAPSDK3="http://schemas.xmlsoap.or
/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<RRT:UpdateResultsPayments xmlns:RRT="RRT">
<DcsFlightId>750576615304012989</DcsFlightId>
</RRT:UpdateResultsPayments>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Note: To get the DcsFlightId, enter the following SQL command:
SELECT dcs_flight_id FROM dcs_flight df INNER JOIN dcs_airport da ON df.dcs_origin_airport_id =
da.dcs_airport_id WHERE df.dcs_carrier_rcd || df.flight_number = 'NK17' AND DATE
(df.departure_date_time) = '08/16/2006' AND da.airport_code = 'FLL'
Sample response:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<RRT:UpdateResultsPaymentsReply xmlns:RRT="http://rrtechnologies.net/soap/">
<PaymentUpdate>
<Reply>OK</Reply>
</PaymentUpdate>
</RRT:UpdateResultsPaymentsReply>
</soap:Body>
</soap:Envelope>
You can also run the request if there are changes to the DCS payment information on a flight after the flight is already
closed. A rerun of the service will adjust the payment information again. The following shows the additional DCS
payment after a rerun:
XML Service APIs Page 290
The adjustment will reflect on the DCS Financial form as well.
XML Service APIs Page 291