Jump to

• Request
• Response

Retrieve configured Lifeboats

get

/spms/v2/ships/{shipId}/configurations/safety/lifeBoats

This is to retrieve the configured Lifeboats

Request

Supported Media Types

• application/json

Path Parameters

• shipId: number
  ship Id

Query Parameters

• lifeBoatId: integer
  Lifeboat Id
• lifeBoatName: string
  Lifeboat Short Name
• lifeBoatType: string
  Type of boat
• limit: integer(int32)
  Minimum Value: 0

  Paging limit
• offset: integer(int32)
  Minimum Value: 0

  Paging offset
• orderBy: string
  Minimum Value: 0

  order by lifeBoatId, lifeBoatName, lifeBoatType with format column1:asc/desc,column2:asc/desc,column3:asc/desc

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Lifeboat Response List

Type: object

Title: Lifeboat Response List

The wrapper object when returning successful values in Oracle standard

Show Source

• count(optional): number
  The total number of items in the list.

  Example: 11
• hasMore(optional): boolean
  Flag which indicates whether or not there are more items.

  Example: false
• items(optional): array items
• limit(optional): number
  Paging limit

  Example: 1
• offset(optional): number
  Paging offset

  Example: 10

{
    "title":"Lifeboat Response List",
    "description":"The wrapper object when returning successful values in Oracle standard",
    "type":"object",
    "properties":{
        "count":{
            "description":"The total number of items in the list.",
            "type":"number",
            "example":11
        },
        "hasMore":{
            "description":"Flag which indicates whether or not there are more items.",
            "type":"boolean",
            "example":false
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LifeBoatConfigurationList"
            }
        },
        "limit":{
            "description":"Paging limit",
            "type":"number",
            "example":1
        },
        "offset":{
            "description":"Paging offset",
            "type":"number",
            "example":10
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Lifeboat Configuration List
  Title: Lifeboat Configuration List

  The Lifeboat Configuration is executed successfully

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

Nested Schema : Lifeboat Configuration List

Type: object

Title: Lifeboat Configuration List

The Lifeboat Configuration is executed successfully

Show Source

• boatSide(optional): string
  Which Side The Boat Is On. Linked to TYP_MSD.TYP_ART (this property only available if Advance Safety Drill is enabled in par)

  Example: SSide
• launchSequence(optional): integer
  Launch sequence

  Example: 2
• lifeBoatCapacity(optional): integer
  Maximum boat capacity

  Example: 20
• lifeBoatDescription(optional): string
  Long name of boat

  Example: Lifeboat 02
• lifeBoatId(optional): integer
  Unique Boat Identifier

  Example: 2
• lifeBoatName(optional): string
  Lifeboat Short Name

  Example: LB02
• lifeBoatRemark(optional): string
  Additional remarks for the boat

  Example: built with Malaysia rubber
• lifeBoatType(optional): string
  Type of boat. Linked to TYP_BRT.TYP_ART

  Example: LB
• maxCertifiedCapacity(optional): integer
  Maximum certified capacity (this property only available if Advance Safety Drill is disabled in par)

  Example: 2
• minCrewWithCPSCRequired(optional): integer
  Required minimum number of crew with CPSC certificates in boat

  Example: 2
• musterStationRalfCrane(optional): integer
  Muster Station Raft Crane

  Example: 1
• noOfCrewAssigned(optional): integer
  Number of crew assigned to boat

  Example: 2

{
    "title":"Lifeboat Configuration List",
    "description":"The Lifeboat Configuration is executed successfully",
    "type":"object",
    "properties":{
        "lifeBoatId":{
            "type":"integer",
            "description":"Unique Boat Identifier",
            "example":2
        },
        "lifeBoatName":{
            "type":"string",
            "description":"Lifeboat Short Name",
            "example":"LB02"
        },
        "lifeBoatDescription":{
            "type":"string",
            "description":"Long name of boat",
            "example":"Lifeboat 02"
        },
        "lifeBoatType":{
            "description":"Type of boat. Linked to TYP_BRT.TYP_ART",
            "type":"string",
            "example":"LB"
        },
        "minCrewWithCPSCRequired":{
            "type":"integer",
            "description":"Required minimum number of crew with CPSC certificates in boat",
            "example":2
        },
        "lifeBoatCapacity":{
            "type":"integer",
            "description":"Maximum boat capacity",
            "example":20
        },
        "noOfCrewAssigned":{
            "type":"integer",
            "description":"Number of crew assigned to boat",
            "example":2
        },
        "lifeBoatRemark":{
            "type":"string",
            "description":"Additional remarks for the boat",
            "example":"built with Malaysia rubber"
        },
        "maxCertifiedCapacity":{
            "type":"integer",
            "description":"Maximum certified capacity (this property only available if Advance Safety Drill is disabled in par)",
            "example":2
        },
        "musterStationRalfCrane":{
            "type":"integer",
            "description":"Muster Station Raft Crane",
            "example":1
        },
        "launchSequence":{
            "type":"integer",
            "description":"Launch sequence",
            "example":2
        },
        "boatSide":{
            "description":"Which Side The Boat Is On. Linked to TYP_MSD.TYP_ART (this property only available if Advance Safety Drill is enabled in par)",
            "type":"string",
            "example":"SSide"
        }
    }
}

204 Response

No Content

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Lifeboat Configurations Error Response
  Title: Lifeboat Configurations Error Response

  Lifeboat Configurations Error Response returned when encountered error

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

Example:

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

Nested Schema : Lifeboat Configurations Error Response

Type: object

Title: Lifeboat Configurations Error Response

Lifeboat Configurations Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Lifeboat Configurations Error Response",
    "description":"Lifeboat Configurations 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 Lifeboat Configurations Error Response
  Title: Lifeboat Configurations Error Response

  Lifeboat Configurations Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/LifeBoatConfigurationsErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorized",
        "detail":"Valid token is required to access this resource"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorized",
    "detail":"Valid token is required to access this resource"
}

Nested Schema : Lifeboat Configurations Error Response

Type: object

Title: Lifeboat Configurations Error Response

Lifeboat Configurations Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Lifeboat Configurations Error Response",
    "description":"Lifeboat Configurations 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 Lifeboat Configurations Error Response
  Title: Lifeboat Configurations Error Response

  Lifeboat Configurations Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/LifeBoatConfigurationsErrorResponse"
        }
    ],
    "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 : Lifeboat Configurations Error Response

Type: object

Title: Lifeboat Configurations Error Response

Lifeboat Configurations Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Lifeboat Configurations Error Response",
    "description":"Lifeboat Configurations 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 Lifeboat Configurations Error Response
  Title: Lifeboat Configurations Error Response

  Lifeboat Configurations Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/LifeBoatConfigurationsErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"This resource path does not exist"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"This resource path does not exist"
}

Nested Schema : Lifeboat Configurations Error Response

Type: object

Title: Lifeboat Configurations Error Response

Lifeboat Configurations Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Lifeboat Configurations Error Response",
    "description":"Lifeboat Configurations 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 Lifeboat Configurations Error Response
  Title: Lifeboat Configurations Error Response

  Lifeboat Configurations Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/LifeBoatConfigurationsErrorResponse"
        }
    ],
    "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 : Lifeboat Configurations Error Response

Type: object

Title: Lifeboat Configurations Error Response

Lifeboat Configurations Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Lifeboat Configurations Error Response",
    "description":"Lifeboat Configurations 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 Lifeboat Configurations Error Response
  Title: Lifeboat Configurations Error Response

  Lifeboat Configurations Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/LifeBoatConfigurationsErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
        "title":"Not Acceptable",
        "detail":"Max certified capacity cannot be saved because parameter advanced safety drill is disabled."
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
    "title":"Not Acceptable",
    "detail":"Max certified capacity cannot be saved because parameter advanced safety drill is disabled."
}

Nested Schema : Lifeboat Configurations Error Response

Type: object

Title: Lifeboat Configurations Error Response

Lifeboat Configurations Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

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

410 Response

Gone

Body ()

Root Schema : schema

Match All

Show Source

• object Lifeboat Configurations Error Response
  Title: Lifeboat Configurations Error Response

  Lifeboat Configurations Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/LifeBoatConfigurationsErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11",
        "title":"Gone",
        "detail":"Requested Resource no longer exists"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11",
    "title":"Gone",
    "detail":"Requested Resource no longer exists"
}

Nested Schema : Lifeboat Configurations Error Response

Type: object

Title: Lifeboat Configurations Error Response

Lifeboat Configurations Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Lifeboat Configurations Error Response",
    "description":"Lifeboat Configurations 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 Lifeboat Configurations Error Response
  Title: Lifeboat Configurations Error Response

  Lifeboat Configurations Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/LifeBoatConfigurationsErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Unsupported Media Type",
        "detail":"Content type not supported"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Unsupported Media Type",
    "detail":"Content type not supported"
}

Nested Schema : Lifeboat Configurations Error Response

Type: object

Title: Lifeboat Configurations Error Response

Lifeboat Configurations Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Lifeboat Configurations Error Response",
    "description":"Lifeboat Configurations 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 Lifeboat Configurations Error Response
  Title: Lifeboat Configurations Error Response

  Lifeboat Configurations Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/LifeBoatConfigurationsErrorResponse"
        }
    ],
    "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 : Lifeboat Configurations Error Response

Type: object

Title: Lifeboat Configurations Error Response

Lifeboat Configurations Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

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

501 Response

Not Implemented

Body ()

Root Schema : schema

Match All

Show Source

• object Lifeboat Configurations Error Response
  Title: Lifeboat Configurations Error Response

  Lifeboat Configurations Error Response returned when encountered error

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

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

Type: object

Title: Lifeboat Configurations Error Response

Lifeboat Configurations Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Lifeboat Configurations Error Response",
    "description":"Lifeboat Configurations 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 Lifeboat Configurations Error Response
  Title: Lifeboat Configurations Error Response

  Lifeboat Configurations Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/LifeBoatConfigurationsErrorResponse"
        }
    ],
    "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 : Lifeboat Configurations Error Response

Type: object

Title: Lifeboat Configurations Error Response

Lifeboat Configurations Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

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

Back to Top