Jump to

• Request
• Response

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

• id: integer

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

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

• items(optional): array items

{
    "title":"Gangway Security Alert Configurations Response object containing list items",
    "description":"The Gangway Security Alert Configurations object when returning a list of objects",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GangwaySecurityConfig"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Gangway Security Configuration
  Title: Gangway Security Configuration

  Gangway Security Configuration

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GangwaySecurityConfig"
    }
}

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 message

  Example: 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 checked

  Example: true
• enableCheckGuest(optional): boolean
  This indicates whether the guest should be checked

  Example: true
• enableCheckVisitor(optional): boolean
  This indicates whether the visitor should be checked

  Example: true
• enabled(optional): boolean
  This indicates whether the security alert validation is enabled

  Example: true
• gangwayType(optional): integer
  Example: 1
• gangwayTypeName(optional): string
  Name of gate settings

  Example:
• id(optional): integer
  This value is the primary key for Gangway Security Alert Configurations

  Example: 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 Configurations

  Example: 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 Allow

  Example: 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

{
    "title":"Gangway Security Configuration",
    "description":"Gangway Security Configuration",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "example":1,
            "description":"This value is the primary key for Gangway Security Alert Configurations"
        },
        "alertMessage":{
            "type":"string",
            "minimum":1,
            "maximum":500,
            "example":"Please collect your confiscated item first",
            "pattern":"^[a-zA-Z0-9 .-?/,]*$",
            "description":"User defined alert message"
        },
        "overrideType":{
            "type":"integer",
            "minimum":0,
            "maximum":3,
            "example":"1",
            "enum":[
                "Override Not Allowed (0)",
                "Override Allow (1)",
                "Send Email Alert (2)",
                "Show Message Only (3)"
            ],
            "description":"All is allowed except for Override Not Allow"
        },
        "enableCheckGuest":{
            "type":"boolean",
            "example":"true",
            "description":"This indicates whether the guest should be checked"
        },
        "enableCheckCrew":{
            "type":"boolean",
            "example":"true",
            "description":"This indicates whether the crew should be checked"
        },
        "enableCheckVisitor":{
            "type":"boolean",
            "example":"true",
            "description":"This indicates whether the visitor should be checked"
        },
        "enabled":{
            "type":"boolean",
            "example":"true",
            "description":"This indicates whether the security alert validation is enabled"
        },
        "name":{
            "type":"string",
            "minimum":0,
            "maximum":500,
            "example":"Name of the security validation",
            "pattern":"^[a-zA-Z0-9 .-?/,]*$",
            "description":"This is the name for this Gangway Security Alert Configurations"
        },
        "modifiedDate":{
            "type":"string",
            "format":"date",
            "example":"2021-04-01"
        },
        "trafficDirection":{
            "type":"integer",
            "example":"1"
        },
        "reportTemplateId":{
            "type":"string",
            "minimum":0,
            "maximum":20,
            "description":"This is the representation id of the message template"
        },
        "emailRecipients":{
            "type":"string",
            "minimum":0,
            "maximum":500,
            "description":"Email list separated by semicolon"
        },
        "soundFileId":{
            "type":"integer",
            "description":"This is a foreign key value that represents the sound file"
        },
        "gangwayType":{
            "type":"integer",
            "example":"1"
        },
        "gangwayTypeName":{
            "type":"string",
            "example":"",
            "description":"Name of gate settings"
        }
    },
    "required":[
        "alertMessage"
    ]
}

400 Response

Bad Request

Body ()

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

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwaySecurityAlertConfigurationsErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"The parameter 'configurationId' has incorrect format"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Gangway Security Alert Configurations Error Response",
    "description":"Gangway Security Alert Configurations Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

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

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwaySecurityAlertConfigurationsErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Gangway Security Alert Configurations Error Response",
    "description":"Gangway Security Alert Configurations Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

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

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwaySecurityAlertConfigurationsErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"You are forbidden to use this API"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Gangway Security Alert Configurations Error Response",
    "description":"Gangway Security Alert Configurations Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

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

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwaySecurityAlertConfigurationsErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"gangway security configuration does not exist"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Gangway Security Alert Configurations Error Response",
    "description":"Gangway Security Alert Configurations Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed

Body ()

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

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwaySecurityAlertConfigurationsErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Supported",
        "detail":"This method is not available"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Gangway Security Alert Configurations Error Response",
    "description":"Gangway Security Alert Configurations Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

406 Response

Not Acceptable

Body ()

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

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwaySecurityAlertConfigurationsErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Gangway Security Alert Configurations Error Response",
    "description":"Gangway Security Alert Configurations Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

415 Response

Unsupported Media Type

Body ()

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

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwaySecurityAlertConfigurationsErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Invalid content",
        "detail":"This media supplied is not supported"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Gangway Security Alert Configurations Error Response",
    "description":"Gangway Security Alert Configurations Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

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

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwaySecurityAlertConfigurationsErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Gangway Security Alert Configurations Error Response",
    "description":"Gangway Security Alert Configurations Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Body ()

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

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwaySecurityAlertConfigurationsErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service not available"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Gangway Security Alert Configurations Error Response",
    "description":"Gangway Security Alert Configurations Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top