支援制度情報提供サービス API V2 リファレンス

area/prefectures/{id}/municipalities

指定した「都道府県」に含まれる全ての「市町村」(名称)を取得します。

{id} に指定する「都道府県」のidは、関連リクエストによるレスポンス内のprefecture要素のidを指定します。

 

関連リクエスト

supports

supports/{id}/local_contacts

area/prefectures

area/area_groups/{id}/intended_area

 

リクエスト

URL

http://api.r-assistance.go.jp/v2/area/prefectures/{id}/municipalities.{format}

パラメータ

名前

省略可否

説明

{id}

必須

取得したい「都道府県」のidを指定します。

idは1つだけ指定できます。

{format}

必須

レスポンスデータの形式を指定します。

“xml” :レスポンスデータがXML形式で返ります。

“json” :レスポンスデータがJSON形式で返ります。

appkey

必須

常に 0 を指定してください。

レスポンス

XML

<municipalities_response>
    <municipalities>
        <municipality>
            <id>string</id>
            <name>string</name>
        </municipality>
    </municipalities>
</municipalities_response>

JSON

{
    "municipalities": [
        {
            "id": {string},
            "name": {string}
        }
    ]
}

要素(フィールド)の説明

要素(フィールド)

説明

municipalities[]

array

「市町村」の配列

municipalities[].id

string

「市町村」のid

municipalities[].name

string

「市町村」の名称

XML

GET    http://api.r-assistance.go.jp/v2/area/prefectures/03000/municipalities.xml?appkey=0
<municipalities_response xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <municipalities>
        <municipality>
            <id>03201</id>
            <name>盛岡市</name>
        </municipality>
        <municipality>
            <id>03202</id>
            <name>宮古市</name>
        </municipality>
        <municipality>
            <id>03203</id>
            <name>大船渡市</name>
        </municipality>
        <municipality>
            <id>03205</id>
            <name>花巻市</name>
        </municipality>
        ・・・
    </municipalities>
</municipalities_response>

JSON

GET    http://api.r-assistance.go.jp/v2/area/prefectures/03000/municipalities.json?appkey=0
{
    "municipalities": [
        {
            "id": "03201",
            "name": "盛岡市"
        },
        {
            "id": "03202",
            "name": "宮古市"
        },
        {
            "id": "03203",
            "name": "大船渡市"
        },
        {
            "id": "03205",
            "name": "花巻市"
        },
        ...
    ]
}