Jump to

• Request
• Response

Create a new gangway activity movement

post

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

This is to create a new gangway activity movement

Request

Supported Media Types

• application/json

Path Parameters

• shipId(required): integer
  Ship identifier Number

Body ()

Required to create and update gangway security movement

Root Schema : request parameter for gangway security movement

Type: object

Title: request parameter for gangway security movement

request parameter for gangway security movement

Show Source

• confiscatedItemIds: array confiscatedItemIds
  The id of the confiscated item(s)
• denyStatus: boolean
  Example: true
• gateDirection: number
  Example: 2
• gateLocation: string
  Minimum Length: 1

  Maximum Length: 50

  Pattern: ^[ A-Za-z0-9_@./#&+-]*$

  Example: Guest Gangway
• gateMovement: string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[ A-Za-z0-9_@./#&+-]*$

  Example: Coming On-board
• gateType: string
  Example: Gangway
• manifest: boolean
  Example: true
• movementDirection: string
  Minimum Length: 1

  Maximum Length: 10

  Pattern: ^[ A-Za-z0-9_@./#&+-]*$

  Example: IN
• offBoardStatus: boolean
  Example: true
• overnightTour: number
  Example: 1
• reservationId(required): number
  Example: 989322
• warning: boolean
  Example: true
• workStation: string
  Minimum Length: 1

  Maximum Length: 50

  Pattern: ^[ A-Za-z0-9_@./#&+-]*$

  Example: workplace

{
    "title":"request parameter for gangway security movement",
    "description":"request parameter for gangway security movement",
    "type":"object",
    "properties":{
        "reservationId":{
            "type":"number",
            "example":"989322"
        },
        "workStation":{
            "type":"string",
            "pattern":"^[ A-Za-z0-9_@./#&+-]*$",
            "minLength":"1",
            "maxLength":"50",
            "example":"workplace"
        },
        "gateLocation":{
            "type":"string",
            "pattern":"^[ A-Za-z0-9_@./#&+-]*$",
            "minLength":"1",
            "maxLength":"50",
            "example":"Guest Gangway"
        },
        "gateMovement":{
            "type":"string",
            "pattern":"^[ A-Za-z0-9_@./#&+-]*$",
            "minLength":"1",
            "maxLength":"30",
            "example":"Coming On-board"
        },
        "denyStatus":{
            "type":"boolean",
            "example":true
        },
        "overnightTour":{
            "type":"number",
            "example":"1"
        },
        "warning":{
            "type":"boolean",
            "example":true
        },
        "movementDirection":{
            "type":"string",
            "pattern":"^[ A-Za-z0-9_@./#&+-]*$",
            "minLength":"1",
            "maxLength":"10",
            "example":"IN"
        },
        "manifest":{
            "type":"boolean",
            "example":true
        },
        "offBoardStatus":{
            "type":"boolean",
            "example":true
        },
        "gateType":{
            "type":"string",
            "example":"Gangway"
        },
        "gateDirection":{
            "type":"number",
            "example":"2"
        },
        "confiscatedItemIds":{
            "type":"array",
            "description":"The id of the confiscated item(s)",
            "items":{
                "$ref":"#/definitions/confiscatedItemIdList"
            }
        }
    },
    "required":[
        "reservationId"
    ]
}

Nested Schema : confiscatedItemIds

Type: array

The id of the confiscated item(s)

Show Source

• Array of: string
  Confiscated Item list

{
    "type":"array",
    "description":"The id of the confiscated item(s)",
    "items":{
        "$ref":"#/definitions/confiscatedItemIdList"
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

Example:

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

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

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwaySecurityMovementErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource was forbidden"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource was 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

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwaySecurityMovementErrorResponse"
        }
    ],
    "example":{
        "title":"Not Found",
        "detail":"Account Id is invalid",
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
    }
}

Example:

{
    "title":"Not Found",
    "detail":"Account Id is invalid",
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
}

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

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

409 Response

Conflict

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwaySecurityMovementErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
        "title":"Conflict",
        "detail":"Method Not Allowed"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
    "title":"Conflict",
    "detail":"Method Not Allowed"
}

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"
        }
    }
}

415 Response

Unsupported Media Type

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwaySecurityMovementErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Invalid content",
        "detail":"Content type not supported"
    }
}

Example:

{
    "type":"https://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

• 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

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GangwaySecurityMovementErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable.  Try again later"
    }
}

Example:

{
    "type":"http://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"
        }
    }
}

Back to Top