市区町村マスタ取得API

市区町村マスタ一覧を取得するAPI

市区町村マスタ取得APIは、市区町村の名前、保険者番号等の情報を取得します。
リクエストで都道府県での絞り込みが可能です。指定がない場合は、全ての市区町村情報を取得します。

API ID

MST0002

Request URL

munic/select
環境 URL
Staging環境 https://stage-api.link.carekarte.jp/munic/select
環境 URL
本番環境 https://api.link.carekarte.jp/munic/select

HTTPメソッド

POST

リクエスト

header（すべて必須）

名前 値
Content-Type application/json
authorization tokenサービスで取得した値を設定

Body（JSON形式）

パラメータ 型 必須 サイズ・形式 説明 仕様
prefCd String   2桁 都道府県コード 宣言あり：該当の都道府県コードの市区町村のみを表示
宣言なし：全ての都道府県市区町村を表示
useFlag Boolean     使用フラグ true：使用チェックONのもののみ表示
false・もしくは宣言なし：使用チェックに関係なく表示

※Bodyに必須項目がないため、Bodyなしでもリクエスト可能

サンプルデータ

{
  "prefCd":"22",
  "useFlag":true
}

レスポンス

Body（JSON形式）

パラメータ 型 必須 サイズ・形式 説明 仕様
result [array] ○   結果を返却する  
  prefCd String ○ 2桁 都道府県コード  
  municCd String ○ 3桁 市区町村コード  
  municNm String ○   市区町村名  
  insurerCd1 String ○ 6桁 保険者番号1  
  insurerCd2 String ○ 6桁 保険者番号2  
  postCd String ○   郵便番号 ※CAREKARTEで入力してある場合、その値が表示されます。
  municldrNm String ○   市町村長名 ※CAREKARTEで入力してある場合、その値が表示されます。
  useFlag Boolean ○   使用フラグ true:使用チェックON
false:使用チェックOFF

サンプルデータ

市区町村マスタの正常取得時
{
    "result": [
        {
            "prefCd": "22",
            "municCd": "100",
            "municNm": "静岡市",
            "insurerCd1": "221002",
            "insurerCd2": "221002",
            "postCd": "",
            "municldrNm": "",
            "useFlag": true
        },
        {
            "prefCd": "22",
            "municCd": "101",
            "municNm": "静岡市葵区",
            "insurerCd1": "221010",
            "insurerCd2": "",
            "postCd": "",
            "municldrNm": "",
            "useFlag": true
        },
        {
            "prefCd": "22",
            "municCd": "102",
            "municNm": "静岡市駿河区",
            "insurerCd1": "221028",
            "insurerCd2": "",
            "postCd": "",
            "municldrNm": "",
            "useFlag": true
        },
        {
            "prefCd": "22",
            "municCd": "130",
            "municNm": "浜松市",
            "insurerCd1": "221309",
            "insurerCd2": "221309",
            "postCd": "",
            "municldrNm": "",
            "useFlag": true
        },
        {
            "prefCd": "22",
            "municCd": "209",
            "municNm": "島田市",
            "insurerCd1": "222091",
            "insurerCd2": "222097",
            "postCd": "",
            "municldrNm": "",
            "useFlag": true
        },
        {
            "prefCd": "22",
            "municCd": "214",
            "municNm": "藤枝市",
            "insurerCd1": "222141",
            "insurerCd2": "222141",
            "postCd": "",
            "municldrNm": "",
            "useFlag": true
        },
        {
            "prefCd": "22",
            "municCd": "215",
            "municNm": "御殿場市",
            "insurerCd1": "222158",
            "insurerCd2": "222158",
            "postCd": "",
            "municldrNm": "",
            "useFlag": true
        }
    ]
}

エラー発生時（リクエスト内のパラメータ値が不正な場合）
{
    "ecErrorCode": "",
    "elErrorCode": "EL400001",
    "message": "[useFlag]の値が正しくありません。",
    "method": "POST",
    "path": "/munic/select",
    "code": 400,
    "timestamp": "4/20/2022, 6:16:43 AM"
}

連携イメージ(CAREKARTE)