1. Oracle Hospitality Cruise Property Management REST API 23.2.2
  2. Tasks
  3. Gateway Security
  4. Internal Gate

Validate internal location rules

post

/spms/v2/ships/{shipId}/gatewaySecurity/internalGate/validations

This is to check if a person complies with the internal location rules

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : Internal Gate Validations Request Body
Type: object
Title: Internal Gate Validations Request Body
Show Source
Nested Schema : gatewaySecurityRuleIds
Type: array
Show Source
  • Minimum Value: 0
    Maximum Value: 100000000000000000000000000000000000000
    Gateway security rules id
Example:
[
    "123",
    "456"
]
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Internal Gate Rules Validations Response
Type: object
Title: Internal Gate Rules Validations Response
Internal Gate Rules Validations Response
Show Source
Nested Schema : movementMessages
Type: array
Show Source
Nested Schema : MovementMessages
Type: object
List of messages that may require user attention.
Show Source
  • The description of the message.
    Example: Do you want to allow this person to exit from the previous location G2 then move into this location?
  • Allowed Values: [ "error", "confirmation", "preconfirmation" ]
    The movement message type: * error - Indicate the message is error type. * confirmation - Indicate the message is confirmation type. * preconfirmation - Indicate the message is preconfirmation type.
    Example: confirmation

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":[
        {
            "errorPath":"profileId",
            "message":"must be greater than or equals to 0"
        },
        {
            "errorPath":"gateDirection",
            "message":"Value must be between 0 and 2"
        },
        {
            "errorPath":"locationId",
            "message":"must be greater than or equals to 0"
        }
    ]
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

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":"Profile Id 12345678 not found."
}
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":"PASS IN NOT ALLOWED. GATE IS OUTWARDS ONLY. PLEASE USE ANOTHER GATE."
}
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