NOT FOR PUBLIC DISTRIBUTION: 2020-09-23
Update a gangway security alert
put
/spms/v1/configurations/gangwaySecurityAlerts
This is to update details for a gangway security alert
Request
Supported Media Types
- application/json
Root Schema : Gangway Security Configuration
Type:
object
Title:
Gangway Security Configuration
Gangway Security Configuration
Show Source
-
alertMessage:
string
Minimum Value:
1
Maximum Value:500
Pattern:^[a-zA-Z0-9 .-?/,]*$
User defined alert messageExample:Please collect your confiscated item first
-
emailRecipients(optional):
string
Minimum Value:
0
Maximum Value:500
Email list separated by semicolon -
enableCheckCrew(optional):
boolean
This indicates whether the crew should be checkedExample:
true
-
enableCheckGuest(optional):
boolean
This indicates whether the guest should be checkedExample:
true
-
enableCheckVisitor(optional):
boolean
This indicates whether the visitor should be checkedExample:
true
-
enabled(optional):
boolean
This indicates whether the security alert validation is enabledExample:
true
-
gangwayType(optional):
integer
Allowed Values:
[ 0, 1, 2 ]
Indicates the gangway type. 0 stands for Internal Gate, 1 for Immigration Gate and 2 for GangwayExample:1
-
id(optional):
integer
This value is the primary key for Gangway Security Alert ConfigurationsExample:
1
-
name(optional):
string
Minimum Value:
0
Maximum Value:500
Pattern:^[a-zA-Z0-9 .-?/,]*$
This is the name for this Gangway Security Alert ConfigurationsExample:Name of the security validation
-
overrideType(optional):
integer
Minimum Value:
0
Maximum Value:3
Allowed Values:[ 0, 1, 2, 3 ]
Indicates the override type. 0 stands for Override Not Allowed, 1 for Override Allow, 2 for Send Email Alert and 3 for Show Message OnlyExample:1
-
reportTemplateId(optional):
string
Minimum Value:
0
Maximum Value:20
This is the representation id of the message template -
soundFileId(optional):
integer
This is a foreign key value that represents the sound file
-
trafficDirection(optional):
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
Successful update of a gangway security configuration
Root Schema : Gangway Security Configuration
Type:
object
Title:
Gangway Security Configuration
Gangway Security Configuration
Show Source
-
alertMessage:
string
Minimum Value:
1
Maximum Value:500
Pattern:^[a-zA-Z0-9 .-?/,]*$
User defined alert messageExample:Please collect your confiscated item first
-
emailRecipients(optional):
string
Minimum Value:
0
Maximum Value:500
Email list separated by semicolon -
enableCheckCrew(optional):
boolean
This indicates whether the crew should be checkedExample:
true
-
enableCheckGuest(optional):
boolean
This indicates whether the guest should be checkedExample:
true
-
enableCheckVisitor(optional):
boolean
This indicates whether the visitor should be checkedExample:
true
-
enabled(optional):
boolean
This indicates whether the security alert validation is enabledExample:
true
-
gangwayType(optional):
integer
Example:
1
-
gangwayTypeName(optional):
string
Name of gate settingsExample:
-
id(optional):
integer
This value is the primary key for Gangway Security Alert ConfigurationsExample:
1
-
name(optional):
string
Minimum Value:
0
Maximum Value:500
Pattern:^[a-zA-Z0-9 .-?/,]*$
This is the name for this Gangway Security Alert ConfigurationsExample:Name of the security validation
-
overrideType(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
-
reportTemplateId(optional):
string
Minimum Value:
0
Maximum Value:20
This is the representation id of the message template -
soundFileId(optional):
integer
This is a foreign key value that represents the sound file
-
trafficDirection(optional):
integer
Example:
1
400 Response
The supplied parameter(s) is not valid
Root 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
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
401 Response
You are not authorized to use this API
Root 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
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:
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
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 security configuration does not exist
Root 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
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:
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
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
409 Response
Conflict occured while trying to update
Root 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
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:
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
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:
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
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