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

Update a bookable tour details

put

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

This is to update a bookable tour details

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : Update bookable tours setup common
Type: object
Title: Update bookable tours setup common
Show Source
Nested Schema : capacity
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
    Example: 2021-10-18
  • Minimum Length: 0
    Maximum Length: 20
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
    External Id
    Example: E12345
  • Is Bookable Tour Overnight Tour
    Example: true
  • Show on the first page in Bookings screen instead of sorting alphabetically
    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 : 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 : pricing
Type: object
Show Source
Nested Schema : promotion
Type: object
Show Source
Nested Schema : time
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Bookable Tour Details
Type: object
Title: Bookable Tour Details
Retrieve Bookable Tour Details
Show Source
Nested Schema : capacity
Type: object
Show Source
Nested Schema : details
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 : time
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