1. Oracle Hospitality Cruise REST API
  2. Tasks
  3. Gateway Security
  4. Gangway

Validate gangway coming onboard rules

get

/spms/v2/ships/{shipId}/gatewaySecurity/gangway/onboard/profiles/{profileId}/movementValidations/{gateDirection}

This is to check if the person complies with the gangway coming onboard rules

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Gangway Onboard Validations
Type: object
Title: Gangway Onboard Validations
Gangway Onboard Validations
Show Source
Nested Schema : confiscatedItems
Type: array
Show Source
Nested Schema : gangwayCheckInValidation
Type: array
Show Source
  • checkIn
    This list only applicable for the profile who required to check-in. If the profile do not required to check-in, It will not display any value in each fields.
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":[
                ]
            }
        ]
    }
]
Nested Schema : checkIn
Type: object
This list only applicable for the profile who required to check-in. If the profile do not required to check-in, It will not display any value in each fields.
Show Source
  • This is a check-in fail sound URL
    Example: /configurations/gangwaySecuritySounds/1234/sound
  • Minimum Length: 0
    Maximum Length: 255
    If the validation required user action, system will show confirmation message otherwise it will show error message or success message
    Example: Guest is expected today. Do you want to check-in?
  • Minimum Length: 0
    Maximum Length: 12
    This is to indicate the message field is confirmation type , information type or error type
    Example: confirmation,information,error

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":"The parameter gateDirection has incorrect format"
}
Nested Schema : Gangway Onboard Validations
Type: object
Title: Gangway Onboard Validations
Gangway Onboard Validations
Show Source
Nested Schema : confiscatedItems
Type: array
Show Source
Nested Schema : gangwayCheckInValidation
Type: array
Show Source
  • checkIn
    This list only applicable for the profile who required to check-in. If the profile do not required to check-in, It will not display any value in each fields.
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":[
                ]
            }
        ]
    }
]
Nested Schema : checkIn
Type: object
This list only applicable for the profile who required to check-in. If the profile do not required to check-in, It will not display any value in each fields.
Show Source
  • This is a check-in fail sound URL
    Example: /configurations/gangwaySecuritySounds/1234/sound
  • Minimum Length: 0
    Maximum Length: 255
    If the validation required user action, system will show confirmation message otherwise it will show error message or success message
    Example: Guest is expected today. Do you want to check-in?
  • Minimum Length: 0
    Maximum Length: 12
    This is to indicate the message field is confirmation type , information type or error type
    Example: confirmation,information,error

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 : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

403 Response

Forbidden
Body ()
Root Schema : schema
Match All
Show Source
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

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":"This resource path does not exist"
}
Nested Schema : Error Response
Type: object
Title: Error Response
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 : Error Response
Type: object
Title: Error Response
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 : Error Response
Type: object
Title: Error Response
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 : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

503 Response

Service Unavailable
Body ()
Root Schema : schema
Match All
Show Source
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
Back to Top