1. Oracle Hospitality Cruise REST API
  2. Tasks
  3. Reservations
  4. Booked Excursion Details

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
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Booked Excursion Reservation
Type: object
Title: Booked Excursion Reservation
Booked Excursion Reservation
Show Source
Nested Schema : bookedExcursionDetails
Type: array
Booked Excursions Detail
Show Source
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

204 Response

No Content

400 Response

Bad Request
Body ()
Root Schema : schema
Match All
Show Source
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
Body ()
Root Schema : schema
Match All
Show Source
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
Body ()
Root Schema : schema
Match All
Show Source
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
Body ()
Root Schema : schema
Match All
Show Source
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
Body ()
Root Schema : schema
Match All
Show Source
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
Body ()
Root Schema : schema
Match All
Show Source
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
Body ()
Root Schema : schema
Match All
Show Source
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
Body ()
Root Schema : schema
Match All
Show Source
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
Back to Top