Update bookable tour general settings
put
/spms/v2/ships/{shipId}/configurations/excursions/general
This is to update the bookable tour's general settings
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: integer
ship Id
Required to update bookable tour setup
Root Schema : Update Bookable Tour General Settings
Type:
object
Title:
Show Source
Update Bookable Tour General Settings
Nested Schema : bookableTourSetup
Type:
Show Source
object
-
allowTourAssignmentToSystemCruise(optional):
boolean
Parameter Value (default value: false)Example:
true
-
autoPopulateCancelationFeesInfo(optional):
boolean
Parameter Value (default value: false)Example:
true
-
defaultCancelFeesDebitDept(optional):
string
Minimum Length:
0
Maximum Length:2000
Pattern:^[ A-Za-z0-9,'_@./#&+-]*$
Parameter value (no default value)Example:8001
-
defaultCancelFeesValue(optional):
string
Parameter ValueExample:
75
-
defaultCancelVoidDept(optional):
string
Minimum Length:
0
Maximum Length:2000
Pattern:^[ A-Za-z0-9,'_@./#&+-]*$
Parameter value (no default value)Example:8001
-
defaultPostingDepartment(optional):
string
Minimum Length:
0
Maximum Length:2000
Pattern:^[ A-Za-z0-9,'_@./#&+-]*$
Parameter value (no default value)Example:8001
-
defaultPostingDepartmentForFCUI(optional):
string
Minimum Length:
0
Maximum Length:2000
Pattern:^[ A-Za-z0-9,'_@./#&+-]*$
Parameter value (no default value)Example:8001
-
defaultPostingDepartmentForKiosk(optional):
string
Minimum Length:
0
Maximum Length:2000
Pattern:^[ A-Za-z0-9,'_@./#&+-]*$
Parameter value (no default value)Example:8001
-
defaultPostingDepartmentForPrepaid(optional):
string
Minimum Length:
0
Maximum Length:2000
Pattern:^[ A-Za-z0-9,'_@./#&+-]*$
Parameter value (no default value)Example:8001
-
defaultTicketReport(optional):
string
Minimum Length:
0
Maximum Length:2000
Pattern:^[ A-Za-z0-9,'_@./#&+-]*$
Parameter Value (default value: EXC01TICKET)Example:EXC01TICKET
-
disableFCUIAndKioskBookingOptions(optional):
boolean
Parameter Value (default value: false)Example:
true
-
enableTimeFields24HourFormat(optional):
boolean
Parameter Value (default value: true)Example:
true
-
totalTourSetupLimitPerDay(optional):
integer
Parameter Value (default value: 0; 0 indicated as unlimited)Example:
99
-
useAdultOrChildMaxCounts(optional):
boolean
Parameter Value (default value: false)Example:
true
-
useFreeTextPortEntry(optional):
boolean
Parameter Value (default value: false)Example:
true
-
useFreeTextTourCommentsOrRecommendedClothes(optional):
boolean
Parameter Value (default value: false)Example:
true
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Bookable Tour General Settings
Type:
object
Title:
Bookable Tour General Settings
Bookable Tour General Settings
Show Source
-
allowTourAssignmentToSystemCruise(optional):
object allowTourAssignmentToSystemCruise
-
autoPopulateCancelationFeesInfo(optional):
object autoPopulateCancelationFeesInfo
-
defaultCancelFeesDebitDept(optional):
object defaultCancelFeesDebitDept
-
defaultCancelFeesValue(optional):
object defaultCancelFeesValue
-
defaultCancelVoidDept(optional):
object defaultCancelVoidDept
-
defaultPostingDepartment(optional):
object defaultPostingDepartment
-
defaultPostingDepartmentForFCUI(optional):
object defaultPostingDepartmentForFCUI
-
defaultPostingDepartmentForKiosk(optional):
object defaultPostingDepartmentForKiosk
-
defaultPostingDepartmentForPrepaid(optional):
object defaultPostingDepartmentForPrepaid
-
defaultTicketReport(optional):
object defaultTicketReport
-
disableFCUIAndKioskBookingOptions(optional):
object disableFCUIAndKioskBookingOptions
-
enableTimeFields24HourFormat(optional):
object enableTimeFields24HourFormat
-
totalTourSetupLimitPerDay(optional):
object totalTourSetupLimitPerDay
-
useAdultOrChildMaxCounts(optional):
object useAdultOrChildMaxCounts
-
useFreeTextPortEntry(optional):
object useFreeTextPortEntry
-
useFreeTextTourCommentsOrRecommendedClothes(optional):
object useFreeTextTourCommentsOrRecommendedClothes
Nested Schema : allowTourAssignmentToSystemCruise
Type:
Show Source
object
-
parName(optional):
string
Parameter NameExample:
Enable Bookable Tour assignment to specific Cruise
-
parValue(optional):
boolean
Parameter Value (default value: false)Example:
true
Nested Schema : autoPopulateCancelationFeesInfo
Type:
Show Source
object
-
parName(optional):
string
Parameter NameExample:
Auto Populate Cancellation Fees info
-
parValue(optional):
boolean
Parameter Value (default value: false)Example:
true
Nested Schema : defaultCancelFeesDebitDept
Type:
Show Source
object
-
parName(optional):
string
Parameter NameExample:
CancelFees Default Dept
-
parValue(optional):
string
Minimum Length:
0
Maximum Length:2000
Pattern:^[ A-Za-z0-9,'_@./#&+-]*$
Parameter value (no default value)Example:8001
Nested Schema : defaultCancelFeesValue
Type:
Show Source
object
-
parName(optional):
string
Parameter NameExample:
CancellationFees Default Value
-
parValue(optional):
string
Parameter ValueExample:
75
Nested Schema : defaultCancelVoidDept
Type:
Show Source
object
-
parName(optional):
string
Parameter NameExample:
PrePaid Voids Default Dept
-
parValue(optional):
string
Minimum Length:
0
Maximum Length:2000
Pattern:^[ A-Za-z0-9,'_@./#&+-]*$
Parameter value (no default value)Example:8001
Nested Schema : defaultPostingDepartment
Type:
Show Source
object
-
parName(optional):
string
Parameter NameExample:
Excursions Department
-
parValue(optional):
string
Minimum Length:
0
Maximum Length:2000
Pattern:^[ A-Za-z0-9,'_@./#&+-]*$
Parameter value (no default value)Example:8001
Nested Schema : defaultPostingDepartmentForFCUI
Type:
Show Source
object
-
parName(optional):
string
Parameter NameExample:
Default Posting Department for FCUI
-
parValue(optional):
string
Minimum Length:
0
Maximum Length:2000
Pattern:^[ A-Za-z0-9,'_@./#&+-]*$
Parameter value (no default value)Example:8001
Nested Schema : defaultPostingDepartmentForKiosk
Type:
Show Source
object
-
parName(optional):
string
Parameter NameExample:
Default Posting Department for KIOSK
-
parValue(optional):
string
Minimum Length:
0
Maximum Length:2000
Pattern:^[ A-Za-z0-9,'_@./#&+-]*$
Parameter value (no default value)Example:8001
Nested Schema : defaultPostingDepartmentForPrepaid
Type:
Show Source
object
-
parName(optional):
string
Parameter NameExample:
Default Posting Department for PREPAID
-
parValue(optional):
string
Minimum Length:
0
Maximum Length:2000
Pattern:^[ A-Za-z0-9,'_@./#&+-]*$
Parameter value (no default value)Example:8001
Nested Schema : defaultTicketReport
Type:
Show Source
object
-
parName(optional):
string
Parameter NameExample:
Default Ticket Report
-
parValue(optional):
string
Minimum Length:
0
Maximum Length:2000
Pattern:^[ A-Za-z0-9,'_@./#&+-]*$
Parameter Value (default value: EXC01TICKET)Example:EXC01TICKET
Nested Schema : disableFCUIAndKioskBookingOptions
Type:
Show Source
object
-
parName(optional):
string
Parameter NameExample:
Disable FCUI/Kiosk Booking options by default
-
parValue(optional):
boolean
Parameter Value (default value: false)Example:
true
Nested Schema : enableTimeFields24HourFormat
Type:
Show Source
object
-
parName(optional):
string
Parameter NameExample:
Display Time Fields in 24Hour format
-
parValue(optional):
boolean
Parameter Value (default value: true)Example:
true
Nested Schema : totalTourSetupLimitPerDay
Type:
Show Source
object
-
parName(optional):
string
Parameter NameExample:
Total Tour Setup Limit Per Day
-
parValue(optional):
integer
Parameter Value (default value: 0; 0 indicated as unlimited)Example:
99
Nested Schema : useAdultOrChildMaxCounts
Type:
Show Source
object
-
parName(optional):
string
Parameter NameExample:
Use Adult/Child Max Counts
-
parValue(optional):
boolean
Parameter Value (default value: false)Example:
true
Nested Schema : useFreeTextPortEntry
Type:
Show Source
object
-
parName(optional):
string
Parameter NameExample:
Use Free Text Port Entry
-
parValue(optional):
boolean
Parameter Value (default value: false)Example:
true
Nested Schema : useFreeTextTourCommentsOrRecommendedClothes
Type:
Show Source
object
-
parName(optional):
string
Parameter NameExample:
Use Free Text Tour Comments/Recommended Clothes
-
parValue(optional):
boolean
Parameter Value (default value: false)Example:
true
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":[
{
"errorPath":"allowTourAssignmentToSystemCruises",
"message":"allowTourAssignmentToSystemCruise parameter is invalid"
}
]
}
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":"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
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":"Ship Id was not found"
}
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 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
415 Response
Unsupported Media Type
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.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
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":"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