PortCall API는 선박의 과거 항구 기항 이력을 조회하는 기능을 제공합니다.
기본 조회 가능 기간은 최대 15일, 계약 조건에 따라 180일까지 확장 가능합니다.
인증 방법
Swagger UI에서는 Basic Authorize 방식을 통해 인증을 진행합니다.
인증 순서:
1.
Swagger 우측 상단의 [Authorize] 버튼 클릭
2.
제공받은 ID / Password 입력
3.
다시 [Authorize] 클릭
4.
인증 성공 시 [Close] 클릭
인증 완료 시 Swagger UI에서 요청마다 자동으로 토큰이 포함됩니다.
PortCall 정보 조회하는 방법
1. 입력 값 (Query Parameter)
파라미터 | 설명 |
shipId | 조회 대상 선박의 UUID예: aaa9dcf0-6af2-4f89-a6d5-c25594ed9837 |
from | 조회 시작일 (UTC 기준)예: 2025-01-01T00:00:00Z |
to | 조회 종료일 (UTC 기준)예: 2025-01-15T23:59:59Z |
2. Swagger UI에서 호출 실행
1.
2.
Fleet 정의 선택
3.
/port-call/{shipId} 항목 이동
4.
[Try it Out] 클릭
5.
파라미터 입력 후 [Execute] 클릭
6.
하단 응답 결과 확인
응답 정보
응답 형식 예시
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2025-05-13T09:32:29.445615013",
"response": [
{
"departurePort": {
"portName": "Lake Charles",
"unlocode": "USLCH",
...
},
"arrivalPort": {
"portName": "Tuxpan",
"unlocode": "MXTUX",
...
},
"atd": "2025-04-28T12:28:46Z",
"ata": "2025-05-05T22:14:00Z",
"atSeaHour": 177.75,
"atSeaDistance": 870.385,
"inPortHour": 78.75
}
]
}
JSON
복사
주요 필드 설명
기본 필드
필드명 | 예시 값 | 설명 |
code | 200 | 응답 상태 코드 |
message | OK | 응답 메시지 |
error | false | 오류 여부 |
timestamp | 2025-05-13T09:32:29.445615013 | 응답 생성 시각 (UTC 기준) |
응답 본문 상세
Depth 1 (항차 데이터)
필드명 | 예시 | 설명 |
atd | 2025-04-28T12:28:46Z | 출항 시각 |
ata | 2025-05-05T22:14:00Z | 입항 시각 |
atb | 2025-05-05T22:14:00Z | 접안 시각 |
atSeaHour | 177.75 | 항해 시간 |
atSeaDistance | 870.385 | 항해 거리 (해리) |
inPortHour | 78.75 | 항만 체류 시간 |
inPortDistance | 7.0155673 | 항만 내 이동 거리 |
ecaDistance | 0 | ECA(배출규제해역) 포함 거리 |
departurePort / arrivalPort | Object | 항구 객체 (아래 참조) |
Depth 2 (항구 정보)
필드 | 예시 | 설명 |
portId | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | 항구 고유 식별자 |
portName | Lake Charles | 항구명 |
unlocode | USLCH | 항구 UNLOCODE |
portAlias | Lakecharles | 별칭 |
nationCode | US | 국가 코드 |
latitude / longitude | 30.16705757 / -93.28987508 | 좌표 |
timezone | -06:00 | 타임존 |
timezoneName | America/Chicago | 타임존 명칭 |
geoData | GeoJSON 형식 문자열 | 항구 영역 좌표 |
isEnabled | true | 활성화 여부 |
응답 코드 안내
코드 | 설명 |
200 | 정상 처리 |
201 | 생성 완료 |
400 | 잘못된 요청 |
401 | 인증 필요 |
403 | 권한 없음 |
422 | 처리 불가 |
429 | 요청 과다 |
관련 링크
