Update bookable tour interfaces
put
/spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/interfaces
This is to update bookable tour interfaces for kiosk, interactiveTV, printing
Request
Supported Media Types
- application/json
Path Parameters
-
bookableTourId: integer
bookableTour Id
-
shipId: integer
ship Id
Root Schema : Update bookable tour interfaces
Type:
object
Title:
Show Source
Update bookable tour interfaces
Nested Schema : interactiveTV
Type:
Show Source
object
-
isEnabledChildBookingInInteractiveTV(optional):
boolean
Enable child booking in Interactive TVExample:
true
-
isMakeBookableInInteractiveTV(optional):
boolean
Excursion is bookable in External Interactive TV SystemExample:
true
-
isShowInInteractiveTV(optional):
boolean
Show excursion in Interactive TVExample:
true
Nested Schema : kiosk
Type:
Show Source
object
-
isEnabledChildBookingInKiosk(optional):
boolean
Enable child boooking in OHC KioskExample:
true
-
isMakeBookableInKiosk(optional):
boolean
Excursion is bookable in OHC KioskExample:
true
-
isShowInKiosk(optional):
boolean
Excursion to show in OHC KioskExample:
true
-
kioskDefaultAudioFileId(optional):
string
Minimum Length:
0
Maximum Length:50
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Kiosk Default Audio File IdExample:160000002481
-
kioskDefaultHTMLFileId(optional):
string
Minimum Length:
0
Maximum Length:500
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Kiosk Default Html File IdExample:160000002482
-
kioskDefaultPictureFileId(optional):
integer
Minimum Value:
0
Maximum Value:1.0E38
Bookable Tour Kiosk Default Picture File Id (allow integer value only)Example:1.60000001221E11
-
kioskDefaultVideoFileId(optional):
string
Minimum Length:
0
Maximum Length:50
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Kiosk Default Video File IdExample:160000002480
Nested Schema : printing
Type:
Show Source
object
-
defaultTicketReport(optional):
string
Minimum Length:
0
Maximum Length:20
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Default Ticket ReportExample:EXC01TICKET
-
isEnabledEInvoice(optional):
boolean
Switch to enable / disable e-Invoice printing for specific ToursExample:
true
-
isPrintTicket(optional):
boolean
A switch to enable/disable Ticket Printing for each TourExample:
true
-
isPrintTicketSummary(optional):
boolean
Print Tour Ticket Summary indicatorExample:
true
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Bookable Tour Interfaces
Type:
object
Title:
Bookable Tour Interfaces
Bookable Tour Interfaces
Show Source
Nested Schema : interactiveTV
Type:
Show Source
object
-
isEnabledChildBookingInInteractiveTV(optional):
boolean
Enable child booking in Interactive TVExample:
true
-
isMakeBookableInInteractiveTV(optional):
boolean
Excursion is bookable in External Interactive TV SystemExample:
true
-
isShowInInteractiveTV(optional):
boolean
Show excursion in Interactive TVExample:
true
Nested Schema : kiosk
Type:
Show Source
object
-
isEnabledChildBookingInKiosk(optional):
boolean
Enable child boooking in OHC KioskExample:
true
-
isMakeBookableInKiosk(optional):
boolean
Excursion is bookable in OHC KioskExample:
true
-
isShowInKiosk(optional):
boolean
Excursion to show in OHC KioskExample:
true
-
kioskDefaultAudioFileId(optional):
string
Bookable Tour Kiosk Default Audio File IdExample:
160000002481
-
kioskDefaultHTMLFileId(optional):
string
Bookable Tour Kiosk Default Html File IdExample:
160000002482
-
kioskDefaultPictureFileId(optional):
integer
Bookable Tour Kiosk Default Picture File IdExample:
1.60000001221E11
-
kioskDefaultVideoFileId(optional):
string
Bookable Tour Kiosk Default Video File IdExample:
160000002480
Nested Schema : printing
Type:
Show Source
object
-
defaultTicketReport(optional):
string
Bookable Tour Default Ticket ReportExample:
EXC01TICKET
-
isEnabledEInvoice(optional):
boolean
Switch to enable / disable e-Invoice printing for specific ToursExample:
true
-
isPrintTicket(optional):
boolean
A switch to enable/disable Ticket Printing for each TourExample:
true
-
isPrintTicketSummary(optional):
boolean
Print Tour Ticket Summary indicatorExample:
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":"defaultTicketReport",
"message":"must be between 0 and 20 characters"
}
]
}
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 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
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
406 Response
Not Acceptable
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.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
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