1. Oracle Hospitality Cruise Property Management REST API 23.2.2
  2. Tasks
  3. Configurations
  4. GatewaySecurityRules

Retrieve a list of all gateway security rules

get

/spms/v2/ships/{shipId}/configurations/gatewaySecurityRules

This is to retrieve a list of all gateway security rules

Request

Supported Media Types
Path Parameters
Query Parameters
  • This is for filtering the direction * 0 - Both ways * 1 - Entry / Shore to Ship * 2 - Exit / Ship to Shore
    Allowed Values: [ "0", "1", "2" ]
  • This is for filtering the gateway type * 0 - Internal Gate * 1 - Immigration Gate * 2 - Gangway / Tender
    Allowed Values: [ "0", "1", "2" ]
  • This is for filtering if the rule is active or not
  • Minimum Value: 1
    Paging limit
  • Minimum Value: 0
    Paging offset
  • order by id, name, gatewayType, direction, isActive with format column1:asc/desc,column2:asc/desc column3:asc/desc
Back to Top

Response

Supported Media Types

200 Response

Ok
Body ()
Root Schema : Gateway Security Rules Success Oracle Responses list
Type: object
Title: Gateway Security Rules Success Oracle Responses list
The wrapper object when returning successful values in Oracle standard
Show Source
Nested Schema : items
Type: array
Show Source
Example:
[
    {
        "id":"1",
        "name":"Guest Confiscated Items",
        "gatewayType":"0",
        "message":"Please collect your confiscated item first.",
        "processType":"3",
        "direction":"0",
        "isActive":true,
        "isValidateOnGuestProfile":true,
        "isValidateOnCrewProfile":false,
        "isValidateOnVisitorProfile":false
    },
    {
        "id":"2",
        "name":"Do not allow minor without guardian to go shoreside",
        "gatewayType":"1",
        "message":"Do not allow minor without guardian to go shoreside",
        "processType":"0",
        "direction":"0",
        "isActive":true,
        "isValidateOnGuestProfile":true,
        "isValidateOnCrewProfile":false,
        "isValidateOnVisitorProfile":false
    },
    {
        "id":"3",
        "name":"Crew on Roster Duty Security Alert",
        "gatewayType":"0",
        "message":"This crew has a roster daily scheduled for today. Do you want to override?",
        "processType":"1",
        "direction":"1",
        "isActive":true,
        "isValidateOnGuestProfile":false,
        "isValidateOnCrewProfile":true,
        "isValidateOnVisitorProfile":false
    }
]
Nested Schema : gatewaySecurityRulesPayload
Type: object
payload
Show Source
  • Allowed Values: [ "0", "1", "2" ]
    Indicates the direction the rule is applied to * 0 - Both ways * 1 - Entry / Shore to Ship * 2 - Exit / Ship to Shore
  • Allowed Values: [ "0", "1", "2" ]
    Indicates whether the rule is applicable to which gateway security type * 0 - Internal Gate * 1 - Immigration Gate * 2 - Gangway / Tender
    Example: High Spender
  • Minimum Value: 1
    Gateway Security Rule Id
    Example: 12345678
  • Flag which indicates if the rule is active
    Example: true
  • Flag which indicates if the rule is applicable for crew/staff profiles
    Example: true
  • Flag which indicates if the rule is applicable for guest/resident profiles
    Example: true
  • Flag which indicates if the rule is applicable for visitor profiles
    Example: true
  • Maximum Length: 500
    Gateway Security Rule Message
    Example: Please collect your confiscated item first.
  • Maximum Length: 500
    Gateway Security Rule Name
    Example: Guest Confiscated Item
  • Allowed Values: [ "0", "1", "2", "3" ]
    Indicates the process type for the rule * 0 - Override Not Allowed * 1 - Override Allow * 2 - Send Alert e-Mail only (Always Allowed) * 3 - Show Message Only
    Example: 0

204 Response

No Content

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 'shipId' has incorrect format"
}
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":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"You are forbidden to use this API"
}
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":"Ship Id could not be 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":"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

415 Response

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

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

501 Response

Not Implemented
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2",
    "title":"Not implemented",
    "detail":"Resource is not implemented in this version of the API"
}
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":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service not available"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source
Back to Top