우편번호 관리

우편번호 저장/수정/삭제

post

기능설명

• 우편번호 정보를 저장, 수정, 삭제합니다.

---

상세설명

• 저장, 수정 시에 시도명, 시군구명, 행정동명, 지번본번, 지번부번, 도로명은 필수 값입니다.

• 삭제 시 삭제할 우편번호순번은 필수 값입니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post

/v1/system/zipNoMgmt/saveZipNoList

HTTPcURLJavaScriptPython

POST /api/bo/v1/system/zipNoMgmt/saveZipNoList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 938

{
  "all": [
    {
      "zipNoSeq": 1406355,
      "zipNo": 52935,
      "ctpNm": "경상남도",
      "sigNm": "고성군",
      "hemdNm": "고성읍",
      "lnbrMnnm": 540,
      "lnbrSlno": 18,
      "roadNm": "남포로",
      "buldMnnm": 89,
      "buldSlno": 1,
      "bdMgtSn": 4.8820250231054e+24,
      "posBulNm": "text"
    }
  ],
  "create": [
    {
      "zipNoSeq": 1406355,
      "zipNo": 52935,
      "ctpNm": "경상남도",
      "sigNm": "고성군",
      "hemdNm": "고성읍",
      "lnbrMnnm": 540,
      "lnbrSlno": 18,
      "roadNm": "남포로",
      "buldMnnm": 89,
      "buldSlno": 1,
      "bdMgtSn": 4.8820250231054e+24,
      "posBulNm": "text"
    }
  ],
  "update": [
    {
      "zipNoSeq": 1406355,
      "zipNo": 52935,
      "ctpNm": "경상남도",
      "sigNm": "고성군",
      "hemdNm": "고성읍",
      "lnbrMnnm": 540,
      "lnbrSlno": 18,
      "roadNm": "남포로",
      "buldMnnm": 89,
      "buldSlno": 1,
      "bdMgtSn": 4.8820250231054e+24,
      "posBulNm": "text"
    }
  ],
  "delete": [
    {
      "zipNoSeq": 1406355,
      "zipNo": 52935,
      "ctpNm": "경상남도",
      "sigNm": "고성군",
      "hemdNm": "고성읍",
      "lnbrMnnm": 540,
      "lnbrSlno": 18,
      "roadNm": "남포로",
      "buldMnnm": 89,
      "buldSlno": 1,
      "bdMgtSn": 4.8820250231054e+24,
      "posBulNm": "text"
    }
  ]
}

text

우편번호 목록 조회

get

기능설명

• 화면에서 넘어온 시도명, 시군구명, 검색어에 맞는 우편번호 목록을 조회합니다.

---

상세설명

• 화면에서 넘어온 시도명, 시군구명, 검색어에 맞는 우편번호 목록을 조회합니다.

• 시도명(ctpNmParam), 시군구명(sigNmParam), 검색어(param1)은 모두 필수 값입니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ctpNmParamstringRequired

시도명

sigNmParamstringRequired

시군구명

param1stringRequired

검색어

pageIdxstringRequired

현재 페이지

Example: 1

rowsPerPagestringRequired

페이지 당 row

Example: 10

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v2/system/zipNoMgmt/getZipNoList

HTTPcURLJavaScriptPython

GET /api/bo/v2/system/zipNoMgmt/getZipNoList?req=[object+Object]&ctpNmParam=text&sigNmParam=text&param1=text&pageIdx=text&rowsPerPage=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "zipNoSeq": 1406355,
      "zipNo": 52935,
      "ctpNm": "경상남도",
      "sigNm": "고성군",
      "hemdNm": "고성읍",
      "lnbrMnnm": 540,
      "lnbrSlno": 18,
      "roadNm": "남포로"
    }
  ]
}

시도명 목록 조회

get

기능설명

• 시도명 목록을 조회합니다.

---

상세설명

• 시도코드와 시도명을 반환합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

성공

*/*

시군구 조회 Response

sidoCdstringOptional

시도코드

Example: 11

sidoGugunCdstringOptional

시군구코드

Example: 110

sidoNmstringOptional

시도명

Example: 서울특별시

sidoGugunNmstringOptional

시군구명

Example: 종로구

900

업무처리 오류 내용

*/*

get

/v1/system/zipNoMgmt/getSidoList

HTTPcURLJavaScriptPython

GET /api/bo/v1/system/zipNoMgmt/getSidoList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "sidoCd": 11,
    "sidoGugunCd": 110,
    "sidoNm": "서울특별시",
    "sidoGugunNm": "종로구"
  }
]

구군명 목록 조회

get

기능설명

• 구군명 목록을 조회합니다.

---

상세설명

• 화면에서 넘어온 시도명에 대한 시도코드, 시도명, 시군구코드, 시군구명을 반환합니다.

• 시도명은 필수입니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

sidoNmstringRequired

시도명

Responses

200

성공

*/*

시군구 조회 Response

sidoCdstringOptional

시도코드

Example: 11

sidoGugunCdstringOptional

시군구코드

Example: 110

sidoNmstringOptional

시도명

Example: 서울특별시

sidoGugunNmstringOptional

시군구명

Example: 종로구

900

업무처리 오류 내용

*/*

get

/v1/system/zipNoMgmt/getGugunList

HTTPcURLJavaScriptPython

GET /api/bo/v1/system/zipNoMgmt/getGugunList?sidoNm=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "sidoCd": 11,
    "sidoGugunCd": 110,
    "sidoNm": "서울특별시",
    "sidoGugunNm": "종로구"
  }
]