1. Oracle Hospitality Cruise REST API
  2. Tasks
  3. Excursions
  4. Bookable Tours

Retrieve a list of bookable tours

get

/spms/v2/ships/{shipId}/configurations/excursions/bookableTours

This is to retrieve a list of bookable tours

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : List of bookable tours
Type: object
Title: List of bookable tours
List of bookable tours
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : ExcursionBookableTourSetupReturnSearchData
Type: object
data return
Show Source
Nested Schema : Bookable Tours
Type: object
Title: Bookable Tours
Retrieve bookable tours
Show Source
Nested Schema : additionalInfo
Type: object
Show Source
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Label 1
    Example: comment1
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Label 10
    Example: comment10
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Label 2
    Example: comment2
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Label 3
    Example: comment3
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Label 4
    Example: comment4
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Label 5
    Example: comment5
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Label 6
    Example: comment6
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Label 7
    Example: comment7
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Label 8
    Example: comment8
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Label 9
    Example: comment9
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Value 1
    Example: value1
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Value 10
    Example: value10
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Value 2
    Example: value2
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Value 3
    Example: value3
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Value 4
    Example: value4
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Value 5
    Example: value5
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Value 6
    Example: value6
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Value 7
    Example: value7
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Value 8
    Example: value8
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Custom Comments Value 9
    Example: value9
Nested Schema : capacity
Type: object
Show Source
Nested Schema : costs
Type: object
Show Source
Nested Schema : details
Type: object
Show Source
Nested Schema : interfaces
Type: object
Show Source
Nested Schema : linking
Type: object
Show Source
Nested Schema : pricing
Type: object
Show Source
Nested Schema : promotion
Type: object
Show Source
Nested Schema : setup
Type: object
Show Source
Nested Schema : time
Type: object
Show Source
Nested Schema : vendors
Type: array
Show Source
Nested Schema : fixedCosts
Type: array
Show Source
Nested Schema : getCostsResponse
Type: object
Show Source
Nested Schema : interactiveTV
Type: object
Show Source
  • This is to indicate enable child booking in Interactive TV (default value is based on parameter 'disableFCUIAndKioskBookingOptions', if the parameter value is null then the default value will set to true)
    Example: true
  • This is to indicate excursion is bookable in External Interactive TV System (default value is based on parameter 'disableFCUIAndKioskBookingOptions', if the parameter value is null then the default value will set to true)
    Example: true
  • This is to indicate to show excursion in Interactive TV (default value is based on parameter 'disableFCUIAndKioskBookingOptions', if the parameter value is null then the default value will set to true)
    Example: true
Nested Schema : kiosk
Type: object
Show Source
Nested Schema : printing
Type: object
Show Source
Nested Schema : sales
Type: object
Show Source
Nested Schema : transferTour
Type: object
Show Source
Nested Schema : salesPosting
Type: object
Show Source
Nested Schema : salesTaxAndFees
Type: object
Show Source
Nested Schema : vatReportingSplit
Type: object
Show Source
Nested Schema : getVendorResponse
Type: object
Show Source
Nested Schema : linksBookableTour
Type: object
links detail
Show Source

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.2",
    "title":"Bad Request",
    "detail":"Empty request body."
}
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
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

You are forbidden to use this API
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

405 Response

This method is not available
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

415 Response

The media supplied is not supported
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "title":"Invalid content",
    "detail":"Content type not supported",
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

500 Response

Error occurred while processing this request
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"https://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 not available
Body ()
Root Schema : schema
Match All
Show Source
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
Back to Top