[GET] /port/{portId}

인증 방법

요청 정보

Depth 1 필드 설명 (response 객체)

이 API는 portId(씨벤티지 port 구분 값)를 기반으로 해당 항구의 상세 정보를 조회합니다.

Swagger 문서 바로가기

인증 방법

Port API는 사용자 인증을 위해 Swagger UI에서 Basic Authorize 인증 방식을 제공합니다.

인증 절차는 다음과 같습니다:

우측 상단의 [Authorize] 버튼을 클릭합니다.

팝업 창에 제공받은 인증 정보(아이디, 비밀번호)를 입력합니다.

입력 후 다시 [Authorize] 버튼을 클릭하여 인증을 진행합니다.

인증이 완료되면 [Close] 버튼을 클릭하여 인증 창을 닫습니다.

Swagger UI에서 호출되는 모든 API 요청에 인증 토큰이 자동으로 포함되어 전송됩니다.

요청 정보

Request URL : [GET] https://insight.seavantage.com/api/port/{portId}

실행 순서

Swagger 문서에 접속한 후, 우측 상단의 Select a definition 메뉴에서 Port 를 선택합니다.

/port/{portId} 경로로 이동합니다.

[Try it out] 버튼을 클릭하여 입력창을 활성화합니다.

아래 요청 Parameters 조건에 따라 결과가 반환됩니다.

•

portId

◦

SeaVantage에서 발급한 고유 항구 식별자 (Port ID)

◦

[GET] /port API를 통해 확인 가능

[Execute] 버튼 클릭합니다.

응답 영역에서 등록 결과를 확인합니다.

응답 정보

요청이 성공하거나 실패했을 때 공통적으로 아래와 같은 형식으로 응답이 반환됩니다.

응답 예시

{
  "code": 200,
  "message": "OK",
  "error": false,
  "timestamp": "2024-12-01T12:00:00",
  "response": {
    "portId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "portName": "Busan",
    "unlocode": "KRPUS",
    "nationCode": "KR",
    "latitude": 35.1796,
    "longitude": 129.0756,
    "timezone": "+09:00",
    "geoData": "{\"type\":\"Polygon\",\"coordinates\":[126.491341,33.499621]}"
  }
}
JavaScript
복사

응답 필드 상세 설명

응답 항목별 정의

필드명	예시 값	설명
code	200	응답 상태 코드 (HTTP status code와 동일하게 사용됨) (아래 별도 응답 상태 코드표 참조)
message	OK	응답 메시지 (상태에 따른 설명)
error	false	오류 여부 true: 오류 발생 false: 정상 처리
timestamp	2025-05-14T01:09:00.834665213	응답 생성 시각 (UTC 기준)
response	null 또는 Object	데이터 존재 시 데이터 객체, 미존재 시 null

응답 코드 종류

코드	설명
200	정상 처리 (Success)
400	잘못된 파라미터 (Bad request)
401	인증 필요 (Unauthorized)
403	권한 없음 (Forbidden)
422	처리 불가 (Unprocessable entity)
429	요청 과다 (Too many requests)

응답 상세 설명

Depth 1 필드 설명 (response 객체)

필드명	예시 값	설명	데이터 타입
portId	3fa85f64-5717-4562-b3fc-2c963f66afa6	내부적으로 사용하는 port 구분 값	varchar(36) - UUID
portName	Busan	항구명	varchar(255)
unlocode	KRPUS	항구 UNLOCODE	varchar(36)
nationCode	KR	국가 코드	varchar(36)
latitude	35.1796	위도	double precision
longitude	129.0756	경도	double precision
timezone	+09:00	항구 타임존	varchar(36)
geoData	{\"type\":\"Polygon\",\"coordinates\":[126.491341,33.499621]}	항구 구역 GeoData	text