API利用の手引き
ドキュメントバージョン 4.0 (Updated: 2023-07-28 17:00 JST)
URL
- 検証環境: https://tasukeai-heroku-20.herokuapp.com/2/volunteer.json
- 本番環境: https://tasukeai.herokuapp.com/2/volunteer.json
クエリパラメータ
| パラメータ名 | 型 | 説明 |
|---|---|---|
| per_page | 整数値 | 取得件数 |
| page | 整数値 | ページ番号 |
レスポンス
フォーマット
JSON 形式レスポンスフィールド
| フィールド名 | 型 | 説明 | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | 整数値 | 記事ID | ||||||||||||||||||||||||
| organization | 文字列 | 主催団体 | ||||||||||||||||||||||||
| title | 文字列 | タイトル | ||||||||||||||||||||||||
| summary | 文字列 | 概要 | ||||||||||||||||||||||||
| conditions | 文字列 | 応募条件 | ||||||||||||||||||||||||
| categories | 配列 |
カテゴリー (オブジェクト)
|
||||||||||||||||||||||||
| contents_of_act | 文字列 | 活動内容 | ||||||||||||||||||||||||
| start_at | 日付文字列 (YYYY-MM-DD) | 募集期間 開始日 | ||||||||||||||||||||||||
| end_at | 日付文字列 (YYYY-MM-DD) | 募集期間 終了日 | ||||||||||||||||||||||||
| actdays | 配列 | 活動日 (日付文字列 YYYY-MM-DD) | ||||||||||||||||||||||||
| act_as_needed | 真偽値 | 活動日 随時フラグ (true: 随時 / false: 随時でない) | ||||||||||||||||||||||||
| actdays_for_display | 文字列 | 活動日 表示日時 | ||||||||||||||||||||||||
| zip_code_to_act | 文字列 | 活動場所 郵便番号 | ||||||||||||||||||||||||
| prefecture_to_act | 文字列 | 活動場所 都道府県 (47都道府県、海外、オンライン) | ||||||||||||||||||||||||
| city_to_act | 文字列 | 活動場所 市区町村 | ||||||||||||||||||||||||
| street_number_to_act | 文字列 | 活動場所 番地 | ||||||||||||||||||||||||
| building_and_room_to_act | 文字列 | 活動場所 建物名・部屋番号 | ||||||||||||||||||||||||
| latitude_to_act | 浮動小数点 | 活動場所 緯度 | ||||||||||||||||||||||||
| longitude_to_act | 浮動小数点 | 活動場所 経度 | ||||||||||||||||||||||||
| number_of_people | 文字列 | 募集人数 | ||||||||||||||||||||||||
| item_to_bring | 文字列 | 持ち物 | ||||||||||||||||||||||||
| way_to_apply_url | 文字列 | 申込み方法 URL | ||||||||||||||||||||||||
| way_to_apply_email | 文字列 | 申込み方法 メールアドレス | ||||||||||||||||||||||||
| way_to_apply_tel | 文字列 | 申込み方法 電話番号 | ||||||||||||||||||||||||
| way_to_apply | 文字列 | 申込み方法 補足 | ||||||||||||||||||||||||
| others | 文字列 | その他 | ||||||||||||||||||||||||
| pdf_url | 文字列 | |||||||||||||||||||||||||
| source_url | 文字列 | 情報元URL | ||||||||||||||||||||||||
| image_url | 文字列 | メイン画像 | ||||||||||||||||||||||||
| image_url_2 | 文字列 | サブ画像(1) | ||||||||||||||||||||||||
| image_url_3 | 文字列 | サブ画像(2) | ||||||||||||||||||||||||
| image_url_4 | 文字列 | サブ画像(3) | ||||||||||||||||||||||||
| image_url_5 | 文字列 | サブ画像(4) | ||||||||||||||||||||||||
| organizer_email | 文字列 | 主催者情報 メールアドレス | ||||||||||||||||||||||||
| organizer_tel | 文字列 | 主催者情報 電話番号 | ||||||||||||||||||||||||
| organizer_zip_code | 文字列 | 主催者情報 郵便番号 | ||||||||||||||||||||||||
| organizer_prefecture | 文字列 | 主催者情報 都道府県 (47都道府県、その他) | ||||||||||||||||||||||||
| organizer_city | 文字列 | 主催者情報 市区町村 | ||||||||||||||||||||||||
| organizer_street_number | 文字列 | 主催者情報 番地 | ||||||||||||||||||||||||
| organizer_building_and_room | 文字列 | 主催者情報 建物名・部屋番号 | ||||||||||||||||||||||||
| organizer_web | 文字列 | 主催者Webサイト | ||||||||||||||||||||||||
| organizer_twitter | 文字列 | 主催者SNS (Twitter) | ||||||||||||||||||||||||
| organizer_instagram | 文字列 | 主催者SNS (Instagram) | ||||||||||||||||||||||||
| organizer_facebook | 文字列 | 主催者SNS (Facebook) | ||||||||||||||||||||||||
| organizer_youtube | 文字列 | 主催者SNS (YouTube) | ||||||||||||||||||||||||
| organizer_image_url | 文字列 | 主催者画像 | ||||||||||||||||||||||||
| sdgs | 配列 | SDGs (オブジェクト)
|
||||||||||||||||||||||||
| preferences | 配列 | こだわり条件 (オブジェクト)
|
||||||||||||||||||||||||
| info_type | 文字列 | 分類 (イベント、ボランティア) | ||||||||||||||||||||||||
| is_disaster | 真偽値 | 災害フラグ (true: 災害である / false: 災害でない) | ||||||||||||||||||||||||
| is_hidden_on_vi | 真偽値 | VI非表示フラグ (true: 非表示 / false: 表示) | ||||||||||||||||||||||||
| created_at | 日時 (日本時間) | 初回登録日時 | ||||||||||||||||||||||||
| updated_at | 日時 (日本時間) | 最終更新日時 | ||||||||||||||||||||||||
| valid_f | 真偽値 | 表示状態 (true: 表示 / false: 非表示(無効データ)) |
情報の提示方法/リンク先について
取得した情報は全て御サイトで表示させることが望ましい形です。 突発的な負荷を避け、安定した入力環境を維持するためにも、 タイトルのみを御サイトで表示し、そこから当サイトの該当ページに動線をはるような形式は好ましくありません。
クレジット表記
個別記事ページには情報ソースとして下記を付加してください- 表記: ボランティアインフォ
ライセンス
本APIはCreative Commons BY-SA(表示-継承)ライセンスに基づき提供されます。
※クレジットを表示し、改変した場合には元の作品と同じCCライセンスで公開することを守れば、営利目的での二次利用も許可されます
アクセス制限
現在のところアクセス制限は加えていません。 ただし状況に応じてIPアドレス単位でのアクセス制限をかける可能性があることをご了承ください
連絡先
APIに関するお問い合わせは下記メールアドレスまでvi-db at googlegroups.com
関連リンク
- Yahoo!検索API - Yahoo!がボランティア情報の検索ＡＰＩを提供しています
- マッシュアップギャラリー - データを活用したサービスを開発された方はマッシュアップギャラリーに投稿ください
- 東日本大震災対応アプリケーション開発の呼びかけ（経産省) - 経済産業省のアプリケーション開発プロジェクトと連携しています