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:
object
Title:
Gangway Onboard Validations Request
Gangway 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
OK
Root Schema : Gangway Onboard Validations
Type:
object
Title:
Gangway Onboard Validations
Gangway Onboard Validations
Show Source
-
accountId(optional):
integer
Profile Id.Example:
12345678
-
confiscatedItems(optional):
array confiscatedItems
-
gangwayCheckInValidation(optional):
array gangwayCheckInValidation
-
gateMovement(optional):
string
This is the value to show gate movementExample:
Double Outward
-
guardianDetails(optional):
object guardianDetails
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.Example:
A guardian should be physically present with his/her children
-
guardiansMessage(optional):
string
This is the label message to display on the guardian list for minor.Example:
Please verify the guardian is present to accompany the children
-
hasOvernightTour(optional):
boolean
Guest has overnight tour or not. 1- has overnight tour, 0- no overnight tourExample:
true
-
manifest(optional):
boolean
This is to indicate whether got manifest printout. 1- has manifest, 0- no manifestExample:
true
-
movementDirection(optional):
string
This is the value to show people movement direction. Can only be Onboard or AshoreExample:
Onboard
-
movementMessage(optional):
string
This is the warning message from movement.Example:
Visitor is double outward entry!
-
movementTitle(optional):
string
This title will inform the user about the reason for the errorExample:
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>John Doe</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. True means have warning messages and false is depend on the denyStatus either have error messages or successExample:
true
Nested Schema : gangwayCheckInValidation
Type:
Show Source
array
-
Array of:
object checkIn
This list only applicable for the profile who required to check-in. If the profile do not required to check-in, It will not display any value in each fields.
Nested Schema : guardianDetails
Type:
object
This list is to show the available guardian list for the minor.
Example:
[
{
"accountId":1234,
"guardians":[
{
"accountId":5678,
"salutation":"Mr.",
"firstName":"John",
"middleName":"Michael",
"lastName":"Doe",
"stateRoom":100,
"photoUrl":"https://oracle.com/resources/john.jpg",
"accountType":"P",
"links":[
]
}
]
}
]
Nested Schema : checkIn
Type:
object
This list only applicable for the profile who required to check-in. If the profile do not required to check-in, It will not display any value in each fields.
Show Source
-
errorSoundUrl(optional):
string
This is a check-in fail sound URLExample:
/configurations/gangwaySecuritySounds/1234/sound
-
message(optional):
string
Minimum Length:
0
Maximum Length:255
If the validation required user action, system will show confirmation message otherwise it will show error message or success messageExample:Guest is expected today. Do you want to check-in?
-
messageType(optional):
string
Minimum Length:
0
Maximum Length:12
This is to indicate the message field is confirmation type , information type or error typeExample:confirmation,information,error
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