The purpose of this article is to provide information regarding the use of APIv3.
...
Table of contents | |
---|---|
|
Tip |
---|
The majority of the requests in this article are order sensitive. Most tools will order the request nodes alphabetically which is the format that is expected. |
Agency Account Service
GetCompanyDetails
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Body> <tem:GetCompanyDetails> <tem:request> <int:CompanyCode>AA00011</int:CompanyCode> </tem:request> </tem:GetCompanyDetails> </soapenv:Body> |
...
Info | ||||
---|---|---|---|---|
| ||||
Company not found or invalid. This error speaks for itself. The safest way to avoid getting this error is to run |
Booking Service
GetTravelOptions
GetTravelOptions Request
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Body> <tem:GetTravelOptions> <tem:optionsRequest> <int:Query> <int1:AdultCount>1</int1:AdultCount> <int1:ArrivalAirportCode>XXX</int1:ArrivalAirportCode> <int1:ChildCount>0</int1:ChildCount> <int1:CurrencyCode>CAN$</int1:CurrencyCode> <int1:DaysAfter>7</int1:DaysAfter> <int1:DaysBefore>7</int1:DaysBefore> <int1:DepartureAirportCode>YYY</int1:DepartureAirportCode> <int1:InfantCount>0</int1:InfantCount> <int1:OutboundDate>2016-03-23</int1:OutboundDate> <int1:PaxCompanyCode></int1:PaxCompanyCode> <----- This must be supplied in order for company specific fares to be returned. </int:Query> </tem:optionsRequest> </tem:GetTravelOptions> </soapenv:Body> |
...
Info | ||||
---|---|---|---|---|
| ||||
|
GetTravelOptions Response
The following is a sample travel option pulled from the GetTravelOptions response:
Code Block | ||||
---|---|---|---|---|
| ||||
<b:Option> <b:Legs> <b:LegOption> <b:DepartureDate>2015-03-23T00:00:00</b:DepartureDate> <b:FareOptions> <b:Adultfares> <b:FareOption> <b:Advancebooking>0</b:Advancebooking> <b:ChangesAllowed>true</b:ChangesAllowed> <b:Currency xmlns:c="http://schemas.datacontract.org/2004/07/InteliSys.Amelia"> <c:Abbreviation>VND</c:Abbreviation> <c:Description>Vietnam Dong</c:Description> <c:ExchangeRate>1</c:ExchangeRate> <c:Format>#,##0 VND</c:Format> </b:Currency> <b:Description>Econ</b:Description> <b:DiscountFare>1260000</b:DiscountFare> <b:DiscountFareTaxes>126000</b:DiscountFareTaxes> <b:DiscountFareTotal>1386000</b:DiscountFareTotal> <b:FareCategory>F</b:FareCategory> <b:FareCategoryFreeTextRules/> <b:FareClass>F</b:FareClass> <b:FareClassFreeTextRules/> <b:FareClassStatus>C</b:FareClassStatus> <b:FareCost>1260000</b:FareCost> <b:FareTaxes>126000</b:FareTaxes> <b:IsDefaultFare>true</b:IsDefaultFare> <b:IsRefundable>true</b:IsRefundable> <b:MaxStayOver>0</b:MaxStayOver> <b:MinStayOver>0</b:MinStayOver> <b:OnewayReturn>OnewayFare</b:OnewayReturn> <b:Option>1</b:Option> <b:PromoCodeID>-1</b:PromoCodeID> <b:PromoCodeSuffixID>-1</b:PromoCodeSuffixID> <b:PromoFlag/> <b:ReasonInvalid/> <b:Restricted>true</b:Restricted> <b:Sale>false</b:Sale> <b:SeatCharge>20000</b:SeatCharge> <b:SeatChargeTax>0</b:SeatChargeTax> <b:SeatChargeTotal>20000</b:SeatChargeTotal> <b:SeatSale>false</b:SeatSale> <b:SeatsAvailable>101</b:SeatsAvailable> <b:Totalfare>1386000</b:Totalfare> <b:Valid>true</b:Valid> <b:Waitlist>false</b:Waitlist> </b:FareOption> </b:Adultfares> <b:Childfares/> </b:FareOptions> <b:NumberOfStops>1</b:NumberOfStops> <b:RouteHours>0</b:RouteHours> <b:SegmentOptions> <b:SegmentOption> ____ <b:Flight xmlns:c="http://schemas.datacontract.org/2004/07/InteliSys.Amelia"> | <c:Aircraft> | <c:ModelIdent>A321</c:ModelIdent> | <c:ModelName>A321</c:ModelName> | </c:Aircraft> | <c:ArrivalAirport> | <c:Code>XXX</c:Code> | <c:Name>Some Airport</c:Name> | This portion of the response would </c:ArrivalAirport> |------------- be used as the flight information <c:DepartureAirport> | in the 'BookReservation' request <c:Code>YYY</c:Code> | <c:Name>Another Airport</c:Name> | </c:DepartureAirport> | <c:ETA>2015-03-23T13:00:00</c:ETA> | <c:ETALocal>2015-03-23T20:00:00</c:ETALocal> | <c:ETD>2015-03-23T11:10:00</c:ETD> | <c:ETDLocal>2015-03-23T18:10:00</c:ETDLocal> | <c:Number>YY456</c:Number> | </b:Flight> ____| <b:Quality>A/C-CHG 0</b:Quality> <b:SeatAllocation>144</b:SeatAllocation> <b:Segdist>1091.2</b:Segdist> </b:SegmentOption> </b:SegmentOptions> <b:Surcharges> <b:Surcharge> <b:AllToAllPassengers>true</b:AllToAllPassengers> <b:Amount>60000</b:Amount> <b:ApplyInfantChargeFlag>A</b:ApplyInfantChargeFlag> <b:ApplyToAdult>true</b:ApplyToAdult> <b:ApplyToChild>false</b:ApplyToChild> <b:ApplyToInfant>false</b:ApplyToInfant> <b:ChargeTypeID>1</b:ChargeTypeID> <b:Description>Airport Tax Domestic</b:Description> <b:Taxes>0</b:Taxes> <----------------------------------| <b:Total>60000</b:Total> <------------------------------| </b:Surcharge> | <b:Surcharge> | <b:AllToAllPassengers>true</b:AllToAllPassengers> | <b:Amount>30000</b:Amount> | <b:ApplyInfantChargeFlag>N</b:ApplyInfantChargeFlag> |----------- During booking these values must be taken into account in the <int1:Amount> section of <b:ApplyToAdult>true</b:ApplyToAdult> | under the <int1:Payment> tag or the operation will fail <b:ApplyToChild>true</b:ApplyToChild> | <b:ApplyToInfant>false</b:ApplyToInfant> | <b:ChargeTypeID>1010</b:ChargeTypeID> | <b:Description>Admin Fee Domestic</b:Description> | <b:Taxes>3000</b:Taxes> <-------------------------------| <b:Total>33000</b:Total> <------------------------------| </b:Surcharge> </b:Surcharges> </b:LegOption> </b:Legs> <b:Number>1</b:Number> </b:Option> |
BookReservation
BookReservation Request
Info | ||
---|---|---|
| ||
|
"On Hold" Booking
The following is an example request for booking a reservation 'On Hold':
...
Info | ||||
---|---|---|---|---|
| ||||
Amelia Error: -7777777 - Message: Permission Denied: Web - Payment - On Hold. This error is caused when the user does not have permission to place on hold payments. |
"Credit Card" Booking
The following is an example for booking a reservation with 'Credit Card' payment:
...
Info | ||||
---|---|---|---|---|
| ||||
Amelia Error: -65987 - Message: The booking request failed. The reservation was not created successfully This error generally manifests when the processing fees for the credit card payment are either not included or incorrect. This can be found by running GetProcessingFee(). Nmbr: 91; Desc: Object variable or With block variable not set The most common cause of this error is a poorly formatted request. Double check the request information and if the error persists, contact support. |
"On Account" Booking
The following is an example for booking a reservation with 'On Account':
...
Info | ||||
---|---|---|---|---|
| ||||
Company not found or invalid. This error speaks for itself. The safest way to avoid getting this error is to run |
Booking with SSR items
The following is an example of how to book a reservation that includes Flight and/or Airport SSR items.
...
Info | ||
---|---|---|
| ||
|
...
|
Booking with an Infant
Info | ||
---|---|---|
| ||
Before executing a booking request with an included infant, run a travel options with the <int1:InfantCount> parameter > 1 |
...
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:int="http://schemas.datacontract.org/2004/07/InteliSys.Amelia.API" xmlns:int1="http://schemas.datacontract.org/2004/07/InteliSys.Amelia"> <soapenv:Header/> <soapenv:Body> <tem:BookReservation> <tem:bookingRequest> <int:Query> <int1:Company> <int1:Code>111111</int1:Code> </int1:Company> <int1:Legs> <int1:BookingLeg> <int1:AdultFares> <int1:BookingClassCode>L</int1:BookingClassCode> <int1:CurrencyCode>CAD</int1:CurrencyCode> <int1:FareCode>L</int1:FareCode> <int1:PaxCount>1</int1:PaxCount> <int1:TotalCost>146.25</int1:TotalCost> </int1:AdultFares> <int1:Segments> <int1:BookingSegment> <int1:ArrivalAirportCode>YQM</int1:ArrivalAirportCode> <int1:DepartureAirportCode>YHM</int1:DepartureAirportCode> <int1:ETALocal>2016-12-19T17:15:00</int1:ETALocal> <int1:ETDLocal>2016-12-19T14:18:00</int1:ETDLocal> <int1:FlightCode>G61100</int1:FlightCode> </int1:BookingSegment> </int1:Segments> </int1:BookingLeg> </int1:Legs> <int1:Passengers> <int1:BookingPassenger> <int1:Address> <int1:Addr1>260 Princess Street</int1:Addr1> <int1:City>Calgary</int1:City> <int1:CountryCode>CDN</int1:CountryCode> <int1:CountryDescription>CANADA</int1:CountryDescription> <int1:PostalCode>E2L4S8</int1:PostalCode> <int1:ProvinceAbbreviation>NB</int1:ProvinceAbbreviation> <int1:ProvinceName>New Brunswick</int1:ProvinceName> </int1:Address> <int1:AgeCategory>Adult</int1:AgeCategory> <int1:Firstname>Greg</int1:Firstname> <int1:Gender>Male</int1:Gender> <int1:Infants> <int1:Infant> <int1:Firstname>Greg Jr</int1:Firstname> <int1:Gender>M</int1:Gender> <int1:Lastname>Pert</int1:Lastname> </int1:Infant> </int1:Infants> <int1:Lastname>Pert</int1:Lastname> <int1:PersonalContact> <int1:Email>support@intelisysaviation.com</int1:Email> </int1:PersonalContact> </int1:BookingPassenger> </int1:Passengers> <int1:Payment> <int1:AccountPayment> <int1:CompanyCode>111111</int1:CompanyCode> <int1:PaymentMethod>ACCT</int1:PaymentMethod> </int1:AccountPayment> <int1:Amount>449.01</int1:Amount> <int1:CurrencyCode>CAD</int1:CurrencyCode> <int1:PaymentType>Account</int1:PaymentType> <int1:ProcessingFee>0</int1:ProcessingFee> <int1:ProcessingFeeTax>0</int1:ProcessingFeeTax> </int1:Payment> </int:Query> </tem:bookingRequest> </tem:BookReservation> </soapenv:Body> </soapenv:Envelope> |
...
CalculateProcessingFee
CalculateProcessingFee Request
The following is an example request for calculating processing fees for a reservation that is not yet created:
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Body> <tem:CalculateProcessingFee> <tem:request> <int:Query> <int1:Legs> <int1:BookingLeg> <int1:AdultFares> <int1:BookingClassCode>F</int1:BookingClassCode> <int1:CurrencyCode>USD</int1:CurrencyCode> <int1:FareCode>F</int1:FareCode> <int1:PaxCount>1</int1:PaxCount> <int1:TotalCost>1386000</int1:TotalCost> </int1:AdultFares> <int1:Segments> <int1:BookingSegment> <int1:ArrivalAirportCode>HAN</int1:ArrivalAirportCode> <int1:DepartureAirportCode>DLI</int1:DepartureAirportCode> <int1:ETALocal>2015-05-23T20:00:00</int1:ETALocal> <int1:ETDLocal>2015-05-23T18:10:00</int1:ETDLocal> <int1:FlightCode>VJ8862</int1:FlightCode> </int1:BookingSegment> </int1:Segments> </int1:BookingLeg> </int1:Legs> <int1:Passengers> <int1:BookingPassenger> <int1:Address> <int1:Addr1>123 anywhere st</int1:Addr1> <int1:Addr2>apt 12</int1:Addr2> <int1:City>saint john</int1:City> <int1:CountryCode>CDN</int1:CountryCode> <int1:CountryDescription>Canada</int1:CountryDescription> <int1:PostalCode>e2e2e2</int1:PostalCode> <int1:ProvinceAbbreviation>nb</int1:ProvinceAbbreviation> <int1:ProvinceName>new brunswick</int1:ProvinceName> </int1:Address> <int1:AgeCategory>Adult</int1:AgeCategory> <int1:DateOfBirth>1950-12-12</int1:DateOfBirth> <int1:DestinationTelephone>5064449999</int1:DestinationTelephone> <int1:Firstname>Jeff</int1:Firstname> <int1:Gender>Male</int1:Gender> <int1:General1>123</int1:General1> <int1:General2>123</int1:General2> <int1:Lastname>Doe</int1:Lastname> <int1:Loyalty xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> <int1:Middlename>Jane</int1:Middlename> <int1:PersonalContact> <int1:Email>test@mail.com</int1:Email> <int1:Extension>444</int1:Extension> <int1:Fax>5067778888</int1:Fax> <int1:Mobile>5064441111</int1:Mobile> <int1:Name>Company</int1:Name> <int1:SpecialNeeds>-1</int1:SpecialNeeds> <int1:Telephone>5064441111</int1:Telephone> </int1:PersonalContact> <int1:Title>Mr</int1:Title> </int1:BookingPassenger> </int1:Passengers> <int1:Payment> <int1:Amount>3288000</int1:Amount> <int1:CreditCardPayment> <int1:Address> <int1:Addr1>123 anywhere st</int1:Addr1> <int1:Addr2>apt 12</int1:Addr2> <int1:City>saint john</int1:City> <int1:CountryCode>CDN</int1:CountryCode> <int1:CountryDescription>Canada</int1:CountryDescription> <int1:PostalCode>e2e2e2</int1:PostalCode> <int1:ProvinceAbbreviation>nb</int1:ProvinceAbbreviation> <int1:ProvinceName>new brunswick</int1:ProvinceName> </int1:Address> <int1:CVV>377</int1:CVV> <int1:Email>mail@mail.com</int1:Email> <int1:ExpireYear>2017</int1:ExpireYear> <int1:ExpiryMonth>12</int1:ExpiryMonth> <int1:Firstname>John</int1:Firstname> <int1:Lastname>Doe</int1:Lastname> <int1:Number>4111111111111111</int1:Number> <int1:TypeCode>VI</int1:TypeCode> </int1:CreditCardPayment> <int1:CurrencyCode>CDN</int1:CurrencyCode> <int1:PaymentType>CreditCard</int1:PaymentType> </int1:Payment> </int:Query> </tem:request> </tem:CalculateProcessingFee> </soapenv:Body> |
CalculateProcessingFee Response
The following is a snippet from the CalculateProcessingFee response:
Code Block | ||||
---|---|---|---|---|
| ||||
<b:Payment> <b:AccountPayment i:nil="true"/> <b:Amount>3288000</b:Amount> <b:CreditCardPayment> <b:Address> <b:Addr1>123 anywhere st</b:Addr1> <b:Addr2>apt 12</b:Addr2> <b:City>saint john</b:City> <b:CountryCode>CDN</b:CountryCode> <b:CountryDescription>Canada</b:CountryDescription> <b:PostalCode>e2e2e2</b:PostalCode> <b:ProvinceAbbreviation>nb</b:ProvinceAbbreviation> <b:ProvinceName>new brunswick</b:ProvinceName> </b:Address> <b:CVV>377</b:CVV> <b:Email>mail@mail.com</b:Email> <b:ExpireYear>2017</b:ExpireYear> <b:ExpiryMonth>12</b:ExpiryMonth> <b:Firstname>John</b:Firstname> <b:Lastname>Doe</b:Lastname> <b:Number>4111111111111111</b:Number> <b:TypeCode>VI</b:TypeCode> </b:CreditCardPayment> <b:CurrencyCode>VND</b:CurrencyCode> <b:PaymentType>CreditCard</b:PaymentType> <b:ProcessingFee>40000</b:ProcessingFee> <--------- These values must be put into the appropriate place in <b:ProcessingFeeTax>0</b:ProcessingFeeTax> <--------- the booking request or the booking will fail <b:RedeemVoucher i:nil="true"/> <b:ThirdPartyPayment i:nil="true"/> </b:Payment> |
GetAgencyCompanyList
GetAgencyCompanyList Request
The following is a snippet from the GetAgencyCompanyList
request:
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Body> <tem:GetAgencyCompanyList/> </soapenv:Body> |
GetAgencyCompanyList Response
The following is a snippet from the GetAgencyCompanyList
response:
...
Info | ||
---|---|---|
| ||
|
GetAirport
GetAirport Request
The following is an example of finding an airport by Airport Code:
...
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Body> <tem:GetAirport> <tem:airportReq> <int:AirportName>Toronto Pearson Intl</int:AirportName> </tem:airportReq> </tem:GetAirport> </soapenv:Body> |
GetAirport Response
The following is a snippet from the GetAirport
response:
Code Block | ||||
---|---|---|---|---|
| ||||
<a:Airport xmlns:b="http://schemas.datacontract.org/2004/07/InteliSys.Amelia"> <b:Code>YYZ</b:Code> <b:Name>Toronto Pearson Intl</b:Name> </a:Airport> |
GetAirportSSRAllocations
GetAirportSSRAllocations Request
The following is an example of finding the available Airport SSR items:
Code Block |
---|
<soapenv:Body> <tem:GetAirportSSRAllocations> <tem:allocRequest> <int:AirportCode>YUL</int:AirportCode> <int:CurrencyCode>CDN</int:CurrencyCode> <int:DateOfDepartureOrArrival>2015-12-30T14:55:00</int:DateOfDepartureOrArrival> <int:DepartureOrArrivalIndicator>Arrival</int:DepartureOrArrivalIndicator> </tem:allocRequest> </tem:GetAirportSSRAllocations> </soapenv:Body> |
GetAirportSSRAllocations Response
The following is a snippet from the GetAirportSSRAllocations response:
Code Block |
---|
<b:AirportItem> <b:ChargeAmount>4.5</b:ChargeAmount> <b:Description>Soup1</b:Description> <b:ID>12777</b:ID> <b:IsMandatory>false</b:IsMandatory> <b:MaxQuatityPerPax>2</b:MaxQuatityPerPax> <b:Name>Onion Soup</b:Name> <b:QuantityAllocated>25</b:QuantityAllocated> <b:QuantityAvailable>24</b:QuantityAvailable> <b:Airport xmlns:c="http://schemas.datacontract.org/2004/07/InteliSys.Amelia"> <c:Code/> <c:Name>Montreal</c:Name> </b:Airport> <b:DeartureArrival>Arrival</b:DeartureArrival> </b:AirportItem> |
GetFlightSSRAllocations
GetFlightSSRAllocations Request
The following is an example of finding the available Flight SSR items:
Code Block |
---|
<soapenv:Body> <tem:GetFlightSSRAllocations> <tem:allocRequest> <int:CurrencyCode>CDN</int:CurrencyCode> <int:Segments> <int1:BookingSegment> <int1:ArrivalAirportCode>YQM</int1:ArrivalAirportCode> <int1:DepartureAirportCode>YUL</int1:DepartureAirportCode> <int1:ETALocal>2015-12-30T14:55:00</int1:ETALocal> <int1:ETDLocal>2015-12-30T11:15:00</int1:ETDLocal> <int1:FlightCode>YY234</int1:FlightCode> </int1:BookingSegment> </int:Segments> </tem:allocRequest> </tem:GetFlightSSRAllocations> </soapenv:Body> |
GetFlightSSRAllocations Response
The following is a snippet from the GetFlightSSRAllocations response:
Code Block |
---|
<b:Allocations> <b:FlightItem> <b:ChargeAmount>2</b:ChargeAmount> <b:Description>Wheelchair Electric Powered</b:Description> <b:ID>36508</b:ID> <b:IsMandatory>false</b:IsMandatory> <b:MaxQuatityPerPax>1</b:MaxQuatityPerPax> <b:Name>WCEP</b:Name> <b:QuantityAllocated>10</b:QuantityAllocated> <b:QuantityAvailable>9</b:QuantityAvailable> <b:DepartureAirport xmlns:c="http://schemas.datacontract.org/2004/07/InteliSys.Amelia"> <c:Code>YUL</c:Code> <c:Name>Montreal</c:Name> </b:DepartureAirport> <b:ETD_Local>2015-12-30T11:15:00</b:ETD_Local> <b:ExtraAllocationIDCount>1</b:ExtraAllocationIDCount> <b:ExtraAllocationIDs>36508</b:ExtraAllocationIDs> <b:FlightNumber>YY234</b:FlightNumber> </b:FlightItem> </b:Allocations> |
GetCityPairSSRAllocations
GetCityPairSSRAllocations Request
The following is an example of finding the available City Pair SSR items:
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Body> <tem:GetCityPairSSRAllocations> <tem:allocRequest> <int:ArrivalAirportCode>XXX</int:ArrivalAirportCode> <int:DepartureAirportCode>YYY</int:DepartureAirportCode> <int:ETALocal>2016-05-12</int:ETALocal> <int:ETDLocal>2016-05-12</int:ETDLocal> </tem:allocRequest> </tem:GetCityPairSSRAllocations> </soapenv:Body> |
GetCityPairSSRAllocations Response
The following is a snippet from the response showing the structure of the returned allocations:
Code Block | ||||
---|---|---|---|---|
| ||||
<a:Allocations xmlns:b="http://schemas.datacontract.org/2004/07/InteliSys.Amelia.SSR"> <b:CityPairItem> <b:ChargeAmount>80000</b:ChargeAmount> <b:Description>Beef</b:Description> <b:ID>4321</b:ID> <b:IsMandatory>false</b:IsMandatory> <b:MaxQuatityPerPax>20</b:MaxQuatityPerPax> <b:Name>Kabab</b:Name> <b:QuantityAllocated>3</b:QuantityAllocated> <b:QuantityAvailable>3</b:QuantityAvailable> <b:ArrivalAirport xmlns:c="http://schemas.datacontract.org/2004/07/InteliSys.Amelia"> <c:Code>XXX</c:Code> <c:Name>Arrival Airport</c:Name> </b:ArrivalAirport> <b:DepartureAirport xmlns:c="http://schemas.datacontract.org/2004/07/InteliSys.Amelia"> <c:Code>YYY</c:Code> <c:Name>Departure Airport</c:Name> </b:DepartureAirport> </b:CityPairItem> </a:Allocations> |
GetSeatMapByFlight
GetSeatMapByFlight Request
The following is a sample GetSeatMapByFlight
request:
...
If a specific travel option contains multiple flights, all flights would be passed to the GetSeatMapByFlight request in the FlightList node.
GetSeatMapByFlight Response
The response will contain seats as well as their availability including any seat blocks that may need to be taken into account.
UpdatePassengerWeight
UpdatePassengerWeight Request
Code Block |
---|
<soapenv:Body> <tem:UpdatePassengerWeight> <tem:request> <int:PaxGroupID>29739</int:PaxGroupID> <int:PaxWeight>160</int:PaxWeight> </tem:request> </tem:UpdatePassengerWeight> </soapenv:Body> |
...
Info |
---|
|
UpdatePassengerWeight Response
Code Block |
---|
<s:Body> <UpdatePassengerWeightResponse xmlns="http://tempuri.org/"> <UpdatePassengerWeightResult xmlns:a="http://schemas.datacontract.org/2004/07/InteliSys.Amelia.API" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:AuditKey>f61fb2d9-f6ad-4411-a4b1-6db8b86be399</a:AuditKey> <a:OperationMessage>SUCCESS</a:OperationMessage> <a:OperationSucceeded>true</a:OperationSucceeded> <a:OperationUID>f61fb2d9-f6ad-4411-a4b1-6db8b86be399</a:OperationUID> </UpdatePassengerWeightResult> </UpdatePassengerWeightResponse> </s:Body> |
...
Info | ||
---|---|---|
| ||
|
GetBookingSeatMaps
Note: This operation will be available with the 16.12 release.
GetBookingSeatMaps Request
The following is an example of a GetBookingSeatMaps request:
...
Info | ||
---|---|---|
| ||
|
GetBookingSeatMaps Response
The response of this operation will return a list of one or more seat maps as well as the charges associated with each seat:
Code Block | ||||
---|---|---|---|---|
| ||||
<a:SeatMapList xmlns:b="http://schemas.datacontract.org/2004/07/InteliSys.Amelia"> <b:BookingSeatMap> <b:Flights> <b:Flight> <b:Aircraft> <b:ModelIdent>Canadair CRA</b:ModelIdent> <b:ModelName>CRJ7</b:ModelName> </b:Aircraft> <b:ArrivalAirport> <b:Code>YYY</b:Code> <b:Name>Some airport</b:Name> </b:ArrivalAirport> <b:DepartureAirport> <b:Code>XXX</b:Code> <b:Name>Some airport</b:Name> </b:DepartureAirport> <b:ETA>2016-11-14T20:10:00</b:ETA> <b:ETALocal>2016-11-14T15:10:00</b:ETALocal> <b:ETD>2016-11-14T19:15:00</b:ETD> <b:ETDLocal>2016-11-14T14:15:00</b:ETDLocal> <b:Number>YY100</b:Number> </b:Flight> <b:Flight> <b:Aircraft> <b:ModelIdent>Canadair CRA</b:ModelIdent> <b:ModelName>CRJ7</b:ModelName> </b:Aircraft> <b:ArrivalAirport> <b:Code>ZZZ</b:Code> <b:Name>Some airport</b:Name> </b:ArrivalAirport> <b:DepartureAirport> <b:Code>YYY</b:Code> <b:Name>Some airport</b:Name> </b:DepartureAirport> <b:ETA>2016-11-14T20:10:00</b:ETA> <b:ETALocal>2016-11-14T15:10:00</b:ETALocal> <b:ETD>2016-11-14T19:15:00</b:ETD> <b:ETDLocal>2016-11-14T14:15:00</b:ETDLocal> <b:Number>YY100</b:Number> </b:Flight> </b:Flights> <b:Seats> <b:FlightSeat> <b:Availability>Available</b:Availability> <b:BlockReason i:nil="true"/> <b:Flags> <b:SeatFlags>WindowSeat</b:SeatFlags> <b:SeatFlags>Seat</b:SeatFlags> </b:Flags> <b:RowNumber>1</b:RowNumber> <b:SeatNumber>A</b:SeatNumber> <b:Charges> <b:SeatCharge> <b:BookingCodeSeatCharge>10</b:BookingCodeSeatCharge> <b:Currency> <b:Abbreviation>USD</b:Abbreviation> <b:Description>US dollars</b:Description> <b:ExchangeRate>1</b:ExchangeRate> <b:Format>$#,##0.00</b:Format> </b:Currency> <b:SeatTypeCharge>10</b:SeatTypeCharge> <b:TaxAmountTotal>1</b:TaxAmountTotal> <b:TaxComponents> <b:TaxComponent> <b:Amount>1</b:Amount> <b:Name>Services</b:Name> </b:TaxComponent> </b:TaxComponents> <b:TotalSeatCost>21</b:TotalSeatCost> </b:SeatCharge> </b:Charges> </b:FlightSeat> ... ... ... ... <b:Seats/> <b:BookingSeatMap/> <a:SeatMapList/> |
CheckIn Service
CheckIn
CheckIn Request
The following is an example of a CheckIn
request:
...
Info | ||
---|---|---|
| ||
|
...
CheckIn Response
The following is a snippet from the CheckIn
request:
...
Info | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
For more detail check the The following are common failure cases:
This error usually occurs when the passenger information in the request does not match the passenger information on the reservation.
This error occurs when the user does not have permission to checkin a passenger. |
GetSeatMap
GetSeatMap Request
The following is an example of a GetSeatMap request:
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Body> <tem:GetSeatMap> <tem:request> <int:Query> <int1:LegNumber>1</int1:LegNumber> <int1:ReservationNumber>123123</int1:ReservationNumber> </int:Query> </tem:request> </tem:GetSeatMap> </soapenv:Body> |
GetSeatMap Response
The following is an snippet from a successful GetSeatMap
request:
...
Info | ||||
---|---|---|---|---|
| ||||
There was an error getting the seatmap. Object reference not set to an instance of an object. The most common cause of this error is that the reservation that you're trying to view a seatmap for is canceled. NOTE: This operation does not currently support connecting flights. |
SetSeatAssignmentsByFlight
Getting the Required Information
Panel |
---|
|
SetSeatAssignmentsByFlightRequest
The following is a sample request for SetSeatAssignmentsByFlight
:
...
Info | ||
---|---|---|
| ||
|
SetSeatAssignments
SetSeatAssignments Request
The following is a sample request for SetSeatAssignments
:
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Body> <tem:SetSeatAssignments> <tem:request> <int:LegNumber>1</int:LegNumber> <int:PaxList> <int1:SeatAssignmentPax> <int1:Firstname>JOHN</int1:Firstname> <int1:Lastname>DOE</int1:Lastname> <int1:Middlename>NOMIDDLENAME</int1:Middlename> <int1:PassportNumber>12345</int1:PassportNumber> <int1:RowNumber>1</int1:RowNumber> <int1:SeatNumber>A</int1:SeatNumber> </int1:SeatAssignmentPax> </int:PaxList> <int:ReservationNumber>123456</int:ReservationNumber> </tem:request> </tem:SetSeatAssignments> </soapenv:Body> |
SetSeatAssignments Response
The following is a snippet from the SetSeatAssignments
response:
...
Info | ||
---|---|---|
| ||
|
Reservation Payment Service
GetPaymentMethodList
GetPaymentMethodList Request
The following is an example of a GetPaymentMethodList
request:
...
Info | ||
---|---|---|
| ||
|
GetPaymentMethodList Response
The following is a snippet from the GetPaymentMethodList
response:
...
Info | ||
---|---|---|
| ||
|
ReservationPayment
ReservationPayment Request
"On Account" Payment
The following is an example of a ReservationPayment
request paying on account:
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Body> <tem:ReservationPayment> <tem:reservationPaymentRequest> <int:Payment> <int1:Company> <int1:Code>11000001</int1:Code> </int1:Company> <int1:CurrencyCode>VND</int1:CurrencyCode> <int1:PayAllPassengers>true</int1:PayAllPassengers> <int1:PayBalance>true</int1:PayBalance> <int1:Payment> <int1:AccountPayment> <int1:CompanyCode>11000001</int1:CompanyCode> <int1:PaymentMethod>AG</int1:PaymentMethod> <int1:PurchaseOrder>717103694</int1:PurchaseOrder> </int1:AccountPayment> <int1:Amount>550000</int1:Amount> <int1:CurrencyCode>VND</int1:CurrencyCode> <int1:PaymentType>Account</int1:PaymentType> <int1:ProcessingFee>0</int1:ProcessingFee> <int1:ProcessingFeeTax>0</int1:ProcessingFeeTax> </int1:Payment> <int1:ReservationNumber>1234567</int1:ReservationNumber> </int:Payment> </tem:reservationPaymentRequest> </tem:ReservationPayment> </soapenv:Body> |
"Credit Card" Payment
The following is an example of a ReservationPayment
request paying with credit card:
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Body> <tem:ReservationPayment> <tem:reservationPaymentRequest> <int:Payment> <int1:CurrencyCode>VND</int1:CurrencyCode> <int1:PayAllPassengers>true</int1:PayAllPassengers> <int1:PayBalance>true</int1:PayBalance> <int1:Payment> <int1:Amount>550000</int1:Amount> <int1:CreditCardPayment> <int1:Address> <int1:Addr1>123 anywhere st</int1:Addr1> <int1:Addr2>apt 12</int1:Addr2> <int1:City>saint john</int1:City> <int1:CountryCode>CDN</int1:CountryCode> <int1:CountryDescription>Canada</int1:CountryDescription> <int1:PostalCode>e2e2e2</int1:PostalCode> <int1:ProvinceAbbreviation>nb</int1:ProvinceAbbreviation> <int1:ProvinceName>new brunswick</int1:ProvinceName> </int1:Address> <int1:CVV>377</int1:CVV> <int1:Email>mail@mail.com</int1:Email> <int1:ExpireYear>2017</int1:ExpireYear> <int1:ExpiryMonth>12</int1:ExpiryMonth> <int1:Firstname>John</int1:Firstname> <int1:Lastname>Doe</int1:Lastname> <int1:Number>4111111111111111</int1:Number> <int1:TypeCode>VI</int1:TypeCode> </int1:CreditCardPayment> <int1:CurrencyCode>VND</int1:CurrencyCode> <int1:PaymentType>CreditCard</int1:PaymentType> <int1:ProcessingFee>0</int1:ProcessingFee> <int1:ProcessingFeeTax>0</int1:ProcessingFeeTax> </int1:Payment> <int1:ReservationNumber>1234567</int1:ReservationNumber> </int:Payment> </tem:reservationPaymentRequest> </tem:ReservationPayment> </soapenv:Body> |
"Voucher" Payment
The following is an example of a ReservationPayment
request paying with a voucher:
Code Block |
---|
<int:Payment> <int1:CurrencyCode>USD</int1:CurrencyCode> <int1:PayAllPassengers>false</int1:PayAllPassengers> <int1:PayBalance>false</int1:PayBalance> <---- Set to true if the full balance of the reservation will be paid with a voucher. <int1:Payment> <int1:Amount>5.00</int1:Amount> <int1:PaymentType>VoucherOnly</int1:PaymentType> <int1:ProcessingFee>0</int1:ProcessingFee> <int1:ProcessingFeeTax>0</int1:ProcessingFeeTax> <int1:RedeemVoucher> <int1:CurrencyCode>USD</int1:CurrencyCode> <int1:Firstname>John</int1:Firstname> <int1:Lastname>Doe</int1:Lastname> <int1:PIN>123</int1:PIN> <int1:Password>123</int1:Password> <int1:RedeemAmount>5.00</int1:RedeemAmount> <int1:SerialNumber>J68PKUAB4X</int1:SerialNumber> </int1:RedeemVoucher> </int1:Payment> <int1:ReservationNumber>1013101</int1:ReservationNumber> </int:Payment> |
...
The response will be similar to a BookReservation response. The "Payments" and "ResStatus" will contian information related to the voucher payment.
Code Block |
---|
<b:Payments> <b:Payment> <b:CurrencyAmount>5</b:CurrencyAmount> <b:DatedLocal>2017-01-24T09:39:00</b:DatedLocal> <b:DatedZulu>2017-01-24T14:39:00</b:DatedZulu> <b:Description/> <b:Firstname>John</b:Firstname> <b:Lastname>Doe</b:Lastname> <b:Payer>Bobby, Bouchee</b:Payer> <b:PaymentMethodCode>VO</b:PaymentMethodCode> <b:ReceiptNumber>13938</b:ReceiptNumber> <b:TakenBy>WEBUSER</b:TakenBy> </b:Payment> </b:Payments> <b:ResStatus> <b:Balance>93.52</b:Balance> <b:CancelledDate>1900-01-01T00:00:00</b:CancelledDate> <b:Charges>98.52</b:Charges> <b:HoldExpiry>1900-01-01T00:00:00</b:HoldExpiry> <b:IsCancelled>false</b:IsCancelled> <b:OnHold>false</b:OnHold> <b:Payments>5</b:Payments> <b:Refunds>0</b:Refunds> <b:StatusCode>Active</b:StatusCode> </b:ResStatus> |
ReservationPayment Response
The following is a snippet from the ReservationPayment
response:
...
Info | ||||
---|---|---|---|---|
| ||||
The reservation could not be found or permission denied. This error presents itself when the reservation number provided is either invalid or does not exist. Further information about errors can be found in the
<a:OperationMessage>Balance is already zero.</a:OperationMessage> This occurs when trying to make a payment on a reservation which has a balance of zero.
<a:OperationMessage>Company not found or invalid.</a:OperationMessage> This occurs when the company account you are trying to pay as is either not currently configured, or does not exist. To avoid this error, always run <a:OperationMessage>Payment method not found or invalid.</a:OperationMessage> This error occurs when the payment method you have chosen is not currently configured. To avoid getting this error run |
Shop Service
PurchaseItems Request
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Body> <tem:PurchaseItems> <tem:req> <int:Payment> <int1:Amount>2.5</int1:Amount> <int1:CreditCardPayment> <int1:Address> <int1:Addr1>164 Anyhere</int1:Addr1> <int1:City>Saint John</int1:City> <int1:CountryCode>CDN</int1:CountryCode> <int1:CountryDescription>Canada</int1:CountryDescription> <int1:PostalCode>e2e2e2</int1:PostalCode> <int1:ProvinceAbbreviation>NB</int1:ProvinceAbbreviation> <int1:ProvinceName>New Brunswick</int1:ProvinceName> </int1:Address> <int1:CVV>377</int1:CVV> <int1:Email>email@email.com</int1:Email> <int1:ExpireYear>2017</int1:ExpireYear> <int1:ExpiryMonth>12</int1:ExpiryMonth> <int1:Firstname>John</int1:Firstname> <int1:Lastname>Doe</int1:Lastname> <int1:Number>4111111111111111</int1:Number> <int1:TypeCode>VI</int1:TypeCode> </int1:CreditCardPayment> <int1:CurrencyCode>USD</int1:CurrencyCode> <int1:PaymentType>CreditCard</int1:PaymentType> <int1:ProcessingFee>0</int1:ProcessingFee> <int1:ProcessingFeeTax>0</int1:ProcessingFeeTax> </int:Payment> <int:RequestedItems> <int2:PurchaseRequestItem> <int2:LegNumber>1</int2:LegNumber> <int2:AirportAllocID>15263</int2:AirportAllocID> <----- Obtained through GetAirportAllocations() <int2:PaxGroupID>24403</int2:PaxGroupID> <----- Obtained through GetReservation() </int2:PurchaseRequestItem> </int:RequestedItems> <int:ReservationNumber>1007151</int:ReservationNumber> </tem:req> </tem:PurchaseItems> </soapenv:Body> |
UserProfile Service
...
Related articles
Filter by label (Content by label) | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Page Properties | ||
---|---|---|
| ||
|
...