Jump to

• Request
• Response

Save the tender boat movement and other related information

post

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

This is to save the tender boat movement and other related information once the tender boat movement is success

Request

Supported Media Types

• application/json

Path Parameters

• shipId: string
  Ship identifier Number

Body ()

Required fields to create Tender Boat

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(optional): array confiscatedItemIds
  The id of the confiscated item(s)
• denyStatus: boolean
  Deny Status. True means have error messages and false is success

  Example: true
• gateDirection: number
  This is the tender boat direction. 1- Outward, 2- Inward

  Example: 2
• gateLocation: string
  Location of the gate

  Example: Guest Gangway
• gateMovement: string
  The movement the passenger is trying to do. It can be Coming On-board or Going Shore-side

  Example: Coming On-board
• gateType: string
  Gate type. Can be Gangway or Tender

  Example: Gangway
• manifest(optional): boolean
  This is to indicate whether got manifest printout. 1- has manifest, 0- no manifest

  Example: true
• movementDirection: string
  This is the value to show people movement direction. Can only be IN or OUT

  Example: IN
• offBoardStatus: boolean
  This is to indicate the person is onboard or ashore. offboardStatus true means the person is ashore, false means the person is onboard

  Example: true
• overnightTour(optional): integer
  Guest has overnight tour or not. 1- has overnight tour, 0- no overnight tour

  Example: 1
• profileId: number
  Profile Id

  Example: 980000
• reservationId: number
  Reservation Id

  Example: 989322
• tenderBoatId: number
  Tender Boat Id

  Example: 989322
• warning: boolean
  This is the value indicate whether this is a warning message. True means have warning messages and false is depend on the denyStatus either have error messages or success

  Example: true
• workStation: string
  Workstation

  Example: workplace

{
    "title":"request parameter for gangway security movement",
    "description":"request parameter for gangway security movement",
    "type":"object",
    "properties":{
        "tenderBoatId":{
            "type":"number",
            "description":"Tender Boat Id",
            "example":989322
        },
        "profileId":{
            "type":"number",
            "description":"Profile Id",
            "example":980000
        },
        "reservationId":{
            "type":"number",
            "description":"Reservation Id",
            "example":989322
        },
        "workStation":{
            "type":"string",
            "description":"Workstation",
            "example":"workplace"
        },
        "gateLocation":{
            "type":"string",
            "description":"Location of the gate",
            "example":"Guest Gangway"
        },
        "gateMovement":{
            "type":"string",
            "description":"The movement the passenger is trying to do. It can be Coming On-board or Going Shore-side",
            "example":"Coming On-board"
        },
        "denyStatus":{
            "type":"boolean",
            "description":"Deny Status. True means have error messages and false is success",
            "example":true
        },
        "overnightTour":{
            "type":"integer",
            "example":1,
            "description":"Guest has overnight tour or not. 1- has overnight tour, 0- no overnight tour"
        },
        "warning":{
            "type":"boolean",
            "description":"This is the value indicate whether this is a warning message. True means have warning messages and false is depend on the denyStatus either have error messages or success",
            "example":true
        },
        "movementDirection":{
            "type":"string",
            "description":"This is the value to show people movement direction. Can only be IN or OUT",
            "example":"IN"
        },
        "manifest":{
            "type":"boolean",
            "description":"This is to indicate whether got manifest printout. 1- has manifest, 0- no manifest",
            "example":true
        },
        "offBoardStatus":{
            "type":"boolean",
            "description":"This is to indicate the person is onboard or ashore. offboardStatus true means the person is ashore, false means the person is onboard",
            "example":true
        },
        "gateType":{
            "type":"string",
            "description":"Gate type. Can be Gangway or Tender",
            "example":"Gangway"
        },
        "gateDirection":{
            "type":"number",
            "description":"This is the tender boat direction. 1- Outward, 2- Inward",
            "example":2
        },
        "confiscatedItemIds":{
            "type":"array",
            "description":"The id of the confiscated item(s)",
            "items":{
                "properties":{
                    "status":{
                        "type":"array",
                        "description":"confiscated Item list",
                        "example":[
                            1001,
                            1002
                        ]
                    }
                }
            }
        }
    },
    "required":[
        "tenderBoatId",
        "profileId",
        "reservationId",
        "gateMovement",
        "warning",
        "denyStatus",
        "movementDirection",
        "offBoardStatus",
        "gateDirection",
        "gateType",
        "workStation",
        "gateLocation"
    ]
}

Nested Schema : confiscatedItemIds

Type: array

The id of the confiscated item(s)

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The id of the confiscated item(s)",
    "items":{
        "properties":{
            "status":{
                "type":"array",
                "description":"confiscated Item list",
                "example":[
                    1001,
                    1002
                ]
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• status(optional): array status
  confiscated Item list

{
    "properties":{
        "status":{
            "type":"array",
            "description":"confiscated Item list",
            "example":[
                1001,
                1002
            ]
        }
    }
}

Nested Schema : status

Type: array

confiscated Item list

Example:

[
    1001,
    1002
]

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created

Body ()

Root Schema : The response for creating a tender boar inventory entry

Type: object

Title: The response for creating a tender boar inventory entry

The response for creating a tender boar inventory entry

Show Source

• active(optional): boolean
  Indicates whether the passenger is currently on the tender boat

  Example: true
• createdBy(optional): number
  Created By

  Example: 98900
• createdDate(optional): string
  Created Date

  Example: 27-10-2020T13:00:00
• id(optional): number
  Example: 989322
• modifiedBy(optional): number
  Modified By

  Example: 98900
• modifiedDate(optional): string
  Modified Date

  Example: 27-10-2020T13:00:00
• profileId(optional): number
  Profile Id

  Example: 12345678
• tenderBoatId(optional): number
  Tender Boat Id

  Example: 12345678

{
    "title":"The response for creating a tender boar inventory entry",
    "description":"The response for creating a tender boar inventory entry",
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "example":989322
        },
        "tenderBoatId":{
            "type":"number",
            "description":"Tender Boat Id",
            "example":12345678
        },
        "profileId":{
            "type":"number",
            "description":"Profile Id",
            "example":12345678
        },
        "active":{
            "type":"boolean",
            "description":"Indicates whether the passenger is currently on the tender boat",
            "example":true
        },
        "createdDate":{
            "type":"string",
            "description":"Created Date",
            "example":"27-10-2020T13:00:00"
        },
        "createdBy":{
            "type":"number",
            "description":"Created By",
            "example":98900
        },
        "modifiedDate":{
            "type":"string",
            "description":"Modified Date",
            "example":"27-10-2020T13:00:00"
        },
        "modifiedBy":{
            "type":"number",
            "description":"Modified By",
            "example":98900
        }
    }
}

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/TenderBoatValidationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"The parameter gateDirection has incorrect format"
    }
}

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 : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

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/TenderBoatValidationErrorResponse"
        }
    ],
    "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(optional): string
  Example: There are validation errors for the object......
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

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/TenderBoatValidationErrorResponse"
        }
    ],
    "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(optional): string
  Example: There are validation errors for the object......
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

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/TenderBoatValidationErrorResponse"
        }
    ],
    "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(optional): string
  Example: There are validation errors for the object......
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

406 Response

Not Acceptable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

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

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

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/TenderBoatValidationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Invalid content",
        "detail":"Content type not supported"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "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(optional): string
  Example: There are validation errors for the object......
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

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/TenderBoatValidationErrorResponse"
        }
    ],
    "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(optional): string
  Example: There are validation errors for the object......
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

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/TenderBoatValidationErrorResponse"
        }
    ],
    "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(optional): string
  Example: There are validation errors for the object......
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

Back to Top