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

Create a new bookable tour

post

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

This is to create a new bookable tour

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : Create new bookable tours
Type: object
Title: Create new bookable tours
Show Source
Nested Schema : additionalInfo
Type: object
Show Source
  • Minimum Length: 0
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 1
    Example: Wonderful view
  • Minimum Length: 0
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 10
    Example: Superb
  • Minimum Length: 0
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 2
    Example: Nice
  • Minimum Length: 0
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 3
    Example: Beautiful
  • Minimum Length: 0
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 4
    Example: Relaxing
  • Minimum Length: 0
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 5
    Example: Lovely
  • Minimum Length: 0
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 6
    Example: Pleasing
  • Minimum Length: 0
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 7
    Example: Marvelous
  • Minimum Length: 0
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 8
    Example: Amazing
  • Minimum Length: 0
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 9
    Example: Awesome
Nested Schema : capacity
Type: object
Show Source
Nested Schema : costs
Type: object
Show Source
Nested Schema : details
Type: object
Show Source
  • Minimum Length: 0
    Maximum Length: 40
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Brochure Number
    Example: 56680
  • Minimum Length: 0
    Maximum Length: 20
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Code
    Example: FAN_TH
  • Minimum Length: 0
    Maximum Length: 2000
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Comments
    Example: COMMENTS
  • Minimum Length: 0
    Maximum Length: 6
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Country Code
    Example: AS
  • Minimum Value: 0
    Maximum Value: 100000000000000000000000000000000000000
    Cruise Day Id
    Example: 1
  • Minimum Value: 0
    Maximum Value: 100000000000000000000000000000000000000
    Cruise Id
    Example: 1
  • Bookable Tour Date. ISO:8601: Date format is YYYY-MM-DD
    Example: 2021-10-18
  • Minimum Length: 0
    Maximum Length: 20
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    External Id
    Example: E12345
  • This is to indicate the tour is an overnight tour or not an overnight tour. (default value: false)
    Example: true
  • This is to indicate to show on the first page in Bookings screen instead of sorting alphabetically (default value: false)
    Example: true
  • Minimum Length: 0
    Maximum Length: 100
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Name
    Example: Fantasia Tour
  • Minimum Length: 0
    Maximum Length: 40
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Port Code
    Example: ATSEA
  • Minimum Length: 0
    Maximum Length: 6
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Predefined Comments
    Example: ID
  • Minimum Length: 0
    Maximum Length: 6
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Predefined Required Clothes
    Example: EXTRA
  • Minimum Length: 0
    Maximum Length: 100
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Required Clothes
    Example: Casual Wear
Nested Schema : groupLinkings
Type: array
Show Source
Nested Schema : interfaces
Type: object
Show Source
Nested Schema : linking
Type: object
Show Source
  • Minimum Length: 0
    Maximum Length: 75
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Tour Categories
    Example: T-CAT1,T-CAT2,
  • Minimum Length: 0
    Maximum Length: 100
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Tour Language
    Example: EN
  • Minimum Length: 0
    Maximum Length: 100
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Tour Reporting Categories
    Example: CITYTO,CULTHI,
  • Minimum Length: 0
    Maximum Length: 100
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Tour Reporting Difficulty Levels
    Example: EASY
  • Minimum Length: 0
    Maximum Length: 100
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Tour Reporting Tags
    Example: 01,05,
  • Minimum Length: 0
    Maximum Length: 6
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Tour Transportation Sharing Group Code
    Example: BUS
Nested Schema : packageLinkings
Type: array
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 : variableCosts
Type: array
Show Source
Nested Schema : fixedCostsRequest
Type: object
Show Source
Nested Schema : variableCostsRequest
Type: object
Show Source
Nested Schema : groupLinkingRequest
Type: object
Show Source
  • Minimum Value: 1
    Maximum Value: 999999999
    Group Account Reference (Only accept group with a reservation status that is either reservation, embark today, no show, checked in or leaving today)
    Example: 1234567
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 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
  • This is to indicate enable child boooking in OHC Kiosk (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 OHC Kiosk (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 to show in OHC Kiosk (default value is based on parameter 'disableFCUIAndKioskBookingOptions', if the parameter value is null then the default value will set to true)
    Example: true
  • Minimum Length: 0
    Maximum Length: 50
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Kiosk Default Audio File Id
    Example: 160000002481
  • Minimum Length: 0
    Maximum Length: 500
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Kiosk Default Html File Id
    Example: 160000002482
  • Minimum Value: 0
    Maximum Value: 100000000000000000000000000000000000000
    Bookable Tour Kiosk Default Picture File Id
    Example: 160000001221
  • Minimum Length: 0
    Maximum Length: 50
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Kiosk Default Video File Id
    Example: 160000002480
Nested Schema : printing
Type: object
Show Source
  • Minimum Length: 0
    Maximum Length: 20
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Default Ticket Report
    Example: EXC01TICKET
  • This is to indicate switch to enable / disable e-Invoice printing for specific Tours (default value: true)
    Example: true
  • This is to indicate a switch to enable/disable Ticket Printing for each Tour (default value: true)
    Example: true
  • This is to indicate print Tour Ticket Summary indicator (default value: true)
    Example: true
Nested Schema : packageLinkingRequest
Type: object
Show Source
Nested Schema : sales
Type: object
Show Source
Nested Schema : transferTour
Type: object
Show Source
  • This is to indicate to transfer tour or not to. (default value: false)
    Example: true
  • Minimum Length: 0
    Maximum Length: 6
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Transfer To Location Code
    Example: TTL01
  • Minimum Length: 0
    Maximum Length: 40
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Transfer From Location Description
    Example: FOR DINNER
  • Minimum Length: 0
    Maximum Length: 6
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Transfer To Location Code
    Example: TTL02
  • Minimum Length: 0
    Maximum Length: 40
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Bookable Tour Transfer To Location Description
    Example: NIGHT MARKET
Nested Schema : salesPosting
Type: object
Show Source
Nested Schema : salesTaxAndFees
Type: object
Show Source
Nested Schema : vatPostingSplit
Type: array
Show Source
Nested Schema : vatReportingSplit
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : vendorRequest
Type: object
Show Source
Back to Top

Response

Supported Media Types

201 Response

Created
Body ()
Root Schema : Bookable Tour Setup Response
Type: object
Title: Bookable Tour Setup Response
Retrieve Bookable Tour Setup
Show Source
Nested Schema : additionalInfo
Type: object
Show Source
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 1
    Example: Wonderful view
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 10
    Example: Superb
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 2
    Example: Nice
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 3
    Example: Beautiful
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 4
    Example: Relaxing
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 5
    Example: Lovely
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 6
    Example: Pleasing
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 7
    Example: Marvelous
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 8
    Example: Amazing
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    Comment for bookable tour custom comments 9
    Example: Awesome
Nested Schema : capacity
Type: object
Show Source
Nested Schema : costs
Type: object
Show Source
Nested Schema : details
Type: object
Show Source
Nested Schema : groupLinkings
Type: array
Show Source
Nested Schema : interfaces
Type: object
Show Source
Nested Schema : linking
Type: object
Show Source
Nested Schema : packageLinkings
Type: array
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 : variableCosts
Type: array
Show Source
Nested Schema : costsResponse
Type: object
Show Source
Nested Schema : variableCostsResponse
Type: object
Show Source
Nested Schema : groupLinkingResponse
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 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
  • This is to indicate enable child boooking in OHC Kiosk (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 OHC Kiosk (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 to show in OHC Kiosk (default value is based on parameter 'disableFCUIAndKioskBookingOptions', if the parameter value is null then the default value will set to true)
    Example: true
  • Bookable Tour Kiosk Default Audio File Id
    Example: 160000002481
  • Bookable Tour Kiosk Default Html File Id
    Example: 160000002482
  • Bookable Tour Kiosk Default Picture File Id
    Example: 160000001221
  • Bookable Tour Kiosk Default Video File Id
    Example: 160000002480
Nested Schema : printing
Type: object
Show Source
Nested Schema : packageLinkingResponse
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 : vatPostingSplit
Type: array
Show Source
Nested Schema : vatReportingSplit
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : vendorResponse
Type: object
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.1",
    "title":"Bad Request",
    "detail":[
        {
            "errorPath":"date",
            "message":"must not be null"
        }
    ]
}
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":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource is 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":"Ship Id could not be found"
}
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 Supported",
    "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":"System not allows officers to schedule a tour before the current date"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

409 Response

Conflict
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
    "title":"Conflict",
    "detail":"This Bookable Tour Code is already in use on the specified Date."
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

415 Response

Unsupported Media Type
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Invalid content",
    "detail":"Content type Not supported"
}
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":"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