> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/back-office-api/system-bo-api/undefined-13.md).
# 우편번호 관리
## 우편번호 저장/수정/삭제
> \## 기능설명\
> \* 우편번호 정보를 저장, 수정, 삭제합니다.\
> \---\
> \## 상세설명\
> \* 저장, 수정 시에 시도명, 시군구명, 행정동명, 지번본번, 지번부번, 도로명은 필수 값입니다.\
> \* 삭제 시 삭제할 우편번호순번은 필수 값입니다.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridCUDRequestZipNoMgmtCudRequest":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/ZipNoMgmtCudRequest"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/ZipNoMgmtCudRequest"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/ZipNoMgmtCudRequest"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/ZipNoMgmtCudRequest"}}}},"ZipNoMgmtCudRequest":{"type":"object","description":"우편번호 등록/수정/삭제 요청 DTO","properties":{"zipNoSeq":{"type":"integer","format":"int32","description":"우편번호순번"},"zipNo":{"type":"string","description":"우편번호"},"ctpNm":{"type":"string","description":"시도명"},"sigNm":{"type":"string","description":"시군구명"},"hemdNm":{"type":"string","description":"행정동명"},"lnbrMnnm":{"type":"string","description":"지번본번"},"lnbrSlno":{"type":"string","description":"지번부번"},"roadNm":{"type":"string","description":"도로명"},"buldMnnm":{"type":"string","description":"건물번호본번"},"buldSlno":{"type":"string","description":"건물번호부번"},"bdMgtSn":{"type":"string","description":"건물관리번호"},"posBulNm":{"type":"string","description":"시군구용건물명"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/zipNoMgmt/saveZipNoList":{"post":{"tags":["우편번호 관리"],"summary":"우편번호 저장/수정/삭제","description":"## 기능설명\n* 우편번호 정보를 저장, 수정, 삭제합니다.\n---\n## 상세설명\n* 저장, 수정 시에 시도명, 시군구명, 행정동명, 지번본번, 지번부번, 도로명은 필수 값입니다.\n* 삭제 시 삭제할 우편번호순번은 필수 값입니다.\n","operationId":"saveZipNoList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestZipNoMgmtCudRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 우편번호 목록 조회
> \## 기능설명\
> \* 화면에서 넘어온 시도명, 시군구명, 검색어에 맞는 우편번호 목록을 조회합니다.\
> \---\
> \## 상세설명\
> \* 화면에서 넘어온 시도명, 시군구명, 검색어에 맞는 우편번호 목록을 조회합니다.\
> \* 시도명(ctpNmParam), 시군구명(sigNmParam), 검색어(param1)은 모두 필수 값입니다.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ZipNoMgmtRequest":{"type":"object","properties":{"ctpNmParam":{"type":"string","minLength":1},"sigNmParam":{"type":"string","minLength":1},"param1":{"type":"string","minLength":1},"param2":{"type":"string"}},"required":["ctpNmParam","param1","sigNmParam"]},"RealGridListResponseZipNoMgmtResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/ZipNoMgmtResponse"}}}},"ZipNoMgmtResponse":{"type":"object","description":"우편번호 관리 조회 Response","properties":{"zipNoSeq":{"type":"string","description":"우편번호순번"},"zipNo":{"type":"string","description":"우편번호"},"ctpNm":{"type":"string","description":"시도명"},"sigNm":{"type":"string","description":"시군구명"},"hemdNm":{"type":"string","description":"행정동명"},"lnbrMnnm":{"type":"string","description":"지번본번"},"lnbrSlno":{"type":"string","description":"지번부번"},"roadNm":{"type":"string","description":"도로명"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/system/zipNoMgmt/getZipNoList":{"get":{"tags":["우편번호 관리"],"summary":"우편번호 목록 조회","description":"## 기능설명\n* 화면에서 넘어온 시도명, 시군구명, 검색어에 맞는 우편번호 목록을 조회합니다.\n---\n## 상세설명\n* 화면에서 넘어온 시도명, 시군구명, 검색어에 맞는 우편번호 목록을 조회합니다.\n* 시도명(ctpNmParam), 시군구명(sigNmParam), 검색어(param1)은 모두 필수 값입니다.\n","operationId":"getZipNoList","parameters":[{"name":"req","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ZipNoMgmtRequest"}},{"name":"ctpNmParam","in":"query","description":"시도명","required":true,"schema":{"type":"string"}},{"name":"sigNmParam","in":"query","description":"시군구명","required":true,"schema":{"type":"string"}},{"name":"param1","in":"query","description":"검색어","required":true,"schema":{"type":"string"}},{"name":"pageIdx","in":"query","description":"현재 페이지","required":true,"schema":{"type":"string"}},{"name":"rowsPerPage","in":"query","description":"페이지 당 row","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseZipNoMgmtResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 시도명 목록 조회
> \## 기능설명\
> \* 시도명 목록을 조회합니다.\
> \---\
> \## 상세설명\
> \* 시도코드와 시도명을 반환합니다.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"EtSidoGugunInfoResponse":{"type":"object","description":"시군구 조회 Response","properties":{"sidoCd":{"type":"string","description":"시도코드"},"sidoGugunCd":{"type":"string","description":"시군구코드"},"sidoNm":{"type":"string","description":"시도명"},"sidoGugunNm":{"type":"string","description":"시군구명"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/zipNoMgmt/getSidoList":{"get":{"tags":["우편번호 관리"],"summary":"시도명 목록 조회","description":"## 기능설명\n* 시도명 목록을 조회합니다.\n---\n## 상세설명\n* 시도코드와 시도명을 반환합니다.\n","operationId":"getSidoList","responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EtSidoGugunInfoResponse"}}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 구군명 목록 조회
> \## 기능설명\
> \* 구군명 목록을 조회합니다.\
> \---\
> \## 상세설명\
> \* 화면에서 넘어온 시도명에 대한 시도코드, 시도명, 시군구코드, 시군구명을 반환합니다.\
> \* 시도명은 필수입니다.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"EtSidoGugunInfoResponse":{"type":"object","description":"시군구 조회 Response","properties":{"sidoCd":{"type":"string","description":"시도코드"},"sidoGugunCd":{"type":"string","description":"시군구코드"},"sidoNm":{"type":"string","description":"시도명"},"sidoGugunNm":{"type":"string","description":"시군구명"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/zipNoMgmt/getGugunList":{"get":{"tags":["우편번호 관리"],"summary":"구군명 목록 조회","description":"## 기능설명\n* 구군명 목록을 조회합니다.\n---\n## 상세설명\n* 화면에서 넘어온 시도명에 대한 시도코드, 시도명, 시군구코드, 시군구명을 반환합니다.\n* 시도명은 필수입니다.\n","operationId":"getGuginList","parameters":[{"name":"sidoNm","in":"query","description":"시도명","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EtSidoGugunInfoResponse"}}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```