NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

Validate gangway movement against configured security alerts

post

/spms/v1/reservations/gangwaySecurityValidations

This is to validate the gangway movement against configured security alerts

Request

Supported Media Types

• application/json

Body ()

Root Schema : Gangway Security Configuration

Type: object

Title: Gangway Security Configuration

Gangway Security Configuration

Show Source

• accountId: integer
  This value is the primary key for Gangway Security Alert Configurations

  Example: 1
• accountType: string
  Allowed Values: [ "guest", "crew", "visitor" ]

  Indicates which type this account belongs to. P stands for Guest, C for Crew and V for Visitor
• gangwayType: 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
• trafficDirection: 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":{
        "accountId":{
            "type":"integer",
            "example":1,
            "description":"This value is the primary key for Gangway Security Alert Configurations"
        },
        "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"
        },
        "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"
        },
        "accountType":{
            "type":"string",
            "enum":[
                "guest",
                "crew",
                "visitor"
            ],
            "description":"Indicates which type this account belongs to. P stands for Guest, C for Crew and V for Visitor"
        }
    },
    "required":[
        "accountId",
        "trafficDirection",
        "gangwayType",
        "accountType"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns the result of the security check based on the supplied account id

Body ()

Root Schema : Oracle Response object containing list items

Type: object

Title: Oracle Response object containing list items

The wrapper object when returning a list of objects in Oracle standard

Show Source

• items(optional): array items

{
    "title":"Oracle Response object containing list items",
    "description":"The wrapper object when returning a list of objects in Oracle standard",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GangwaySecurityConfigResult"
            }
        }
    }
}

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/GangwaySecurityConfigResult"
    }
}

Nested Schema : Gangway Security Configuration

Type: object

Title: Gangway Security Configuration

Gangway Security Configuration

Show Source

• id(optional): integer
  This value is the primary key for gangway security alert configurations

  Example: 1
• message(optional): string
  Minimum Value: 0

  Maximum Value: 500

  The message that is returned whenever the security check failed

  Example: Do not allow minor without guardian to go shoreside
• override(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
• soundId(optional): integer
  This is the id that represents the sound file that is saved in the system
• violated(optional): boolean
  This value indicates whether this account violated the security check

  Example: true

{
    "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"
        },
        "violated":{
            "type":"boolean",
            "example":"true",
            "description":"This value indicates whether this account violated the security check"
        },
        "override":{
            "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"
        },
        "message":{
            "type":"string",
            "minimum":0,
            "maximum":500,
            "example":"Do not allow minor without guardian to go shoreside",
            "description":"The message that is returned whenever the security check failed"
        },
        "soundId":{
            "type":"integer",
            "description":"This is the id that represents the sound file that is saved in the system"
        }
    }
}

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 Alert Configurations 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......"
        }
    }
}

406 Response

Account Type 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......"
        }
    }
}

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