eSignon
Search…
기간으로 조회
    특정 서식으로 작성한 문서를 기간으로 조회합니다.

API 속성-

Url
Type
Code
https://docs.esignon.net/api/:companyId/search
POST
5009Q

Request

Parameters

PathParameters

Parameter Name
DataType
Description
companyId
String
회사ID

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
"5009Q"(API 고유 코드)
api_name
String
Required
"start api"
session_id
String
Required
""
version
String
Required
"1.1.60"
Body - Body Parameter
Parameter Name
DataType
Required
Description
comp_id
String
Required
회사 ID
search_date_type
String
Optional
START or END / START – 문서 시작 기준 / END – 문서 완료 기준 - 미 입력시 디폴트값 "END"
start_date
String
Required
검색 시작 지점 YYYY-MM-DD
end_date
String
Required
검색 종료 지점 YYYY-MM-DD
field_list
Data
Required
조회할 문서 정보
field_list.doc_uid
String
Required
조회할 문서의 서식 ID
field_list.field_name
String
Optional
조회할 문서 서식의 필드 이름
- 입력시 해당 필드 이름과 같은 필드의 값을 가져옵니다.

요청 Body 예시)

1
{
2
"header" : {
3
"request_code" : "5009Q",
4
"api_name" : "start api",
5
"session_id" : "",
6
"version" : "1.1.60"
7
},
8
"body" : {
9
"comp_id": "{회사 ID}",
10
"search_date_type":"{START or END}",
11
"start_date": "{검색 시작 지점}",
12
"end_date": "{검색 종료 지점}",
13
"field_list": [{
14
"doc_uid": "{서식 ID}",
15
"field_name": "{서식 내부에 있는 필드명}"
16
}]
17
}
18
}
Copied!

Response

Code
Description
Reference
200
성공
형식이 잘못 된 경우 result_msg 참조
400
연결 실패

Result_msg

Code
Description
Reference
00
성공
성공
10
실패
실패
99
실패
Unexpected exception ( 잘못된 포맷 )
12
실패
수신 메세지의 Body 정보가 잘못된 형태여서 파싱하지 못했습니다.
17
실패
필수 검색 조건이 없습니다.
18
실패
검색 조건이 없습니다.
19
실패
날짜 형식이 잘못되었습니다.

응답 Body 예시)

1
{
2
"header":{
3
"response_code": "5009A",
4
"result_code": "00",
5
"result_msg": "필드 상태가 검색되었습니다.",
6
"session_id": "",
7
"version": "1.1.60"
8
},
9
"body":{
10
"comp_id": "{회사 ID}",
11
"wf_list":[
12
{
13
"doc_uid": "{서식ID}",
14
"end_date": "{서명 완료 시간}",
15
"total_process_count": "{문서의 계약자 }",
16
"wf_manager_name": "{ 문서 생성자 이름 }",
17
"wf_manager_email": "{ 문서 생성자 이메일 }",
18
"wf_status": "{문서의 상태값}",
19
"field_value": "{조회한 필드 값}",
20
"wfuid": "{문서 ID}",
21
"current_process_no": "1",
22
"wf_title": "{문서 이름}",
23
"start_date": "{문서 시작 시간}",
24
"field_name": "{조회한 필드 이름}"
25
}
26
]
27
}
28
}
Copied!

Parameter Info

Name
Value
Description
wf_list.wf_status
Playing
진행중
Canceled
취소
Complete
완료
Disposal
폐기
Truncate
(취소 상태 후 삭제한 경우)
Last modified 7mo ago