joseon-address.js API
DOWN ☞
joseon-address-1.0.js
Method Info
● Joseon.Address
＃public
- setParam() : Joseon Address를 사용하기 위해 파라미터 셋팅(리터럴 형식)
- sendData() : 검색 결과(우편번호,지번)를 클릭 시 Input에 채워넣어준다.
(예외상황 : postCode , roadFullAddr 이라는 id 속성이 존재하지 않을경우 발생 // throw new Error)
- toggleElementAppendBody() : setParam()에서 설정한 'showElement' 기준으로 해당 태그가 없으면 자동으로 마지막 body 태그위에
검색결과 물을 담아줄 부모 태그를 생성하게 된다.
- load() : 검색 결과를 화면에 노출시켜준다.
＃private
- _paramCheck() : setParam()에서 입력한 파라미터를 체크
(return true,false // false 일경우 Param argument Error!! 라는 메시지 제공)
● Joseon.module.exports
(동적으로 생성된 데이터를 이벤트 처리)
● Joseon.global
(전역 변수로 사용)
RequestParam Info
| 요청변수 | 값 | 설명 |
|---|---|---|
| regkey | string(필수) |
사용신청을 통해 받은 인증 key 스트링(30자리) |
| target | string(필수) |
postNew 우편번호 통합검색을 위해 지정해야 하는 필수 값 입니다. |
| query | string(필수) |
조회하고자 하는 내용의 검색 질의어입니다. - 도로명 + 건물번호 (예) 도움5로 19 - 건물명 (예) 우정사업본부 - 읍/면/동/리 + 지번 (예) 어진동 307-19 - 사서함 + 사서함번호 (예) 광화문우체국사서함 45 |
| countPerPage | number |
한번에 조회할 결과 건수입니다.(페이지당 조회 건수) - 기본값(미입력 시) : 10 - 최대 입력 가능 값 : 50 |
| currentPage | number |
조회할 페이지 번호입니다. - 기본값(미입력 시) : 1 |