전자계약 목록 조회
개요
싸인오케이 홈페이지에서 설정한 문서의 목록 정보를 조회합니다.
URL
/api/v2/document
요청 데이터
| 항목 | 타입 | 위치 | 설명 |
|---|---|---|---|
| page | Integer | query | 페이지 수 |
| per_page | Integer | query | 페이지 당 개수 |
| title | String | query | 문서 제목 |
| start_date | String | query | 생성 날짜 검색 시작일 : yyyyMMdd |
| end_date | String | query | 생성 날짜 검색 종료일 : yyyyMMdd |
| signer_name | String | query | 서명자 명 |
| status | String | query | 문서 상태 코드 |
| search_code | String | query | 검색 코드 |
요청 데이터 예시
?page=1&per_page=10&title=문서제목&start_date=20230101&end_date=20230131&singer_name=서명자명&status=문서상태코드&search_code=검색코드
응답 데이터
| 항목 | 타입 | 위치 | 설명 |
|---|---|---|---|
| result | Object | body | 결과 데이터 |
| page | Integer | body | 페이지 |
| per_page | Integer | body | 페이지 당 개수 |
| documents | Array | body | 문서 배열 |
| id | String | body | 문서 ID |
| title | String | body | 제목 |
| status_description | String | body | 문서 이력 상태 설명 |
| status | String | body | 문서 상태 코드 |
| creator_id | String | body | 생성자 ID |
| creator_name | String | body | 생성자 이름 |
| create_datetime | String | body | 생성 일시 |
| complete_datetime | String | body | 문서 완료 일시 |
| search_code | String | body | 검색 코드 |
| code | String | body | 성공, 실패 코드 |
| message | String | body | 성공, 실패 메시지 |
응답 데이터 예시
{
"result": {
"page": 1,
"per_page": 10,
"documents": [
{
"id": "342c100e7039470f92ebf48ffaec8a74",
"title": "title",
"status_description": "진행",
"status": "ESC001",
"creator_id": "test@signgate.com",
"creator_name": "creator_name",
"create_datetime": "2023-06-30 13:23:43",
"complete_datetime": "2023-06-31 13:23:43",
"search_code": "searchcode"
}
]
},
"code": "200",
"message": "success"
}