Retrieve Flight Booking Details
get
/spms/v2/ships/{shipId}/reservations/{reservationId}/flightAssignments
This is to retrieve the Flight bookings that are linked to a cruise reservation
Request
Supported Media Types
- application/json
Path Parameters
-
reservationId: number
-
shipId: number
Ship Id
Query Parameters
-
Flight Number(optional): string
Flight Number
-
FlightDirectionType(optional): string
Flight Direction TypeAllowed Values:
[ "arrival", "departure", "transfer" ]
-
arrivalAirport(optional): string
Arrival Airport
-
departureAirport(optional): string
Departure Airport
-
flightArrivalDateFrom(optional): string
Flight Arrival Date From
-
flightArrivalDateTo(optional): string
Flight Arrival Booking Date To
-
flightBookingId(optional): number
Flight Booking Id
-
flightDepartureDateFrom(optional): string
Flight Departure Date From
-
flightDepartureDateTo(optional): string
Flight Arrival Date To
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Retrieve Flight Booking Details
Type:
object
Title:
Retrieve Flight Booking Details
Retrieve Flight Booking Details
Show Source
-
flightBookingDetails(optional):
array flightBookingDetails
Flight Booking Details
-
reservationId(optional):
object reservationId
Reservation Id
Nested Schema : flightBookingDetails
Type:
array
Flight Booking Details
Show Source
-
Array of:
object flightBookings
Flight Bookings
Example:
[
{
"flightBookingId":1,
"flightDirection":"Departure",
"flightNumber":"AK007",
"flightCompany":"Air Asia",
"flightArrivalDate":"2009-10-31",
"flightArrivalTime":"06:59:00",
"flightDepartureDate":"2009-11-10",
"flightDepatureTime":"06:59:00",
"departureAirport":"KLIA",
"arrivalAirport":"Changi Airport",
"internationalFlight":true,
"flightSeatNumber":"A01",
"flightClass":"J",
"transferPrice":50,
"passengerNameRecord":"John Smith",
"numberOfBags":2,
"bagLabel":"B1011",
"airlineCheckIn":true
}
]
Nested Schema : reservationId
Type:
object
Reservation Id
Show Source
-
hasManualGuardianAssignment(optional):
boolean(boolean)
This is a value indicate whether this profile has done the manual guardian assignment or not. true - user had perform manual guardian assignment, false - system perform auto guardian assignment based on parameterExample:
true
-
reservationId(optional):
integer(int64)
Reservation IDExample:
12345678
Nested Schema : flightBookings
Type:
object
Flight Bookings
Show Source
-
airlineCheckIn(optional):
boolean
Airline Check InExample:
true
-
arrivalAirport(optional):
string
Minimum Length:
0
Maximum Length:50
Arrival AirportExample:Changi Airport
-
bagLabel(optional):
string
Minimum Length:
0
Maximum Length:50
Bag LabelExample:B1011
-
departureAirport(optional):
string
Minimum Length:
0
Maximum Length:50
Departure AirportExample:KLIA
-
flightArrivalDate(optional):
string(ISO 8601)
Flight Arrival DateExample:
2009-10-31
-
flightArrivalTime(optional):
string(ISO 8601)
Flight Arrival TimeExample:
06:59:00
-
flightBookingId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Flight Booking IdExample:1001
-
flightClass(optional):
string
Minimum Length:
0
Maximum Length:50
Flight ClassExample:J
-
flightCompany(optional):
string
Minimum Length:
0
Maximum Length:50
Flight CompanyExample:Air Asia
-
flightDepartureDate(optional):
string(ISO 8601)
flight Departure DateExample:
2009-11-10
-
flightDepatureTime(optional):
string(ISO 8601)
Flight Departure TimeExample:
06:59:00
-
flightDirection(optional):
string
Allowed Values:
[ "arrival", "departure", "transfer" ]
Flight DirectionExample:arrival
-
flightNumber(optional):
string
Minimum Length:
0
Maximum Length:20
Flight NumberExample:AK007
-
flightSeatNumber(optional):
string
Minimum Length:
0
Maximum Length:50
AirportExample:Flight Seat Number
-
internationalFlight(optional):
boolean
International FlightExample:
true
-
numberOfBags(optional):
number
Minimum Value:
0
Number of bagsExample:2
-
passengerNameRecord(optional):
string
Minimum Length:
0
Maximum Length:50
Passenger Name RecordExample:John Smith
-
transferPrice(optional):
number
Minimum Value:
0
Pattern:^[0-9]*$
Transfer PriceExample:50
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"title":"Bad Request",
"detail":"The parameter flightArrivalDateTo has incorrect format",
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
401 Response
You are not authorized to use this API
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"title":"Unauthorized",
"detail":"Valid token is required to access this resource",
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
403 Response
You are forbidden to use this API
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"title":"Forbidden",
"detail":"Access to this resource is forbidden",
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
404 Response
Not Found
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"title":"Not Found",
"detail":"Event ticket details not found.",
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
405 Response
This method is not available
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"title":"Method Not Supported",
"detail":"HTTP method not supported for this resource",
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
406 Response
Not Acceptable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"title":"Not Acceptable",
"detail":"Request a Mime type that is supported for this Resource",
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
500 Response
Error occured while processing this request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"title":"Internal Server Error",
"details":"Issue fulfilling request. Please retry or contact support",
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
503 Response
Service Unavailable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
"title":"Service Unavailable",
"detail":"Service Unavailable. Try again later"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source