Page Structure
Open API Details
※ Standard Metadata for Data Integration and Search.
Schema.org| Category(Korean) | Category(English) | Size | Division | Sample Data | Description |
|---|---|---|---|---|---|
| 서비스키 | ServiceKey | 100 | Essential | - | Use the authentication key received from the Public Data Portal. However, when actually calling the API, you must enter the first character of the serviceKey parameter in lowercase. |
| 페이지 번호 | pageNo | 4 | Essential | 1 | Page number |
| 한 페이지 결과 수 | numOfRows | 4 | Essential | 10 | Number of results per page |
| 검색조건기간 통보일자시작일 | sDate | 8 | Essential | 20200813 | Data provided since July 15, 2020 |
| 검색조건기간 통보일자종료일 | eDate | 8 | Essential | 20200813 | Data provided since July 15, 2020 |
| 현장소재지코드 | area | 2 | Optional | 11 | Site location search criteria: Omit parameters or enter 'All' codes when querying all (refer to the site location code in the response message specification for code information). |
| 도급구분코드 | dogub | 1 | Optional | 1 | Contract Classification search criteria; omit parameters when querying all (refer to the Contract Classification Code in the response message specification for code information). |
| 발주자구분코드 | balju | 1 | Optional | 0 | Orderer Classification search condition; omit the parameter or enter 'All' codes when retrieving all (refer to the Orderer Classification Code in the response message specification for code information). |
| 데이터포맷 | _type | 5 | Optional | json | If you want to receive the Open API return type as JSON, specify 'json'. |
| Category(Korean) | Category(English) | Size | Division | Sample Data | Description |
|---|---|---|---|---|---|
| 결과코드 | resultCode | 2 | Essential | 00 | Result code |
| 결과메시지 | resultMsg | 50 | Essential | NORMAL SERVICE | Result message |
| 한 페이지 결과 수 | numOfRows | 4 | Essential | 10 | Number of results per page |
| 페이지 번호 | pageNo | 4 | Essential | 1 | Page number |
| 전체 결과 수 | totalCount | 4 | Essential | 17 | Total number of results |
| 현장소재지코드 | areaCode | 2 | Essential | 11 | Total : 00, Seoul : 11, Jeonnam Gwangju: 12, Busan : 21, Daegu : 22, Incheon : 23, Gwangju : 24, Daejeon : 25, Ulsan : 26, Gyeonggi : 31, Gangwon : 32, Chungbuk : 33, Chungnam : 34, Jeonbuk : 35, Jeonnam : 36, Gyeongbuk : 37, Gyeongnam : 38, Jeju : 39, Se |
| 현장소재지 | areaName | 50 | Essential | 서울 | Site location |
| 발주자구분코드 | baljuCode | 1 | Essential | 0 | Public : 0 , Private (Corporate : 1, Private (Individual : 2, Total : 3 |
| 발주자구분 | baljuGubun | 20 | Essential | 공공 | Client Classification |
| 통보건수 | cnt | 10 | Essential | 100 | Unit: cases |
| 도급구분코드 | dogubCode | 1 | Essential | 1 | Prime Contractor: 1, Subcontractor: 2 |
| 도급구분 | dogubGubun | 20 | Essential | 원도급 | Classification of contract |
| 통보일자 | notiDate | 8 | Essential | 20200813 | Date of notification |
| 에러메시지 | 설명 |
|---|---|
| Unauthorized | API 인증키가 존재하지 않거나 유효하지 않습니다. 공공데이터포털에서 발급받은 인증키 정보를 확인해 주세요. |
| Forbidden | API 서비스에 대한 신청내역이 확인되지 않습니다. 해당 API의 활용신청 여부와 승인 상태를 확인해 주세요. |
| API not found | API 서비스가 존재하지 않습니다. 호출 URL에 오타가 없는지, 폐기된 API는 아닌지 확인해 주세요. |
| Error forwarding request to backend server | 기관 API 서버와의 연결에 실패했습니다. 일시적인 네트워크 오류일 수 있으니 잠시 후 다시 시도해 주세요. |
| Error receiving response from backend server | 기관 API 서버로부터 응답을 받지 못했습니다. 문제가 계속될 경우, '관리부서 전화번호' 혹은 '오류신고 및 문의'를 통해 제공기관에 문의바랍니다. |
| API rate limit exceeded | 현재 많은 사용자가 API를 호출하고 있어, 서버의 최대 동시 요청 수를 초과하였습니다. 잠시 후 다시 호출해주시기 바랍니다. |
| API token quota exceeded | API 서비스의 일일 호출 허용량을 초과하였습니다. 초기화된 이후 다시 이용 바랍니다. |
| Unexpected error | 일시적인 시스템 오류가 발생하였습니다. 문제가 반복될 경우 활용지원센터로 문의바랍니다. |
| SSL certificate verification failed: unknown certificate authority | 자체 서명된 인증서이거나 필요한 중간 인증서가 누락되어 인증서를 신뢰할 수 없습니다. 인증서의 발급 상태를 확인하고, 신뢰할 수 있는 인증기관에서 발급된 인증서를 사용해 주세요. |
| SSL certificate verification failed: invalid certificate | 인증서가 만료되었거나 유효하지 않아 검증에 실패했습니다.인증서의 유효기간 및 정상 여부를 확인해 주세요. |
| SSL certificate verification failed: hostname mismatch | 인증서에 등록된 도메인 주소와 요청한 사이트 주소가 일치하지 않습니다. 호출 URL 또는 인증서의 도메인 설정을 확인해 주세요. |
기업회원입니다. 활용신청할 서비스키를 선택해주세요