This API retrieves the list of terminals associated with a given portId. Optionally, a keyword parameter can be included to filter the results and return only the terminals that match the specified condition.
Authentication
The Port 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/port/terminal
Execution Steps
1.
2.
Navigate to the /port/terminal endpoint.
3.
Click [Try it out] to activate input fields.
4.
Enter values according to the following request parameters:
•
portId (required)
◦
The unique Port ID issued by SeaVantage.
◦
•
keyword (optional)
◦
Enter all or part of the terminalName
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
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2025-06-30T04:20:55.155678719",
"response": [
{
"terminalId": "f66c027a-08d8-11ed-b938-049226dae5ce",
"terminalName": "BUSAN CONTAINER TERMINAL (BCT)"
}
]
}
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 | Returns an array if data exists; returns an empty array if no data exists |
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 |
terminalId | f66c027a-08d8-11ed-b938-049226dae5ce | Internal terminal identifier provided by SeaVantage | varchar(36) - UUID |
terminalName | BUSAN CONTAINER TERMINAL (BCT) | Terminal name | varchar(128) |