This API registers a Class B vessel to the Fleet under a specified categoryId. If categoryId is not provided, the Class B vessel is registered at the workspace level by default.
Authentication
The NonIMONo (Class B) Fleet API uses Basic Authorization for user authentication via Swagger UI.
The authentication procedure is as follows:
1.
Click the [Authorize] button in the top-right corner.
2.
Enter the provided credentials (username and password) in the pop-up dialog.
3.
Click [Authorize] again to proceed with authentication.
4.
Once authentication is complete, click [Close] to close the dialog.
All API requests executed from Swagger UI automatically include authentication credentials.
Request Information
Request Details
Request URL : [POST] https://insight.seavantage.com/api/fleet/class-b
Execution Steps
1.
2.
Navigate to the /fleet/class-b endpoint.
3.
Click [Try it out] to enable the input fields.
4.
Configure the request Parameters according to the desired registration method:
•
categoryId + shipId provided: Registers the vessel under a specific category.
◦
categoryId must be a UUID.
◦
◦
•
shipId only provided: Registers the vessel under the default category.
◦
shipId must be a UUID.
◦
shipId can be retrieved via the /ship/class-b/search API.
5.
Click [Execute].
6.
Review the result in the response section at the bottom.
Response Information
Response Examples
•
On success
◦
HTTP Status: 204 No Content
◦
No response body
•
On failure
{
"code": 400,
"message": "Invalid request body. Trace id : 17f7dadbdcd13ebc994c71aa05cebb06",
"error": true,
"timestamp": "2025-07-23T02:02:20.560862948",
"response": null
}
JSON
복사
Response Field Details
Failure Response Field Definitions
Field | Example | Description |
code | 400 | Response status code (Aligned with HTTP status code)
(See the list of codes below for reference) |
message | Invalid request body. | Error description |
error | true | true: error occurred
false: success |
timestamp | 2024-12-01T12:00:00 | Response generation time (UTC) |
Response Status Codes
Code | Description |
204 | Deleted |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
422 | Unprocessable entity |
429 | Too many requests |