Fare Rules
Fare rule Search
Fare rule search request consists with the offerId and the relevant fare basis code and response consists with fare rules, mini fare rules by including penalties as well.
Fare rule Search Request
| Tag | Attributes | Description |
|---|---|---|
| offerId | offerId* (Object) |
OfferId can be found from flight search response.This should be same with selected result offerId from search response. It is joined with a "-".tripId-resultId Ex : offerId= AIR03019045-67. |
| fareBasis | fareBasis (String List) |
Not released yet This attribute contains fare basis list which came from the result. The Client can send one fareBasis at a time with single request then can get the fare rule response. Ex: If client has 3 fareBasis with the search result response then it is required to send 3 individual request to get all fare rules for each fare basis. However current version of API it will work like backend will send all the fare rules which are belongs to all fare basis in single request.But it will changed with future version as explained above. |
| Flight Fare Rule request | |
|---|---|
Fare rule Search Response
Booking Rules
Suppliers have varying booking restrictions, which can result in failed bookings if customers fail to provide sufficient information. To avoid such scenarios, a booking rules section has been included in the fare rule response.
The fare rules response includes a booking rule section that validates data in the provisional book request. Within the booking rules list, there is also a passenger rule list. Passenger rules consist of mandatory information specific to each passenger at the time of booking. Each passenger rule list contains a pax types list. If the required information is the same for all passenger types, there will be a single passenger rule object. However, if the required information differs, there will be multiple passenger rule objects within the rule. Additionally, there are several attributes at the booking rule level.
| Tag | Attributes | Description |
|---|---|---|
| success (String) |
Response status will be return Ex: "true" | |
| statusCode (Boolean) |
Response statusCode will be return Ex: "1" | |
| statusMessage (String) |
Response statusMessage will be return Ex: "SUCCESS" | |
| commonData | commonData (Object) |
This tag has the common Data in the response. |
| productCode* (String) |
Product code of the item being booked,Flight -A | |
| searchKey* (String) |
A unique search id will be returned in the response. | |
| data | data (Object) |
|
| notes | notes (List) |
This returns important notes for the route. At the search response it has mentioned whether this is available or not. The search response relevant attribute is fareRuleMandatory |
| text (String) |
Content of note | |
| bookingRules | bookingRules (List) |
Booking rules contains the validation parameters which received from suppliers in fare rule response.This contain the passenger level rules and booking level rules. |
| passengerRules | passengerRules (List) |
Passenger rules also a list of parameters based on the passenger type.In a booking adult may required more details than a child or infant.Therefore mandatory details categorised based on the passenger type.The required informaition should be present in the provisional book request ,otherwise user will not be able to proceed. |
| isBirthDateMandatory (Boolean) |
This is a passenger level attribute and applicable to the relevant passenger type only. | |
| isIdTypeMandatory (Boolean) |
This is a passenger level attribute and applicable to the relevant passenger type only.Currently this is valid for the passport only. | |
| isDocumentNumberMandatory (Boolean) |
This is a passenger level attribute and applicable to the relevant passenger type only. Currently this is valid for the passport only. | |
| isIssuingCountryCodeMandatory (Boolean) |
This is a passenger level attribute and applicable to the relevant passenger type only.Currently this is valid for the passport only. | |
| isResidenceCountryCode (Boolean) |
This is a passenger level attribute and applicable to the relevant passenger type only.Currently this is valid for the passport only. | |
| isDateOfIssueMandatory (Boolean) |
This is a passenger level attribute and applicable to the relevant passenger type only.Currently this is valid for the passport only. | |
| isExpiryDateMandatory (Boolean) |
This is a passenger level attribute and applicable to the relevant passenger type only.Currently this is valid for the passport only. | |
| isPANMandatory (Boolean) |
This is a passenger level attribute and applicable to the relevant passenger type only. | |
| isSeatMandatory (Boolean) |
This is a passenger level attribute and applicable to the relevant passenger type only.According to the these values ancillary selection will be validated as explained in the Ancillary section of the document.. |
|
| isMealMandatory (Boolean) |
This is a passenger level attribute and applicable to the relevant passenger type only. According to the these values ancillary selection will be validated explained in the Ancillary section of the document. |
|
| isBaggageMandatory (Boolean) |
This is a passenger level attribute and applicable to the relevant passenger type only. According to the these values ancillary selection will be validated explained in the Ancillary section of the document. |
|
| isOtherAncillaryMandatory (Boolean) |
This is a passenger level attribute and applicable to the relevant passenger type only. According to the these values ancillary selection will be validated explained in the Ancillary section of the document. |
|
| isAdditionalIdTypeMandatory (Boolean) |
This is a passenger level attribute and applicable to the relevant passenger type only. | |
| isAdditionalDocumentNumberMandatory (Boolean) |
This is a passenger level attribute and applicable to the relevant passenger type only. | |
| passengerKeys (Boolean) |
This list defines the applicable passenger types of the above mandatory information | |
| isGSTMandatory | isGSTMandatory (Boolean) |
This is a booking rule. If gst is mandatory then provisional book request should contain following gst related information. Tax Name,Register Number,Company Name,Email Id,Phone number and Address. |
| isLeadEmailAddressMandatory | isLeadEmailAddressMandatory (Boolean) |
This is a booking rule and related to lead passenger only. |
| isLeadEmailAddressMandatory | isLeadEmailAddressMandatory (Boolean) |
This is a booking rule and related to lead passenger only. |
| onHoldSupported | onHoldSupported (Boolean) |
This attribute is indication whether supplier is supporting for on-hold or not. For LCCs this value will receive from suppliers. Due to that it will come with Fare rule response. However for GDSs this value will take from master data. Hence it will be available even search response for GDSs. |
| fareRules | fareRules (List) |
This returns fare rules for the flights |
| fareBasis (String) |
Fare basis for the requested itinerary | |
| subSection | subSection (List) |
|
| subSectionNumber (String) |
||
| subCode (String) |
||
| subTitle (String) |
||
| remark (String) |
||
| paragraph (String) |
||
| miniFareRules | miniFareRules (Object List) |
This returns mini fare rules for the selected flight |
| fareBasis fareBasis |
||
| paxType (String) |
This attribute signifies the passenger type that is associated with the specific fare basis. | |
| penalties | penalties (String) |
This returns penalties for the request flights |
| type (String) |
||
| penaltyInfo | penaltyInfo (Object List) |
|
| applicationCode (String) |
This attributes indicates the Rule is before departure or after departure. Ex: BEFORE_DEPARTURE_CHARGE_TYPE = 1; AFTER_DEPARTURE_CHARGE_TYPE = 2; |
|
| startTime (String) |
||
| endTime (String) |
||
| unit (String) |
||
| amounts | amounts (Double) |
|
| currency (String) |
||
| amount (String) |
This indicates charge amount of penalty. If charge is 100% or not refundable then the amount is -1 and remark section will show like relevant action. | |
| amountApplication (String) |
This indicates amount charge type EX: amountApplication: MAX, | |
| applicableFeeRemarks | applicableFeeRemarks (String) |
|
| value (String) |
EX: NOT ALLOWED, CHECK FULL FARE RULES, FULLY CHARGEABLE AMOUNT | |
| cancelFeeInd (Boolean) |
Not released yet | |
| refundableInd (Boolean) |
Not released yet | |
| changeFeeInd (Boolean) |
Not released yet | |
| baggageAllowance | baggageAllowance (Object) |
Baggage allowance for the particular flight |
| segmentKey (String) |
An unique identifier will be added as the segment key. a590892f-48d0-4c0b-b552-2f00d394a67c | |
| carryOnBaggage | carryOnBaggage (Object) |
Carry on baggage descriptions. |
| paxType (String) |
Pax type related to the baggage type. | |
| value (String) |
Value of the particular baggage | |
| unit (String) |
Number of units | |
| description (String) |
Baggage description | |
| checkedInBaggage | checkedInBaggage (Object) |
Checked in baggage description |
| paxType (String) |
Pax type related to the baggage type. | |
| value (String) |
Value of the particular baggage's | |
| unit (String) |
Number of units | |
| description (String) |
Baggage description |
| Fare Rule response | |
|---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 | |