震災関連情報
災害ボランティア検索API
Version 1
リクエストURL
XML
PHPSerialize
JSON
http://shinsai.yahooapis.jp/v1/volunteers
災害ボランティア情報で掲載されている情報の検索機能を適用するAPIです。
※情報提供:ボランティアインフォ、ボランティアプラットフォーム
※本APIは、期間限定のAPIです。更新頻度、サービスの提供期間・終了日は未定ですが、決まり次第、掲載します。
※被災地のNPOなどから提供された情報をそのまま記載しております。掲載情報に不備があることもございます。あらかじめご了承ください。
※情報提供元の情報開示内容が変更になった場合、本APIの仕様も予告なく変更になる場合があります。
※利用にはアプリケーションIDが必要です。
リクエストパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| appid (必須) |
string | アプリケーションID。詳細はアプリケーションIDのヘルプをご覧ください。 |
| query | string | URLエンコードされた検索クエリーです。文字コードはUTF-8です。 |
| id | string | メッセージIDで検索します。 |
| results | integer (デフォルト:20) |
検索結果の返却数を指定します。指定できる最大値は30です。 |
| start | integer (デフォルト:1) |
検索結果の先頭位置を指定します。 |
| lat | float | 緯度。 |
| lon | float | 経度。 |
| sort | string (デフォルト:-date) |
検索条件を指定します。
|
| status | enum(-1,0,1) デフォルト:1 |
掲載ステータスを絞り込みます。
|
| output | enum (xml, php, json) デフォルト:xml |
出力形式を指定します。省略した場合、XML形式となります。 |
| callback | string デフォルト:(なし) |
output=jsonを指定した場合、このパラメータを指定するとレスポンスがJSONP形式になります。callback関数名を指定します。 |
サンプルリクエストURL
http://shinsai.yahooapis.jp/v1/volunteers?id=tasukeai_japan_462&appid=<あなたのアプリケーションID>レスポンスフィールド
| フィールド | 説明 |
|---|---|
| Messages | ルートノードです。以下のノードを含みます。
|
| フィールド | 説明 | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Message | 各個別レスポンスを含みます。
|
サンプルレスポンス
XMLのレスポンス例
エラー
このAPIは、Yahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。
利用制限
このAPIは、24時間中1アプリケーションIDにつき50000件のリクエストが上限となっています。詳しくは「利用制限」をご参照ください。