Jump to

• Request
• Response

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(required): number
• shipId(required): number
  Ship Id

Query Parameters

• Flight Number: string
  Flight Number
• FlightDirectionType: string
  Flight Direction Type

  Allowed Values: [ "arrival", "departure", "transfer" ]
• arrivalAirport: string
  Arrival Airport
• departureAirport: string
  Departure Airport
• flightArrivalDateFrom: string
  Flight Arrival Date From
• flightArrivalDateTo: string
  Flight Arrival Booking Date To
• flightBookingId: number
  Flight Booking Id
• flightDepartureDateFrom: string
  Flight Departure Date From
• flightDepartureDateTo: string
  Flight Arrival Date To

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Retrieve Flight Booking Details

Type: object

Title: Retrieve Flight Booking Details

Retrieve Flight Booking Details

Show Source

• flightBookingDetails: array flightBookingDetails
  Flight Booking Details
• reservationId: number
  Minimum Length: 1

  Pattern: ^[0-9]*$

  Reservation Id

  Example: 1001

{
    "title":"Retrieve Flight Booking Details",
    "description":"Retrieve Flight Booking Details",
    "type":"object",
    "properties":{
        "reservationId":{
            "$ref":"#/definitions/reservationId"
        },
        "flightBookingDetails":{
            "$ref":"#/definitions/flightBookingDetails"
        }
    }
}

Nested Schema : flightBookingDetails

Type: array

Flight Booking Details

Show Source

• Array of: object flightBookings
  Flight Bookings

{
    "description":"Flight Booking Details",
    "type":"array",
    "items":{
        "$ref":"#/definitions/flightBookings"
    },
    "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
        }
    ]
}

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 : flightBookings

Type: object

Flight Bookings

Show Source

• airlineCheckIn: boolean
  Airline Check In

  Example: true
• arrivalAirport: string
  Minimum Length: 0

  Maximum Length: 50

  Arrival Airport

  Example: Changi Airport
• bagLabel: string
  Minimum Length: 0

  Maximum Length: 50

  Bag Label

  Example: B1011
• departureAirport: string
  Minimum Length: 0

  Maximum Length: 50

  Departure Airport

  Example: KLIA
• flightArrivalDate: string(ISO 8601)
  Flight Arrival Date

  Example: 2009-10-31
• flightArrivalTime: string(ISO 8601)
  Flight Arrival Time

  Example: 06:59:00
• flightBookingId: number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Flight Booking Id

  Example: 1001
• flightClass: string
  Minimum Length: 0

  Maximum Length: 50

  Flight Class

  Example: J
• flightCompany: string
  Minimum Length: 0

  Maximum Length: 50

  Flight Company

  Example: Air Asia
• flightDepartureDate: string(ISO 8601)
  flight Departure Date

  Example: 2009-11-10
• flightDepatureTime: string(ISO 8601)
  Flight Departure Time

  Example: 06:59:00
• flightDirection: string
  Allowed Values: [ "arrival", "departure", "transfer" ]

  Flight Direction

  Example: arrival
• flightNumber: string
  Minimum Length: 0

  Maximum Length: 20

  Flight Number

  Example: AK007
• flightSeatNumber: string
  Minimum Length: 0

  Maximum Length: 50

  Airport

  Example: Flight Seat Number
• internationalFlight: boolean
  International Flight

  Example: true
• numberOfBags: number
  Minimum Value: 0

  Number of bags

  Example: 2
• passengerNameRecord: string
  Minimum Length: 0

  Maximum Length: 50

  Passenger Name Record

  Example: John Smith
• transferPrice: number
  Minimum Value: 0

  Pattern: ^[0-9]*$

  Transfer Price

  Example: 50

{
    "description":"Flight Bookings",
    "type":"object",
    "properties":{
        "flightBookingId":{
            "$ref":"#/definitions/flightBookingId"
        },
        "flightDirection":{
            "$ref":"#/definitions/flightDirection"
        },
        "flightNumber":{
            "$ref":"#/definitions/flightNumber"
        },
        "flightCompany":{
            "$ref":"#/definitions/flightCompany"
        },
        "flightArrivalDate":{
            "$ref":"#/definitions/flightArrivalDate"
        },
        "flightArrivalTime":{
            "$ref":"#/definitions/flightArrivalTime"
        },
        "flightDepartureDate":{
            "$ref":"#/definitions/flightDepartureDate"
        },
        "flightDepatureTime":{
            "$ref":"#/definitions/flightDepatureTime"
        },
        "departureAirport":{
            "$ref":"#/definitions/departureAirport"
        },
        "arrivalAirport":{
            "$ref":"#/definitions/arrivalAirport"
        },
        "internationalFlight":{
            "$ref":"#/definitions/internationalFlight"
        },
        "flightSeatNumber":{
            "$ref":"#/definitions/flightSeatNumber"
        },
        "flightClass":{
            "$ref":"#/definitions/flightClass"
        },
        "transferPrice":{
            "$ref":"#/definitions/transferPrice"
        },
        "passengerNameRecord":{
            "$ref":"#/definitions/passengerNameRecord"
        },
        "numberOfBags":{
            "$ref":"#/definitions/numberOfBags"
        },
        "bagLabel":{
            "$ref":"#/definitions/bagLabel"
        },
        "airlineCheckIn":{
            "$ref":"#/definitions/airlineCheckIn"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/FlightAssignmentErrorResponse"
        }
    ],
    "example":{
        "title":"Bad Request",
        "detail":"The parameter flightArrivalDateTo has incorrect format",
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

401 Response

You are not authorized to use this API

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/FlightAssignmentErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

You are forbidden to use this API

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/FlightAssignmentErrorResponse"
        }
    ],
    "example":{
        "title":"Forbidden",
        "detail":"Access to this resource is forbidden",
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/FlightAssignmentErrorResponse"
        }
    ],
    "example":{
        "title":"Not Found",
        "detail":"Event ticket details not found.",
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

This method is not available

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/FlightAssignmentErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

406 Response

Not Acceptable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/FlightAssignmentErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

500 Response

Error occured while processing this request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/FlightAssignmentErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/FlightAssignmentErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable.  Try again later"
    }
}

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

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top