This API is used to delete ships registered in the workspace. The deletion applies to ships that have been added to Favorites under the user's account or are registered under a specific category.
Authentication
The Ship 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.
Delete Ship Request Information
Request URL
Request URL : [DELETE] https://insight.seavantage.com/api/ship
Execution Steps
1.
2.
Navigate to the/ship endpoint.
3.
Click [Try it out] to activate input fields.
4.
Enter the shipId value in the request.
5.
Click [Execute].
6.
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
•
If successful:
◦
HTTP Status: 204 No Content
◦
Response Body: None
•
If fail:
{
"code": 400,
"message": "Invalid request body. Trace id : 5d4c6d66874f3faeeb186d5137bc799f",
"error": true,
"timestamp": "2024-12-01T12:00:00",
"response": null
}
JavaScript
복사
Response Field Descriptions
Top-Level Response Fields
Field | Example Value | Description |
code | 400 | Response status code (used in the same way as standard HTTP status codes).
See the list of codes below for reference. |
message | Invalid request body. | Response message (description based on status) |
error | true | Error flag
true: error occurred
false: successful processing |
timestamp | 2024-12-01T12:00:00 | Time of response creation (UTC) |
Response Codes
Code | Description |
204 | Deleted |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
422 | Unprocessable entity |
429 | Too many requests |