The Zone API delivers spatial and attribute information for HRA, ECA, JWC, and user-defined zones in JSON format. It is designed to support maritime risk assessments and boundary visualization.
Authentication
The Zone 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.
Zone All Request Information
Request URL
[GET] https://insight.seavantage.com/api/zone/all
Execution Steps
1.
2.
Navigate to the /zone/all endpoint.
3.
Click [Try it Out] to activate input fields.
4.
Click [Execute].
5.
View results in the response section.
Response Information
Sample Response Format
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2024-12-01T12:00:00",
"response": [
{
"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 Response Description
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 | success | Response message (description based on status) |
error | false | Error flag
true: error occurred
false: successful processing |
timestamp | 2025-05-15T10:56:59.034880881 | Time of response creation (UTC) |
response | null or Object | Returns cargo data if found
Returns null if not found |
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 |
zoneSection | JWC | Zone type
HRA: High Risk Area
ECA: Emission Control Area
JWC: Joint War Committee
CUSTOM_ZONE: Custom Defined Zone |
zoneName | Nigeria | Zone Name |
latitude | 12.345678 | Latitude |
longitude | 98.765432 | Longitude |
radiusLength | 100 | Zone Radius (Diameter) |
shapeType | Polygon | Zone Shape |
properties | 2 | Zone-related Properties |
geoData | {\"type\":\"Polygon\",\"coordinates\":[[[102.0,2.0],[103.0,2.0],[103.0,3.0],[102.0,3.0],[102.0,2.0]]]} | Port Zone GeoData |
enabled | true | Zone activation status
true: enabled
false: disabled |