NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

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

Body ()

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 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
  Allowed Values: [ 0, 1, 2 ]

  Indicates the gangway type. 0 stands for Internal Gate, 1 for Immigration Gate and 2 for Gangway

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

  Example: 1
• 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: [ 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 Only

  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
  Allowed Values: [ 0, 1, 2 ]

  Indicates the traffic direction. 0 stands for Both Ways, 1 for Outwards and 2 for Inwards

  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"
        },
        "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"
        },
        "alertMessage":{
            "type":"string",
            "minimum":1,
            "maximum":500,
            "example":"Please collect your confiscated item first",
            "pattern":"^[a-zA-Z0-9 .-?/,]*$",
            "description":"User defined alert message"
        },
        "enabled":{
            "type":"boolean",
            "example":"true",
            "description":"This indicates whether the security alert validation is enabled"
        },
        "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"
        },
        "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"
        },
        "gangwayType":{
            "type":"integer",
            "example":"1",
            "enum":[
                0,
                1,
                2
            ],
            "description":"Indicates the gangway type. 0 stands for Internal Gate, 1 for Immigration Gate and 2 for Gangway"
        },
        "trafficDirection":{
            "type":"integer",
            "example":"1",
            "enum":[
                0,
                1,
                2
            ],
            "description":"Indicates the traffic direction. 0 stands for Both Ways, 1 for Outwards and 2 for Inwards"
        },
        "overrideType":{
            "type":"integer",
            "minimum":0,
            "maximum":3,
            "example":"1",
            "enum":[
                0,
                1,
                2,
                3
            ],
            "description":"Indicates the override type. 0 stands for Override Not Allowed, 1 for Override Allow, 2 for Send Email Alert and 3 for Show Message Only"
        },
        "soundFileId":{
            "type":"integer",
            "description":"This is a foreign key value that represents the sound file"
        }
    },
    "required":[
        "alertMessage"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful update of a gangway security configuration

Body ()

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 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
• 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"
        },
        "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"
        },
        "alertMessage":{
            "type":"string",
            "minimum":1,
            "maximum":500,
            "example":"Please collect your confiscated item first",
            "pattern":"^[a-zA-Z0-9 .-?/,]*$",
            "description":"User defined alert message"
        },
        "enabled":{
            "type":"boolean",
            "example":"true",
            "description":"This indicates whether the security alert validation is enabled"
        },
        "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"
        },
        "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"
        },
        "gangwayType":{
            "type":"integer",
            "example":"1"
        },
        "gangwayTypeName":{
            "type":"string",
            "example":"",
            "description":"Name of gate settings"
        },
        "trafficDirection":{
            "type":"integer",
            "example":"1"
        },
        "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"
        },
        "soundFileId":{
            "type":"integer",
            "description":"This is a foreign key value that represents the sound file"
        }
    },
    "required":[
        "alertMessage"
    ]
}

400 Response

The supplied parameter(s) is not valid

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

401 Response

You are not authorized to use this API

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

403 Response

You are forbidden to use this API

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

404 Response

The gangway security configuration does not exist

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

405 Response

This method is not available

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

409 Response

Conflict occured while trying to update

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

415 Response

This media supplied is not supported

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

500 Response

Error occured while processing this request

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

502 Response

Bad Gateway

503 Response

Service not available

Back to Top