復旧・復興支援制度情報 API についての非公式HTML版(現在変換作業中)です。PDF版・Word版と内容に差異がある場合は、PDF版・Word版の内容を正しいものとして参照してください。


復旧・復興支援制度データベース
APIリファレンス

経済産業省商務情報政策局情報プロジェクト室


目次


API共通仕様

リクエスト

各APIの説明に記載されているURLにアクセスすることで、APIの実行結果を受け取ることができます。

http://api.r-assistance.go.jp/v1/api.svc/searchSupportInfomations
※URLの大文字・小文字は区別されません。

APIにパラメータを指定する場合は、APIのURLに「?」を連結し、「パラメータ名=パラメータ値」の形式で指定します。

http://api.r-assistance.go.jp/v1/api.svc/searchSupportInformations?maxcount=50

複数のパラメータを指定する場合は、2つ目以降のパラメータを「&」で連結します。

http://api.r-assistance.go.jp/v1/api.svc/searchSupportInformations?maxcount=50&pageno=1

リファレンスに記載のないパラメータが指定された場合、そのパラメータは無視されます。

省略不可のパラメータを省略した場合、(400)エラーとなります。

レスポンス

APIのレスポンスは、XMLで出力されます。詳細は、各APIの説明を参照ください。

レスポンスの改行コード

APIのレスポンス (XML) に含まれる文字列値において、文字列内の改行を示すために、「CRLF(復帰と改行)」 または 「LF(改行)」 のいずれかの改行コードが使用されます。

エラー時のレスポンス

APIのリクエストでエラーが発生した場合は、次のエラーコードおよびレスポンスを出力します。

エラーコード

コード説明
400Bad request. 渡されたパラメータの内容が APIで期待されたものと一致しない場合。
401

Unauthorized. 許可されていないアクセスであった場合。
403

Forbidden. APIの利用回数制限を超えている場合。
404Not found. 指定されたURLが存在しない場合。
500Internal Server Error. サーバーの内部エラーなどの問題によってデータを返すことができない場合。
503Service unavailable. サーバーが高負荷の状態や、メンテナンス中などの理由によりデータを返すことができない場合。

エラー時のレスポンス

<?xml version="1.0" encoding="utf-8"?>
><Error xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Message>エラーメッセージ</Message>
</Error>

appkeyについて

すべてのAPIは、パラメータappkeyが必須となっています。現在は、常にパラメータappkeyには0を指定してください。

http://api.r-assistance.go.jp/v1/api.svc/searchSupportInformations?appkey=0&maxcount=50

※’appkey’に不正な値を指定した場合、(401)エラーが返されます。

利用回数制限

APIは呼び出し元IPアドレス毎に利用回数制限を設けています。

1時間あたり、5,000回を超えてアクセスした場合、エラーコード403(Forbidden)が返ります。

※制限の単位時間および回数は、予告なく変更する場合があります。

同じAPIを同じパラメータで何度も呼び出さないようにしたり、一度取得した結果はキャッシュしておく等、APIの呼び出し回数をなるべく減らすなどして利用されることを推奨します。


APIリファレンス

getSupportTargets

支援対象の配列を取得します。
支援対象は、制度の大分類である「個人向け」や「事業者向け」を表します。

URL

http://api.r-assistance.go.jp/v1/api.svc/getSupportTargets

パラメータ

戻り値

(ArrayOf)SupportTarget

要素/属性 データの内容 データ型
ID 支援対象のID 数値
Name 支援対象の名前 文字列

リクエストの例

GET http://api.r-assistance.go.jp/v1/api.svc/getSupportTargets?appkey=0
<?xml version="1.0" encoding="utf-8" ?> 
<ArrayOfSupportTarget xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SupportTarget ID=”1”>
<Name>個人向け</Name>
</SupportTarget>
<SupportTarget ID=”2”>
<Name>事業者向け</Name>
</SupportTarget>
<SupportTarget ID=”3”>
<Name>地方公共団体向け</Name>
</SupportTarget>
</ArrayOfSupportTarget> 

getSearchCategories

指定した支援対象に含まれる検索カテゴリの配列を取得します。

URL

http://api.r-assistance.go.jp/v1/api.svc/getSearchCategories

パラメータ

appkey

省略不可。指定する値は「appkeyについて」を参照ください。

supporttarget

省略可。支援対象のID。省略した場合、共通の検索カテゴリを取得します。

getSupportTargetsリクエストで取得されたSupportTarget要素のID属性の値を指定します。

   ※数値以外の値を指定した場合、(400)エラーとなります。

   ※指定したIDのデータが存在しない場合、該当データが含まれない配列が返ります。


戻り値

(ArrayOf)SearchCategory

要素/属性 データの内容 データ型
ID 検索カテゴリのID 数値
Name 検索カテゴリの名称 文字列

リクエストの例

GET http://api.r-assistance.go.jp/v1/api.svc/getSearchCategories?appkey=0&supporttarget=1
<?xml version="1.0" encoding="utf-8" ?>
<ArrayOfSearchCategory xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SearchCategory ID="2">
<Name>住まいのこと</Name>
</SearchCategory>
<SearchCategory ID="3">
<Name>仕事のこと</Name>
</SearchCategory>
・・・
></ArrayOfSearchCategory>

getSearchConditionItems

指定した検索カテゴリに含まれる抽出項目の配列を取得します。

抽出項目のIDをsearchSupportInformationsリクエストで指定することにより、該当する制度情報を検索できます。

URL

http://api.r-assistance.go.jp/v1/api.svc/getSearchConditionItems

パラメータ

appkey

省略不可。指定する値は「appkeyについて」を参照ください。

category

省略不可。検索カテゴリのID。

getSearchCategoriesリクエストで取得されたSearchCategory要素のID属性の値を指定します。

   ※数値以外の値を指定した場合、(400)エラーとなります。

   ※指定したIDのデータが存在しない場合、該当データが含まれない配列が返ります。

戻り値

(ArrayOf)SearchConditionItem

要素/属性 データの内容 データ型
ID 抽出項目のID 数値
Name 抽出項目の名称 文字列

リクエストの例

GET http://api.r-assistance.go.jp/v1/api.svc/getSearchConditionItems?appkey=0&category=2
<?xml version="1.0" encoding="utf-8" ?> 
<ArrayOfSearchConditionItem xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 <SearchConditionItem ID="10">
  <Name>建設したい(増築・改築含む)</Name> 
 </SearchConditionItem>
<SearchConditionItem ID="11">
  <Name>購入したい</Name> 
 </SearchConditionItem>
・・・
</ArrayOfSearchConditionItem> 

getPrefectures

都道府県を表す地方公共団体(コードおよび名称)の配列を取得します。


URL

http://api.r-assistance.go.jp/v1/api.svc/getPrefectures


パラメータ

appkey

省略不可。指定する値は「appkeyについて」を参照ください。

prefcodes

省略可。都道府県コード。

複数のコードを指定する場合は、パイプ( | )文字で区切ります。

省略した場合は、全ての都道府県が対象となります。

   ※指定したコードのデータが存在しない場合、該当データが含まれない配列が返ります。


戻り値

(ArrayOf)LocalGoverment

要素/属性 データの内容 データ型
PrefCode 都道府県コード 文字列
LocalGovCode 地方公共団体コード 文字列
LocalGovName 地方公共団体名 文字列

※配列は、復旧・復興支援制度データベースで指定された順序で返します。


リクエストの例

GET http://api.r-assistance.go.jp/v1/api.svc/getPrefectures?appkey=0
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfLocalGoverment xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <LocalGoverment PrefCode="03" LocalGovCode="03000">
    <LocalGovName>岩手県</LocalGovName>
  </LocalGoverment>
  <LocalGoverment PrefCode="04" LocalGovCode="04000">
    <LocalGovName>宮城県</LocalGovName>
  </LocalGoverment>
  <LocalGoverment PrefCode="07" LocalGovCode="07000">
    <LocalGovName>福島県</LocalGovName>
  </LocalGoverment>
  <LocalGoverment PrefCode="01" LocalGovCode="01000">
    <LocalGovName>北海道</LocalGovName>
  </LocalGoverment>
  …
</ArrayOfLocalGoverment>

getMunicipalities

市町村を表す地方公共団体(コードおよび名称)を取得します。


URL

http://api.r-assistance.go.jp/v1/api.svc/getMunicipalities


パラメータ

appkey

省略不可。指定する値は「appkeyについて」を参照ください。

prefcode

省略可。都道府県コード。

getPrefecturesリクエストで取得されたLocalGoverment要素のPrefCode属性の値を指定します。

※指定したコードのデータが存在しない場合、該当データが含まれない配列が返ります。

localgovcodes

省略可。地方公共団体コード。

複数のコードを指定する場合は、パイプ( | )文字で区切ります。

    ※指定したコードのデータが存在しない場合、該当データが含まれない配列が返ります。


※都道府県コードから関連する地方公共団体のコードおよび名前を取得する場合は、prefcodeのみ指定します。

※地方公共団体コードから名前を取得する場合は、localgovcodesのみ指定します。

※両方のパラメータを指定した場合は、(400)エラーとなります。

※戻り値には、都道府県を示す地方公共団体は含まれません。


戻り値

(ArrayOf)LocalGoverment

要素/属性 データの内容 データ型
PrefCode 都道府県コード 文字列
LocalGovCode 地方公共団体コード 文字列
LocalGovName 地方公共団体名 文字列

リクエストの例1

岩手県(PrefCode=03)の全ての市町村を取得する例

GET http://api.r-assistance.go.jp/v1/api.svc/getMunicipalities?appkey=0&prefcode=03
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfLocalGoverment xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <LocalGoverment PrefCode="03" LocalGovCode="03201">
    <LocalGovName>盛岡市</LocalGovName>
  </LocalGoverment>
  <LocalGoverment PrefCode="03" LocalGovCode="03202">
    <LocalGovName>宮古市</LocalGovName>
  </LocalGoverment>
  <LocalGoverment PrefCode="03" LocalGovCode="03203">
    <LocalGovName>大船渡市</LocalGovName>
  </LocalGoverment>
  <LocalGoverment PrefCode="03" LocalGovCode="03205">
    <LocalGovName>花巻市</LocalGovName>
  </LocalGoverment>
  <LocalGoverment PrefCode="03" LocalGovCode="03206">
    <LocalGovName>北上市</LocalGovName>
  </LocalGoverment>
  …
</ArrayOfLocalGoverment>

リクエストの例2

岩手県(PrefCode=03)の特定の市町村を指定して取得する例

GET http://api.r-assistance.go.jp/v1/api.svc/getMunicipalities?appkey=0&localgovcodes=03201|03205
<ArrayOfLocalGoverment xmlns="http://schemas.datacontract.org/2004/07/SSDB.Site" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
 <LocalGoverment PrefCode="03" IsPref="false" LocalGovCode="03201">
    <LocalGovName>盛岡市</LocalGovName> 
  </LocalGoverment>
<LocalGoverment PrefCode="03" IsPref="false" LocalGovCode="03205">
    <LocalGovName>花巻市</LocalGovName> 
  </LocalGoverment>
</ArrayOfLocalGovInfo>

searchSupportInformations

指定した条件に該当する制度情報を検索します。条件に該当する制度IDを返します。


URL

http://api.r-assistance.go.jp/v1/api.svc/searchSupportInformations


パラメータ

appkey

省略不可。指定する値は「appkeyについて」を参照ください。

maxcount

省略可。1度のAPIの呼び出しで取得するデータの最大取得件数を指定します。

総件数のみ取得する場合は、0を指定します。

省略時は10として処理されます。

maxcountに100を超える値を指定した場合、100として処理されます。

※指定した値が0未満の数値、または数値ではない場合、(400)エラーとなります。

pageno

省略可。データの総件数とmaxCountからデータを分割した時に、取得するページ数を指定します。

pagenoを省略または0を指定した場合は、pageno=1とみなし、1ページ目が対象となります。

指定したpagenoが存在しない場合は、総件数のみ取得されます。

※指定した値が0未満の数値、または数値ではない場合、(400)エラーとなります。

supporttarget

省略可。支援対象のIDを指定します。

複数指定する場合は、パイプ( | )文字で区切ります。OR条件。

※パイプ( | )文字で区切られたIDに数値以外の値を指定した場合、(400)エラーとなります。

q

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

複数の文字列による検索を指定する場合は、文字列を全角スペース(‘ ’)または半角スペース(‘ ’)で区切ります。

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

※全体で100文字を超える値を指定した場合、(400)エラーとなります。

※全角または半角スペース(‘ ’,' ')区切りで複数指定した条件の個数が5項目を超える場合、(400)エラーとなります。

qmode

省略可。フリーワード検索の検索モードを指定します。

0または省略:AND検索、1:OR検索

パラメータqで指定した条件文字列が複数ある場合のみ有効です。

※0,1以外の値を設定した場合は0:AND扱いとなります。

※数値以外の値を指定した場合、(400)エラーとなります。

conditionitems

省略可。抽出項目のIDを指定します。

複数のIDを指定する場合は、パイプ( | )文字またはカンマ( , )で区切ります。

パイプ( | )文字で区切ったIDは、OR条件となります。

カンマで区切ったIDは、AND条件となります。

パイプ( | )文字およびカンマを混合指定した場合、カンマで分割したグループ内がOR条件となり、各グループがAND条件で評価されます。

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

※パイプ( | )文字またはカンマ( , )で区切られたIDに数値以外の値を指定した場合、(400)エラーとなります。

localgovcodes

省略可。地方公共団体コードを指定します。

指定されたコードが対象地域となっているデータを取得します。

複数のコードを指定する場合は、パイプ( | )文字で区切ります。OR条件。

※指定した地方公共団体コードのデータと、対象地域が設定されていない(全国)のデータが検索されます。

※都道府県に該当する地方公共団体コードを指定した場合、指定した都道府県内の市町村の地方公共団体  

  コードも検索の対象となります。

※市町村に該当する地方公共団体コードを指定した場合、市町村が属する都道府県の地方公共団体コード

  も検索の対象となります。

date_from

省略可。日付を指定します。フォーマット(yyyyMMdd)

指定した日付以降の更新履歴を持つデータを取得する場合、指定します。

※日付以外の値を指定した場合、(400)エラーとなります。

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

date_to

省略可。日付を指定します。フォーマット(yyyyMMdd)

指定した日付以前の更新履歴を持つデータを取得する場合、指定します。

※日付以外の値を指定した場合、(400)エラーとなります。

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

sortmode

省略可。データの並び順を指定します。

0 または省略: 復旧・復興支援制度データベースで既定の並び順

※現在、復旧・復興支援制度データベースでは、よく利用される制度が上位に並びます。既定の並び順は、予告なく変更される可能性があります。

1:更新日降順 + 制度名昇順


※上記の値以外を指定した場合、省略時と同じ並び順になります。

※数値以外の値を指定した場合、(400)エラーとなります。


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


戻り値

SearchResult

要素/属性 データの内容 データ型
IDs 該当する制度情報のID。該当の制度が複数ある場合は、各IDがカンマで区切られます。 文字列
TotalCount 該当する制度情報の総件数 数値

該当する制度が無い場合は、TotalCountの値=0、IDsは空要素となります。


リクエストの例

GET http://api.r-assistance.go.jp/v1/api.svc/searchSupportInformations?appkey=0&maxcount=10&pageno=1&supporttarget=1
<?xml version="1.0" encoding="utf-8" ?> 
<SearchResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 <IDs>86,103,110</IDs>
<TotalCount>84</TotalCount> 
</SearchResult> 

getSupportInformation

指定したIDの制度情報をOpenUMの形式で取得します。


URL

http://api.r-assistance.go.jp/v1/api.svc/getSupportInformation


パラメータ

appkey

省略不可。指定する値は「appkeyについて」を参照ください。

id

省略不可。対象となる制度のIDを指定します。

制度のIDを取得する方法は、searchSupportInformationsリクエストを参照して下さい。

※数値以外の値を指定した場合、(400)エラーとなります。

※指定したIDのデータが存在しない場合、r-assistance_Content 要素を含まないデータが返されます。


戻り値

XMLDocument(OpenUM形式)

※制度情報は、OpenUM形式のr-assistance_Content型として出力されます。

OpenUMの定義については、補足資料「OpenUMの定義説明」を参照してください。


r-assistance_Content型への設定内容 (記載のない要素は出力しません。)

No. 要素/属性 設定内容 備考
1 uuid 制度情報のUUID
2 author 制度情報の作成者(組織名)
3 local_gov_id (設定されません。)
4 local_gov_name (設定されません。)
5 governing_law  根拠法 ※1
6 governing_law_url 根拠法URL ※1、※2
7 service name 制度名
8 title 自治体独自名 ※1
9 general_info 内容 ※1
10 general_list 概要 ※1
11 intended_person 対象者 ※1
12 intended_area 対象地域 ※1
13 application_procedure 申請・届出方法 ※1
14 applicatipon_deadline 申請期限 ※1
15 support_term 支援期間 ※1
16 application_form 申請書類 ※1
17 application_form_url 申請書類入手URL ※1、※2
18 related_link 詳細参照先名 ※1
19 related_link_url 詳細URL ※1、※2
20 e_application 電子申請名称 ※1
21 e_application_url 電子申請URL ※1、※2
22 contact お問合せ(組織・窓口名称) ※1
23 contact_postal_code お問合せ(郵便番号) ※1
24 contact_address お問合せ(住所) ※1
25 contact_tel お問合せ(TEL) ※1
26 contact_fax お問合せ(FAX) ※1
27 contact_mail お問合せ(メール) ※1
28 contact_free_description お問合せ(自由記述) ※1
29 contact_list お問合せ先一覧 ※1
30 budget 予算枠の有無 ※1
31 meta メタ情報  ※3
32 created_at 制度情報の作成日
33 updated_at 制度情報の更新日
34 assistance_type 支援の種類 ※1
35 citizens_housing 個人向け:住まいのこと ※1
36 citizens_work 個人向け:仕事のこと ※1
37 citizens_medical_welfare 個人向け:医療・福祉のこと ※1
38 citizens_nurturing_education 個人向け:子育て・教育のこと ※1
39 citizens_money 個人向け:おかねのこと ※1
40 citizens_others_living 個人向け:その他・暮らしにかかわること ※1
41 citizens_nuclear_power 個人向け:原発関係のこと ※1
42 businesses _segments 事業者向け:事業区分 ※1
43 businesses _situation 事業者向け:状況 ※1

※1:ContentItem型について

備考欄に※1と記載されている項目は、OpenUM形式のContentItem型として出力されます。(OpenUMの定義については、補足資料「OpenUMの定義説明」を参照してください。)

下表は、ContentItem型への設定内容です。 (記載のない要素は出力しません。)

要素/属性 設定内容
uuid 項目のUUID
title 項目の名称
title_short (設定されません。)
summary (設定されません。)
body 項目の値

※intended_area (No.12:対象地域) は、地方公共団体コードが設定されます。複数の場合、カンマ( , )区切りで設定されます。未設定の場合、全国が対象であることを示します。

※contact_list (No.29:お問合せ先一覧) は、一覧名が設定されます。複数の場合、2重スラッシュ( // )区切りで設定されます。一覧名に対応する情報は、getContactsTextリクエストで取得できます。

※抽出用項目(No.34~43)は、項目の名称が設定されます。複数の場合、2重スラッシュ( // )区切りで設定されます。


※2:URL項目について

下記「URL項目要素」に値が設定されている場合、値は「対応する項目要素」のURLを示します。

URL項目要素 対応する項目要素
governing_law_url   (根拠法URL)
governing_law (根拠法)
application_form_url (申請書類入手URL)
application_form (申請書類)
related_link_url (詳細URL)
related_link (詳細参照先名)
e_application_url (電子申請URL)
e_application (電子申請名称)

「URL項目要素」の値は改行区切りで複数設定される場合があり、その場合は、「対応する項目」を改行区切りで分割した、行数が一致する値に対するURLを示します。(※改行数が一致しない場合や、URL以外の値が設定される場合があります。)

設定例は後述の「リクエストの例」を参照下さい。


※3:metaについて

次のmeta要素が設定されます。

name Value
update_kind 更新種別を表す数値が設定されます。0=追加、1=更新
update_comment 更新コメントが設定されます。

※文字列値内の改行は、「CR+LF」または「LFのみ」の両方が混在する場合があります。詳細は「レスポンスの改行コード」を参照ください。


リクエストの例

GET http://api.r-assistance.go.jp/v1/api.svc/getSupportInformation?appkey=0&id=1
<?xml version="1.0" encoding="utf-8"?>
<UM:UmDocument xmlns:UM="urn:UMDocument">
  <UM:r-assistance_Content uuid="29957cef-b51d-4954-9fbc-41939a349df3">
    <UM:service_name uuid="9c541990-8e6b-4cc6-b2c7-b4f827149b38">
      <UM:title>制度名</UM:title>
      <UM:title_short></UM:title_short>
      <UM:summary></UM:summary>
      <UM:body>災害関係保証</UM:body>
    </UM:service_name>
    <UM:general_list uuid="bd1cc782-8c0d-45fa-97c2-8f1b7a88a7bf">
      <UM:title>概要</UM:title>
      <UM:title_short></UM:title_short>
      <UM:summary></UM:summary>
      <UM:body>●金融機関から事業の再建に必要な資金の借入を行う場合、信用保証協会が一般保証とは別枠で保証する制度です。</UM:body>
    </UM:general_list>
    <UM:general_info uuid="ccdf796a-2d8a-4e0b-9d73-a25ebe39fb4a">
      <UM:title>内容</UM:title>
      <UM:title_short></UM:title_short>
      <UM:summary></UM:summary>
      <UM:body>
        ●金融機関から事業の再建に必要な資金の借入を行う場合、信用保証協会が一般保証とは別枠で保証する制度です。
        ●融資額の全額を保証(100%)し、保証料率は概ね0.7%~1.0%です。
        ●無担保8千万円、最大で2億8千万円まで一般保証とは別枠で利用できます。
        <出典:【内閣府】被災者支援に関する各種制度の概要(東日本大震災編)>
        ■ 保証限度額:無担保8千万円、最大で2億8千万円。
                    一般保証とは、別枠。セーフティネット保証と同枠。
        ■ 保証料率  :概ね0.7%~1.0% 
        ※詳しくは、各信用保証協会にお問い合わせください。
        ■ 資金使途  :事業再建に必要な資金
        ■ 保証割合  :借入額の全額(100%)
        ■ 保証人    :代表者保証のみ(第三者保証人については、原則不要。)
        <出典:【中小企業庁】平成23年度 中小企業施策利用ガイドブック>
      </UM:body>
    </UM:general_info>
    <UM:governing_law uuid="6e2700f5-7b91-40d1-bed8-e91ae410d363">
      <UM:title>根拠法</UM:title>
      <UM:title_short></UM:title_short>
      <UM:summary></UM:summary>
      <UM:body>
        中小企業信用保険法
        激甚災害に対処するための特別の財政援助等に関する法律
      </UM:body>
    </UM:governing_law>
    <UM:governing_law_url uuid="31939bc8-e616-4855-819b-b04dc5431e1e">
      <UM:title>根拠法URL</UM:title>
      <UM:title_short></UM:title_short>
      <UM:summary></UM:summary>
      <UM:body>
        http://law.e-gov.go.jp/htmldata/S25/S25HO264.html
        http://law.e-gov.go.jp/htmldata/S37/S37HO150.html
      </UM:body>
    </UM:governing_law_url>
    <UM:intended_person uuid="2acc6a5c-278b-4498-99c1-e3482e08c117">
      <UM:title>対象者</UM:title>
      <UM:title_short></UM:title_short>
      <UM:summary></UM:summary>
      <UM:body>
        下記のいずれかに該当する方
        ・地震・津波等により直接被害を受けた方。
         → 市区町村等の罹災証明が必要。 (写しで可、事後提出可)
        ・原発事故に係る警戒区域、計画的避難区域、緊急時避難準備区域の区域内の方。
         →  納税証明、商業登記簿等の確認書面が必要。 (写しで可、事後提出可)
      </UM:body>
    </UM:intended_person>
    <UM:application_procedure uuid="e2383cb8-4255-43cc-8d3a-0ba23db037e6">
      <UM:title>申請・届出方法</UM:title>
      <UM:title_short></UM:title_short>
      <UM:summary></UM:summary>
      <UM:body>窓口にお問合せください。</UM:body>
    </UM:application_procedure>
    <UM:applicatipon_deadline uuid="7e782f0f-d45d-4256-b561-4068a3b824a5">
      <UM:title>申請期限</UM:title>
      <UM:title_short></UM:title_short>
      <UM:summary></UM:summary>
      <UM:body>窓口にお問合せください。</UM:body>
    </UM:applicatipon_deadline>
    <UM:related_link uuid="33127bbd-5e87-4be5-9ff0-d59dba394ef3">
      <UM:title>詳細参照先名</UM:title>
      <UM:title_short></UM:title_short>
      <UM:summary></UM:summary>
      <UM:body>
        【内閣府】被災者支援に関する各種制度の概要(東日本大震災編)
        【中小企業庁】平成23年度 中小企業施策利用ガイドブック
      </UM:body>
    </UM:related_link>
    <UM:related_link_url uuid="457b53b0-b5a9-467b-9203-241b5f0fc2c8">
      <UM:title>詳細URL</UM:title>
      <UM:title_short></UM:title_short>
      <UM:summary></UM:summary>
      <UM:body>
        http://www.bousai.go.jp/fukkou/kakusyuseido.pdf
        http://www.chusho.meti.go.jp/pamflet/g_book/h23/pdf/111005Eq-v2.pdf
      </UM:body>
    </UM:related_link_url>
    <UM:contact uuid="2a41d0cc-b292-4e8d-8c60-9758b165d8e8">
      <UM:title>お問合せ(組織・窓口名称)</UM:title>
      <UM:title_short></UM:title_short>
      <UM:summary></UM:summary>
      <UM:body>信用保証協会</UM:body>
    </UM:contact>
    <UM:contact_free_description uuid="c9fded57-a88f-4220-89be-b829e33b5c37">
      <UM:title>お問合せ(自由記述)</UM:title>
      <UM:title_short></UM:title_short>
      <UM:summary></UM:summary>
      <UM:body>
        各都道府県等の信用保証協会
        URL:http://www.zenshinhoren.or.jp/others/nearest.html
      </UM:body>
    </UM:contact_free_description>
<UM:contact_list uuid="7e526cb2-94b6-4b7c-b1bd-b9a0c5365cb9">
<UM:title>お問合せ先一覧</UM:title>
<UM:title_short></UM:title_short>
<UM:summary></UM:summary>
<UM:body>岩手県//岩手県(税関係)//宮城県//宮城県(税関係)//福島県//福島県(税関係)</UM:body>
</UM:contact_list>
    <UM:intended_area uuid="790c94e5-cafc-4166-bc47-158b77f3a9a1">
      <UM:title>対象地域</UM:title>
      <UM:title_short></UM:title_short>
      <UM:summary></UM:summary>
      <UM:body>03000,04000,07000</UM:body>
    </UM:intended_area>
    <UM:assistance_type uuid="858d880a-fbf4-42e9-a85e-0eaa94e81a63">
      <UM:title>支援の種類</UM:title>
      <UM:title_short></UM:title_short>
      <UM:summary></UM:summary>
      <UM:body>信用保証</UM:body>
    </UM:assistance_type>
    <UM:businesses_segments uuid="0f079875-24d3-4ab2-b15c-0f95837e7c90">
      <UM:title>事業区分</UM:title>
      <UM:title_short></UM:title_short>
      <UM:summary></UM:summary>
      <UM:body>すべての事業主のみなさま</UM:body>
    </UM:businesses_segments>
    <UM:businesses_situation uuid="1b481f15-52bb-46b8-a342-de78725918a8">
      <UM:title>状況</UM:title>
      <UM:title_short></UM:title_short>
      <UM:summary></UM:summary>
      <UM:body>資金繰りの支援</UM:body>
    </UM:businesses_situation>
    <UM:author>事務局</UM:author>
    <UM:created_at>2012-01-16T07:26:00+09:00</UM:created_at>
    <UM:updated_at>2012-01-16T07:26:00+09:00</UM:updated_at>
    <UM:meta name="update_kind" value="0"/>
<UM:meta name="update_comment" value="対象者が更新されました。"/>
  </UM:r-assistance_Content>
</UM:UmDocument>

getSupportInformationSummaries

指定したIDの制度情報の概要を取得します。


URL

http://api.r-assistance.go.jp/v1/api.svc/getSupportInformationSummaries


パラメータ

appkey

省略不可。指定する値は「appkeyについて」を参照ください。

ids

省略不可。対象となる制度のIDを指定します。

複数のIDを指定する場合はパイプ( | )文字で区切ります。

一度に指定できるIDの数は最大で100です。

制度のIDを取得する方法は、searchSupportInformationsリクエストを参照して下さい。

※パイプ( | )文字で区切られたIDに数値以外の値が設定された場合、(400)エラーとなります。

※指定したIDの個数が100を超える場合、(400)エラーとなります。

※指定したIDのデータが存在しない場合、該当データを含まない配列が返ります。

get_title

省略可。制度のタイトル(制度名or自治体独自名)を取得する場合、1を指定します。

省略した場合、1が指定されます。

※数値以外の値を指定した場合、(400)エラーとなります。

1以外の値を指定した場合、戻り値に制度のタイトルは含まれません。

get_contact

省略可。制度のお問合せ先を取得する場合、1を指定します。

省略した場合、1が指定されます。

※数値以外の値を指定した場合、(400)エラーとなります。

1以外の値を指定した場合、戻り値に制度のお問合せ先は含まれません。

get_intendedarea

省略可。制度の対象地域を取得する場合、1を指定します。

省略した場合、1が指定されます。

※数値以外の値を指定した場合、(400)エラーとなります。

1以外の値を指定した場合、戻り値に制度の対象地域は含まれません。

get_summary

省略可。制度の概要を取得する場合、1を指定します。

省略した場合、1が指定されます。

※数値以外の値を指定した場合、(400)エラーとなります。

1以外の値を指定した場合、戻り値に制度の概要は含まれません。


戻り値

(ArrayOf)SupportInformationSummary

要素/属性 データの内容 データ型
ID 制度のID。 数値
Title 制度名。※自治体独自名が存在する制度の場合、自治体独自名が返ります。 文字列
Contact 制度のお問合せ先。 文字列
IntendedArea 制度の対象地域を表す地方公共団体コード。複数の場合、カンマ( , )区切りで設定されます。未設定の場合、全国が対象であることを示します。 文字列
Summary 制度の概要。 文字列

※文字列値内の改行は、「CR+LF」または「LFのみ」の両方が混在する場合があります。詳細は「レスポンスの改行コード」を参照ください。


リクエストの例

GET http://api.r-assistance.go.jp/v1/api.svc/getSupportInformationSummaries?appkey=0&ids=1|2
<?xml version="1.0" encoding="utf-8" ?> 
<ArrayOfSupportInformationSummary xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 <SupportInformationSummary ID=”05”>
    <Title>○○制度</Title> 
    <Contact>市町村</Contact> 
    <IntendedArea>03000,04000,07000</IntendedArea> 
    <Summary>○○をサポートします。</Summary> 
 </SupportInformationSummary>
<SupportInformationSummary>
    <Title>○○制度</Title> 
    <Contact>市町村</Contact> 
    <IntendedArea>03000,04000,07000</IntendedArea> 
    <Summary>○○をサポートします。</Summary> 
 </SupportInformationSummary>
 ・・・
</ArrayOfSupportInformationSummary> 

getSupportInformationNotifications

指定した制度を対象とする通達のID配列を取得します。


URL

http://api.r-assistance.go.jp/v1/api.svc/getSupportInformationNotifications


パラメータ

appkey

省略不可。指定する値は「appkeyについて」を参照ください。

id

省略不可。対象となる制度のIDを指定します。

制度のIDを取得する方法は、searchSupportInformationsリクエストを参照して下さい。

※数値以外の値を指定した場合、(400)エラーとなります。

※指定したIDのデータが存在しない場合、空のデータが返されます。


戻り値

SupportInformationNotifications

要素/属性 データの内容 データ型
IDs 通達のID(カンマ区切り) 文字列

リクエストの例

GET http://api.r-assistance.go.jp/v1/api.svc/getSupportInformationNotifications?appkey=0&id=1
<?xml version="1.0" encoding="utf-8" ?> 
<SupportInformationNotifications xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 <IDs>1,5</IDs>
</SupportInformationNotifications>

getNotification

指定したIDの通達をOpenUMの形式で取得します。


URL

http://api.r-assistance.go.jp/v1/api.svc/getNotification


パラメータ

appkey

省略不可。指定する値は「appkeyについて」を参照ください。

id

省略不可。通達のIDを指定します。

通達のIDを取得する方法は、getSupportInformationNotificationsリクエストを参照して下さい。

※数値以外の値を指定した場合、(400)エラーとなります。

※指定したIDのデータが存在しない場合、DocumentContent要素を含まないデータが返ります。


戻り値

XMLDocument(OpenUM)

※通達は、OpenUM形式のDocumentContent型として出力されます。

OpenUMの定義については補足資料「OpenUMの定義説明」を参照してください。


DocumentContent型への設定内容

要素/属性 設定内容 備考
uuid 通達のUUID
author 通達の作成者(組織名)
local_gov_id (設定されません。)
local_gov_name (設定されません。)
document_number 番号
document_date 日付
document_destination 宛先
document_sender 発信者
document_name タイトル
document_body 本文
intended_service_name 対象制度 ※1
updated_at 通達の更新日
meta メタ情報  ※2


1:対象制度について

通達の対象となる制度名が、「//」区切りで設定されます。


※2:metaについて

次のmeta要素が設定されます。

name Value
update_kind 更新種別を表す数値が設定されます。0=追加、1=更新
update_comment 更新コメントが設定されます。

※文字列値内の改行は、「CR+LF」または「LFのみ」の両方が混在する場合があります。詳細は「レスポンスの改行コード」を参照ください。


リクエストの例

GET http://api.r-assistance.go.jp/v1/api.svc/getNotification?appkey=0&id=1
<?xml version="1.0" encoding="utf-8"?>
<UM:UmDocument xmlns:UM="urn:UMDocument">
<UM:DocumentContent uuid="4a2d12b3-78d0-43d4-b88b-211f0478c6c4">
<UM:author>事務局</UM:author>
<UM:local_gov_id></UM:local_gov_id>
<UM:local_gov_name></UM:local_gov_name>
<UM:document_number>第000号</UM:document_number>
<UM:document_date>2012-02-18T00:00:00+09:00</UM:document_date>
<UM:document_destination>○○○○殿&#xD;
××××殿</UM:document_destination>
<UM:document_sender>△△△△</UM:document_sender>
<UM:document_name>○○○○○○○○○の取り扱いについて</UM:document_name>
<UM:document_body>○○○○○○に係る××××××の取り扱いに関しては、遺漏のないようよろしくお願いする。</UM:document_body>
<UM:intended_service_name>○○制度</UM:intended_service_name>
<UM:update_at>2012-02-18T09:23:00+09:00</UM:update_at>
<UM:meta name="update_comment" value=""/>
<UM:meta name="update_kind" value="0"/>
</UM:DocumentContent>
</UM:UmDocument>

getContactsText

指定された名前のお問合せ先一覧(テキスト形式)を取得します。


URL

http://api.r-assistance.go.jp/v1/api.svc/getContactsText


パラメータ

appkey

省略不可。指定する値は「appkeyについて」を参照ください。

name

省略不可。お問合せ先一覧の名前を指定します。

getSupportInformationで取得したr-assistance_Content型のcontact_list要素(お問い合わせ先一覧)の値から1つの名称を指定します。

※指定した名前のデータが存在しない場合、Textが空のContactsTextが返ります。

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


戻り値

ContactsText

要素/属性 データの内容 データ型
Text お問合せ先一覧(テキスト形式)。※スペースおよび改行で位置合わせされたテキストです。 文字列

※文字列値内の改行は、「CR+LF」または「LFのみ」の両方が混在する場合があります。詳細は「レスポンスの改行コード」を参照ください。


リクエストの例 (一覧名”ハローワーク”の情報を取得)

GET http://api.r-assistance.go.jp/v1/api.svc/getContactsText?appkey=0&name=%e3%83%8f%e3%83%ad%e3%83%bc%e3%83%af%e3%83%bc%e3%82%af
 <?xml version="1.0" encoding="utf-8"?>
<ContactsText xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Text>                                   電話番号       FAX番号&#xD;
〈岩手県〉&#xD;
盛岡                019-651-8811     019-654-9305&#xD;
沼宮内                0195-62-2139     0195-62-1312&#xD;
・・・
</Text>
</ContactsText>

補足資料

OpenUMの定義説明

「復旧復興支援制度データベース」XMLスキーマ

UM(Universal Menu)文書型(UmDocument型)

No. タグ名 日本語名 種類 データ型 Usage 最小回数 最大回数 内容の例 備考
1 pathset パスセット 要素 PathSet - 0 任意    
2 category_content カテゴリ系コンテンツ 要素 CategoryContent - 0 任意    
3 notification_content 申請系コンテンツ 要素 NotificationContent - 0 任意    
4 r-assistance_Content 復旧復興支援制度系コンテンツ 要素 r-assistance_Content - 0 任意    
5 DocumentContent 通知・通達コンテンツ 要素 DocumentContent - 0 任意

カテゴリコンテンツ型(Universal Menu CategoryContent型)

No. タグ名 日本語名 種類 データ型 Usage 最小回数 最大回数 内容の例 備考
1 uuid UUID 属性 UUID 必須 - - 550e8400-e29b-41d4-a716-446655440001  ※1
2 umcd UMコード 要素 文字列 - 0 1 01-01-01-01-02-01-00  ※1
3 author 作成者 要素 文字列 - 1 1 株式会社アスコエパートナーズ  ※1
4 local_gov_id 地方公共団体コード 要素 整数 - 1 1 0  ※1
5 local_gov_name 地方公共団体名 要素 文字列 - 1 1 ▲▲市  ※1
6 created_at 作成日時 要素 日時 - 0 1 2001-12-31T12:00:00+09:00  ※1
7 updated_at 更新日時 要素 日時 - 0 1 2001-12-31T12:00:00+09:00  ※1
8 org_uuid コピー元UUID 要素 UUID - 0 1 550e8400-e29b-41d4-a716-446655440001  ※1
9 governing_law 根拠法 要素 文字列 - 0 1 災害援護法  ※1
10 governing_law_id 根拠法ID 要素 整数 - 0 1 2  ※1
11 division 管轄部署 要素 文字列 - 0 1 市民課  ※1
12 gic 実施区分 要素 文字列 - 0 1 5  ※1
13 service_name 行政サービス名 要素 文字列 - 0 1 災害援護資金  ※1
14 meta メタ情報 要素 Meta - 0 任意    ※1
15 title 名前 要素 ContentItem - 1 1    

※1 カテゴリコンテンツは、カテゴリの項目を継承しています。

コンテンツ参照型(ContentRef型)

No. タグ名 日本語名 種類 データ型 Usage 最小回数 最大回数 内容の例 備考
1 uuid コンテンツUUID 要素 UUID - 1 1 550e8400-e29b-41d4-a716-446655440001  

コンテンツ型(Content型)

No. タグ名 日本語名 種類 データ型 Usage 最小回数 最大回数 内容の例 備考
1 uuid UUID 属性 UUID 必須 - - 550e8400-e29b-41d4-a716-446655440001  
2 umcd UMコード 要素 文字列 - 0 1 01-01-01-01-02-01-00  
3 author 作成者 要素 文字列 - 1 1 株式会社アスコエパートナーズ  
4 local_gov_id 地方公共団体コード 要素 整数 - 1 1 0  
5 local_gov_name 地方公共団体名 要素 文字列 - 1 1 ▲▲市  
6 created_at 作成日時 要素 日時 - 0 1 2001-12-31T12:00:00+09:00  
7 updated_at 更新日時 要素 日時 - 0 1 2001-12-31T12:00:00+09:00  
8 org_uuid コピー元UUID 要素 UUID - 0 1 550e8400-e29b-41d4-a716-446655440001  
9 governing_law 根拠法 要素 文字列 - 0 1 災害援護法  
10 governing_law_id 根拠法ID 要素 整数 - 0 1 2  
11 division 管轄部署 要素 文字列 - 0 1 市民課  
12 gic 実施区分 要素 文字列 - 0 1 5  
13 service_name 行政サービス名 要素 文字列 - 0 1 災害援護資金  
14 meta メタ情報 要素 Meta - 0 任意    

コンテンツアイテム型(ContentItem型)

No. タグ名 日本語名 種類 データ型 Usage 最小回数 最大回数 内容の例 備考
1 uuid UUID 属性 UUID 必須 - - 550e8400-e29b-41d4-a716-446655440001  
2 umcd UMコード 要素 文字列 - 0 1 01-01-01-01-02-01-00-01  
3 title タイトル 要素 文字列 - 1 1 概要  
4 title_short タイトル(略称) 要素 文字列 - 1 1 概要  
5 summary 概要 要素 文字列 - 1 1 復旧時に行う手続き、サービスについて  
6 body 本文 要素 文字列 - 1 1 住宅の再建に利用できる支援制度  
7 note 注釈 要素 文字列 - 0 1    
8 memo 備考 要素 文字列 - 0 1 このコンテンツは今後削除する  
9 created_at 作成日時 要素 日時 - 0 1 2001-12-31T12:00:00+09:00  
10 updated_at 更新日時 要素 日時 - 0 1 2001-12-31T12:00:00+09:00  
11 org_uuid コピー元UUID 要素 UUID - 0 1 550e8400-e29b-41d4-a716-446655440000  

メタ情報型(Meta型)

No. タグ名 日本語名 種類 データ型 Usage 最小回数 最大回数 内容の例 備考
1 name 名前 属性 文字列 必須 - - 名前  
2 value 属性 文字列 必須 - - 1  

復旧復興支援制度系コンテンツ型(r-assistance_Content型)

No. タグ名 日本語名 種類 データ型 Usage 最小回数 最大回数 内容の例 備考
1 uuid UUID 属性 UUID 必須 - -    
2 umcd UMコード 要素 文字列 - 0 任意    
3 author 作成者 要素 文字列 - 1 1    
4 local_gov_id 地方公共団体コード 要素 整数 - 1 1    
5 local_gov_name 地方公共団体名 要素 文字列 - 1 1    
6 governing_law 根拠法 要素 文字列 - 0 任意    
7 governing_law_url 根拠法URL 要素 文字列 - 0 任意    
8 service name 行政サービス名 要素 文字列 - 0 1    
9 title 制度名 要素 ContentItem - 1 1    
10 general_info 内容 要素 ContentItem - 1 1    
11 general_list 概要(一覧用) 要素 ContentItem - 0 1    
12 intended_person 対象者 要素 ContentItem - 1 任意  
13 intended_area 対象地域 要素 ContentItem - 0 任意  
14 application_procedure 申請・届出方法 要素 ContentItem - 0 任意    
15 applicatipon_deadline 申請期限 要素 ContentItem - 1 1    
16 support_term 支援期間 要素 ContentItem - 0 1    
17 application_form 申請書類 要素 ContentItem - 0 任意    
18 application_form_url 申請書類入手URL 要素 ContentItem - 0 任意    
19 related_link 詳細参照先名 要素 ContentItem - 0 任意    
20 related_link_url 詳細URL 要素 ContentItem - 0 任意    
21 e_application 電子申請名称 要素 ContentItem - 0 任意    
22 e_application_url 電子申請URL 要素 ContentItem - 0 任意    
23 contact お問合せ(組織・窓口名称) 要素 ContentItem - 0 任意    
24 contact_postal_code お問合せ(郵便番号) 要素 ContentItem - 0 任意    
25 contact_address お問合せ(住所) 要素 ContentItem - 0 任意    
26 contact_tel お問合せ(TEL) 要素 ContentItem - 0 任意    
27 contact_fax お問合せ(FAX) 要素 ContentItem - 0 任意    
28 contact_mail お問合せ(メール) 要素 ContentItem - 0 任意    
29 contact_free_description お問合せ(自由記述) 要素 ContentItem - 0 任意    
30 contact_list お問合せ先一覧表示(対象県) 要素 ContentItem - 0 任意    
31 budget 予算枠の有無 要素 ContentItem - 0 1    
32 meta メタ情報 要素 meta - 0 任意    
33   以下、予備フィールド     - 0 任意    
34                  

※2 「コンテンツ型」を継承します。

抽出用項目 XMLタグ名称

No. タグ名 日本語名 種類 データ型 Usage 最小回数 最大回数 内容の例 備考
1 assistance_type 支援の種類 要素 ContentItem - 0 任意    
2 citizens_housing 個人向け:住まいのこと 要素 ContentItem - 0 任意    
3 citizens_work 個人向け:仕事のこと 要素 ContentItem - 0 任意    
4 citizens_medical_welfare 個人向け:医療・福祉のこと 要素 ContentItem - 0 任意    
5 citizens_nurturing_education 個人向け:子育て・教育のこと 要素 ContentItem - 0 任意    
6 citizens_money 個人向け:おかねのこと 要素 ContentItem - 0 任意    
7 citizens_others_living 個人向け:その他・暮らしにかかわること 要素 ContentItem - 0 任意    
8 citizens_nuclear_power 個人向け:原発関係のこと 要素 ContentItem - 0 任意    
9 businesses _segments 事業者向け:事業区分 要素 ContentItem - 0 任意    
10 businesses _situation 事業者向け:状況 要素 ContentItem - 0 任意  

通知・通達コンテンツ型(DocumentContent型)

No. タグ名 日本語名 種類 データ型 Usage 最小回数 最大回数 内容の例 備考
1 uuid yUUID 属性 UUID 必須 - -    
2 document_number 文書番号 要素 文字列 - 1 1    
3 document_date 文書年月日 要素 日時 - 1 1    
4 document_destination 宛先 要素 文字列 - 1 1    
5 document_sender 発信者 要素 文字列 - 1 1    
6 document_name 文書名 要素 文字列 - 1 1    
7 document_body 本文 要素 文字列 - 1 1    
8 intended_service_name 制度名 (通達対象の制度名を「//」区切り複数入力) 要素 文字列 0 任意    

※3 「コンテンツ型」を継承します。

CC-BY-SA (あとで画像に置き換える)

ユニバーサルメニューXMLスキーマ by 一般社団法人ユニバーサルメニュー普及協会、震災復興支援ユニバーサルメニュープロジェクト

OpenUM Project is licensed under a Creative Commons 表示 - 継承 2.1 日本 License.

OpenUM Project

OpenUM Project の詳細は、下記URLまで。

http://www.asukoe.org/openum/


更新履歴

ドキュメントの更新履歴について記載しています。

日付内容
2012-02-27初版