Retrieve Excursion Bookings
get
/spms/v2/ships/{shipId}/reservations/{reservationId}/bookedExcursions
This API provides the ability to retrieve Excursion reservations that are linked to the guest/passenger cruise booking
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
-
excursionBookingId(optional): number
Excursion booking id
-
excursionCode(optional): string
Excursion Code
-
excursionName(optional): string
Excursion Name
-
postingStatus(optional): string
Posting statusAllowed Values:
[ "all", "posted", "unposted", "onhold" ]
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Booked Excursion Reservation
Type:
object
Title:
Booked Excursion Reservation
Booked Excursion Reservation
Show Source
-
bookedExcursionDetails(optional):
array bookedExcursionDetails
Booked Excursions Detail
-
reservationId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Reservation IdExample:1001
Nested Schema : bookedExcursionDetails
Type:
array
Booked Excursions Detail
Show Source
-
Array of:
object bookedExcursionDetail
Booked Excursion Detail
Example:
[
{
"excursionBookingId":1234,
"excursionName":"DRAGONS CAVES",
"excursionCode":"PMI02",
"excursionDescription":"See the caves with dragons outlook",
"bookingDate":"2009-10-31",
"startTime":"06:59:00.00",
"endTime":"06:59:00.00",
"ticketControlNumber":"EXC01TICKET",
"packageName":"PACSURDO LO",
"ticketPrinted":false,
"bookingComments":"Allergy to nuts",
"netPrice":99.9,
"grossPrice":102.9,
"quantity":3,
"discountPercentage":3,
"discountAmount":51.9,
"totalAmount":90.9,
"prepaidExcursion":true,
"prebookedExcursion":true,
"overnightTour":true,
"payerName":"PAY001 - BA",
"postingStatus":"posted",
"boardcardNumber":"1234567543"
}
]
Nested Schema : bookedExcursionDetail
Type:
object
Booked Excursion Detail
Show Source
-
boardcardNumber(optional):
string
Minimum Length:
1
Maximum Length:50
Boardcard NumberExample:1234567543
-
bookingComments(optional):
string
Minimum Length:
1
Maximum Length:255
Booking CommentsExample:Allergy to nuts
-
bookingDate(optional):
string(ISO 8601)
Booking DateExample:
2009-10-31
-
discountAmount(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Discount AmountExample:51
-
discountPercentage(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Discount PercentageExample:3
-
endTime(optional):
string(ISO 8601)
End TimeExample:
06:59:00.00
-
excursionBookingId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Excursion Booking IdExample:1234
-
excursionCode(optional):
string
Minimum Length:
1
Maximum Length:50
Excursion CodeExample:PMI02
-
excursionDescription(optional):
string
Minimum Length:
1
Maximum Length:2000
Excursion DescriptionExample:See the caves with dragons outlook
-
excursionName(optional):
string
Minimum Length:
1
Maximum Length:255
Excursion NameExample:DRAGONS CAVES
-
grossPrice(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Gross PriceExample:102
-
netPrice(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Net PriceExample:99
-
overnightTour(optional):
boolean
Overnight TourExample:
true
-
packageName(optional):
string
Minimum Length:
1
Maximum Length:50
Excursion Package NameExample:PACSURDO LO
-
payerName(optional):
string
Minimum Length:
1
Maximum Length:50
Payer NameExample:GR Gambino
-
postingStatus(optional):
string
Allowed Values:
[ "posted", "unposted", "onhold" ]
Posting StatusExample:posted
-
prebookedExcursion(optional):
boolean
Excursion PrebookedExample:
true
-
prepaidExcursion(optional):
boolean
Excursion PrepaidExample:
true
-
quantity(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
QuantityExample:3
-
startTime(optional):
string(ISO 8601)
Start TimeExample:
06:59:00.00
-
ticketControlNumber(optional):
string
Minimum Length:
1
Maximum Length:50
Excursion Ticket Control NumberExample:EXC01TICKET
-
ticketPrinted(optional):
boolean
Ticket PrintedExample:
false
-
totalAmount(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Total AmountExample:90
204 Response
No Content
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Bad Request",
"detail":"The parameter \"bookingDateFrom\" has incorrect format"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
401 Response
Unauthorized
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
"title":"Unauthorized",
"detail":"Valid token is required to access this resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
403 Response
Forbidden
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
"title":"Forbidden",
"detail":"Access to this resource was forbidden"
}
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:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
"title":"Not Found",
"detail":"This resource path does not exist"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
405 Response
Method Not Allowed
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
"title":"Method Not Allowed",
"detail":"HTTP method not supported for this resource"
}
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:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
"title":"Not Acceptable",
"detail":"Request a Mime type that is supported for this Resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
500 Response
Internal Server Error
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
"title":"Internal Server Error",
"detail":"Issue fulfilling request. Please retry or contact support"
}
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":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
"title":"Service not available",
"detail":"Service Unavailable. Try again later"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source