Retrieve a gangway security alert by ID
get
/spms/v1/configurations/gangwaySecurityAlerts/{id}
This is to retrieve a gangway security alert by ID
Request
Supported Media Types
- application/json
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Gangway Security Alert Configurations Response object containing list items
Type:
object
Title:
Gangway Security Alert Configurations Response object containing list items
The Gangway Security Alert Configurations object when returning a list of objects
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
-
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
-
modifiedDate(optional):
string(date)
Example:
2021-04-01
-
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
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Gangway Security Alert Configurations Error Response
Title:
Gangway Security Alert Configurations Error Response
Gangway Security Alert Configurations Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Bad Request",
"detail":"The parameter 'configurationId' has incorrect format"
}
Nested Schema : Gangway Security Alert Configurations Error Response
Type:
object
Title:
Gangway Security Alert Configurations Error Response
Gangway Security Alert Configurations Error Response returned when encountered error
Show Source
401 Response
Unauthorized
Root Schema : schema
Match All
Show Source
-
object
Gangway Security Alert Configurations Error Response
Title:
Gangway Security Alert Configurations Error Response
Gangway Security Alert Configurations Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
"title":"Unauthorized",
"detail":"You are not authorized to use this API"
}
Nested Schema : Gangway Security Alert Configurations Error Response
Type:
object
Title:
Gangway Security Alert Configurations Error Response
Gangway Security Alert Configurations Error Response returned when encountered error
Show Source
403 Response
Forbidden
Root Schema : schema
Match All
Show Source
-
object
Gangway Security Alert Configurations Error Response
Title:
Gangway Security Alert Configurations Error Response
Gangway Security Alert Configurations Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
"title":"Forbidden",
"detail":"You are forbidden to use this API"
}
Nested Schema : Gangway Security Alert Configurations Error Response
Type:
object
Title:
Gangway Security Alert Configurations Error Response
Gangway Security Alert Configurations Error Response returned when encountered error
Show Source
404 Response
Not Found
Root Schema : schema
Match All
Show Source
-
object
Gangway Security Alert Configurations Error Response
Title:
Gangway Security Alert Configurations Error Response
Gangway Security Alert Configurations Error Response returned when encountered error
Example:
{
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
"title":"Not Found",
"detail":"gangway security configuration does not exist"
}
Nested Schema : Gangway Security Alert Configurations Error Response
Type:
object
Title:
Gangway Security Alert Configurations Error Response
Gangway Security Alert Configurations Error Response returned when encountered error
Show Source
405 Response
Method Not Allowed
Root Schema : schema
Match All
Show Source
-
object
Gangway Security Alert Configurations Error Response
Title:
Gangway Security Alert Configurations Error Response
Gangway Security Alert Configurations 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":"This method is not available"
}
Nested Schema : Gangway Security Alert Configurations Error Response
Type:
object
Title:
Gangway Security Alert Configurations Error Response
Gangway Security Alert Configurations Error Response returned when encountered error
Show Source
406 Response
Not Acceptable
Root Schema : schema
Match All
Show Source
-
object
Gangway Security Alert Configurations Error Response
Title:
Gangway Security Alert Configurations Error Response
Gangway Security Alert Configurations 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 : Gangway Security Alert Configurations Error Response
Type:
object
Title:
Gangway Security Alert Configurations Error Response
Gangway Security Alert Configurations Error Response returned when encountered error
Show Source
415 Response
Unsupported Media Type
Root Schema : schema
Match All
Show Source
-
object
Gangway Security Alert Configurations Error Response
Title:
Gangway Security Alert Configurations Error Response
Gangway Security Alert Configurations Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
"title":"Invalid content",
"detail":"This media supplied is not supported"
}
Nested Schema : Gangway Security Alert Configurations Error Response
Type:
object
Title:
Gangway Security Alert Configurations Error Response
Gangway Security Alert Configurations Error Response returned when encountered error
Show Source
500 Response
Internal Server Error
Root Schema : schema
Match All
Show Source
-
object
Gangway Security Alert Configurations Error Response
Title:
Gangway Security Alert Configurations Error Response
Gangway Security Alert Configurations 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":"Error occured while processing this request"
}
Nested Schema : Gangway Security Alert Configurations Error Response
Type:
object
Title:
Gangway Security Alert Configurations Error Response
Gangway Security Alert Configurations Error Response returned when encountered error
Show Source
503 Response
Service Unavailable
Root Schema : schema
Match All
Show Source
-
object
Gangway Security Alert Configurations Error Response
Title:
Gangway Security Alert Configurations Error Response
Gangway Security Alert Configurations 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 not available"
}
Nested Schema : Gangway Security Alert Configurations Error Response
Type:
object
Title:
Gangway Security Alert Configurations Error Response
Gangway Security Alert Configurations Error Response returned when encountered error
Show Source