都道府県マスタ取得API

都道府県マスタ一覧を取得するAPI

都道府県マスタ取得APIは、都道府県のコードを取得します。
リクエストで都道府県マスタに使用するチェックをつけているもののみ、全てのいずれかの絞り込みが可能です。

API ID

MST0001

Request URL

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

HTTPメソッド

POST

リクエスト

header（すべて必須）

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

Body（JSON形式）

パラメータ 型 必須 サイズ・形式 説明 仕様
useFlag Boolean     使用フラグ true：使用チェックONのみ表示
false・もしくは宣言なし：使用チェックに関係なく表示

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

サンプルデータ

{
  "useFlag":true
}

レスポンス

Body（JSON形式）

パラメータ 型 必須 サイズ・形式 説明 仕様
result [array] ○   結果を返却する  
　prefCd String ○ 2桁 都道府県コード  
　prefNm String ○   都道府県名  
　useFlag Boolean ○   使用フラグ true：使用チェックON
false：使用チェックOFF

サンプルデータ

都道府県の正常取得時
{
    "result": [
        {
            "prefCd": "01",
            "prefNm": "北海道",
            "useFlag": true
        },
        {
            "prefCd": "03",
            "prefNm": "岩手県",
            "useFlag": true
        },
        {
            "prefCd": "10",
            "prefNm": "群馬県",
            "useFlag": true
        },
        {
            "prefCd": "12",
            "prefNm": "千葉県",
            "useFlag": true
        },
        {
            "prefCd": "14",
            "prefNm": "神奈川県",
            "useFlag": true
        },
        {
            "prefCd": "22",
            "prefNm": "静岡県",
            "useFlag": true
        },
        {
            "prefCd": "23",
            "prefNm": "愛知県",
            "useFlag": true
        }
    ]
}

エラー発生時（許可されていないHTTPメソッドのリクエストを実施した場合）
{
    "ecErrorCode": "",
    "elErrorCode": "EL405000",
    "message": "リクエストのHTTPメソッドが間違っています。",
    "method": "PUT",
    "path": "/pref/select",
    "code": 405,
    "timestamp": "4/14/2022, 9:53:48 AM"
}

連携イメージ(CAREKARTE)