Jump to

• Request
• Response

Validate and display customized messages for a profile going ashore

post

/spms/v1/gatewaySecurity/gangway/validations/ashore

This is to validate gangway going ashore rules for a profile and to display list of all customized messages to allow or deny the profile for going ashore

Request

Supported Media Types

• application/json

Body ()

Root Schema : Gangway Ashore Validations Request

Type: object

Title: Gangway Ashore Validations Request

Gangway Ashore Validations Request

Show Source

• accountId: integer
  This value is the primary key for Gangway Ashore Validations

  Example: 1
• gateDirection: integer
  This is the value to indicate the gate entrance direction. 0 stands for Both Ways, 1 for Outwards and 2 for Inwards

  Example: 0
• gateType: string
  This value indicates which gate type.

  Example: Gangway

{
    "title":"Gangway Ashore Validations Request",
    "description":"Gangway Ashore Validations Request",
    "type":"object",
    "properties":{
        "accountId":{
            "type":"integer",
            "example":1,
            "description":"This value is the primary key for Gangway Ashore Validations"
        },
        "gateType":{
            "type":"string",
            "example":"Gangway",
            "description":"This value indicates which gate type."
        },
        "gateDirection":{
            "type":"integer",
            "example":"0",
            "description":"This is the value to indicate the gate entrance direction. 0 stands for Both Ways, 1 for Outwards and 2 for Inwards"
        }
    },
    "required":[
        "accountId",
        "gateType",
        "gateDirection"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Gangway Ashore Validations

Type: object

Title: Gangway Ashore Validations

Gangway Ashore Validations

Show Source

• accountId(optional): integer
  Guest profile Id.

  Example: 838014
• confiscatedItems(optional): string
  This list is to show the confiscated items
• gateMovement(optional): string
  This is the value to show gate movement

  Example: Double Outward
• guardianDetails(optional): string
  This list is to show the available guardian list for the minor.
• guardiansErrorMessage(optional): string
  This is the label error message to display on the guardian list for minor.
• guardiansMessage(optional): string
  This is the label message to display on the guardian list for minor.
• hasOvernightTour(optional): integer
  Guest has overnight tour or not. 1- has overnight tour, 0- no overnight tour

  Example: 1
• manifest(optional): boolean
  This is to indicate whether got manifest printout

  Example: false
• movementDirection(optional): string
  This is the value to show gate direction

  Example: out
• movementMessage(optional): string
  This is the warning message from movement.

  Example: Visitor is double outward entry!
• movementTitle(optional): string
  Example: Dual Movement Ashore Detected
• offboardStatus(optional): boolean
  This is to indicate the person is onboard or ashore. offboardStatus true means the person is ashore, false means the person is onboard

  Example: true
• overnightTourMessage(optional): string
  This is the label message to display to indicate whether the person got overnight tour.

  Example: <b>Bruno Eric Michael Jackson Raharison</b> is going for an overnight tour.
• resultSoundUrl(optional): string
  This is the value of result sound URL

  Example: /configurations/gangwaySecuritySounds/1234/sound
• warning(optional): boolean
  This is the value indicate whether this is a warning message.

  Example: true

{
    "title":"Gangway Ashore Validations",
    "description":"Gangway Ashore Validations",
    "type":"object",
    "properties":{
        "movementTitle":{
            "type":"string",
            "example":"Dual Movement Ashore Detected"
        },
        "gateMovement":{
            "type":"string",
            "example":"Double Outward",
            "description":"This is the value to show gate movement"
        },
        "movementDirection":{
            "type":"string",
            "example":"out",
            "description":"This is the value to show gate direction"
        },
        "movementMessage":{
            "type":"string",
            "example":"Visitor is double outward entry!",
            "description":"This is the warning message from movement."
        },
        "warning":{
            "type":"boolean",
            "example":true,
            "description":"This is the value indicate whether this is a warning message."
        },
        "accountId":{
            "type":"integer",
            "example":838014,
            "description":"Guest profile Id."
        },
        "hasOvernightTour":{
            "type":"integer",
            "example":"1",
            "description":"Guest has overnight tour or not. 1- has overnight tour, 0- no overnight tour"
        },
        "overnightTourMessage":{
            "type":"string",
            "example":"<b>Bruno Eric Michael Jackson Raharison</b> is going for an overnight tour.",
            "description":"This is the label message to display to indicate whether the person got overnight tour."
        },
        "manifest":{
            "type":"boolean",
            "example":false,
            "description":"This is to indicate whether got manifest printout"
        },
        "offboardStatus":{
            "type":"boolean",
            "example":true,
            "description":"This is to indicate the person is onboard or ashore. offboardStatus true means the person is ashore, false means the person is onboard"
        },
        "resultSoundUrl":{
            "type":"string",
            "example":"/configurations/gangwaySecuritySounds/1234/sound",
            "description":"This is the value of result sound URL"
        },
        "guardianDetails":{
            "type":"string",
            "description":"This list is to show the available guardian list for the minor."
        },
        "guardiansMessage":{
            "type":"string",
            "description":"This is the label message to display on the guardian list for minor."
        },
        "guardiansErrorMessage":{
            "type":"string",
            "description":"This is the label error message to display on the guardian list for minor."
        },
        "confiscatedItems":{
            "type":"string",
            "description":"This list is to show the confiscated items"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwayValidationErrorResponse"
        }
    ],
    "example":{
        "title":"Bad Request",
        "detail":"Gate Direction must be either 0,1 or 2.",
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
    }
}

Example:

{
    "title":"Bad Request",
    "detail":"Gate Direction must be either 0,1 or 2.",
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
}

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

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/GangwayValidationErrorResponse"
        }
    ],
    "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/GangwayValidationErrorResponse"
        }
    ],
    "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"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwayValidationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Account not found!"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Account not found!"
}

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/GangwayValidationErrorResponse"
        }
    ],
    "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"
        }
    }
}

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/GangwayValidationErrorResponse"
        }
    ],
    "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/GangwayValidationErrorResponse"
        }
    ],
    "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