NOT FOR PUBLIC DISTRIBUTION: 2020-09-23
Validate and display customized messages for a profile coming onboard
post
/spms/v1/gatewaySecurity/gangway/validations/onboard
Validate gangway coming onboard rules for a profile and to display list of all customized messages to allow or deny the profile for coming onboard
Request
Supported Media Types
- application/json
Root Schema : Gangway Onboard Validations Request
Type:
objectTitle:
Gangway Onboard Validations RequestGangway Onboard Validations Request
Show Source
-
accountId:
integer
This value is the primary key for Gangway Onboard ValidationsExample:
1 -
gateDirection(optional):
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(optional):
string
This value indicates which gate type.Example:
Gangway
Response
Supported Media Types
- application/json
200 Response
Returns the result of the gangway validations check if this person has a record in Onboard Denied List or if the visa requirement is not complied or if minor who must have guardian presented or people are going for any overnight tour based on the supplied resId, profileId, current timestamp, direction.
Root Schema : Gangway Onboard Validations
Type:
objectTitle:
Gangway Onboard ValidationsGangway Onboard Validations
Show Source
-
accountId(optional):
integer
Guest profile Id.Example:
838014 -
gateMovement(optional):
string
This is the value to show gate movementExample:
Double Inward -
guardianDetails(optional):
string
This list is to show the available guardian list for the minor.
-
guardiansErrorMessage(optional):
string
This is the label error message to display on the guardian list for minor.
-
guardiansMessage(optional):
string
This is the label message to display on the guardian list for minor.
-
hasOvernightTour(optional):
integer
Guest has overnight tour or not. 1- has overnight tour, 0- no overnight tourExample:
0 -
manifest(optional):
boolean
This is to indicate whether got manifest printoutExample:
true -
movementDirection(optional):
string
This is the value to show gate directionExample:
out -
movementMessage(optional):
string
This is the warning message from movement.Example:
Visitor is double inward entry! -
movementTitle(optional):
string
Example:
Dual Movement Onboard 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 coming back from 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
The supplied parameter(s) is not valid
Root Schema : Error Response
Type:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
Example Response (application/json)
{
"movementTitle":"ONBOARD DENIED",
"gateMovement":"Coming On-board",
"movementDirection":"ONBOARD",
"movementMessage":"Welcome back Onboard.",
"warning":false,
"accountId":838014,
"hasOvernightTour":0,
"overnightTourMessage":"Bruno Eric Michael Jackson Raharison is coming back from an overnight tour.",
"manifest":true,
"offboardStatus":false,
"resultSoundUrl":"/configurations/gangwaySecuritySounds/1234/sound",
"guardianDetails":"",
"guardiansMessage":"",
"guardiansErrorMessage":"",
"details":[
{
"step":"ONBOARD DENIED",
"override":false,
"error":{
"errorPath":"ONBOARD DENIED",
"message":"Please see the crew purser."
},
"soundUrl":"/configurations/gangwaySecuritySounds/4567/sound"
},
{
"step":"VISITOR",
"override":false,
"error":{
"errorPath":"visitorOnboardDenied",
"message":"The visitor card is expired"
},
"soundUrl":"/configurations/gangwaySecuritySounds/8568/sound"
},
{
"step":"SAG",
"override":true,
"error":{
"errorPath":"sag",
"message":"Do not allow minor without guardian to go shoreside"
},
"soundUrl":"/configurations/gangwaySecuritySounds/1456/sound"
},
{
"step":"GUARDIAN",
"override":false,
"error":{
"errorPath":"guardian",
"message":"Guest is minor, please assign a guardian!"
},
"soundUrl":"/configurations/gangwaySecuritySounds/9438/sound"
}
]
}401 Response
You are not authorized to use this API
Root Schema : Error Response
Type:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
403 Response
You are forbidden to use this API
Root Schema : Error Response
Type:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
404 Response
The Gangway Onboard Validations does not exist
Root Schema : Error Response
Type:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
405 Response
This method is not available
Root Schema : Error Response
Type:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
406 Response
Account Type not valid
Root Schema : Error Response
Type:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
415 Response
This media supplied is not supported
Root Schema : Error Response
Type:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
500 Response
Error occured while processing this request
Root Schema : Error Response
Type:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
502 Response
Bad Gateway
503 Response
Service not available