FareRules

Attachments:

Introduction

This service returns fare rules per fare category on the requested origin and destination for the particular travel date.

FareRules Webservice

Limitations (This list is not exhaustive):

Amadeus HOST limitation applies;
Only English language localization is supported.

This web service is called with the following inputs:

Origin airport
Departure date
Destination airport
Fare basis code

The output data this service returns include:

Departure date
Destination airport
Fare basis code
Fare rule category
Fare category text

Access

In order to access API, you will need to pass the following two headers for each call.

Authentication and authorization stand on the protocol layer using basic HTTP authentication. Given username and password with separator “:” MUST be base64-encoded and passed as HTTP header “Authorization”. This header is mandatory for all requests. For example, if "TestLogin" set as the username and "TestPass" set as the password, then the field's value is base64-encoding of TestLogin: TestPass, or QWxhZGRpbjpPcGVuU2VzYW1l. Then the Authorization header will appear as Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l

Header 'Content-Type: text/xml'

FareRulesRQ structure

FareRulesRQ

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/EDIST/2017.1 NDC/17_1%20schemas_EDIST/FareRulesRQ.xsd">
	<Header/>
	<Body>
		<FareRulesRQ Version="17.1" PrimaryLangID="EN" xmlns="http://www.iata.org/IATA/EDIST/2017.1">
			<Document>
				<Name>PS</Name>
			</Document>
			<Party>
				<Sender>
					<TravelAgencySender>
						<Name>Agent</Name>
						<PseudoCity>IEVPS28ND</PseudoCity>
						<AgencyID>TA123</AgencyID>
					</TravelAgencySender>
				</Sender>
			</Party>
			<Query>
				<Departure>
					<AirportCode>KBP</AirportCode>
					<Date>2021-01-16</Date>
				</Departure>
				<Arrival>
					<AirportCode>YYZ</AirportCode>
				</Arrival>
				<FareBasisCode>
					<Code>PL02PPU5</Code>
				</FareBasisCode>
				<AirlineID>PS</AirlineID>
			</Query>
		</FareRulesRQ>
	</Body>
</Envelope>

FareRulesRQ fields description

Click here to expand...

M = Mandatory; O = Optional; C = Conditional

Field name	Description	M/O/C	Example
FareRulesRQ	Attributes: Version - Specify NDC schema message version. Always pass 17.1 PrimaryLangID - Specifies the agent’s preferred language. Service response will be returned in this language. IF not specified default language = EN	M O	<FareRulesRQ Version="17.1" PrimaryLangID="EN" xmlns="http://www.iata.org/IATA/EDIST/2017.1">
↳ Document	NDC Message Document information.	M
↳ Name	Document name will be always "PS"	M	`<Document>` `<Name>PS</Name>` `</Document>`
↳ Party	NDC Message/ Transaction Party(s) information. Note that information about parties is intended for business use, it is not intended for transaction authentication and routing of the message.	M
↳ Sender	Message Sender information.	M
↳ TravelAgencySender	SELLER: Travel Agency	M
↳ Name	Name of the travel agency	M	Smith Travel
↳ PseudoCity	Pseudo City code./ Office ID	M	IEVPS00ZZ
↳ AgencyID	Unique Agency Seller ID.	O	SASELLER1
↳ Query	Core Fare Rules query parameters.	M
↳ Departure	Departure (origin) Airport	M	<AirportCode>LWO</AirportCode>
↳ AirportCode	Airport or a city code	M
↳ Date	Departure date. Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)	M	<Date>2019-06-10</Date>
↳ Arrival	Arrival (destination) Airport	M
↳ AirportCode	Airport or city code.	M	<AirportCode>MIL</AirportCode>
↳ FareBasisCode	Fare Basis Code with the optional application.	M
↳ Code	Fare basis code.	M	<Code>X002LLU2</Code>
↳ AirlineID	A two-character alpha-numeric code	M	<AirlineID>PS</AirlineID>

FareRulesRS structure

FareRulesRS

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/EDIST/2017.1 NDC/17_1%20schemas_EDIST/FareRulesRS.xsd">
	<Header/>
	<Body>
		<FareRulesRS xmlns="http://www.iata.org/IATA/EDIST/2017.1" Version="17.1">
			<Document>
				<Name>PS</Name>
			</Document>
			<Success/>
			<Rules>
				<Departure>
					<AirportCode>KBP</AirportCode>
					<Date>2021-01-16Z</Date>
				</Departure>
				<Arrival>
					<AirportCode>YYZ</AirportCode>
				</Arrival>
				<FareBasisCode>
					<Code>PL02PPU5</Code>
				</FareBasisCode>
				<AirlineID>PS</AirlineID>
				<Rule>
					<FareRuleCategory>RU</FareRuleCategory>
					<Text>FOR PL02PPU5 TYPE FARES
PREMIUM FLEX FARES
PREMIUM CABIN FOR SECTORS BTWN IEV AND YTO ONLY
 APPLICATION
   AREA
     THESE FARES APPLY
     TO CANADA.
   CLASS OF SERVICE
     THESE FARES APPLY FOR PREMIUM ECONOMY CLASS SERVICE.
   TYPES OF TRANSPORTATION
     THIS RULE GOVERNS ONE-WAY AND ROUND-TRIP FARES.
     FARES GOVERNED BY THIS RULE CAN BE USED TO CREATE
     ONE-WAY/ROUND-TRIP/OPEN-JAW JOURNEYS.</Text>
				</Rule>
				<Rule>
					<FareRuleCategory>MN</FareRuleCategory>
					<Text>BETWEEN UKRAINE AND CANADA FOR PL02PPU5 TYPE FARES
 
  TRAVEL FROM LAST STOPOVER MUST COMMENCE NO EARLIER THAN
  1201AM ON THE FIRST SUN AFTER DEPARTURE FROM FARE ORIGIN
  OR - TRAVEL FROM LAST STOPOVER MUST COMMENCE NO EARLIER
       THAN 6 DAYS AFTER DEPARTURE FROM FARE ORIGIN.</Text>
				</Rule>
				<Rule>
					<FareRuleCategory>MX</FareRuleCategory>
					<Text> 
  TRAVEL FROM LAST STOPOVER MUST COMMENCE NO LATER THAN 12
  MONTHS AFTER DEPARTURE FROM FARE ORIGIN.</Text>
				</Rule>
				<Rule>
					<FareRuleCategory>SE</FareRuleCategory>
					<Text>BETWEEN IEV AND CANADA FOR LOW/OFF-PEAK SEASON FARES
 
  PERMITTED 02JUL 20 THROUGH 26JUN 21.</Text>
				</Rule>
				<Rule>
					<FareRuleCategory>SR</FareRuleCategory>
					<Text> 
  TICKETS MAY NOT BE SOLD IN IRAN,ISLAMIC REPUBLIC OF.</Text>
				</Rule>
				<Rule>
					<FareRuleCategory>AP</FareRuleCategory>
					<Text>BETWEEN IEV AND CANADA FOR PL02PPU5 TYPE FARES
 
  RESERVATIONS ARE REQUIRED FOR ALL SECTORS.
         NOTE -
          FOR  TICKETING DEADLINE PLEASE SEE AUTOMATED MESSA
          GE IN YOUR PNR</Text>
				</Rule>
				<Rule>
					<FareRuleCategory>FL</FareRuleCategory>
					<Text>FROM/TO YTO
 
  THE FARE COMPONENT MUST BE ON
      ONE OR MORE OF THE FOLLOWING
        ANY PS FLIGHT OPERATED BY PS.</Text>
				</Rule>
				<Rule>
					<FareRuleCategory>CD</FareRuleCategory>
					<Text>FROM/TO YTO
 
  ACCOMPANIED CHILD 2-11 - CHARGE 75 PERCENT OF THE FARE.
        TICKET DESIGNATOR - CH AND PERCENT OF DISCOUNT
  OR - 1ST INFANT UNDER 2 WITHOUT A SEAT - CHARGE 10 PERCENT
         OF THE FARE.
             TICKET DESIGNATOR - IN AND PERCENT OF DISCOUNT
  OR - INFANT UNDER 2 WITH A SEAT - CHARGE 75 PERCENT OF THE
         FARE.
             TICKET DESIGNATOR - IN AND PERCENT OF DISCOUNT
  OR - UNACCOMPANIED CHILD 5-16 - NO DISCOUNT.
         NOTE -
          UNACCOMPANIED  CHILDREN
          -AGED 2-4 YEARS- NOT ACCEPTED.
          AGED 5-11 YEARS - CHILD DISCOUNT OR ZZ FARE ARE
          NOT APPLICABLE IN CASE OF UMNR</Text>
				</Rule>
				<Rule>
					<FareRuleCategory>OD</FareRuleCategory>
					<Text>FROM/TO YTO
 
         NOTE -
          NO OTHER DISCOUNT PERMITTED</Text>
				</Rule>
				<Rule>
					<FareRuleCategory>SO</FareRuleCategory>
					<Text> 
  2 FREE STOPOVERS PERMITTED ON THE PRICING UNIT - 1 IN EACH
      DIRECTION.
     A STOPOVER MAY NOT EXCEED 120 HOURS.</Text>
				</Rule>
				<Rule>
					<FareRuleCategory>TF</FareRuleCategory>
					<Text> 
  UNLIMITED TRANSFERS PERMITTED ON THE PRICING UNIT
    FARE BREAK AND EMBEDDED SURFACE SECTORS NOT PERMITTED ON
     THE FARE COMPONENT.</Text>
				</Rule>
				<Rule>
					<FareRuleCategory>SU</FareRuleCategory>
					<Text> 
  THE PROVISIONS BELOW APPLY ONLY AS FOLLOWS -
  TICKETS MUST BE ISSUED ON QR.
    A SURCHARGE OF USD 185.00 PER FARE COMPONENT WILL BE
    ADDED TO THE APPLICABLE FARE FOR TRAVEL.</Text>
				</Rule>
				<Rule>
					<FareRuleCategory>TE</FareRuleCategory>
					<Text>FOR PL02PPU5 TYPE FARES
 
  THE ORIGINAL AND THE REISSUED TICKET MUST BE ANNOTATED -
  NONEND/REF RSTR/RBK FOC - IN THE ENDORSEMENT BOX.</Text>
				</Rule>
				<Rule>
					<FareRuleCategory>PE</FareRuleCategory>
					<Text>FOR PL02PPU5 TYPE FARES
 
  CANCELLATIONS
 
    BEFORE DEPARTURE
      CANCELLATIONS PERMITTED FOR CANCEL/NO-SHOW/REFUND.
         NOTE -
          YQ IS REFUNDABLE FOR UNUSED TICKET
          ONLY IN CASE CANCELLATION MORE
          THAN 24H BEFORE  DEPARTURE
 
    AFTER DEPARTURE
      CANCELLATIONS PERMITTED FOR CANCEL/NO-SHOW/REFUND.
         NOTE -
          PARTLY USED TICKET - REFUND THE
          DIFFERENCE BETWEEN FARE PAID AND
          OW FARE FOR FLOWN FARE COMPONENT
          IN THE SAME RBD OR HIGHER WITHIN
          SAME BRAND
          ----
          IN CASE OF PARTIAL USE OF OUTBOUND
          OR INBOUND FARE COMPONENT THE
          AMOUNT OF THIS FARE COMPONENT
          IS FULLY NONREFUNDABLE
 
  CHANGES
 
    ANY TIME
      CHANGES PERMITTED FOR NO-SHOW/REISSUE/REVALIDATION.
         NOTE -
          UPGRADE PERMITTED TO HIGHER FARE
          WITHIN SAME OR HIGHER BRAND ONLY
          UPON PAYMENT OF THE DIFFERENCE
          BETWEEN FARE PAID AND HIGHER FARE
          ---------------------------
          REROUTING PERMITTED ON PS FARES
          ONLY WITHIN SAME OR HIGHER BRAND
          WITH COLLECTION ADDITIONAL TAXES/
          FARE AMOUNT/ IF NEW FARE IS LOWER
          NO FARE DIFFERENCE REFUND
          -----------------
          VOLUNTARY UPSELL TO BUSINESS
          CLASS FARES PERMITTED  IN CASE OF
          NO DATE OR FLIGHT CHANGE
          ------
          IN SUBSEQUENTLY CHANGES AND
          REFUND RULES OF NEW FARE WILL BE
          APPLIED BUT NON-REFUNDABLE
          AMOUNT REMAINS NON-REFUNDABLE
          ---------</Text>
				</Rule>
				<Rule>
					<FareRuleCategory>CO</FareRuleCategory>
					<Text>   END-ON-END NOT PERMITTED. SIDE TRIPS NOT PERMITTED
   APPLICABLE ADD-ON CONSTRUCTION IS ADDRESSED IN
   MISCELLANEOUS PROVISIONS - CATEGORY 23.
  ROUND TRIPS/CIRCLE TRIPS
    FARES MAY BE COMBINED ON A HALF ROUND TRIP BASIS
    -TO FORM ROUND TRIPS
     ROUND TRIPS NOTE -
       IN CASE OF COMBINATION THE MOST RESTRICTIVE
       CONDITIONS APPLY.
    -TO FORM CIRCLE TRIPS.
   PROVIDED -
     COMBINATIONS ARE WITH ANY FARE FOR CARRIER PS IN ANY
     RULE AND TARIFF.
  OPEN JAWS
    FARES MAY BE COMBINED ON A HALF ROUND TRIP BASIS WITH PS
    FARES
    -TO FORM SINGLE OR DOUBLE OPEN JAWS.
     OPEN JAWS NOTE -
       IN CASE OF COMBINATION THE MOST RESTRICTIVE
       CONDITIONS APPLY.
   PROVIDED -
     WHEN THE OPEN SEGMENT OCCURS
      -WITHIN MIDDLE EAST OR WITHIN EUROPE OR WITHIN AREA 1
       OR WITHIN AREA 3
       COMBINATIONS ARE WITH ANY FARE FOR CARRIER PS IN ANY
     RULE AND TARIFF.</Text>
				</Rule>
				<Rule>
					<FareRuleCategory>HI</FareRuleCategory>
					<Text> 
  THE HIGHER INTERMEDIATE POINT RULE DOES NOT APPLY FOR
  STOPOVERS.
         NOTE -
          HIGHER INTERMEDIATE POINT/MILEAGE EXCEPTIONS
          DO NOT APPLY.
          DIFFERENTIAL DOES NOT APPLY.
  AND - THE HIGHER INTERMEDIATE POINT RULE DOES NOT APPLY
        FOR CONNECTIONS.
         NOTE -
          HIGHER INTERMEDIATE POINT/MILEAGE EXCEPTIONS
          DO NOT APPLY.
          DIFFERENTIAL DOES NOT APPLY.
 
         NOTE -
          HIGHER INTERMEDIATE POINT/MILEAGE EXCEPTIONS
          DO NOT APPLY.
          DIFFERENTIAL DOES NOT APPLY.</Text>
				</Rule>
				<Rule>
					<FareRuleCategory>MD</FareRuleCategory>
					<Text> 
  THIS FARE MAY BE USED FOR ADD-ON CONSTRUCTION. THIS FARE
  MUST NOT BE USED AS THE HIGH OR THE LOW FARE WHEN
  CALCULATING A DIFFERENTIAL. THIS FARE MUST NOT BE USED AS
  THE THROUGH FARE WHEN PRICING A FARE COMPONENT WITH A
  DIFFERENTIAL.
         NOTE -
          FULL AND SEQUENTIAL USE OF FLIGHT COUPONS
          --
            THE TICKET/ OR ELECTRONIC TICKET/ IS NOT VALID I
          F THE FIRST COUPON HAS NOT BEEN USED AND WILL NOT
          BE HONORED IF ALL THE COUPONS ARE NOT USED IN THE
          SEQUENCE PROVIDED IN THE TICKET/OR ELECTRONIC TICK
          ET/
          --
          CAPACITY LIMITATIONS
          --
          THE CARRIER SHALL LIMIT THE NUMBER OF PASSENGERS C
          ARRIED ON ANY ONE FLIGHT AT FARES GOVERNED BY THIS
           RULE AND SUCH FARES WILL NOT NECESSARILY BE AVAIL
          ABLE ON ALL FLIGHTS. THE NUMBER OF SEATS WHICH THE
           CARRIER SHALL MAKE AVAILABLE ON A GIVEN FLIGHT WI
          LL BE DETERMINED BY THE CARRIERS BEST JUDGMENT
          --
          FARES ARE ONLY GUARANTEED IF AUTO-PRICED AND TICKE
          TED IN GDS ON THE SAME DAY</Text>
				</Rule>
				<Rule>
					<FareRuleCategory>VC</FareRuleCategory>
					<Text>VOLUNTARY CHANGES CONDITIONS MAY APPLY FOR AUTOMATED
REISSUE/REVALIDATION
REFER TO PENALTIES CATEGORY *PE FOR DETAILS
 </Text>
				</Rule>
			</Rules>
		</FareRulesRS>
	</Body>
</Envelope>

FareRulesRS fields description

Click here to expand...

M = Mandatory; O = Optional; C = Conditional

Field name	Description	M/O/C	Example
FareRulesRS	Attributes: Version - Specify NDC schema message version. Always pass 17.1 PrimaryLangID - Specifies the agent’s preferred language. Service response will be returned in this language. IF not specified default language = EN	M	<FareRulesRS Version="17.1" PrimaryLangID="EN" xmlns="http://www.iata.org/IATA/EDIST/2017.1">
↳ Document	NDC Message Document information.	M
↳ Name	Will be returned as “PS”	M	`<Document>` `<Name>PS</Name>` `</Document>`
↳ Success	The presence of the empty Success element explicitly indicates that the message succeeded	M	<Success/>
↳ Rules	Fare Rules.	O
↳ Departure	Departure (origin) Airport	M
↳ AirportCode	Airport or a city code.	M	<AirportCode>LWO</AirportCode>
↳ Date	Departure date. Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)	M	<Date>2019-06-10</Date>
↳ Arrival	Arrival (destination) Airport	M
↳ AirportCode	Airport or a city code.	M	<AirportCode>MIL</AirportCode>
↳ FareBasisCode	Fare Basis Code with optional application.	M
↳ Code	Fare basis code.	M	<Code>X002LLU2</Code>
↳ AirlineID	A two-character alpha-numeric code	M	<AirlineID>PS</AirlineID>
↳ Rule	Fare Rules.	M
↳ FareRuleCategory	Fare Rule Category.	O	<FareRuleCategory>MN</FareRuleCategory>
↳ Text	Fare Rule Text.	O	<Text> MIN STAY NO RESTRICTIONS </Text>

FareRules Error/Validation Checks

Click here to expand...

PADIS Error Code	PADIS Error Text	Cases
System errors
911	Unable to process - system error	Invalid query
486	Unknown	The equivalent of -1 error
304	System Temporarily unavailable	The system is not available/HOST problem
916	EDIFACT version not supported	Not supported NDC service version.
Agent authorization errors
368	Not authorized	Wrong agent authentication key. Agent is inactive
79A	Invalid office identification	OID is missing or incorrect
Query errors
73V	Invalid PFC city/airport code	Airport/City code does not exist or missing
914	Invalid format/data - data does not match syntax rules	Incorrect date format
102	Invalid/Missing Departure Date	Departure date is missing in the query
453	Bulk fare(s) not supported
719	No fares available	Requested fare is not available in HOST
107	Invalid Airline Designator/Vendor Supplier	Provided airline ID =! PS