GET/port/all

이 API는 Port Insight 서비스가 적용되는 모든 항구에 대한 정보를

한 번에 조회할 수 있는 기능을 제공합니다.

요청 방식

•

HTTP Method : GET

•

API 경로 : /port/all

•

예시 URL : https://insight.seavantage.com/api/port/all

•

인증 방식 : Basic Auth

•

응답 포맷 : JSON

인증 방법

Swagger UI에서 본 API를 호출하려면 아래 인증 절차를 따라야 합니다:

Swagger 우측 상단 [Authorize] 버튼 클릭

팝업 창에 제공된 인증 정보(ID / PW) 입력

[Authorize] 클릭

인증 완료 후 [Close] 클릭하여 창 닫기

인증이 완료되면 Swagger에서 실행되는 모든 API 요청에 인증 정보가 자동 포함되어 전송됩니다.

전체 항구 목록 조회 방법

1. Swagger UI 실행 절차

Swagger 문서에서 Port 선택

/port/all 항목으로 이동

[Try it Out] 클릭

[Execute] 클릭하여 호출 실행

하단에서 응답 결과 확인

Swagger 문서 바로가기

응답 정보

응답 예시

{
  "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
복사

응답 필드 설명

필드명	예시 값	설명
code	200	응답 상태 코드
message	OK	응답 메시지
error	false	오류 여부
timestamp	2024-12-01T12:00:00	응답 생성 시각 (UTC 기준)
response	Array	Port Insight에서 관리 중인 모든 zone/port 목록 배열

Depth 1 – 항구 Zone 필드

필드명	예시 값	설명
workspaceId	123e4567-e89b-12d3-a456-426614174000	사용자 정의 영역인 경우 UUID. 일반 zone일 경우 null
zoneSection	JWC	영역 종류 (예: JWC, HRA, ECA, CUSTOM_ZONE 등)
zoneName	Nigeria	구역 이름
latitude	12.345678	위도
longitude	98.765432	경도
radiusLength	100	반경 또는 면적 기준 길이 (m 단위)
shapeType	POLYGON	영역 형태 (예: POLYGON, CIRCLE 등)
properties	MTISC	구역 관련 속성 또는 주석
geoData	{ "type": "Polygon", "coordinates": [...] }	GeoJSON 형식의 지리 정보
enabled	true	zone의 유효 여부 (true/false)

응답 코드 안내

코드	설명
200	정상 처리
201	리소스 생성
400	잘못된 요청
401	인증 실패
403	권한 없음
422	처리 불가
429	호출 한도 초과