Jump to

• Request
• Response

Retrieve the opened tenderboat gateway details

get

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

This is to retrieve the opened tender boat gateway details

Request

Supported Media Types

• application/json

Path Parameters

• shipId: number(12345678)
  Ship ID

Query Parameters

• enabled: boolean
  Returns tender boat gateway which is active or inactive
• limit: integer(int32)
  Paging limit
• locationCode: string
  Search Value based on the location code
• offset: integer(int32)
  Paging offset
• orderBy: string
  order by tenderBoatId or locationCode. Format: column tenderBoatId:asc or desc. if multiple columns needed then split it by comma
• tenderBoatId: integer(12345678)
  Tender Boat Id

Back to Top

Response

Supported Media Types

• applicaton/json

200 Response

OK

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Retrieve Tender Boat Gateway
  Title: Retrieve Tender Boat Gateway

  Retrieve Tender Boat Gateway

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TenderBoatHandling"
    }
}

Nested Schema : Retrieve Tender Boat Gateway

Type: object

Title: Retrieve Tender Boat Gateway

Retrieve Tender Boat Gateway

Show Source

• count(optional): integer
  Example: 12345678
• hasMore(optional): boolean
  Example: true
• items(optional): array items
• limit(optional): integer
  Example: 10
• offset(optional): integer
  Example: 1

{
    "title":"Retrieve Tender Boat Gateway",
    "description":"Retrieve Tender Boat Gateway",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "example":12345678
        },
        "hasMore":{
            "type":"boolean",
            "example":true
        },
        "offset":{
            "type":"integer",
            "example":1
        },
        "limit":{
            "type":"integer",
            "example":10
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GetTenderBoatGatewayInformationResponse"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: GetTenderBoatGatewayInformationResponse

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GetTenderBoatGatewayInformationResponse"
    }
}

Nested Schema : GetTenderBoatGatewayInformationResponse

Match All

Show Source

• object GetTenderBoatGatewayInformationResponse-allOf[0]
• object TenderBoatGatewayInformation
  Title: TenderBoatGatewayInformation

{
    "allOf":[
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"number",
                    "description":"Tender boat gateway id",
                    "example":12345678
                },
                "locationName":{
                    "type":"string",
                    "description":"Location Name",
                    "example":"Gangway A Entrance"
                },
                "tenderBoatName":{
                    "pattern":"[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\\|,.\":;{}[]",
                    "type":"string",
                    "example":"Tender boat 1"
                },
                "dateTime":{
                    "type":"string",
                    "description":"Opened tender boat datetime",
                    "example":"2013-07-16T19:23"
                },
                "tenderBoatStatus":{
                    "type":"boolean",
                    "description":"true is opening , false is closed",
                    "example":true
                },
                "tenderBoatGatewayUsers":{
                    "type":"array",
                    "items":[
                        {
                            "$ref":"#/definitions/TenderBoatGatewayUserInformation"
                        }
                    ]
                }
            }
        },
        {
            "$ref":"#/definitions/TenderBoatGatewayInformation"
        }
    ]
}

Nested Schema : GetTenderBoatGatewayInformationResponse-allOf[0]

Type: object

Show Source

• dateTime(optional): string
  Opened tender boat datetime

  Example: 2013-07-16T19:23
• id(optional): number
  Tender boat gateway id

  Example: 12345678
• locationName(optional): string
  Location Name

  Example: Gangway A Entrance
• tenderBoatGatewayUsers(optional): array tenderBoatGatewayUsers
• tenderBoatName(optional): string
  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  Example: Tender boat 1
• tenderBoatStatus(optional): boolean
  true is opening , false is closed

  Example: true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "description":"Tender boat gateway id",
            "example":12345678
        },
        "locationName":{
            "type":"string",
            "description":"Location Name",
            "example":"Gangway A Entrance"
        },
        "tenderBoatName":{
            "pattern":"[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\\|,.\":;{}[]",
            "type":"string",
            "example":"Tender boat 1"
        },
        "dateTime":{
            "type":"string",
            "description":"Opened tender boat datetime",
            "example":"2013-07-16T19:23"
        },
        "tenderBoatStatus":{
            "type":"boolean",
            "description":"true is opening , false is closed",
            "example":true
        },
        "tenderBoatGatewayUsers":{
            "type":"array",
            "items":[
                {
                    "$ref":"#/definitions/TenderBoatGatewayUserInformation"
                }
            ]
        }
    }
}

Nested Schema : TenderBoatGatewayInformation

Type: object

Title: TenderBoatGatewayInformation

Show Source

• direction(optional): string
  This is the tender boat direction, 1 = Outward, 2 = Inward only

  Example: 1
• locationCode(optional): string
  Location code

  Example: GA1
• tenderBoatId(optional): number
  Tender Boat ID

  Example: 12345678

{
    "title":"TenderBoatGatewayInformation",
    "type":"object",
    "properties":{
        "tenderBoatId":{
            "type":"number",
            "description":"Tender Boat ID",
            "example":12345678
        },
        "locationCode":{
            "description":"Location code",
            "type":"string",
            "example":"GA1"
        },
        "direction":{
            "description":"This is the tender boat direction, 1 = Outward,  2\t= Inward only",
            "type":"string",
            "example":"1"
        }
    }
}

Nested Schema : tenderBoatGatewayUsers

Type: array

Show Source

• Array of: TenderBoatGatewayUserInformation

{
    "type":"array",
    "items":[
        {
            "$ref":"#/definitions/TenderBoatGatewayUserInformation"
        }
    ]
}

Nested Schema : TenderBoatGatewayUserInformation

Match All

Show Source

• object TenderBoatGatewayUserInformation-allOf[0]

{
    "allOf":[
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"number",
                    "description":"User id",
                    "example":123456
                },
                "name":{
                    "type":"string",
                    "description":"User name",
                    "example":"user1"
                }
            }
        }
    ]
}

Nested Schema : TenderBoatGatewayUserInformation-allOf[0]

Type: object

Show Source

• id(optional): number
  User id

  Example: 123456
• name(optional): string
  User name

  Example: user1

{
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "description":"User id",
            "example":123456
        },
        "name":{
            "type":"string",
            "description":"User name",
            "example":"user1"
        }
    }
}

204 Response

No Contents

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/TenderBoatGatewayErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"Invalid tenderboat gateway location id"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"Invalid tenderboat gateway location id"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• 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"
        }
    }
}

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/TenderBoatGatewayErrorResponse"
        }
    ],
    "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
• 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"
        }
    }
}

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/TenderBoatGatewayErrorResponse"
        }
    ],
    "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(optional): string
• 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"
        }
    }
}

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/TenderBoatGatewayErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Ship 123 was not found"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Ship 123 was not found"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• 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"
        }
    }
}

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/TenderBoatGatewayErrorResponse"
        }
    ],
    "example":{
        "type":"https://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":"https://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
• 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"
        }
    }
}

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/TenderBoatGatewayErrorResponse"
        }
    ],
    "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
• 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"
        }
    }
}

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/TenderBoatGatewayErrorResponse"
        }
    ],
    "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(optional): string
• 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"
        }
    }
}

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/TenderBoatGatewayErrorResponse"
        }
    ],
    "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
• 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"
        }
    }
}

Back to Top