Jump to

• Request
• Response

Validate gangway tender boat coming onboard rules

get

/spms/v2/ships/{shipId}/gatewaySecurity/tenderBoatGateway/tenderBoat/{tenderBoatId}/onboard/profiles/{profileId}/movementValidations/{gateDirection}

This is to check if the person comply with the gangway tender boat coming onboard rules and to display a list of all customized messages to allow or deny the person coming onboard

Request

Supported Media Types

• application/json

Path Parameters

• gateDirection: integer
  This is the tender boat direction, 1 = Outward, 2 = Inward only
• profileId: integer
  Profile identifier Number
• shipId: integer
  Ship identifier Number
• tenderBoatId: integer
  Tender Boat identifier Number

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Gangway Onboard Validations

Type: object

Title: Gangway Onboard Validations

Gangway Onboard Validations

Show Source

• accountId(optional): integer
  Profile Id.

  Example: 12345678
• confiscatedItems(optional): object confiscatedItems
  This list is to show the confiscated items
• gangwayCheckInValidation(optional): object gangwayCheckInValidation
  This list is to show the available message ,message type and soundurl
• gateMovement(optional): string
  This is the value to show gate movement

  Example: Double Outward
• guardianDetails(optional): object guardianDetails
  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.

  Example: A guardian should be physically present with his/her children
• guardiansMessage(optional): string
  This is the label message to display on the guardian list for minor.

  Example: Please verify the guardian is present to accompany the children
• hasOvernightTour(optional): boolean
  Guest has overnight tour or not. 1- has overnight tour, 0- no overnight tour

  Example: true
• manifest(optional): boolean
  This is to indicate whether got manifest printout. true - has manifest, false - no manifest

  Example: true
• movementDirection(optional): string
  This is the value to show people movement direction. Can only be IN or OUT

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

  Example: Visitor is double outward entry!
• movementTitle(optional): string
  This title will inform the user about the reason for the error

  Example: Dual Movement Onboard 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>John Doe</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. True means have warning messages and false is depend on the denyStatus either have error messages or success

  Example: true

{
    "title":"Gangway Onboard Validations",
    "description":"Gangway Onboard Validations",
    "type":"object",
    "properties":{
        "movementTitle":{
            "type":"string",
            "example":"Dual Movement Onboard Detected",
            "description":"This title will inform the user about the reason for the error"
        },
        "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 people movement direction. Can only be IN or OUT"
        },
        "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. True means have warning messages and false is depend on the denyStatus either have error messages or success"
        },
        "accountId":{
            "type":"integer",
            "example":12345678,
            "description":"Profile Id."
        },
        "hasOvernightTour":{
            "type":"boolean",
            "example":true,
            "description":"Guest has overnight tour or not. 1- has overnight tour, 0- no overnight tour"
        },
        "overnightTourMessage":{
            "type":"string",
            "example":"<b>John Doe</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":true,
            "description":"This is to indicate whether got manifest printout. true - has manifest, false - no manifest"
        },
        "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":"object",
            "description":"This list is to show the available guardian list for the minor.",
            "example":[
                {
                    "accountId":1234,
                    "guardians":[
                        {
                            "accountId":5678,
                            "salutation":"Mr.",
                            "firstName":"John",
                            "middleName":"Michael",
                            "lastName":"Doe",
                            "stateRoom":100,
                            "photoUrl":"https://oracle.com/resources/john.jpg",
                            "accountType":"P",
                            "links":[
                            ]
                        }
                    ]
                }
            ]
        },
        "guardiansMessage":{
            "type":"string",
            "example":"Please verify the guardian is present to accompany the children",
            "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.",
            "example":"A guardian should be physically present with his/her children"
        },
        "confiscatedItems":{
            "type":"object",
            "description":"This list is to show the confiscated items",
            "example":[
                1001,
                1002
            ]
        },
        "gangwayCheckInValidation":{
            "type":"object",
            "description":"This list is to show the available message ,message type and soundurl",
            "example":[
                {
                    "message":null,
                    "messageType":null,
                    "errorSoundUrl":null
                }
            ]
        }
    }
}

Nested Schema : confiscatedItems

Type: object

This list is to show the confiscated items

Example:

[
    1001,
    1002
]

Nested Schema : gangwayCheckInValidation

Type: object

This list is to show the available message ,message type and soundurl

Example:

[
    {
        "message":null,
        "messageType":null,
        "errorSoundUrl":null
    }
]

Nested Schema : guardianDetails

Type: object

This list is to show the available guardian list for the minor.

Example:

[
    {
        "accountId":1234,
        "guardians":[
            {
                "accountId":5678,
                "salutation":"Mr.",
                "firstName":"John",
                "middleName":"Michael",
                "lastName":"Doe",
                "stateRoom":100,
                "photoUrl":"https://oracle.com/resources/john.jpg",
                "accountType":"P",
                "links":[
                ]
            }
        ]
    }
]

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object List of Gangway Validation error response
  Title: List of Gangway Validation error response

  List of Gangway Validation error response

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwayValidationListErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"The parameter gateDirection has incorrect format"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"The parameter gateDirection has incorrect format"
}

Nested Schema : List of Gangway Validation error response

Type: object

Title: List of Gangway Validation error response

List of Gangway Validation error response

Show Source

• accountId(optional): integer
  Guest profile Id.

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

  Example: Double Outward
• guardianDetails(optional): object guardianDetails
  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.

  Example: A guardian should be physically present with his/her children
• guardiansMessage(optional): string
  This is the label message to display on the guardian list for minor.

  Example: Please verify the guardian is present to accompany the children
• hasOvernightTour(optional): boolean
  Guest has overnight tour or not. 1- has overnight tour, 0- no overnight tour

  Example: true
• manifest(optional): boolean
  This is to indicate whether got manifest printout. 1- has manifest, 0- no manifest

  Example: true
• movementDirection(optional): string
  This is the value to show people movement direction. Can only be IN or OUT

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

  Example: Visitor is double outward entry!
• movementTitle(optional): string
  This title will inform the user about the reason for the error

  Example: ONBOARD DENIED
• 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: John Doe 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. True means have warning messages and false is depend on the denyStatus either have error messages or success

  Example: 0

{
    "title":"List of Gangway Validation error response",
    "description":"List of Gangway Validation error response",
    "type":"object",
    "properties":{
        "movementTitle":{
            "type":"string",
            "example":"ONBOARD DENIED",
            "description":"This title will inform the user about the reason for the error"
        },
        "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 people movement direction. Can only be IN or OUT"
        },
        "movementMessage":{
            "type":"string",
            "example":"Visitor is double outward entry!",
            "description":"This is the warning message from movement."
        },
        "warning":{
            "type":"boolean",
            "example":0,
            "description":"This is the value indicate whether this is a warning message. True means have warning messages and false is depend on the denyStatus either have error messages or success"
        },
        "accountId":{
            "type":"integer",
            "example":12345678,
            "description":"Guest profile Id."
        },
        "hasOvernightTour":{
            "type":"boolean",
            "example":true,
            "description":"Guest has overnight tour or not. 1- has overnight tour, 0- no overnight tour"
        },
        "overnightTourMessage":{
            "type":"string",
            "example":"John Doe 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":true,
            "description":"This is to indicate whether got manifest printout. 1- has manifest, 0- no manifest"
        },
        "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":"object",
            "description":"This list is to show the available guardian list for the minor.",
            "example":[
                {
                    "accountId":1234,
                    "guardians":[
                        {
                            "accountId":5678,
                            "salutation":"Mr.",
                            "firstName":"John",
                            "middleName":"Michael",
                            "lastName":"Doe",
                            "stateRoom":100,
                            "photoUrl":"https://oracle.com/resources/john.jpg",
                            "accountType":"P",
                            "links":[
                            ]
                        }
                    ]
                }
            ]
        },
        "guardiansMessage":{
            "type":"string",
            "description":"This is the label message to display on the guardian list for minor.",
            "example":"Please verify the guardian is present to accompany the children"
        },
        "guardiansErrorMessage":{
            "type":"string",
            "description":"This is the label error message to display on the guardian list for minor.",
            "example":"A guardian should be physically present with his/her children"
        },
        "confiscatedItems":{
            "type":"object",
            "description":"This list is to show the confiscated items",
            "example":[
                1001,
                1002
            ]
        },
        "details":{
            "type":"array",
            "description":"details",
            "items":{
                "example":[
                    {
                        "step":"SHORESIDE DENIED",
                        "override":true,
                        "error":{
                            "errorPath":"shoreLeaveDenied",
                            "message":"Please approach a crew member."
                        },
                        "soundUrl":"/configurations/gangwaySecuritySounds/4567/sound"
                    }
                ]
            }
        }
    }
}

Nested Schema : confiscatedItems

Type: object

This list is to show the confiscated items

Example:

[
    1001,
    1002
]

Nested Schema : details

Type: array

details

Show Source

• Array of:
  Example: [ { "step":"SHORESIDE DENIED", "override":true, "error":{ "errorPath":"shoreLeaveDenied", "message":"Please approach a crew member." }, "soundUrl":"/configurations/gangwaySecuritySounds/4567/sound" } ]

{
    "type":"array",
    "description":"details",
    "items":{
        "example":[
            {
                "step":"SHORESIDE DENIED",
                "override":true,
                "error":{
                    "errorPath":"shoreLeaveDenied",
                    "message":"Please approach a crew member."
                },
                "soundUrl":"/configurations/gangwaySecuritySounds/4567/sound"
            }
        ]
    }
}

Nested Schema : guardianDetails

Type: object

This list is to show the available guardian list for the minor.

Example:

[
    {
        "accountId":1234,
        "guardians":[
            {
                "accountId":5678,
                "salutation":"Mr.",
                "firstName":"John",
                "middleName":"Michael",
                "lastName":"Doe",
                "stateRoom":100,
                "photoUrl":"https://oracle.com/resources/john.jpg",
                "accountType":"P",
                "links":[
                ]
            }
        ]
    }
]

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/TenderBoatValidationErrorResponse"
        }
    ],
    "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
  Example: There are validation errors for the object......
• 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",
            "example":"There are validation errors for the object......"
        }
    }
}

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/TenderBoatValidationErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource is forbidden"
    }
}

Example:

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

Nested 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
• 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",
            "example":"There are validation errors for the object......"
        }
    }
}

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/TenderBoatValidationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Ship 18600000117 was not found"
    }
}

Example:

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

Nested 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
• 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",
            "example":"There are validation errors for the object......"
        }
    }
}

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

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 : 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
• 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",
            "example":"There are validation errors for the object......"
        }
    }
}

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/TenderBoatValidationErrorResponse"
        }
    ],
    "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
  Example: There are validation errors for the object......
• 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",
            "example":"There are validation errors for the object......"
        }
    }
}

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

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 : 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
• 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",
            "example":"There are validation errors for the object......"
        }
    }
}

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/TenderBoatValidationErrorResponse"
        }
    ],
    "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
  Example: There are validation errors for the object......
• 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",
            "example":"There are validation errors for the object......"
        }
    }
}

Back to Top