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

OK

Body ()

Root Schema : Gangway Security Validation List

Type: object

Title: Gangway Security Validation List

Gangway Security Validation List

Show Source

• items(optional): array items

{
    "title":"Gangway Security Validation List",
    "description":"Gangway Security Validation List",
    "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"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

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 : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

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

{
    "title":"Error Response",
    "description":"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 Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwaySecurityValidationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource was forbidden"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource was forbidden"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

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

{
    "title":"Error Response",
    "description":"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 Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwaySecurityValidationErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Supported",
        "detail":"HTTP method not supported for this resource"
    }
}

Example:

{
    "type":"https://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 : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

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

{
    "title":"Error Response",
    "description":"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 Error Response
  Title: Error Response

  Error Response returned when encountered error

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

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

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

{
    "title":"Error Response",
    "description":"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 Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwaySecurityValidationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Invalid content",
        "detail":"Content type Not supported"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Invalid content",
    "detail":"Content type Not supported"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

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

{
    "title":"Error Response",
    "description":"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 Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwaySecurityValidationErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
        "title":"Internal Server Error",
        "detail":"Issue fulfilling request. Please retry or contact support"
    }
}

Example:

{
    "type":"https://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 : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

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

{
    "title":"Error Response",
    "description":"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 Error Response
  Title: Error Response

  Error Response returned when encountered error

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

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service Unavailable. Try again later"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

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

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

Back to Top