이 페이지의 구성
오픈API 상세
| 항목명(국문) | 항목명(영문) | 항목크기 | 항목구분 | 샘플데이터 | 항목설명 |
|---|---|---|---|---|---|
| 서비스키 | serviceKey | 100 | 필 | - | 공공데이터포털에서 받은 인증키 |
| 페이지 번호 | pageNo | 4 | 옵 | 1 | 페이지번호 |
| 한 페이지 결과 수 | numOfRows | 4 | 옵 | 10 | 한 페이지 결과 수 |
| 요청 데이터 타입 | resultType | 4 | 옵 | JSON | 요청 데이터 타입(JSON, XML) |
| 항목명(국문) | 항목명(영문) | 항목크기 | 항목구분 | 샘플데이터 | 항목설명 |
|---|---|---|---|---|---|
| 그룹ID | gpId | 100 | 옵 | CLRC_RG_CNDX | 메타그룹ID |
| 그룹명 | gpNm | 300 | 옵 | 진단정보 | 메타그룹명 |
| 테이블ID | tblId | 100 | 옵 | CLRC_RG_CNDX | 테이블영문명 |
| 테이블명 | tblNm | 300 | 옵 | 진단정보 | 테이블한글명 |
| 컬럼ID | colId | 100 | 옵 | ETC_CNCR_YN | 컬럼영문명 |
| 컬럼명 | colNm | 300 | 옵 | 기타암여부 | 컬럼한글명 |
| 타입 | dataType | 50 | 옵 | CHAR | 데이터타입 |
| 항목설명 | colDesc | 4000 | 옵 | 기타 암여부 | 항목설명 |
| 항목건수 | colCnt | 6 | 옵 | 55 | 항목건수 |
| 항목형식 | dispFormat | 1000 | 옵 | Y/N | 항목형식 |
| 결과코드 | resultCode | 2 | 필 | 00 | 결과코드 |
| 결과메시지 | resultMsg | 50 | 필 | OK | 결과메시지 |
| 순번 | num | 50 | 옵 | 1 | 정렬순서 |
| 에러메시지 | 에러코드 | 설명 |
|---|---|---|
| APPLICATION_ERROR | 01 | GW 내부 처리 중 예기치 않은 오류가 발생했습니다. 잠시 후 다시 호출하고, 문제가 반복되면 활용지원센터로 문의해 주세요. |
| HTTP_ERROR | 04 | 허용되지 않은 HTTP 요청이거나 기관 API 응답 처리에 실패했습니다. 요청 방식과 호출 URL을 확인해 주세요. |
| SERVICETIMEOUT_ERROR | 05 | 기관 API 또는 GW 연계 서비스와의 연결에 실패했거나 응답 대기시간을 초과했습니다. 잠시 후 다시 호출해 주세요. |
| INVALID_REQUEST_PARAMETER_ERROR | 10 | 요청 파라미터의 값이나 형식이 올바르지 않습니다. API 명세에서 파라미터 이름, 형식 및 허용값을 확인해 주세요. |
| NO_OPENAPI_SERVICE_ERROR | 12 | 요청한 오픈API 서비스가 존재하지 않거나 폐기되었습니다. 호출 URL에 오타가 없는지 확인해 주세요. |
| SERVICE_KEY_IS_NULL | 20 | 요청에 API 인증키가 포함되지 않았습니다. 공공데이터포털에서 발급받은 인증키를 요청 파라미터에 포함해 주세요. |
| PERMISSION_DENIED | 20 | GW 접근 권한 검사에서 요청이 거부되었습니다. 해당 API의 활용신청 및 접근 권한을 확인해 주세요. |
| LIMITED_NUMBER_OF_SERVICE_REQUESTS_EXCEEDS_ERROR | 22 | API 서비스의 일일 호출 허용량을 초과했습니다. 호출량이 초기화된 이후 다시 이용하거나 트래픽 증설을 신청해 주세요. |
| LIMITED_NUMBER_OF_SERVICE_REQUESTS_PER_SECOND_EXCEEDS_ERROR | 23 | 짧은 시간에 많은 요청이 발생하여 초당 호출 허용량을 초과했습니다. 잠시 후 다시 호출해 주세요. |
| BLACKLIST_IP_ACCESS_ERROR | 29 | 차단된 IP에서 호출한 요청입니다. 호출 서버의 IP를 확인하고, 차단 해제가 필요한 경우 활용지원센터로 문의해 주세요. |
| 에러메시지 | 에러코드 | 설명 |
|---|---|---|
| SERVICE_ACCESS_DENIED_ERROR | 20 | 해당 API 서비스에 대한 이용 권한이 확인되지 않습니다. 활용신청 여부와 승인 또는 일시중지 상태를 확인해 주세요. |
| SERVICE_KEY_IS_NOT_REGISTERED_ERROR | 30 | 등록되지 않은 API 인증키입니다. 인증키가 정확한지와 해당 서비스의 활용신청이 정상적으로 완료되었는지 확인해 주세요. |
| DEADLINE_HAS_EXPIRED_ERROR | 31 | API 인증키의 사용 기한이 만료되었습니다. 공공데이터포털에서 이용 기간을 확인하거나 갱신해 주세요. |
기업회원입니다. 활용신청할 서비스키를 선택해주세요