1. Oracle Hospitality Cruise Property Management REST API 23.2.2
  2. Tasks
  3. Gateway Security
  4. Configuration
  5. Security Alerts

Update a gangway security alert

put

/spms/v1/configurations/gangwaySecurityAlerts

This is to update details for a gangway security alert

Request

Supported Media Types
Body ()
Root Schema : Gangway Security Configuration
Type: object
Title: Gangway Security Configuration
Gangway Security Configuration
Show Source
  • Minimum Value: 1
    Maximum Value: 500
    Pattern: ^[a-zA-Z0-9 .-?/,]*$
    User defined alert message
    Example: Please collect your confiscated item first
  • Minimum Value: 0
    Maximum Value: 500
    Email list separated by semicolon
  • This indicates whether the crew should be checked
    Example: true
  • This indicates whether the guest should be checked
    Example: true
  • This indicates whether the visitor should be checked
    Example: true
  • This indicates whether the security alert validation is enabled
    Example: true
  • Allowed Values: [ "0", "1", "2" ]
    Indicates the gangway type. 0 stands for Internal Gate, 1 for Immigration Gate and 2 for Gangway
    Example: 1
  • This value is the primary key for Gangway Security Alert Configurations
    Example: 1
  • 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
  • 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
  • Minimum Value: 0
    Maximum Value: 20
    This is the representation id of the message template
  • This is a foreign key value that represents the sound file
  • Allowed Values: [ "0", "1", "2" ]
    Indicates the traffic direction. 0 stands for Both Ways, 1 for Outwards and 2 for Inwards
    Example: 1
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Gangway Security Configuration
Type: object
Title: Gangway Security Configuration
Gangway Security Configuration
Show Source
  • Minimum Value: 1
    Maximum Value: 500
    Pattern: ^[a-zA-Z0-9 .-?/,]*$
    User defined alert message
    Example: Please collect your confiscated item first
  • Minimum Value: 0
    Maximum Value: 500
    Email list separated by semicolon
  • This indicates whether the crew should be checked
    Example: true
  • This indicates whether the guest should be checked
    Example: true
  • This indicates whether the visitor should be checked
    Example: true
  • This indicates whether the security alert validation is enabled
    Example: true
  • Example: 1
  • This value is the primary key for Gangway Security Alert Configurations
    Example: 1
  • Example: 2021-04-01
  • 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
  • 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
  • Minimum Value: 0
    Maximum Value: 20
    This is the representation id of the message template
  • This is a foreign key value that represents the sound file
  • Minimum Value: 0
    Maximum Value: 4000
    Pattern: ^[a-zA-Z0-9 =<>/\\.=\\[\\]\\|_(),':]*$
    SQL statement to check Row-Exist in MOBILE device (Use the work ONLINEONLY for online only case)
    Example: FROM a WHERE a_id = <AID>
  • Minimum Value: 0
    Maximum Value: 4000
    Pattern: ^[a-zA-Z0-9 =<>/\\.=\\[\\]\\|_(),':]*$
    SQL statement to check Row-Exist
    Example: FROM a WHERE a_id = <AID>
  • Example: 1

400 Response

Bad Request
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":[
        {
            "errorPath":"gangwayType",
            "message":"gangwayType cannot be empty"
        },
        {
            "errorPath":"sqlStatement",
            "message":"not all characters are accepted"
        },
        {
            "errorPath":"overrideType",
            "message":"overrideType cannot be empty"
        },
        {
            "errorPath":"trafficDirection",
            "message":"trafficDirection cannot be empty"
        },
        {
            "errorPath":"name",
            "message":"cannot be empty"
        },
        {
            "errorPath":"id",
            "message":"id field cannot have negative values"
        }
    ]
}
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
Body ()
Root Schema : schema
Match All
Show Source
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 : 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
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource is forbidden"
}
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
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://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
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://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 : 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
Body ()
Root Schema : schema
Match All
Show Source
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
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Invalid content",
    "detail":"Content type 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
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://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 : 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
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service Unavailable.  Try again later"
}
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
Back to Top