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

categories

全ての「カテゴリ」(名称)を取得します。

「カテゴリ」は、「制度情報」のカテゴリ "住まいのこと"、"仕事のこと"、"事業区分" などを表します。

 

各「カテゴリ」は、複数の「条件項目」を含みます。

 例1: 「カテゴリ」 "住まいのこと" は、「条件項目」 "建設したい"、"購入したい" などを含みます。

 例2: 「カテゴリ」 "事業区分" は、「条件項目」 "すべての事業者のみなさま"、"中小企業のみなさま" などを含みます。

「カテゴリ」に含まれる「条件項目」を取得するには、categories/{id}/conditions リクエストを使用します。

 

リクエスト

URL

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

パラメータ

名前

省略可否

説明

{format}

必須

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

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

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

appkey

必須

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

レスポンス

XML

<categories_response>  
    <categories>
        <category>
            <id>string</id>
            <name>string</name>
            <support_target>
                <id>string</id>
            </support_target>
        </category>
    </categories>
</categories_response>

JSON

{
    "categories": [
        {
            "id": {string},
            "name": {string},
            "support_target": {
                "id": {string}
            }
        }
    ]
}

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

要素(フィールド)

説明

categories[]

array

「カテゴリ」の配列

categories[].id

string

「カテゴリ」のid

categories[].name

string

「カテゴリ」の名称

categories[].support_target.id

string

関連する「支援の対象」のid

XML

GET    http://api.r-assistance.go.jp/v2/categories.xml?appkey=0
<categories_response xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <categories>
        <category>
            <id>2</id>
            <name>住まいのこと</name>
            <support_target>
                <id>1</id>
            </support_target>
        </category>
        <category>
            <id>3</id>
            <name>仕事のこと</name>
            <support_target>
                <id>1</id>
            </support_target>
        </category>
        ...
    </categories>
</categories_response>

JSON

GET    http://api.r-assistance.go.jp/v2/categories.json?appkey=0
{
    "categories": [
        {
            "id": "2",
            "name": "住まいのこと",
            "support_target": {
                "id": "1"
            }
        },
        {
            "id": "3",
            "name": "仕事のこと",
            "support_target": {
                "id": "1"
            }
        },
        ...
    ]
}