Validate gangway movement against configured security alerts
post
/spms/v1/reservations/gangwaySecurityValidations
This is to validate the gangway movement against configured security alerts
Request
Supported Media Types
- application/json
Root Schema : Gangway Security Configuration
Type:
object
Title:
Gangway Security Configuration
Gangway Security Configuration
Show Source
-
accountId:
integer
This value is the primary key for Gangway Security Alert ConfigurationsExample:
1
-
accountType:
string
Allowed Values:
[ "guest", "crew", "visitor" ]
Indicates which type this account belongs to. P stands for Guest, C for Crew and V for Visitor -
gangwayType:
integer
Allowed Values:
[ 0, 1, 2 ]
Indicates the gangway type. 0 stands for Internal Gate, 1 for Immigration Gate and 2 for GangwayExample:1
-
trafficDirection:
integer
Allowed Values:
[ 0, 1, 2 ]
Indicates the traffic direction. 0 stands for Both Ways, 1 for Outwards and 2 for InwardsExample:1
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Gangway Security Validation List
Type:
object
Title:
Gangway Security Validation List
Gangway Security Validation List
Show Source
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Gangway Security Configuration
Title:
Gangway Security Configuration
Gangway Security Configuration
Nested Schema : Gangway Security Configuration
Type:
object
Title:
Gangway Security Configuration
Gangway Security Configuration
Show Source
-
id(optional):
integer
This value is the primary key for gangway security alert configurationsExample:
1
-
message(optional):
string
Minimum Value:
0
Maximum Value:500
The message that is returned whenever the security check failedExample:Do not allow minor without guardian to go shoreside
-
override(optional):
integer
Minimum Value:
0
Maximum Value:3
Allowed Values:[ "Override Not Allowed (0)", "Override Allow (1)", "Send Email Alert (2)", "Show Message Only (3)" ]
All is allowed except for Override Not AllowExample:1
-
soundId(optional):
integer
This is the id that represents the sound file that is saved in the system
-
violated(optional):
boolean
This value indicates whether this account violated the security checkExample:
true
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
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
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
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":"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