home

[DELETE] /cargo/{documentId}

이 API는 잘못 등록된 화물이거나, 조회 대상에서 제외해야 하는 경우 화물을 삭제할 때 사용됩니다. 삭제된 화물은 시스템에서 완전히 제거되어 더 이상 조회되지 않도록 처리됩니다.
  Swagger 문서 바로가기

인증 방법

Cargo Insight API는 사용자 인증을 위해 Swagger UI에서 Basic Authorize 인증 방식을 제공합니다.
인증 절차는 다음과 같습니다:
1.
우측 상단의 [Authorize] 버튼을 클릭합니다.
2.
팝업 창에 제공받은 인증 정보(아이디, 비밀번호)를 입력합니다.
3.
입력 후 다시 [Authorize] 버튼을 클릭하여 인증을 진행합니다.
4.
인증이 완료되면 [Close] 버튼을 클릭하여 인증 창을 닫습니다.
Swagger UI에서 호출되는 모든 API 요청에 인증 토큰이 자동으로 포함되어 전송됩니다.

요청 정보

요청 정보

Request URL: [DELETE] https://insight.seavantage.com/api/cargo/{documentId}

실행 순서

1.
Swagger 문서에서 우측 상단의 Select a definition 메뉴에서 Cargo 를 선택합니다.
2.
/cargo/{documentId} 경로로 이동합니다.
3.
[Try it out] 버튼을 클릭하여 입력창을 활성화합니다.
4.
필수 Parameters, documentId 값을 입력합니다.
documentId: [GET] /cargo/search API를 통해 조회한 화물 구분 식별자(ID)를 입력합니다.
5.
[Execute] 버튼을 클릭합니다.
6.
하단 응답 영역에서 등록 결과를 확인합니다.

응답 정보

요청이 성공하거나 실패했을 때 HTTP 상태 코드로 구분이 가능합니다.

응답 코드 종류

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