郵便番号から住所を求める最終更新日: 2021年3月9日
R8 | R9

郵便番号からの前方一致検索

郵便番号を前方一致で検索し、対応する住所を返します。

@RequestMapping(value="/rest/zipcode/{zipcode}", method=GET)

URL例

http://localhost:8921/wagby/rest/zipcode/9012227

レスポンス

STATUS=200 OK
返戻の内容例を示します。

[
   {
       "ZIPCODE": "9012227",
       "ADDRESS": "沖縄県宜野湾市宇地泊"
   }
]

ハイフン区切りで指定すると、結果もハイフン区切りとなります。
http://localhost:8921/wagby/rest/zipcode/901-2227

[
   {
       "ZIPCODE": "901-2227",
       "ADDRESS": "沖縄県宜野湾市宇地泊"
   }
]

マッチするデータがない場合は ADDRESS 部が空白になります。ステータスコードは 404 Not Found になります。
http://localhost:8921/wagby/rest/zipcode/9999999

[
   {
       "ZIPCODE": "9999999",
       "ADDRESS": ""
   }
]

マッチするデータが複数の場合は次のようになります。
http://localhost:8921/wagby/rest/zipcode/901

[
   {
       "ZIPCODE": "9010141",
       "ADDRESS": "沖縄県那覇市住吉町"
   },
   {
       "ZIPCODE": "9010142",
       "ADDRESS": "沖縄県那覇市鏡水"
   },
...
   {
       "ZIPCODE": "9013992",
       "ADDRESS": "沖縄県島尻郡北大東村字中野218"
   }
]

マッチするデータが複数の場合、ハイフン区切りで入力すると結果にもハイフンが付与されます。
http://localhost:8921/wagby/rest/zipcode/901-

[
   {
       "ZIPCODE": "901-0141",
       "ADDRESS": "沖縄県那覇市住吉町"
   },
   {
       "ZIPCODE": "901-0142",
       "ADDRESS": "沖縄県那覇市鏡水"
   },
   {
       "ZIPCODE": "901-0143",
       "ADDRESS": "沖縄県那覇市安次嶺"
   },
...
   {
       "ZIPCODE": "901-3992",
       "ADDRESS": "沖縄県島尻郡北大東村字中野218"
   }
]

レスポンス - 住所がみつからない

STATUS=404 Not Found

レスポンス - エラー

  • 郵便番号は3桁以上、7桁までを指定する必要があります。3桁未満もしくは7桁を超えた場合、400 Bad Request が返されます。またログにエラーが記録されます。
  • 定義したモデルに郵便番号項目がない場合に、このREST APIを呼びだした場合は 500 Internal Serverr Error が返されます。