Search by period
Search for documents created by specific template and period
API URL
Url | Type | Code |
https://docs.esignon.net/api/{CompID}/search | POST | 5009Q |
Request
Parameters
PathParameters
Parameter Name | DataType | Description |
CompID | String | Company ID |
Headers
Parameter Name | DataType | Required | Description |
Content-Type | String | Required | "application/json" |
Authorization | String | Required | "esignon accesstoken" |
Body
Body - Header Parameter
Parameter Name | DataType | Required | Description |
request_code | String | Required | "5009Q" |
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 | Company ID |
client_id | String | Required | ID issued by esignon (question for issue) |
search_date_type | String | Optional | START or END / default - END START – based on the start of the document END – based on the end of the document |
start_date | String | Required | Search Start Point YYYY-MM-DD |
end_date | String | Required | Search End Point YYYY-MM-DD |
field_list | Data | Required | Information of the document to search |
field_list.doc_uid | String | Required | Templete ID of the document to search |
field_list.field_name | String | Optional | Templete field name of the document to search |
Request Body Example)
Response
Code | Description | Reference |
200 | success | success |
400 | Connection failed |
Result_msg
Code | Description | Reference |
00 | success | success |
10 | fail | fail |
12 | fail | Parsing failed because the body information of the received message is incorrect. |
17 | fail | No required search conditions |
18 | fail | No search conditions |
19 | fail | Incorrect date format |
99 | fail | Unexpected exception (incorrect format) |
Response Body Example)
Last updated