Validate and display customized messages for a profile going ashore
post
/spms/v1/gatewaySecurity/gangway/validations/ashore
This is to validate gangway going ashore rules for a profile and to display list of all customized messages to allow or deny the profile for going ashore
Request
Supported Media Types
- application/json
Root Schema : Gangway Ashore Validations Request
Type:
object
Title:
Gangway Ashore Validations Request
Gangway Ashore Validations Request
Show Source
-
accountId:
integer
This value is the primary key for Gangway Ashore ValidationsExample:
1
-
gateDirection:
integer
This is the value to indicate the gate entrance direction. 0 stands for Both Ways, 1 for Outwards and 2 for InwardsExample:
0
-
gateType:
string
This value indicates which gate type.Example:
Gangway
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Gangway Ashore Validations
Type:
object
Title:
Gangway Ashore Validations
Gangway Ashore Validations
Show Source
-
accountId(optional):
integer
Guest profile Id.Example:
838014
-
confiscatedItems(optional):
string
This list is to show the confiscated itemsExample:
[]
-
gateMovement(optional):
string
This is the value to show gate movementExample:
Double Outward
-
guardianDetails(optional):
string
This list is to show the available guardian list for the minor.Example:
null
-
guardiansErrorMessage(optional):
string
This is the label error message to display on the guardian list for minor.Example:
null
-
guardiansMessage(optional):
string
This is the label message to display on the guardian list for minor.Example:
null
-
hasOvernightTour(optional):
integer
Guest has overnight tour or not. 1- has overnight tour, 0- no overnight tourExample:
1
-
manifest(optional):
boolean
This is to indicate whether got manifest printoutExample:
false
-
movementDirection(optional):
string
This is the value to show gate directionExample:
Ashore
-
movementMessage(optional):
string
This is the warning message from movement.Example:
Visitor is double outward entry!
-
movementTitle(optional):
string
Example:
Dual Movement Ashore Detected
-
offboardStatus(optional):
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
-
overnightTourMessage(optional):
string
This is the label message to display to indicate whether the person got overnight tour.Example:
<b>Bruno Eric Michael Jackson Raharison</b> is going for an overnight tour.
-
resultSoundUrl(optional):
string
This is the value of result sound URLExample:
/configurations/gangwaySecuritySounds/1234/sound
-
warning(optional):
boolean
This is the value indicate whether this is a warning message.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:
{
"title":"Bad Request",
"detail":"Gate Direction must be either 0,1 or 2.",
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
}
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":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
"title":"Forbidden",
"detail":"Access to this resource was 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":"Account 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":"https://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
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":"https://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