This API retrieves the list of category IDs created within a workspace.
Authentication
The Fleet API uses Basic Authorization on Swagger UI.
Authentication Steps
1.
Click the [Authorize] button in the top right corner.
2.
Enter the provided username and password in the pop-up window.
3.
Click [Authorize] again to proceed with authentication.
4.
After successful login, click [Close] to close the window.
All API requests from Swagger UI will automatically include the authorization token.
Request Information
Request URL
Request URL : [GET] https://insight.seavantage.com/api/fleet/categories
Execution Steps
1.
2.
Navigate to the /fleet/categories endpoint.
3.
Click [Try it out] to activate input fields.
4.
Click the [Execute] button.
5.
View results in the response section.
Response Information
The response is returned in the following format, regardless of whether the request is successful or failed.
Sample Response Format
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2025-07-14T04:27:06.946368475",
"response": [
{
"fleetCategoryId": "27ecdb29-08ec-4880-b73c-dacdd3e6c93c",
"categoryName": "Active",
"parentCategoryName": "Status",
"includeShipsCount": 10
}
]
}
JavaScript
복사
Response Field Descriptions
Top-Level Response Fields
Field | Example Value | Description |
code | 200 | Response status code (used in the same way as standard HTTP status codes).
See the list of codes below for reference. |
message | OK | Response message (description based on status) |
error | false | Error flag
true: error occurred
false: successful processing |
timestamp | 2025-05-14T01:09:00.834665213 | Time of response creation (UTC) |
response | Array or Empty Array | An array is returned if the vessel exists; otherwise, an empty array is returned. |
Response Codes
Code | Description |
200 | Success |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
422 | Unprocessable entity |
429 | Too many requests |
Detailed Response Description
Depth 1 Field Description (response object)
Field | Example Value | Description | Data Type |
fleetCategoryId | 27ecdb29-08ec-4880-b73c-dacdd3e6c93c | Category ID | varchar(36) - UUID |
categoryName | Active | Category ID name | varchar(64) |
parentCategoryName | Status | Parent category menu name | varchar(64) |
includeShipsCount | 10 | Number of vessels registered under the menu | integer |