이 API는 등록된 Class B 선박(ship)을 특정 카테고리(categoryId)에서 삭제하는 기능을 제공합니다. 단, 등록 직후 즉시 삭제는 불가능하며, 기본적으로 등록 후 7일이 경과해야 삭제할 수 있습니다.
인증 방법
NonIMONo(ClassB) Fleet API는 사용자 인증을 위해 Swagger UI에서 Basic Authorize 인증 방식을 제공합니다.
인증 절차는 다음과 같습니다:
1.
우측 상단의 [Authorize] 버튼을 클릭합니다.
2.
팝업 창에 제공받은 인증 정보(아이디, 비밀번호)를 입력합니다.
3.
입력 후 다시 [Authorize] 버튼을 클릭하여 인증을 진행합니다.
4.
인증이 완료되면 [Close] 버튼을 클릭하여 인증 창을 닫습니다.
Swagger UI에서 호출되는 모든 API 요청에 인증 토큰이 자동으로 포함되어 전송됩니다.
요청 정보
요청 정보
Request URL : [DELETE] https://insight.seavantage.com/api/fleet/class-b
실행 순서
1.
2.
/fleet/class-b 경로로 이동합니다.
3.
[Try it out] 버튼을 클릭하여 입력창을 활성화합니다.
4.
아래 요청 Parameters 조건에 따라 결과가 반환됩니다.
•
categoryId + shipId 입력 : 특정 카테고리 내 지정된 Class B 선박 삭제
◦
categoryId는 UUID 형식의 값
◦
•
shipId만 입력 : 해당 선박이 속해 있는 모든 카테고리에서 Class B 선박 삭제
◦
shipId는 UUID 형식의 값
◦
5.
[Execute] 버튼을 클릭합니다.
6.
하단 응답 영역에서 등록 결과를 확인합니다.
이 API는 카테고리별 선박 관리 목적으로 카테고리 내에서 선박을 제거할 때 사용하는 API 입니다.
응답 정보
응답 예시
•
성공 했을 경우
◦
HTTP Status : 204 No Content
◦
Response Body 없음
•
실패 했을 경우
{
"code": 400,
"message": "Invalid request body. Trace id : 5d4c6d66874f3faeeb186d5137bc799f",
"error": true,
"timestamp": "2024-12-01T12:00:00",
"response": null
}
JSON
복사
응답 필드 상세 설명
실패 시 응답 항목별 정의
필드명 | 예시 값 | 설명 |
code | 400 | 응답 상태 코드 (HTTP status code와 동일하게 사용됨)
(아래 별도 응답 상태 코드표 참조) |
message | Invalid request body. | 응답 메시지 (상태에 따른 설명) |
error | true | 오류 여부
true: 오류 발생
false: 정상 처리 |
timestamp | 2024-12-01T12:00:00 | 응답 생성 시각 (UTC 기준) |
응답 코드 종류
코드 | 설명 |
204 | 정상 처리 (Deleted) |
400 | 잘못된 파라미터 (Bad request) |
401 | 인증 필요 (Unauthorized) |
403 | 권한 없음 (Forbidden) |
422 | 처리 불가 (Unprocessable entity) |
429 | 요청 과다 (Too many requests) |