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

supports

指定した条件に合致する「制度情報」を取得します。

リクエスト

URL

http://api.r-assistance.go.jp/v2/supports.{format}

パラメータ

名前

省略可否

(既定値)

説明

{format}

必須

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

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

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

appkey

必須

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

count

省略可

(10)

取得するデータの最大件数を指定します。

許容値は0以上100以下の整数です。

※0を指定すると、総件数のみ取得されます。

page

省略可

(1)

取得するデータのページ番号を指定します。

許容値は1以上の整数です。

page=1&count=20 →1件目から20件目のデータが取得されます。

page=2&count=20 →21件目から40件目のデータが取得されます。

※ 指定したページ番号に該当するデータが存在しない場合は、総件数のみ取得されます。

sort

省略可

(0)

取得するデータの並び順を指定します。
0: 支援制度情報提供サービスで既定の並び順
1: 更新日降順 + 制度名昇順

※既定の並び順は、よく利用される制度が上位に並びます。既定の並び順は、予告なく変更される可能性があります。

※その他の値を指定した場合はエラーになります。

q

省略可

フリーワード検索の条件文字列を指定します。

半角または全角スペース区切りで複数の文字列を指定できます。(全体で最大100文字、最大5個、重複指定不可)

※条件文字列はURLエンコード(UTF-8)する必要があります。URLエンコードしていない場合は正しい検索結果が得られません。

q_mode

省略可

(0)

q パラメータで指定した条件文字列の検索モードを指定します。
0: AND検索
1: OR検索

※その他の値を指定した場合はエラーになります。

disasters

省略可

検索する「災害」のidを指定します。

(disastersリクエストを参照)

カンマ区切りで複数のidを指定できます。(最大100個、重複指定不可)

※複数指定した場合、OR条件で検索されます。

※存在しないidを指定した場合、該当idによる検索結果は0件となります。

※災害を特定しない制度情報は検索結果に含まれます。

※文字列 "none" を指定した場合、災害を特定しない制度情報のみを検索します。

(2017.12 文字列 "none" での検索に対応)

areas

省略可

検索する「都道府県」または「市町村」のidを指定します。

(area/prefecturesリクエスト、およびarea/prefectures/{id}/municipalitiesリクエストを参照)

カンマ区切りで複数のidを指定できます。(最大100個、重複指定不可)

※複数指定した場合、OR条件で検索されます。

※存在しないidを指定した場合、該当idによる検索結果は0件となります。

※全国を対象とする制度情報は必ず含まれます。

※support_targetsパラメータの指定内容によって、検索内容が異なります。

support_targetsパラメータで 3 (地方公共団体向け) を指定した場合

 「都道府県」のidを指定した場合、その「都道府県」を対象とする制度が該当します。

 「市町村」のidを指定した場合、その「市町村」を対象とする制度が該当します。

support_targetsパラメータの指定が 3 以外の場合

 「都道府県」のidを指定した場合、その「都道府県」またはその「都道府県」に含まれる「市町村」を対象とする制度が該当します。

 「市町村」のidを指定した場合、その「市町村」またはその「市町村」の「都道府県」を対象とする制度が該当します。

support_targets

省略可

検索する「支援の対象」のidを指定します。

(support_targets リクエストを参照)

カンマ区切りで複数のidを指定できます。(最大100個、重複指定不可)

※複数指定した場合、OR条件で検索されます。

※存在しないidを指定した場合、該当idによる検索結果は0件となります。

support_types

省略可

検索する「支援の種類」のidを指定します。

(support_typesリクエストを参照)

カンマ区切りで複数のidを指定できます。(最大100個、重複指定不可)

※現時点では、個人向けおよび事業者向け制度の検索時のみ有効です。

※複数指定した場合、OR条件で検索されます。

※存在しないidを指定した場合、該当idによる検索結果は0件となります。

conditions

省略可

検索する「条件項目」のidを指定します。

(categoriesリクエスト、およびcategories/{id}/conditionsリクエストを参照)

カンマまたはパイプ( | )区切りで複数のidを指定できます。

※カンマはOR条件、パイプはAND条件となります。

※カンマおよびパイプを混合指定した場合、パイプで分割したグループ内がOR条件となり、各グループがAND条件で検索されます。

 (例:1,2|3|4,5,6 の場合、(1 OR 2) AND 3 AND (4 OR 5 OR 6) と評価されます。)

※idは最大100個まで指定でき、グループ内で重複指定不可です。

※存在しないidを指定した場合、該当idによる検索結果は0件となります。

authorities

省略可

検索する「所管組織」のidを指定します。

(authorities/top_authoritiesリクエスト、および authorities/{id}/authoritiesリクエストを参照)

カンマ区切りで複数のid値を指定できます。(最大100個、重複指定不可)

※複数指定した場合、OR条件で検索されます。

※存在しないidを指定した場合、該当idによる検索結果は0件となります。

※最上位の組織のidを指定した場合、配下の組織も検索対象に含まれます。(最上位の組織のみの検索には対応していません。)

updated_since

省略可

指定した日付以降に更新された制度情報を取得します。

日付は、YYYY-MM-DD形式で指定します。

※不正な日付を指定した場合、(400)エラーとなります。

※指定されたフォーマット以外の形式で指定した場合、(400)エラーとなります。

updated_until

省略可

指定した日付以前に更新された制度情報を取得します。

日付は、YYYY-MM-DD形式で指定します。

※不正な日付を指定した場合、(400)エラーとなります。

※指定されたフォーマット以外の形式で指定した場合、(400)エラーとなります。

fields

省略可

「制度情報」に含まれる要素名 (フィールド名) を指定すると、指定した要素 (フィールド) のみ返ります。

カンマ区切りで複数の要素名 (フィールド名) を指定できます。(重複指定不可)

例: id と name のみ取得する場合

  /supports.xml?fileds=id,name

※省略した場合、すべての要素 (フィールド) が返ります。

※idは必ず含まれます。

※孫要素は指定できません。

※不正な要素名を指定するとエラーになります。

intended_area_format

省略可

(1)

「制度情報」に含まれる「対象地域」の取得形式を指定します。

1 :通常の形式です。

0 :互換性のための形式です。対象地域 (intended_area) の地域群 (area_group) に設定されている情報が、都道府県 (prefectures) および市町村セット (municipalities_set) 要素に追加されて返ります。地域群の要素は返りません。

※その他の値を指定した場合はエラーになります。

 

※各検索パラメータ間の検索条件はAND条件となります。

※全ての省略可能なパラメータを省略した場合は、既定値が指定された条件で検索されます。

 

レスポンス

XML

<supports_response>
    <total_count>integer</total_count>
    <supports>
        <support>
            <id>string</id>
            <number>string</number>
            <name>string</name>
            <base>
                <id>string</id>
                <number>string</number>
                <name>string</name>
            </base>
            <has_difference_from_base>string</has_difference_from_base>
            <summary>string</summary>
            <general_info>string</general_info>
            <governing_laws>
                <governing_law>
                    <name>string</name>
                    <url>string</url>
                </governing_law>
            </governing_laws>
            <intended_person>
                <description>string</description>
                <annual_income_max>string</annual_income_max>
                <annual_income_max_remarks>string</annual_income_max_remarks>
            </intended_person>
            <intended_disaster>
                <id>string</id>
            </intended_disaster>
            <intended_area>
                <prefectures>
                    <prefecture>
                        <id>string</id>
                    </prefecture>
                </prefectures>
                <municipalities_sets>
                    <municipalities_set>
                        <id>string</id>
                    </municipalities_set>
                    <municipalitie>
                        <municipality>
                            <id>string</id>
                        </municipality>
                    </municipalities>
                </municipalities_sets>
                <area_groups>
                    <area_group>
                        <id>string</id>
                    </area_group>
                </area_groups>
            </intended_area>
            <application>
                <deadline>
                    <description>string</description>
                </deadline>
                <procedure>
                    <description>string</description>
                    <forms>
                        <form>
                            <name>string</name>
                            <url>string</url>
                        </form>
                    </forms>
                </procedure>
                <e_procedure>
                    <references>
                        <reference>
                            <name>string</name>
                            <url>string</url>
                        </reference>
                    </references>
                </e_procedure>
            </application>
            <term>
                <description>string</description>
            </term>
            <references>
                <reference>
                    <name>string</name>
                    <url>string</url>
                </reference>
            </references>
            <contact>
                <name>string</name>
                <tel>string</tel>
                <fax>string</fax>
                <mail>string</mail>
                <postal_code>string</postal_code>
                <address>string</address>
                <free_description>string</free_description>
            </contact>
            <contact_lists>
                <contact_list>
                    <id>string</id>
                </contact_list>
            </contact_lists>
            <budget>
                <description>string</description>
            </budget>
            <attachments>
                <attachment>
                    <type>string</type>
                    <url>string</url>
                    <file_name>string</file_name>
                    <display_name>string</display_name>
                </attachment>
            </attachments>
            <support_targets>
                <support_target>
                    <id>string</id>
                </support_target>
            </support_targets>
            <support_types>
                <support_type>
                    <id>string</id>
                </support_type>
            </support_types>
            <categories>
                <category>
                    <id>string</id>
                    <conditions>
                        <condition>
                            <id>string</id>
                        </condition>
                    </conditions>
                </category>
            </categories>
            <competent_authorities>
                <authority>
                    <id>string</id>
                </authority>
            </competent_authorities>
            <updated_info>
                <time>string</time>
                <kind>string</kind>
                <comment>string</comment>
            </updated_info>
        </support>
    </supports>
</supports_response>

JSON

{
    "total_count": {integer},
    "supports": [
        {
            "id": {string},
            "number": {string},
            "name": {string},
            "base": {
                 "id": {string},
                 "number": {string},
                 "name": {string}
            },
            "has_difference_from_base": {string},
            "summary": {string},
            "general_info": {string},
            "governing_laws": [
                {
                    "name": {string},
                    "url": {string}
                 }
            ],
            "intended_person": {
                "description": {string},
                "annual_income_max": {string},
                "annual_income_max_remarks": {string}
            },
            "intended_disaster": {
                "id": {string}
            },
            "intended_area": {
                "prefectures": [
                    {
                        "id": {string}
                    }
                ],
                "municipalities_sets": [
                    {
                        "id": {string},
                        "municipalities": [
                            {
                                "id": {string}
                            }
                        ]
                    }
                ]
                "area_groups": [
                    {
                        "id": {string}
                    }
                ]
            },
            "application": {
                "deadline": {
                    "description": {string}
                },
                "procedure": {
                    "description": {string},
                    "forms": [
                        {
                            "name": {string},
                            "url": {string}
                        }
                    ]
                },
                "e_procedure": {
                    "references": [
                        {
                            "name": {string},
                            "url": {string}
                        }
                    ]
                }
            },
            "term": {
                "description": {string}
            },
            "references": [
                {
                    "name": {string},
                    "url": {string}
                }
            ],
            "contact": {
                "name": {string},
                "tel": {string},
                "fax": {string},
                "mail": {string},
                "postal_code": {string},
                "address": {string},
                "free_description": {string}
            },
            "contact_lists": [
                {
                    "id": {string}
                }
            ],
            "budget": {
                "description": {string}
            },
            "attachments": [
                {
                    "type": {string},
                    "url": {string},
                    "file_name": {string},
                    "display_name": {string}
                }
            ],
            "support_targets": [
                {
                    "id": {string}
                }
            ],
            "support_types": [
                {
                    "id": {string}
                }
            ],
            "categories": [
                {
                    "id": {string},
                    "conditions": [
                        {
                            "id": {string}
                        }
                    ]
                }
            ],
            "competent_authorities": [
                {
                    "id": {string}
                }
            ],
            "updated_info": {
                "time": {string},
                "kind": {string},
                "comment": {string}
            }
        }
    ]
}

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

要素(フィールド)

説明

total_count

integer

指定した条件に該当する「制度情報」の総件数

supports/{id} リクエストのレスポンスでは、この要素は返りません。

supports[]

array

「制度情報」の配列

supports[].id

string

「制度情報」のid

supports[].number

string

制度番号

※制度を一意に識別する番号です。(形式: XXXXX-XXXX-XXXX)

※所管組織の変更により、値が変更される場合があります。

(2017.12 追加)

supports[].name

string

制度名

supports[].base

object

(基となる制度)

※自治体の制度について、基となる国の制度が存在する場合に出力されます。

※基となる制度が表示できない状態(削除や非公開)でも、本フィールドに id や制度名が含まれる場合があります。

supports[].base.id

string

(基となる制度の)「制度情報」のid

※要素がない場合があります。(基となる制度名のみ登録されている場合など)

(2017.12 追加)

supports[].base.number

string

(基となる制度の) 制度番号

※要素がない場合があります。(基となる制度名のみ登録されている場合など)

(2017.12 追加)

supports[].base.name

string

(基となる制度の) 制度名

supports[].has_difference_from_base

string

基制度からの変更有無

1: 変更有り

※基となる国の制度から自治体が独自に条件を変更している場合 1 が出力されます。(説明追加などに限る場合は、条件変更に該当しません。)

※条件変更がない場合、要素自体出力されません。

(2017.12 追加)

supports[].summary

string

概要

supports[].general_info

string

内容

supports[].governing_laws[]

array

根拠法の配列

supports[].governing_laws[].name

string

根拠法の名称

supports[].governing_laws[].url

string

根拠法のURL

supports[].intended_person

object

(対象者)

supports[].intended_person.description

string

対象者備考

supports[].intended_person.annual_income_max

string

対象者年収上限

※単位:円

(2017.12 追加)

supports[].intended_person.annual_income_max_remarks

string

対象者年収上限補足

※対象者年収上限に関する補足が出力されます。(世帯全体、世帯主、個人など)

(2017.12 追加)

supports[].intended_disaster

object

対象災害

supports[].intended_disaster.id

string

「災害」のid

(名称を取得するには、disasters/{id} リクエストを使用します。)

supports[].intended_area

object

対象地域

※設定内容について、解説ページの「対象地域について」を参照ください。

supports[].intended_area.prefectures[]

array

「都道府県」の配列

supports[].intended_area.prefectures[].id

string

「都道府県」のid

(名称を取得するには、area/prefectures/{id} リクエストを使用します。)

supports[].intended_area.municipalities_sets[]

array

市町村セット(「都道府県」単位の「市町村」配列)の配列

supports[].intended_area.municipalities_sets[].id

string

「都道府県」のid

supports[].intended_area.municipalities_sets[].municipalities[]

array

「市町村」の配列

supports[].intended_area.municipalities_sets[].municipalities[].id

string

「市町村」のid

(名称を取得するには、area/prefectures/{id1}/municipalities/{id2}リクエストを使用します。)

supports[].intended_area.area_groups[]

array

「地域群」の配列

supports[].intended_area.area_groups[].id

string

「地域群」のid

(名称および情報を取得するには、area/area_groups/{id}リクエストを使用します。)

supports[].application

object

(申請に関する情報)

supports[].application.deadline.description

string

申請期限

supports[].application.procedure.description

string

申請・届出方法

supports[].application.procedure.forms[]

array

申請書類の配列

supports[].application.procedure.forms[].name

string

申請書類

supports[].application.procedure.forms[].url

string

申請書類入手URL

supports[].application.e_procedure.references[]

array

電子申請の配列

supports[].application.e_procedure.references[].name

string

電子申請

supports[].application.e_procedure.references[].url

string

電子申請URL

supports[].term.description

string

支援期間

supports[].references[]

array

詳細参照先の配列

supports[].references[].name

string

詳細参照先

supports[].references[].url

string

詳細URL

supports[].contact

object

(お問合せ先に関する情報)

supports[].contact.name

string

お問合せ先 組織・窓口名称

supports[].contact.tel

string

お問合せ先 電話番号

supports[].contact.fax

string

お問合せ先 FAX番号

supports[].contact.mail

string

お問合せ先 メールアドレス

supports[].contact.postal_code

string

お問合せ先 郵便番号

supports[].contact.address

string

お問合せ先 住所

supports[].contact.free_description

string

お問合せ先 自由記述

supports[].contact_lists[]

array

「お問合せ先一覧」の配列

supports[].contact_lists[].id

string

「お問合せ先一覧」のid

(名称および情報を取得するには、contact_lists/{id}リクエストを使用します。)

supports[].budget.description

string

予算枠の有無

supports[].attachments[]

array

添付ファイルの配列

supports[].attachments[].type

string

添付ファイルの種類を表す文字列

0:ファイル

1:画像

supports[].attachments[].url

string

添付ファイルのURL

supports[].attachments[].file_name

string

添付ファイルのファイル名

supports[].attachments[].display_name

string

添付ファイルの表示名

supports[].support_targets[]

array

「支援の対象」の配列

supports[].support_targets[].id

string

「支援の対象」のid

(名称を取得するには、support_targets/{id}リクエストを使用します。)

supports[].support_types[]

array

「支援の種類」の配列

supports[].support_types[].id

string

「支援の種類」のid

(名称を取得するには、support_types/{id}リクエストを使用します。)

supports[].categories[]

array

「カテゴリ」の配列

supports[].categories[].id

string

「カテゴリ」のid

(名称を取得するには、categories/{id}リクエストを使用します。)

supports[].categories[].conditions[]

array

「条件項目」の配列

supports[].categories[].conditions[].id

string

「条件項目」のid

(名称を取得するには、categories/{id1}/conditions/{id2}リクエストを使用します。)

supports[].competent_authorities[]

array

「所管組織」の配列

supports[].competect_authorities[].id

string

「所管組織」のid

(名称を取得するには、authorities/{id}リクエストを使用します。)

supports[].updated_info

object

(更新情報)

supports[].updated_info.time

string

更新日時(ISO8601形式の日付形式で設定されます。例:2012-02-22T00:00:00+09:00)

supports[].updated_info.kind

string

更新種別を表す文字列

0: 追加

1: 更新

supports[].updated_info.comment

string

更新コメント

 

XML

GET    http://api.r-assistance.go.jp/v2/supports.xml?appkey=0
<supports_response xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <total_count>598</total_count>
    <supports>
        <support>
            <id>1</id>
            <number>XXXXX-XXXX-XXXX</number>
            <name>災害廃棄物の処理を進めます 災害廃棄物の処理を支援しています</name>
            <summary>地方公共団体が行う災害廃棄物(がれきなど)の処理に対する国の補助率を最大9割まで引き上げました。</summary>
            <general_info>
                地方公共団体が行う災害廃棄物(がれきなど)の処理に対する国の補助率を最大9割まで引き上げました。  <出典:【政府広報】 生活再建ハンドブックVol.4>
            </general_info>
            <intended_person>
                <description>地方公共団体</description>
            </intended_person>
            <intended_disaster>
                <id>1</id>
            </intended_disaster>
            <intended_area>
                <area_groups>
                    <area_group>
                        <id>2</id>
                    </area_group>
                </area_groups>
            </intended_area>
            <application>
                <deadline>
                    <description>窓口にお問合せください。</description>
                </deadline>
                <procedure>
                    <description>窓口にお問合せください。</description>
                </procedure>
            </application>
            <references>
                <reference>
                    <name>【政府広報】 生活再建ハンドブックVol.4</name>
                    <url>
                        http://www.kantei.go.jp/saigai/handbook/231130handbook_sa.pdf
                    </url>
                </reference>
            </references>
            <contact>
                <name>環境省廃棄物・リサイクル対策部廃棄物対策課</name>
                <tel>03-5501-3154</tel>
                <fax>03-3593-8263</fax>
                <free_description>受付時間 月~金 9:30~18:15 祝日除く</free_description>
            </contact>
            <support_targets>
                <support_target>
                    <id>3</id>
                </support_target>
            </support_targets>
            <support_types>
                <support_type>
                    <id>6</id>
                </support_type>
            </support_types>
            <categories>
                <category>
                    <id>12</id>
                    <conditions>
                        <condition>
                            <id>62</id>
                        </condition>
                        <condition>
                            <id>66</id>
                        </condition>
                        <condition>
                            <id>69</id>
                        </condition>
                    </conditions>
                </category>
            </categories>
            <competent_authorities>
                <authority>
                    <id>65</id>
                </authority>
                <authority>
                    <id>190</id>
                </authority>
            </competent_authorities>
            <updated_info>
                <time>2012-06-18T17:40:06+09:00</time>
                <kind>0</kind>
            </updated_info>
        </support>
    </supports>
    ...
</supports_response>

JSON

GET    http://api.r-assistance.go.jp/v2/supports.json?appkey=0
{
    "total_count": 598,
    "supports": [
        {
            "id": "1",
            "number": "XXXXX-XXXX-XXXX",
            "name": "災害廃棄物の処理を進めます 災害廃棄物の処理を支援しています",
            "summary": "地方公共団体が行う災害廃棄物(がれきなど)の処理に対する国の補助率を最大9割まで引き上げました。",
            "general_info": "地方公共団体が行う災害廃棄物(がれきなど)の処理に対する国の補助率を最大9割まで引き上げました。\u000a\u000a<出典:【政府広報】 生活再建ハンドブックVol.4>",
            "intended_person": {
                "description": "地方公共団体"
            },
            "intended_disaster": {
                "id": "1"
            },
            "intended_area": {
                "area_groups": [
                    {
                        "id": "2"
                    }
                ]
            },
            "application": {
                "deadline": {
                    "description": "窓口にお問合せください。"
                },
                "procedure": {
                    "description": "窓口にお問合せください。"
                }
            },
            "references": [
                {
                    "name": "【政府広報】 生活再建ハンドブックVol.4",
                    "url": "http://www.kantei.go.jp/saigai/handbook/231130handbook_sa.pdf"
                }
            ],
            "contact": {
                "name": "環境省廃棄物・リサイクル対策部廃棄物対策課",
                "tel": "03-5501-3154",
                "fax": "03-3593-8263",
                "free_description": "受付時間\n月~金 9:30~18:15 祝日除く"
            },
            "support_targets": [
                {
                    "id": "3"
                }
            ],
            "support_types": [
                {
                    "id": "6"
                }
            ],
            "categories": [
                {
                    "id": "12",
                    "conditions": [
                        {
                            "id": "62"
                        },
                        {
                            "id": "66"
                        },
                        {
                            "id": "69"
                        }
                    ]
                }
            ],
            "competent_authorities": [
                {
                    "id": "65"
                },
                {
                    "id": "190"
                }
            ],
            "updated_info": {
                "time": "2012-06-18T17:40:06+09:00",
                "kind": "0"
            }
        }
    ]
    ...
}