취소, 폐기, 삭제

  • 문서를 취소 또는 폐기합니다.

  • 취소 - 진행중인 문서를 취소 처리합니다.

  • 폐기 - 완료된 문서를 폐기 처리합니다.

  • 삭제 - 취소된 문서를 삭제 처리합니다. ( 문서란에서 보이지않게 삭제합니다. )

API 속성-

Url

Type

Code

https://docs.esignon.net/JEDOC/Common.do

POST

1510Q

Request

Parameters

Headers

Parameter Name

DataType

Required

Description

Content-Type

String

Required

"application/json"

Authorization

String

Required

"esignon ${발급받은토큰}"

Body

Body - Header Parameter

Parameter Name

DataType

Required

Description

request_code

String

Required

"1510Q"(API 고유 코드)

request_msg

String

Required

""

request_lang

String

Optional

"ko","en","ja"

session_id

String

Required

"thread_023"

version

String

Required

"9.9.99"

Body - Body Parameter

Parameter Name

DataType

Required

Description

comp_id

String

Required

회사 ID

biz_id

String

Required

"0"

memb_email

String

Required

사용자 이메일

workflow_id

String

Required

문서 ID

command

String

Required

"CANCEL" - 취소 / "DISPOSAL" - 폐기 / "DELETE" - 삭제

description

String

Optional

"disposal" 시엔 필수 값 - "폐기 사유"

timezone_offset

String

Optional

"disposal" 시엔 필수 값 - "UTC 시간값 입력"/"+00:00"

한국의 경우 "+09:00"

요청 Body 예시)

{
"header": {
"request_code": "1510Q",
"request_msg": "",
"request_lang":"{ko or ja or en}",
"session_id": "session_id",
"version": "9.9.99"
},
"body": {
"comp_id": "{회사 ID}",
"biz_id":"0",
"memb_email":"{사용자 이메일}",
"workflow_id":"{문서 ID}",
"command":"{ CANCEL or DISPOSAL or DELETE }",
"description":"{폐기 사유 입력}",
"timezone_offset":"+09:00"
}
}

Response

Code

Description

Reference

200

성공

형식이 잘못 된 경우 result_msg 참조

400

연결 실패

Result_msg

Code

Description

Reference

00

성공

성공

94

실패

인증키가 올바르지 않습니다.

11

실패

필수 값이 없거나 상태 값이 올바르지 않습니다.

-1

실패

수신 메세지의 Body 정보가 잘못된 형태여서 파싱하지 못했습니다.

응답 Body 예시)

{
"header":{
"session_id": "session_id",
"response_code": "1510A",
"result_code": "00",
"result_msg": "폐기/취소를 성공했습니다.",
"version": "9.9.99"
},
"body":{
"comp_id": "{회사 ID}",
"biz_id": "0",
"memb_email": "{사용자 이메일}",
"workflow_id": "{문서 ID}",
"command": "{실행된 커맨드}"
}
}