GET Flights by context, contextId

Overview

Retrieve Flights by Booking ID

Request

GET /[context]/[contextId]/Flights

Request Information

Request Parameters

Name
Type
Requirement
Description
context
String
Mandatory
Context in Request URI should be 'bookings'
contextId
Integer
Mandatory
ContextId in Request URI should be Booking ID

Response Information

Response Properties

Name
Type
Description
flights
List<Flight>
Flight list

Flights

Name
Type
Description
fareId
String
Airfare ID
flightName
String
Name of flight
airline
String
Airline code
fromCountry
String
From country
fromAirportCode
String
From airport code
toCountry
String
To country
toAirportCode
String
To airport code
grossPrice
Decimal
Gross price
flightSectors
List<FlightSector>
Flight sectors
customers
HrefWrapper
URI used to retrieve all customers on flight
customerStatuses
Key Value Pair
Key/value pairs indicating the number of customers 
per status on the flight; e.g.: 
{
''confirmed'': 2,
''cancelled'': 1
}
customerStatusIds
List<CustomerStatuses>
List of customer statuses along with url for each customer on that status
currency
String
Currency
reloc
String
Airline booking reference
totalPrice
Decimal
Total gross price for all customers on flight
id
Integer
ID of the resource
href
String
URI of the resource
sequence
Int64
Sequence of product

Flightsectors

Name
Type
Description
flightNo
String
Flight number
class
String
Fare class
departureDate
String
Departure date
arrivalDate
String
Arrival date
origin
String
Departure airport code
destination
String
Arrival airport code
eTD
String
Estimated time of departure
eTA
String
Estimated time of arrival
operator
String
Operator airline code
terminal
String
Terminal number
sectorStatus
String
Sector status
originAirportName
String
Departure airport name
destinationAirportName
String
Arrival airport name
operatorAirline
String
Operator airline name
startCity
String
Start city of the flight
endCity
String
End city of the flight

Customerstatusids

Name
Type
Description
status
String
Customers status
customers
List<HrefWrapper>
Url of Customers in relevant status

Customers

Name
Type
Description
href
String
URI of the resource

Response Codes

HTTP status code
Description
200 OK
The resource was retrieved successfully
400 Bad Request
The resource was malformed
401 Unauthorized
Missing or invalid API key
404 Not Found
The specified resource was not found
500 Internal Server Error
An unexpected error occurred on the API server

Response Example

{
  "flights": [
    {
      "fareId": "41",
      "flightName": "MEL-CMB",
      "airline": "SQ",
      "fromCountry": "Singapore",
      "fromAirportCode": "SIN",
      "toCountry": "Australia",
      "toAirportCode": "MEL",
      "grossPrice": 100.0,
      "flightSectors": [
        {
          "flightNo": "EK11",
          "class": "Y",
          "departureDate": "2016-12-10",
          "arrivalDate": "2016-12-11",
          "origin": "MEL",
          "destination": "AMM",
          "eTD": "0800",
          "eTA": "2100",
          "operator": "EK",
          "terminal": "4",
          "sectorStatus": "Confirmed",
          "originAirportName": "Melbourne",
          "destinationAirportName": "Melbourne",
          "operatorAirline": "EK",
          "startCity": "Melbourne",
          "endCity": "Singapore"
        },
        {
          "flightNo": "EK11",
          "class": "Y",
          "departureDate": "2016-12-10",
          "arrivalDate": "2016-12-11",
          "origin": "MEL",
          "destination": "AMM",
          "eTD": "0800",
          "eTA": "2100",
          "operator": "EK",
          "terminal": "4",
          "sectorStatus": "Confirmed",
          "originAirportName": "Melbourne",
          "destinationAirportName": "Melbourne",
          "operatorAirline": "EK",
          "startCity": "Melbourne",
          "endCity": "Singapore"
        }
      ],
      "customers": {
        "href": "/flights/887124/customers"
      },
      "customerStatuses": {
        "confirmed": 2,
        "tentative": 1
      },
      "customerStatusIds": [
        {
          "status": "tentative",
          "customers": [
            {
              "href": "/context/5057124/customers/4945398"
            },
            {
              "href": "/context/5057124/customers/4945398"
            }
          ]
        },
        {
          "status": "tentative",
          "customers": [
            {
              "href": "/context/5057124/customers/4945398"
            },
            {
              "href": "/context/5057124/customers/4945398"
            }
          ]
        }
      ],
      "currency": "AUD",
      "reloc": "SIN",
      "totalPrice": 150.0,
      "id": 887124,
      "href": "context/contextid/flights/887124",
      "sequence": "202403312359580000"
    },
    {
      "fareId": "41",
      "flightName": "MEL-CMB",
      "airline": "SQ",
      "fromCountry": "Singapore",
      "fromAirportCode": "SIN",
      "toCountry": "Australia",
      "toAirportCode": "MEL",
      "grossPrice": 100.0,
      "flightSectors": [
        {
          "flightNo": "EK11",
          "class": "Y",
          "departureDate": "2016-12-10",
          "arrivalDate": "2016-12-11",
          "origin": "MEL",
          "destination": "AMM",
          "eTD": "0800",
          "eTA": "2100",
          "operator": "EK",
          "terminal": "4",
          "sectorStatus": "Confirmed",
          "originAirportName": "Melbourne",
          "destinationAirportName": "Melbourne",
          "operatorAirline": "EK",
          "startCity": "Melbourne",
          "endCity": "Singapore"
        },
        {
          "flightNo": "EK11",
          "class": "Y",
          "departureDate": "2016-12-10",
          "arrivalDate": "2016-12-11",
          "origin": "MEL",
          "destination": "AMM",
          "eTD": "0800",
          "eTA": "2100",
          "operator": "EK",
          "terminal": "4",
          "sectorStatus": "Confirmed",
          "originAirportName": "Melbourne",
          "destinationAirportName": "Melbourne",
          "operatorAirline": "EK",
          "startCity": "Melbourne",
          "endCity": "Singapore"
        }
      ],
      "customers": {
        "href": "/flights/887124/customers"
      },
      "customerStatuses": {
        "confirmed": 2,
        "tentative": 1
      },
      "customerStatusIds": [
        {
          "status": "tentative",
          "customers": [
            {
              "href": "/context/5057124/customers/4945398"
            },
            {
              "href": "/context/5057124/customers/4945398"
            }
          ]
        },
        {
          "status": "tentative",
          "customers": [
            {
              "href": "/context/5057124/customers/4945398"
            },
            {
              "href": "/context/5057124/customers/4945398"
            }
          ]
        }
      ],
      "currency": "AUD",
      "reloc": "SIN",
      "totalPrice": 150.0,
      "id": 887124,
      "href": "context/contextid/flights/887124",
      "sequence": "202403312359580000"
    }
  ]
}