Retrieve event ticketing booking by reservation Id
get
/spms/v2/ships/{shipId}/reservations/{reservationId}/bookedEventTicketing
This is to retrieve the Event Ticketing booking that are linked to a Cruise reservation Id
Request
Supported Media Types
- application/json
Path Parameters
-
reservationId: number
-
shipId: number
Ship Id
Query Parameters
-
bookingDateFrom(optional): string
Booking Date From
-
bookingDateTo(optional): string
Booking Date To
-
bookingStatus(optional): string
Booking StatusAllowed Values:
[ "check in", "expected" ]
-
eventTicketBookingId(optional): number
Event Ticket Booking Id
-
eventTicketName(optional): string
Event Ticket Name
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Event Ticketings
Type:
object
Title:
Event Ticketings
Event Ticketings
Show Source
-
eventTicketBookingDetails(optional):
array eventTicketBookingDetails
Event Tickets Booking Details
-
reservationId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Reservation IdExample:1001
Nested Schema : eventTicketBookingDetails
Type:
array
Event Tickets Booking Details
Show Source
-
Array of:
object eventTicketBookings
Event Ticket Bookings
Example:
[
{
"eventTicketBookingId":1,
"bookableEvent":{
"id":1,
"code":"MV01",
"eventTicketingName":"Movie - Transformer",
"description":"Transformer"
},
"bookingDate":"2009-10-31",
"bookingTime":"06:59:00",
"bookingStatus":"Expected",
"postingStatus":"Posted",
"seatingPriceCategory":{
"id":1,
"priceCategory":"Price Category 1"
},
"seatingZone":{
"id":1,
"seatCode":"SZ1",
"zone":"Zone"
},
"netPrice":9,
"grossPrice":10,
"quantity":1,
"discountPercentage":10,
"refundAmount":0,
"totalAmount":9
}
]
Nested Schema : eventTicketBookings
Type:
object
Event Ticket Bookings
Show Source
-
bookableEvent(optional):
object bookableEvent
Bookable Event
-
bookedDate(optional):
string(ISO 8601)
Booking DateExample:
2009-10-31
-
bookedTime(optional):
string(ISO 8601)
Booking TimeExample:
06:59:00
-
bookingStatus(optional):
string
Allowed Values:
[ "in house", "finished", "expected" ]
Booking StatusExample:in house
-
discountPercentage(optional):
number
Discount PercentageExample:
50
-
eventTicketBookingId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Event Ticket Booking IdExample:1001
-
grossPrice(optional):
number
Gross PriceExample:
50
-
netPrice(optional):
number
Net PriceExample:
50
-
postingStatus(optional):
string
Allowed Values:
[ "posted", "unposted" ]
Posting StatusExample:posted
-
quantity(optional):
number
QuantityExample:
50
-
refundAmount(optional):
number
Refund AmountExample:
50
-
seatCode(optional):
string
Minimum Length:
1
Maximum Length:20
Seat CodeExample:SZ1
-
seatingPriceCategory(optional):
object seatingPriceCategory
Seating Price Category
-
seatingZone(optional):
object seatingZone
Seating Zone
-
totalAmount(optional):
number
Total Amount (If posting status is Posted, the total amoumt is the actual charged amount. If posting status is Unposted, the total amount is the gross amount.Example:
50
Nested Schema : bookableEvent
Type:
object
Bookable Event
Show Source
-
code(optional):
string
Minimum Length:
1
Maximum Length:20
Bookable Event CodeExample:MV01
-
description(optional):
string
Minimum Length:
1
Maximum Length:50
Bookable Event DescriptionExample:Transformer
-
eventTicketingName(optional):
string
Minimum Length:
1
Maximum Length:50
Bookable Event NameExample:Movie - Transformer
-
id(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Event Ticket Booking IdExample:1001
Nested Schema : seatingPriceCategory
Type:
object
Seating Price Category
Show Source
-
code(optional):
string
Minimum Length:
1
Maximum Length:1000
Price CategoryExample:Price Category 1
-
id(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Price Category IdExample:1001
Nested Schema : seatingZone
Type:
object
Seating Zone
Show Source
-
code(optional):
string
Minimum Length:
1
Maximum Length:20
Seat CodeExample:SZ1
-
id(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Zone IdExample:1001
-
zone(optional):
string
Minimum Length:
1
Maximum Length:50
Seating ZoneExample:Zone
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":"Invalid Booking Status.",
"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