Update transfer tours for bookable tour
put
/spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/setup/transferTours
This is to update transfer tour for bookable tour
Request
Supported Media Types
- application/json
Path Parameters
-
bookableTourId: integer
bookableTour Id
-
shipId: integer
ship Id
Root Schema : Update transfer tours for bookable tour
Type:
object
Title:
Show Source
Update transfer tours for bookable tour
-
isTransferTour(optional):
boolean
Flag to indicate to transfer tour or not to.Example:
true
-
transferFromLocationCode(optional):
string
Minimum Length:
0
Maximum Length:6
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Transfer To Location CodeExample:TTL01
-
transferFromLocationDescription(optional):
string
Minimum Length:
0
Maximum Length:40
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Transfer From Location DescriptionExample:FOR DINNER
-
transferToLocationCode(optional):
string
Minimum Length:
0
Maximum Length:6
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Transfer To Location CodeExample:TTL02
-
transferToLocationDescription(optional):
string
Minimum Length:
0
Maximum Length:40
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Example:NIGHT MARKET
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Transfer Tour Info for Bookable Tour
Type:
object
Title:
Transfer Tour Info for Bookable Tour
Transfer Tour Info for Bookable Tour
Show Source
-
isTransferTour(optional):
boolean
Flag to indicate to transfer tour or not to.Example:
true
-
transferFromLocationCode(optional):
string
Bookable Tour Transfer From Location CodeExample:
TTL01
-
transferFromLocationDescription(optional):
string
Bookable Tour Transfer To Location DescriptionExample:
FOR DINNER
-
transferToLocationCode(optional):
string
Bookable Tour Transfer To Location CodeExample:
TTL02
-
transferToLocationDescription(optional):
string
Bookable Tour Transfer To Location DescriptionExample:
NIGHT MARKET
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":"transferFromLocationCode",
"message":"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 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