1. API Overview
This API is used to delete cargo records in cases where they were registered incorrectly or need to be excluded from search results. Deleted cargo is completely removed from the system and can no longer be retrieved.
2. Authentication Method
The Cargo API uses the Basic Authorize method for authentication via Swagger UI.
Authentication steps:
1.
Click the [Authorize] button at the top-right corner.
2.
Enter the provided ID and Password in the popup window.
3.
Click [Authorize] again to complete authentication.
4.
Click [Close] to close the popup.
Once authenticated, an access token is automatically included in all API requests made via Swagger UI.
3. Request Information
3-1. Request Details
Request URL: [DELETE] https://insight.seavantage.com/api/cargo/{documentId}
3-2. Execution Steps
1.
In the Swagger UI, select Cargo from the Select a definition menu at the top-right.
2.
Navigate to the /cargo/{documentId} endpoint.
3.
Click [Try it Out] to activate the input field.
4.
Enter the documentId as a parameter.
5.
Click [Execute].
6.
Check the response area for the result.
Parameters
•
You must provide the documentId, which is the cargo identifier obtained from the GET /cargo/search API.
4. Response Information
Whether the request was successful or failed is determined by the HTTP status code.
Response Code Types (based on code field):코드 | 설명 |
204 | Successfully deleted (No Content) |
400 | Invalid parameter (Bad Request) |
401 | Authentication required (Unauthorized) |
403 | Access denied (Forbidden) |
422 | Unprocessable request |
429 | Too many requests (Rate limited) |