気象情報取得API(ハレックス社):WeatherHistoryH
- 更新日 2023-09-28
概要
API名称
説明
ハレックス提供、過去の情報を取得する
データの更新頻度
カテゴリー
添付ファイル
リクエスト
URL
https://api.wagri.net/API/Public/WeatherHistoryH/Hpd?sid={sid}&lat={lat}&lon={lon}&rem={rem}&gran={gran}&from={from}&to={to}&key={key}&func={func}
説明
過去情報の取得。
詳細は、添付ファイル:農業データ連携基盤_過去dataAPI仕様書 をご参照下さい。
HTTPメソッド
パラメータ
詳細は添付ファイル農業データ連携基盤_過去dataAPI仕様書 を参照下さい。
認証
HTTPヘッダーのAuthorization項目にアクセスキー(別途ご案内)を記載して送付してください。
パラメータ
名称 | 値 | 型 | 値の説明 |
---|---|---|---|
sid | サービスID | string | 必須、データ種類および形式を指定 実況データ,JSON : analysis-service 実況データ,JSONP : analysis-p-service |
lat | 緯度 | string | 必須、(世界測地系・10進法) |
lon | 経度 | string | 必須、(世界測地系・10進法) |
rem | 要素指定 | string | 必須、all(全要素)固定
※指定するデータ粒度によって取得できる要素が異なります。 |
gran | データ取得粒度 | string | 必須、取得したい時間粒度を指定
年:1, 月:2, 旬:3, 半旬:4, 日:5, 時:6 |
from | データ取得開始 | string | 必須、取得したい期間の始めを指定
年 :YYYY (例:2017年 2017) ※「データ取得粒度」の指定により設定値が異なります。 |
to | データ取得終了 | string | 必須、取得したい期間の終わりを指定
from 「データ取得開始」と同様 |
key | アクセスキー | string | 別途ご案内、必須
(HTTPヘッダーのAuthorization項目に設定した 場合、省略可) |
func | JSONPコール バック関数名 | string | コールバック関数名を指定します。(例:doJson 等) ※JSONPリクエスト時のみ有効(省略した場合、 doJson) |
呼出例
GET /API/Public/WeatherHistoryH/Hpd?sid=analysis-service&lat=35&lon=139&rem=all&gran=6&from=2017010100&to=2017010323&key=xxxxx
レスポンス
レイアウト
レスポンスデータ定義
詳細は添付ファイル「農業データ連携基盤_過去dataAPI仕様書」 をご参照下さい。
レスポンス例
レスポンスイメージ (sid=analysis-service、rem=all、gran=6の場合)
{"Data": {"YYYYMMDDhh": {"pr":"0.5", "te":"13.7", "wd":"279.1", "ws":"999.9", "wt":"100"}, "YYYYMMDDhh": {"pr":"999.9", "te":"-99.9", "wd":"999.9", "ws":"999.9", "wt":"999"}, ・ ・ "YYYYMMDDhh": {"pr":"999.9", "te":"-99.9", "wd":"999.9", "ws":"999.9", "wt":"999"} }, "param": {"from":"2016111000", "gran":"6", "lat":"35.55555", "lon":"138.95555", "rem":"all", "sid":"analysis-service", "to":"2016111023"}, "sessionId":"quff95yik77qm2mrlw8jm5pe", "sid":"analysis-service", "systemTime":"2017/03/23 15:35:12.231 JST"}
ステータスコード
APIエラーコードは、添付ファイル「農業データ連携基盤_過去dataAPI仕様書」をご参照下さい。
コード | 名称 | 値の説明 |
---|---|---|
200 | OK | リクエストが成功しました。 |
400 | Bad Request | リクエストが不正です。 |
401 | Unauthorized | 認証情報が不正です。 |
403 | Forbidden | リソースのアクセスが禁止されています。 |
404 | Forbidden | リソースが見つかりませんでした。 |
500 | Internal Server Error | サーバー内部でエラーが発生しました。 |
サンプルソースコード
ソースコード
–