1. API Overview
This API provides access to various maritime zone information, including HRA, ECA, and JWC, segmented by section.
Each zone’s boundaries and attributes are returned as individual sections, making the API useful for analyzing maritime risk areas and user-defined zones.
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 : [GET] https://insight.seavantage.com/api/zone/{zoneSection}
3-2. Execution Steps
1.
In the Swagger documentation, go to the top-right corner and select Zone from the Select a definition menu.
2.
Navigate to the /zone/{zoneSection} endpoint.
3.
Click [Try it Out] to activate the input fields.
4.
Enter the appropriate value for the request parameter based on the zone section you wish to query.
•
Descriptions of each zoneSection:
zoneSection | Desc |
HRA | High Risk Area |
ECA | Emission Control Area |
JWC | Joint War Committee (War Risk Zone) |
CUSTOM_ZONE | Custom User-Defined Zone |
5.
Click [Execute] to run the request.
6.
Review the response details in the lower results panel.
4. Response Information
Example Response{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2024-12-01T12:00:00",
"response": [
{
"workspaceId": "123e4567-e89b-12d3-a456-426614174000",
"zoneSection": "JWC",
"zoneName": "Zone name",
"latitude": 12.345678,
"longitude": 98.765432,
"radiusLength": 100,
"shapeType": "Polygon",
"properties": "MTISC",
"geoData": "{\"type\":\"Polygon\",\"coordinates\":[[[102.0,2.0],[103.0,2.0],[103.0,3.0],[102.0,3.0],[102.0,2.0]]]}",
"enabled": true
}
]
}
JSON
복사
Detailed Description of Response FieldsField Name (Attr) | Example Value | Description (Desc) |
code | 200 | Response status code (Same as HTTP status code) — See the code list below for reference. |
message | success | Response message (description based on the status) |
error | false | Error flag (true: error occurred, false: successful processing) |
timestamp | 2025-05-15T10:56:59.034880881 | Response creation time (UTC) |
response | null 또는 Object | Response body data. If cargo is not found, returns an empty object or null. |
Response Code Types (based on the code field)Code | Description |
201 | Successful Processing (Created) |
400 | Invalid Parameter (Bad Request) |
401 | Authentication Required (Unauthorized) |
403 | Permission Denied (Forbidden) |
422 | Unprocessable Entity (Unprocessable Entity) |
429 | Too Many Requests (Too Many Requests) |
Depth 1 필드 설명Attr | Example | Desc |
workspaceId | null | 기본적으로 null로 표시하며, CUSTOM_ZONE인 경우 UUID 형식으로 표시 |
zoneSection | JWC | HRA = 고위험 구역
ECA = 배출 규제 지역
JWC= 전쟁 위험 지역
CUSTOM_ZONE = 사용자 정의 영역
CUSTOM_PLACE_ZONE |
zoneName | Nigeria | zone 이름 |
latitude | 12.345678 | 위도 |
longitude | 98.765432 | 경도 |
radiusLength | 100 | 영역 지름 |
shapeType | POLYGON | zone의 형태 |
properties | 2 | |
geoData | {\"type\":\"Polygon\",\"coordinates\":[[[102.0,2.0],[103.0,2.0],[103.0,3.0],[102.0,3.0],[102.0,2.0]]]} | 항구 구역 GeoData |
enabled | true | zone 유효 여부 |