Oracle Hospitality Cruise Property Management REST API 23.2.2

Create a new internal gate activity movement

post

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

This is to create a new internal gate activity movement

Request

Supported Media Types

application/json

Path Parameters

shipId(required): number

Ship Id

Root Schema : Internal Gate Movements Request Body

Type: object

Title: Internal Gate Movements Request Body

Show Source

gateDirection(required): integer

Minimum Value: 0

Maximum Value: 2

Allowed Values: [ "0", "1", "2" ]

The internal gate direction: * 0 - Bothways * 1 - Outward * 2 - Inward

Example: 1
gatewaySecurityRuleIds: array gatewaySecurityRuleIds
locationId(required): integer(int64)

Minimum Value: 0

Maximum Value: 100000000000000000000000000000000000000

Internal gate location id.

Example: 12345678
profileId(required): integer(int64)

Minimum Value: 0

Maximum Value: 100000000000000000000000000000000000000

Profile Id.

Example: 12345678

{
    "title":"Internal Gate Movements Request Body",
    "type":"object",
    "properties":{
        "profileId":{
            "type":"integer",
            "format":"int64",
            "minimum":"0",
            "maximum":"100000000000000000000000000000000000000",
            "example":"12345678",
            "description":"Profile Id."
        },
        "gateDirection":{
            "type":"integer",
            "minimum":"0",
            "maximum":"2",
            "example":"1",
            "description":"The internal gate direction:\n * 0 - Bothways\n * 1 - Outward\n * 2 - Inward\n",
            "enum":[
                "0",
                "1",
                "2"
            ]
        },
        "locationId":{
            "type":"integer",
            "format":"int64",
            "minimum":"0",
            "maximum":"100000000000000000000000000000000000000",
            "example":"12345678",
            "description":"Internal gate location id."
        },
        "gatewaySecurityRuleIds":{
            "type":"array",
            "example":[
                "123",
                "456"
            ],
            "items":{
                "type":"integer",
                "minimum":"0",
                "maximum":"100000000000000000000000000000000000000",
                "description":"Gateway security rules id"
            }
        }
    },
    "required":[
        "profileId",
        "gateDirection",
        "locationId"
    ]
}

Nested Schema : gatewaySecurityRuleIds

Type: array

Show Source

Array of: integer

Minimum Value: 0

Maximum Value: 100000000000000000000000000000000000000

Gateway security rules id

{
    "type":"array",
    "example":[
        "123",
        "456"
    ],
    "items":{
        "type":"integer",
        "minimum":"0",
        "maximum":"100000000000000000000000000000000000000",
        "description":"Gateway security rules id"
    }
}

Example:

[
    "123",
    "456"
]

Response

Supported Media Types

application/json

201 Response

Created

Root Schema : Internal Gate Rules Movements Response

Type: object

Title: Internal Gate Rules Movements Response

Internal Gate Rules Movements Response

Show Source

gateMovement: string

The value to show internal gate movement.

Example: GATE PASS-IN
locationCode: string

Internal gate location code. Please refer to TYP_GWL.TYP_ART.

Example: G1
locationId: integer

Internal gate location id.

Example: 12345678
profileId: integer

Profile Id

Example: 12345678

{
    "title":"Internal Gate Rules Movements Response",
    "description":"Internal Gate Rules Movements Response",
    "type":"object",
    "properties":{
        "profileId":{
            "type":"integer",
            "example":"12345678",
            "description":"Profile Id"
        },
        "locationId":{
            "type":"integer",
            "example":"12345678",
            "description":"Internal gate location id."
        },
        "locationCode":{
            "type":"string",
            "example":"G1",
            "description":"Internal gate location code. Please refer to TYP_GWL.TYP_ART."
        },
        "gateMovement":{
            "type":"string",
            "example":"GATE PASS-IN",
            "description":"The value to show internal gate movement."
        }
    }
}

400 Response

Bad Request

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/InternalGateMovementsErrorResponse"
        }
    ],
    "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"
            }
        ]
    }
}

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

detail: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/InternalGateMovementsErrorResponse"
        }
    ],
    "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: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/InternalGateMovementsErrorResponse"
        }
    ],
    "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: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

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

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

detail: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/InternalGateMovementsErrorResponse"
        }
    ],
    "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: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

406 Response

Not Acceptable

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/InternalGateMovementsErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
        "title":"Not Acceptable",
        "detail":"PASS OUT NOT ALLOWED. GATE is INWARDS ONLY. PLEASE USE ANOTHER GATE"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
    "title":"Not Acceptable",
    "detail":"PASS OUT NOT ALLOWED. GATE is INWARDS ONLY. PLEASE USE ANOTHER GATE"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/InternalGateMovementsErrorResponse"
        }
    ],
    "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: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/InternalGateMovementsErrorResponse"
        }
    ],
    "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: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}