2D데이터 API 2.0 레퍼런스
2D데이터 API 2.0 레퍼런스입니다.생태계경관보전지역 (데이터버전 : 1.0)
- 생물다양성이 풍부하여 생태적으로 중요하거나 자연경관이 수려하여 특별히 보전할 가치가 큰 지역으로서 환경부장관이 「자연환경보전법」에 의하여 지정·고시하는 지역
요청 URL
| http://api.vworld.kr/req/data |
|---|
https나 Flex 등 웹뷰어가 아닌 브라우저에서의 API사용은 요청URL에 도메인정보를 추가하여 서비스를 이용합니다.
예) http://api.vworld.kr/req/data?service=data&request=GetFeature&data=LT_C_WGISARECO&key=인증키&domain=인증키 URL&[요청파라미터] |
생태계경관보전지역 속성정보
| 속성명 | 단일검색* | 샘플데이터 | 설명 |
|---|---|---|---|
| name | N | 관악산 | 명칭 |
| ag_geom | N | POLYGON(...) | GEOMETRY 데이터 |
*단일검색=Y : geomFilter 없이도 해당속성명이 포함된 attrFilter만으로 검색 가능
오퍼레이션
| 오퍼레이션 | 설명 |
|---|---|
| GetFeature | 생태계경관보전지역의 도형, 속성 정보를 조회 WFS보다 간결한 형태의 데이터 조회 기능을 제공하며, 복잡한 Query가 필요할 경우 WFS를 사용하도록 권고함 |
| GetFeatureType | 생태계경관보전지역 데이터의 타입(스키마)을 조회 (서비스 예정) |
요청파라미터
| 파라미터 | 선택 | 설명 | 유효값 |
|---|---|---|---|
| service | O/1 | 요청 서비스명 | data(기본값) |
| version | O/1 | 요청 서비스 버전 | 2.0(기본값) |
| request | M/1 | 요청 서비스 오퍼레이션 | GetFeature, GetFeatureType |
| key | M/1 | 발급받은 api key | |
| format | O/1 | 응답결과 포맷 | json(기본값), xml |
| errorFormat | O/1 | 에러 응답결과 포맷, 생략 시 format파라미터에 지정된 포맷으로 설정 | json, xml |
| size | O/1 | 한 페이지에 출력될 응답결과 건수 | 숫자, default(10), min(1), max(1000) |
| page | O/1 | 응답결과 페이지 번호 | 숫자
기본값 : 1 |
| data | M/1 | 조회할 데이터 | LT_C_WGISARECO |
| geomFilter | M/1 | 지오메트리 필터
포맷 - POINT(x y) - LINESTRING(x1 y1,x2 y2 [,xn yn]) - POLYGON((x1 y1,x2 y2[,xn yn])) - MULTIPOLYGON(((x1 y1,x2 y2[,xn yn]))[,((x1 y1,x2 y2 [,xn yn]))]) - BOX(minx,miny,maxx,maxy) |
|
| attrFilter | O/n | 속성조회를 위한 조건검색을 정의
포맷 : 속성명A:연산자A:비교값A|속성명B:연산자B:비교값B - 여러 조건은 [|](Shift+\)로 구분하며, 한 조건의 내부는 [:]로 구분함 속성명 : 연산 대상이 되는 필드명 연산자 : =, >=, <=, <, >, <>, BETWEEN(포맷 : min,max), LIKE, IN(포맷 : 값1,값2) 예) attrFilter=uname:like:제2종일반|dyear:between:2000,2015|emdCd:=:41173102 단, 단일검색=Y가 있는 경우에는 해당속성명을 포함할 경우 geomFilter없이 attrFilter만으로 검색 가능 예) attrFilter=pnu:=:검색값 |
단일검색=Y도 없고 geomFilter도 없을 경우, emdCd(읍면동코드) 필수  읍면동코드 조회 |
| columns | O/1 | 응답결과로 받기를 원하는 컬럼, 생략 시 전체 컬럼 반환 | 생태계경관보전지역 속성정보 |
| geometry | O/1 | 지오메트리 반환 여부 | true(기본값), false |
| attribute | O/1 | 속성 반환 여부 | true(기본값), false |
| buffer | O/1 | geomFilter파라미터에 입력한 feature를 buffer(거리, 단위:m)만큼 확장 | 숫자, 기본값:0 |
| crs | O/1 | 응답결과 좌표계 | 지원좌표계 참고,
EPSG:4326(기본값) |
| callback | O/1 | format값이 json일 경우 callback함수를 지원합니다. | |
| domain | O/1 | https나 Flex 등 웹뷰어가 아닌 브라우저에서의 API사용할 경우
인증키 발급 시 입력한 url을 입력합니다. |
* M/1 : 필수 입력, 값은 1개만 입력가능
* O/1 : 선택 입력(입력안하면 기본값 설정), 값은 1개만 입력가능
* O/n : 선택 입력, 쉼표(,)로 구분된 여러개의 값입력 가능. 예)category=1134,112829,11284
응답결과
| 항목명 | 타입 | 설명 | |
|---|---|---|---|
| service | 요청 서비스 정보 Root | ||
| name | 문자 | 요청 서비스명 | |
| version | 숫자 | 요청 서비스 버전 | |
| operation | 문자 | 요청 서비스 오퍼레이션 이름 | |
| time | 숫자 | 응답결과 생성 시간 | |
| status | 문자 | 처리 결과의 상태 표시, 유효값 : OK(성공), NOT_FOUND(결과없음), ERROR(에러) | |
| record | 응답결과 건수 정보 Root | ||
| total | 숫자 | 전체 결과 건수 | |
| current | 숫자 | 현재 반환된 결과 건수 | |
| page | 응답결과 페이지 정보 Root | ||
| total | 숫자 | 전체 페이지 수 | |
| current | 숫자 | 현재 페이지 번호 | |
| size | 숫자 | 페이지 당 반환되는 결과 건수 | |
| result | 응답결과 Root | ||
| 생태계경관보전지역 속성정보 | 문자 | format이 xml일 경우 GML로, json일 경우 geojson으로 표현 | |
지원좌표계
| 좌표계 | 설명 |
|---|---|
| WGS84 경위도 | EPSG:4326 |
| GRS80 경위도 | EPSG:4019 |
| Google Mercator | EPSG:3857, EPSG:900913 |
| 서부원점(GRS80) | EPSG:5180(50만), EPSG:5185 |
| 중부원점(GRS80) | EPSG:5181(50만), EPSG:5186 |
| 제주원점(GRS80, 55만) | EPSG:5182 |
| 동부원점(GRS80) | EPSG:5183(50만), EPSG:5187 |
| 동해(울릉)원점(GRS80) | EPSG:5184(50만), EPSG:5188 |
| UTM-K(GRS80) | EPSG:5179 |
오류 응답결과
| 항목명 | 타입 | 설명 | |
|---|---|---|---|
| service | 문자 | 요청 서비스 정보 Root | |
| name | 문자 | 요청 서비스명 | |
| version | 숫자 | 요청 서비스 버전 | |
| operation | 문자 | 요청 서비스 오퍼레이션 이름 | |
| time | 숫자 | 응답결과 생성 시간 | |
| status | 문자 | 처리 결과의 상태 표시, 유효값 : OK(성공), NOT_FOUND(결과없음), ERROR(에러) | |
| error | 문자 | 에러 정보 Root | |
| level | 숫자 | 에러 레벨 | |
| code | 문자 | 에러 코드 | |
| text | 문자 | 에러 메시지 | |
오류메세지
| 코드 | 레벨 | 메세지 | 비고 |
|---|---|---|---|
| PARAM_REQUIRED | 1 | 필수 파라미터인 <%S1>가 없어서 요청을 처리할수 없습니다. | %S1 : 파라미터 이름 |
| INVALID_TYPE | 1 |
<%S1> 파라미터 타입이 유효하지 않습니다.
유효한 파라미터 타입 : <%S2> 입력한 파라미터 값 : <%S3> |
%S1 : 파라미터 이름
%S2 : 유효한 파라미터 값의 유형 %S3 : 입력한 파라미터 값 |
| INVALID_RANGE | 1 | <%S1> 파라미터의 값이 유효한 범위를 넘었습니다.
유효한 파라미터 타입 : <%S2> 입력한 파라미터 값 : <%S3> |
%S1 : 파라미터 이름
%S2 : 유효한 파라미터 값의 범위 %S3 : 입력한 파라미터 값 |
| INVALID_KEY | 2 | 등록되지 않은 인증키입니다. | |
| INCORRECT_KEY | 2 | 인증키 정보가 올바르지 않습니다.
(ex. 인증키 발급 시 입력한 도메인이 다를경우) |
|
| UNAVAILABLE_KEY | 2 | 임시로 인증키를 사용할 수 없는 상태입니다. | |
| OVER_REQUEST_LIMIT | 2 | 서비스 사용량이 일일 제한량을 초과하여 더 이상 서비스를 사용할 수 없습니다. | |
| SYSTEM_ERROR | 3 | 시스템 에러가 발생하였습니다. | |
| UNKNOWN_ERROR | 3 | 알 수 없는 에러가 발생하였습니다. |