Retrieve a list of tender boat details
get
/spms/v2/ships/{shipId}/configurations/tenderBoats
This is to retrieve a list of tender boat details
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: integer
ship Id
Query Parameters
-
enabled: boolean
Returns tender board configuration which is true or false
-
limit: integer(int32)
Paging limit
-
name: string
Search Value based on the name
-
offset: integer(int32)
Paging offset
-
orderBy: string
order by code or name or capacity or threshold or comments. Format: column name:asc or desc. if multiple columns needed then split it by comma
-
searchValue: string
Search Value based on the code or name
-
tenderBoatId: integer(12345678)
Tender Boat Id
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : schema
Type:
Show Source
array
-
Array of:
object List of Tender Boat Config
Title:
List of Tender Boat Config
List of Tender Boat Config
Nested Schema : List of Tender Boat Config
Type:
object
Title:
List of Tender Boat Config
List of Tender Boat Config
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
Nested Schema : tenderBoat
Type:
object
Tender Boat Configuration
Show Source
-
capacity(optional):
number
Tender Boat capacityExample:
12345678
-
code(optional):
string
Minimum Value:
1
Maximum Value:100
Pattern:^[a-zA-Z ]*$
Tender Boat codeExample:B1
-
comments(optional):
string
Minimum Value:
1
Maximum Value:200
Pattern:^[a-zA-Z ]*$
Tender Boat commentsExample:Boat 6
-
enabled(optional):
boolean
true is tender boat is active and false is tender boat is inactiveExample:
true
-
id(optional):
number
Tender Boat IdExample:
12345678
-
name(optional):
string
Minimum Value:
1
Maximum Value:200
Pattern:^[a-zA-Z ]*$
Tender Boat nameExample:Boat 6
-
threshold(optional):
number
Tender Boat thresholdExample:
12345678
204 Response
No Content
401 Response
Unauthorized
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
"title":"Unauthorised",
"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
403 Response
Forbidden
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
404 Response
Not Found
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
"title":"Not Found",
"detail":"This resource path does not exist"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
405 Response
Method Not Allowed
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
"title":"Method Not Allowed",
"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
406 Response
Not Acceptable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
415 Response
Unsupported Media Type
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"HTTP://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
500 Response
Internal Server Error
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
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 : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
503 Response
Service Unavailable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
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 : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source