- Previous: Fare Summary
- Up: Flight Booking
- Next: Extend Session
Fare Conditions
## Content
- [Postman collection](#postman-collection)
- [API Description](#api-description)
- [API Parameters](#api-parameters)
- [Input Parameters](#input-parameters)
- [Output Parameters](#output-parameters)
- [Error Codes](#error-codes)
## Postman collection
Please download the postman collection, environment and request for API Key to get started.
Flight Booking API Collection - Local playground with examples of request/response pairs for each endpoint. Additionally it assist the developers to understand the logical flow for the endpoints.
Flight Booking API Environment - Holds the credential information that allows invocation of the endpoints. You can request for the credentials for this specific API [here](/apps/myapps).
Request for API key
## API Description
| | |
| ----------- | -------------------------- |
| API Name | Detailedfareconditions/get |
| API Type | Query |
| Description | Provides the detailed list of fare conditions associated with the current booking. To be shown to user for acceptance before confirmation of booking |
## API Parameters
### HTTP Headers
| Headers | Value | Description |
| ------------------ | --------- | ---------------------------------------------------------------------------- |
|Content-Type|application/json||
|apikey|*|An active SQ API Key for the FlightBooking Package|
### Input Parameters
| Input Parameters | Data Type | Optional | Description |
| ---------------- | ----------- | -------- | ------------------------------------------------------- |
| clientUUID | String | No | Should be unique per request. For debug purpose only. |
| sessionID | String | No | Should be unique per user session. |
| pageTicket | Number | No | Denotes the page flow, e.g. 0 |
| request | JSON Object | No | |
| fareFamily | String | No | Fare family code. E.g. FF41SIN |
| segments | JSONArray | No | List of flight details (not including layovers/stopovers). Every unique flight number has one record in this |
| sellingClass | String Array | No | Fare family code. E.g. FF41SIN |
| originAirportCode | String | No | 3 char IATA code |
| destinationAirportCode | String | No | 3 char IATA code |
| fareFamilyCode | String | Yes | Corresponding value taken from fareFamilyCodesPerBound in /faresummary response |
### Output Parameters
| Output Parameters | Data Type | Description |
| -------------------- | ----------- | ----------------------------------------------------------------------- |
| status | String | “SUCCESS” / “FAILURE” |
| code | Number | 200 if status is “SUCCESS”. Refer to Section 5 for possible error codes |
| message | String | Error message if status is “FAILURE” |
| clientUUID | String | |
| pageTicket | Number | |
| sessionID | String | ERetail session ID |
| response | JSON Object | |
| fareConditionDetails | JSON Array | |
| classOfTravel | String | Description based on selling class. E.g. ECONOMY |
| sellingClass | String | Strictest selling class. E.g. Y |
| maxStay | String | Maximum stay period as per response. E.g. 1 MONTH |
| minStay | String | Minimum stay period as per response. E.g. 1 DAY |
| minTravelParty | String | Minimum Pax required, if available in response |
| fareBasisCode | String | |
| blackOutDates | String | Blackout dates, if available in response |
| detailedConditions | JSON Object | |
| category | String | Condition name. E.g. Stop Over |
| isallowed | String | Condition allowed flag. |
| details | String | Condition rule description. |
| |
### Error Codes
| ErrorCodes | Message | Description |
| ---------- | ------------------------------------------------------------------------------------- | ----------- |
| BKAGCO0000 | Invalid Request | |
| BKAGCO0001 | Invalid ClientID | |
| BKAGCO0009 | Missing or Invalid expected field: sellingClass[]. Expected list of single char input | |
| BKAGCO0010 | Invalid expected field: sellingClass[]->(). Expected single char input | |
| BKAGCO0020 | Missing or Invalid expected field: sessionID | |
| BKAGCO0021 | Missing or Invalid expected field: pageTicket | |
| BKAGCO0067 | Missing expected field: segments. Must be a list with at least one element | |
| BKAGCO0068 | Missing or Invalid expected field: fareFamily | |
| ErrorCodes | Message | Description |
| FAREFC0001 | Error while transforming FareConditions response | |
| FAREFC0002 | Error while generating FareConditionsBO | |
| FAREFC0003 | No components were found or no component matched the strictest RBD | |
| BKAGPR0011 | Provided selling classes could not be sorted for fare conditions | |
- Previous: Fare Summary
- Up: Flight Booking
- Next: Extend Session