개요
다우오피스 OpenAPI 서비스의 전자결재 기안 연동을 위한 <전자결재 처리상태 전송 API> 입니다. <전자결재 기안 API>와 함께 사용할 수 있습니다. 전달받은 callbackUrl로 전자결재 처리상태 정보를 전송합니다.
Request URL
전자결재 기안 API에서 전달받은 callbackUrl
ex) https://partner.domain.com:8080/do/document/status
HTTP Method
POST (Content-Type: application/json; charset=UTF-8)
Request Parameters
| 변수 (Parameter) |
타입(Type) | 필수 여부 |
사전 발급 |
설명 (Description) |
|---|---|---|---|---|
| docId | String | Y | N | 다우오피스 전자결재 문서 고유번호 ※ 다른 다우오피스 전자결재 연동(문서조회 등)을 위한 고유키 정보 |
| docNum | Srting | Y | N | 다우오피스 전자결재 문서번호 |
| partnerStatusCode | String | N | Y | [업무시스템] 고객사정의 문서 상태 코드 |
| docStatusCode | String | Y | N | 다우오피스 전자결재 문서 상태 코드 (DRAFT/COMPLETE/RETURN/FORCED_RETURN/CANCEL/DELETE/FORCE_DELETE/TEMPSAVE |
| docStatusName | String | Y | N | 다우오피스 전자결재 문서 상태 명 (기안/완료/반려/강제반려/취소/삭제/강제삭제/임시저장/진행중) |
| allianceInfo | Object | N | N | 전자결재 공유정보를 위한 Object[배열] |
- allianceInfo (업무시스템에서 전달하고자 하는 배열값으로 필요 시에만 작성합니다.)
| 변수 (Parameter) |
타입(Type) | 필수 여부 |
사전 발급 |
설명 (Description) |
|---|---|---|---|---|
| {업무시스템 생성} #1 | String | N | N | 업무시스템에서 전달하는 연동관련 고유정보 #1 |
| {업무시스템 생성} #2 | String | N | N | 업무시스템에서 전달하는 연동관련 고유정보 #2 |
| {업무시스템 생성} #3 | String | N | N | 업무시스템에서 전달하는 연동관련 고유정보 #3 |
Request Example
POST /do/document/status HTTP/1.1
partner.domain.com:8080
Content-Type : application/json; charset=UTF-8
{
"docId" : "203489",
"docNum" : "다우기술-API문서-00102",
"partnerStatusCode" : "E",
"docStatusCode" : "COMPLETE",
"docStatusName" : "완료",
"allianceInfo" : {"key":"","code":"","info":"","detail":{"no":"","value":""}}
}
Response Parameters
| 변수 (Parameter) |
타입 (Type) |
필수 여부 |
사전 발급 |
설명 (Description) |
|---|---|---|---|---|
| code | String | Y | N | API 호출결과 코드 |
| message | String | Y | N | API 호출결과 메시지 |
Response Example
Content-Type: application/json;charset=UTF-8
{
"code": "200",
"message": "OK"
}
Return Code
| 구분 | 코드 (Code) |
내용 (Message) |
설명 (Description) |
|---|---|---|---|
| 성공 (Success) |
200 | 성공 | OK |
|
실패 |
901 | 유효하지 않은 client ID | client ID를 확인하세요. |
| 902 | 유효하지 않은 client Secret | client Secret을 확인하세요. | |
| 955 | 도메인 코드 오류 | 'XXXX'는 존재하지 않는 도메인 코드입니다. |
제공 서비스 유형
| 구분 | 제공 여부 |
|---|---|
| 다우오피스 단독형 | 제공 |
| 다우오피스 설치형 | 제공 |
| 다우오피스 구축형 | 제공 |
| 다우오피스 공유형 | 미제공 |