Save the tender boat movement and other related information
post
/spms/v2/ships/{shipId}/gatewaySecurity/movements/tenderBoatGateway
This is to save the tender boat movement and other related information once the tender boat movement is success
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: string
Ship identifier Number
Required fields to create Tender Boat
Root Schema : request parameter for gangway security movement
Type:
object
Title:
request parameter for gangway security movement
request parameter for gangway security movement
Show Source
-
confiscatedItemIds(optional):
array confiscatedItemIds
The id of the confiscated item(s)
-
denyStatus:
boolean
Deny Status. True means have error messages and false is successExample:
true
-
gateDirection:
number
This is the tender boat direction. 1- Outward, 2- InwardExample:
2
-
gateLocation:
string
Location of the gateExample:
Guest Gangway
-
gateMovement:
string
The movement the passenger is trying to do. It can be Coming On-board or Going Shore-sideExample:
Coming On-board
-
gateType:
string
Gate type. Can be Gangway or TenderExample:
Gangway
-
manifest(optional):
boolean
This is to indicate whether got manifest printout. 1- has manifest, 0- no manifestExample:
true
-
movementDirection:
string
This is the value to show people movement direction. Can only be IN or OUTExample:
IN
-
offBoardStatus:
boolean
This is to indicate the person is onboard or ashore. offboardStatus true means the person is ashore, false means the person is onboardExample:
true
-
overnightTour(optional):
integer
Guest has overnight tour or not. 1- has overnight tour, 0- no overnight tourExample:
1
-
profileId:
number
Profile IdExample:
980000
-
reservationId:
number
Reservation IdExample:
989322
-
tenderBoatId:
number
Tender Boat IdExample:
989322
-
warning:
boolean
This is the value indicate whether this is a warning message. True means have warning messages and false is depend on the denyStatus either have error messages or successExample:
true
-
workStation:
string
WorkstationExample:
workplace
Nested Schema : status
Type:
array
confiscated Item list
Example:
[
1001,
1002
]
Response
Supported Media Types
- application/json
201 Response
Created
Root Schema : The response for creating a tender boar inventory entry
Type:
object
Title:
The response for creating a tender boar inventory entry
The response for creating a tender boar inventory entry
Show Source
-
active(optional):
boolean
Indicates whether the passenger is currently on the tender boatExample:
true
-
createdBy(optional):
number
Created ByExample:
98900
-
createdDate(optional):
string
Created DateExample:
27-10-2020T13:00:00
-
id(optional):
number
Example:
989322
-
modifiedBy(optional):
number
Modified ByExample:
98900
-
modifiedDate(optional):
string
Modified DateExample:
27-10-2020T13:00:00
-
profileId(optional):
number
Profile IdExample:
12345678
-
tenderBoatId(optional):
number
Tender Boat IdExample:
12345678
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":"The parameter gateDirection has incorrect format"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
-
type(optional):
string
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
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
-
type(optional):
string
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
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
-
type(optional):
string
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
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
-
type(optional):
string
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":"Request a Mime type that is supported for this Resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
-
type(optional):
string
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.5",
"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
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
-
type(optional):
string
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
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
-
type(optional):
string
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
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
-
type(optional):
string