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
Response
Supported Media Types
- application/json
200 Response
OK
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 limitExample:
1
-
offset(optional):
number
Paging offsetExample:
10
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Lifeboat Configuration List
Title:
Lifeboat Configuration List
The Lifeboat Configuration is executed successfully
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 sequenceExample:
2
-
lifeBoatCapacity(optional):
integer
Maximum boat capacityExample:
20
-
lifeBoatDescription(optional):
string
Long name of boatExample:
Lifeboat 02
-
lifeBoatId(optional):
integer
Unique Boat IdentifierExample:
2
-
lifeBoatName(optional):
string
Lifeboat Short NameExample:
LB02
-
lifeBoatRemark(optional):
string
Additional remarks for the boatExample:
built with Malaysia rubber
-
lifeBoatType(optional):
string
Type of boat. Linked to TYP_BRT.TYP_ARTExample:
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 boatExample:
2
-
musterStationRalfCrane(optional):
integer
Muster Station Raft CraneExample:
1
-
noOfCrewAssigned(optional):
integer
Number of crew assigned to boatExample:
2
204 Response
No Content
400 Response
Bad Request
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
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
401 Response
Unauthorized
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
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
403 Response
Forbidden
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
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
404 Response
Not Found
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
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
405 Response
Method Not Allowed
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
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
406 Response
Not Acceptable
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
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
410 Response
Gone
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
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
415 Response
Unsupported Media Type
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
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
500 Response
Internal Server Error
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
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
501 Response
Not Implemented
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
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
503 Response
Service Unavailable
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
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