1API 요청
POST
/rest/registry_realestate_jobs요청 파라미터 8개 · 필수 1
파라미터
설명
query검색에 사용한 주소 또는 부동산고유번호 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
- 최대 길이
- 120자
- 예시
서울특별시 중구 세종대로 110
pin부동산고유번호 14자리(선택) 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
- 형식
^[0-9]{14}$
index검색 결과 행 번호(1부터), 기본 1 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다.
- 범위
- 1 ~ 20
- 예시
1
usage열람(view)·발급(issue) 등, 기본 view 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. 가능한 값은 4가지입니다. view = view 값을 뜻하며, 같은 응답의 다른 필드와 함께 해석하세요. issue = issue 값을 뜻하며, 같은 응답의 다른 필드와 함께 해석하세요. transfer-gov24 = transfer-gov24 값을 뜻하며, 같은 응답의 다른 필드와 함께 해석하세요. transfer-court = transfer-court 값을 뜻하며, 같은 응답의 다른 필드와 함께 해석하세요.
- 허용값
viewissuetransfer-gov24transfer-court- 예시
view
record_scope전부(all)·일부(part), 기본 all 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. 가능한 값은 2가지입니다. all = all 값을 뜻하며, 같은 응답의 다른 필드와 함께 해석하세요. part = part 값을 뜻하며, 같은 응답의 다른 필드와 함께 해석하세요.
- 허용값
allpart
include_cancelled말소사항 포함 여부, 기본 true true/false로 보내며, 생략하면 서버 기본값이 적용됩니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.
publish_resident_no주민등록번호 공개 여부, 기본 false true/false로 보내며, 생략하면 서버 기본값이 적용됩니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.
idempotency_key같은 요청을 다시 보낼 때 중복 접수·과금을 막는 고유 키입니다. 요청 내용이 같으면 같은 키를 유지하고, 내용이 바뀌면 새 키를 만드세요.
- 최대 길이
- 128자
응답 필드 17개
응답 필드
설명
data요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다.
data.job_id'job_id' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.product조회한 상품의 내부 코드입니다. 인증요청 때 보낸 product와 같은 값이며, 응답의 result 구조를 해석할 때 기준이 됩니다.
data.status현재 처리 상태 코드입니다. 괄호 안 설명은 이 서비스에서의 상태 의미이며, 값별 다음 행동은 이 문서의 상태 표를 확인하세요. 상태가 바뀌면 같은 경로를 다시 조회합니다.
data.reserved_point'reserved_point' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.download_point'download_point' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.created_at작업이 접수된 일시입니다. ISO 8601 형식이며, 결과 만료 시각을 계산할 때 기준으로 사용합니다.
data.completed_at작업이 완료된 일시입니다. 완료 전에는 null이며, 처리 시간을 계산할 때 created_at과 함께 사용합니다.
data.pdf'pdf' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
apiAPI 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다.
api.successAPI 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다.
api.cost이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다.
하위 필드 5개 더 보기
응답 필드
설명
data.pdf.bytes'bytes' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.pdf.pages'pages' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.pdf.sha256'sha256' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.pdf.expires_at'expires_at' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.pdf.download_point'download_point' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
