Skip to main content Link Menu Expand (external link) Document Search Copy Copied

전자계약 목록 조회

개요

싸인오케이 홈페이지에서 설정한 문서의 목록 정보를 조회합니다.


URL

/api/v2/document

요청 데이터

항목타입위치설명
pageIntegerquery페이지 수
per_pageIntegerquery페이지 당 개수
titleStringquery문서 제목
start_dateStringquery생성 날짜 검색 시작일 : yyyyMMdd
end_dateStringquery생성 날짜 검색 종료일 : yyyyMMdd
signer_nameStringquery서명자 명
statusStringquery문서 상태 코드
search_codeStringquery검색 코드

요청 데이터 예시

?page=1&per_page=10&title=문서제목&start_date=20230101&end_date=20230131&singer_name=서명자명&status=문서상태코드&search_code=검색코드

응답 데이터

항목타입위치설명
resultObjectbody결과 데이터
    pageIntegerbody페이지
    per_pageIntegerbody페이지 당 개수
    documentsArraybody문서 배열
            idStringbody문서 ID
            titleStringbody제목
            status_descriptionStringbody문서 이력 상태 설명
            statusStringbody문서 상태 코드
            creator_idStringbody생성자 ID
            creator_nameStringbody생성자 이름
            create_datetimeStringbody생성 일시
            complete_datetimeStringbody문서 완료 일시
            search_codeStringbody검색 코드
codeStringbody성공, 실패 코드
messageStringbody성공, 실패 메시지

응답 데이터 예시

{
    "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"
}

Back to top

COPYRIGHT (C) 2022 KICA INC. ALL RIGHTS RESERVED