Flight Services¶
A FlightService cannot yet be booked via the API and has no underlying product.
XML Schema:
GET: Get a Flight Service
Fields
Name |
Type |
Description |
---|---|---|
id read-only |
String |
|
href read-only |
Field |
|
name read-only |
String |
The name of this service. |
status |
String |
The current status of the service:
Active service status transitions:
|
status_transitions read-only |
List |
A list of status values to which this service can transition. |
type read-only |
String |
The type of this resource. |
sub_type read-only |
String |
A brief description of this service type. |
start_date read-only |
Date |
The start date of this service. |
finish_date read-only |
Date |
The finish date of this service. |
customers |
Field |
|
|
String |
|
|
Field |
|
|
Nested Object |
|
|
String |
Legal first name as it appears on a passport. |
|
String |
Legal middle name as it appears on a passport. |
|
String |
Legal last name as it appears on a passport. |
|
String |
The name this person likes to be called if different from their legal name. |
|
String |
The title. Valid values are: Mr, Mrs, Ms, and Miss |
date_created read-only |
Datetime |
The date/time this service was created, in the standard Dates & Times. |
date_confirmed read-only |
Datetime |
The date/time this service had its service status set to Confirmed, in the standard Dates & Times. |
date_cancelled read-only |
Datetime |
The date/time this service had its service status set to Cancelled, in the standard Dates & Times. |
option_expiry_date read-only |
Datetime |
The date/time when an Option service status will automatically be set to Expired, in the standard Dates & Times. |
purchase_price read-only |
Decimal |
The currency-specific purchase price this service was Confirmed at, in the standard Currencies & Prices. The price reflected includes any promotions applied. The price is not locked until the service has its service status set to Confirmed (i.e. the price could change when the service status is on Option). |
applied_promotion |
Nested Object |
|
|
String |
|
|
Field |
|
|
String |
The name of the promotion used. |
|
String |
A unique code for this promotion. |
|
Decimal |
The currency-specific amount that has been discounted from the purchase_price. Add the discount_amount and purchase_price to see the original non-discounted price. |
|
Integer |
The commission rate for this promotion. |
|
String |
|
flags read-only |
List |
A list of codes that, when present, require special considerations for a booked service. The list of departure service flags related to the current status of a request to hike the Inca Trail, or the option booked for services on these special departures: Service Status Flags
Inca Trail Flags
|
booking read-only |
Reference Object |
|
documents read-only |
Field |
|
|
String |
|
|
Field |
|
|
Datetime |
The time when the resource was created, in the standard Dates & Times. |
|
String |
The document type, currently: INVOICE, ATOL_CERTIFICATE, VOUCHER. |
|
String |
The intended audience of this document. Either |
|
Reference Object |
The related booking resource. |
|
String |
The Internet media type. |
declined_reason read-only |
Reference Object |
The related declined reason resource. |
record_locator required |
String |
The record locator for this flight service. |
itinerary_url required |
String |
A link to detailed information about the flight itinerary. |
segments required |
Field |
|
|
String |
|
|
Field |
|
|
String |
Record Locator for this specific segment |
|
String |
The flight number of the segment. |
|
String |
A brief description of the airfare booking class. |
|
Datetime |
The local departure date/tiome of the segment. |
|
Datetime |
The local arrival date/time of the segment. |
|
Nested Object |
The airline for this segment. |
|
String |
The airline code for this segment, using the standard airline code. |
|
String |
The airline name for this segment. |
|
Nested Object |
The departure airport for this segment. |
|
String |
The departure airport code, using the standard International Air Transport Association (IATA) airport codes. |
|
String |
The departure airport name. |
|
Nested Object |
The arrival airport for this segment. |
|
String |
The departure airport code, using the standard International Air Transport Association (IATA) airport codes. |
|
String |
The departure airport name. |
|
Field |
Each segment represents a portion of an airfare itinerary, usually a flight between two cities. |
|
Datetime |
The local departure date/time of the segment, in the standard Dates & Times. |
|
Datetime |
The local arriva date/time of the segment, in the standard Dates & Times. |
|
String |
The model number of the airplane used. |
|
Nested Object |
The departure airport for this segment. |
|
String |
The departure airport code, using the standard International Air Transport Association (IATA) airport codes. |
|
String |
The departure airport name. |
|
Nested Object |
The arrival airport for this segment. |
|
String |
The departure airport code, using the standard International Air Transport Association (IATA) airport codes. |
|
String |
The departure airport name. |
associated_services required |
List |
|
flight_status read-only |
Reference Object |
Get a Flight Service¶
- GET /flight_services/(string: service_id)/¶
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"applied_promotion": null,
"booking": {
"href": "https://rest.gadventures.com/bookings/123456",
"id": "123456"
},
"commission": null,
"customers": [
{
"href": "https://rest.gadventures.com/customers/123",
"id": "123",
"name": {
"common_name": null,
"legal_first_name": "Diego",
"legal_last_name": "Maradona",
"legal_middle_name": "",
"title": "Mr"
}
}
],
"date_cancelled": null,
"date_confirmed": "2014-11-12T05:00:00Z",
"date_created": "2014-11-12T05:00:00Z",
"documents": [],
"finish_date": "2014-12-13",
"flags": [],
"href": "https://rest.gadventures.com/flight_services/f81604",
"id": "f81604",
"itinerary_url": "https://www.checkmytrip.com/cmtservlet?R=ABC123&L=GB&N=Maradona",
"name": "Miami to Bangkok",
"option_expiry_date": null,
"purchase_price": "1470.40",
"record_locator": "ABC123",
"segments": [
{
"airline": {
"code": "AA",
"name": "American Airlines"
},
"arrival_date": "2014-11-12T16:15:00",
"booking_class": "N",
"departure_date": "2014-11-11T07:15:00",
"destination_airport": {
"code": "NRT",
"name": "Tokyo Airport (Narita International Airport)"
},
"flight_number": "61",
"origin_airport": {
"code": "MIA",
"name": "Miami Airport"
},
"technical_stops": [
{
"arrival_date": "2014-11-11T09:34:00",
"departure_date": "2014-11-11T07:15:00",
"destination_airport": {
"code": "DFW",
"name": "Dallas Airport"
},
"equipment": "32B",
"origin_airport": {
"code": "MIA",
"name": "Miami Airport"
}
},
{
"arrival_date": "2014-11-12T16:15:00",
"departure_date": "2014-11-11T11:25:00",
"destination_airport": {
"code": "NRT",
"name": "Tokyo Airport (Narita International Airport)"
},
"equipment": "777",
"origin_airport": {
"code": "DFW",
"name": "Dallas Airport"
}
}
]
},
{
"airline": {
"code": "AA",
"name": "American Airlines"
},
"arrival_date": "2014-11-12T23:15:00",
"booking_class": "S",
"departure_date": "2014-11-12T18:05:00",
"destination_airport": {
"code": "BKK",
"name": "Bangkok Airport"
},
"flight_number": "8411",
"origin_airport": {
"code": "NRT",
"name": "Tokyo Airport (Narita International Airport)"
},
"technical_stops": []
},
{
"airline": {
"code": "AA",
"name": "American Airlines"
},
"arrival_date": "2014-12-13T16:05:00",
"booking_class": "Q",
"departure_date": "2014-12-13T08:15:00",
"destination_airport": {
"code": "NRT",
"name": "Tokyo Airport (Narita International Airport)"
},
"flight_number": "8412",
"origin_airport": {
"code": "BKK",
"name": "Bangkok Airport"
},
"technical_stops": []
},
{
"airline": {
"code": "AA",
"name": "American Airlines"
},
"arrival_date": "2014-12-13T10:10:00",
"booking_class": "Q",
"departure_date": "2014-12-13T17:05:00",
"destination_airport": {
"code": "LAX",
"name": "Los Angeles Airport"
},
"flight_number": "170",
"origin_airport": {
"code": "NRT",
"name": "Tokyo Airport (Narita International Airport)"
},
"technical_stops": []
},
{
"airline": {
"code": "AA",
"name": "American Airlines"
},
"arrival_date": "2014-12-13T20:35:00",
"booking_class": "V",
"departure_date": "2014-12-13T12:50:00",
"destination_airport": {
"code": "MIA",
"name": "Miami Airport"
},
"flight_number": "124",
"origin_airport": {
"code": "LAX",
"name": "Los Angeles Airport"
},
"technical_stops": []
}
]
}