気象情報取得API(ハレックス社):WeatherWarningH
- 更新日 2023-09-28
概要
API名称
気象情報取得API(ハレックス社):WeatherWarningH
説明
ハレックス提供、気象特別警報・警報・注意報を取得する
データの更新頻度
-
カテゴリー
リクエスト
URL
https://api.wagri.net/API/Public/WeatherWarningH/Hpd?sid={sid}&key={key}&mode={mode}&code={code}&lat={lat}&lon={lon}&func={func}
説明
気象特別警報・警報・注意報
HTTPメソッド
GET
パラメータ
詳細は添付ファイル:「農業データ連携基盤_気象特別警報・警報・注意報API仕様書」を参照下さい。
認証
パラメータまたは、HTTPヘッダーのAuthorization項目にアクセスキーを記載して送付することで認証します。
気象特別警報・警報・注意報dataの取得のパラメータ。
名称 | 値 | 型 | 値の説明 |
---|---|---|---|
sid | サービスID | string | 必須
point-warn:JSONレスポンス |
key | アクセスキー(別途ご案内) | string | 必須
別途ご案内(HTTPヘッダーのAuthorization項目に設定した場合、省略可) |
mode | レスポンス種別指定 | string | 必須
s:特別警報・警報・注意報の発表等の状況ステータスのみ要求 all:今後の推移の時系列情報等を含めて要求 |
code | 二次細分区域コード | string | 省略不可(「code」 もしくは、「lat・lon」の指定が必要、双方指定した場合、「code」の値を優先)
半角数字、7桁 |
lat | 緯度
|
string | 省略不可(「code」 もしくは、「lat・lon」の指定が必要、双方指定した場合、「code」の値を優先)
例.35.5729 , 35.5 (世界測地系、10進法) |
lon | 経度
|
string | 省略不可(「code」 もしくは、「lat・lon」の指定が必要、双方指定した場合、「code」の値を優先)
例.139.0035 , 140(世界測地系、10進法) |
func | JSONPコール バック関数名 | string | コールバック関数名を指定します。(例:doJson 等) ※JSONPリクエスト時のみ有効(省略した場合、 doJson) |
呼出例
GET /API/Public/WeatherWarningH/Hpd?sid=point-warn&key=xxxxx&mode=all&lat=35&lon=139
レスポンス
レイアウト
添付ファイル:「農業データ連携基盤_気象特別警報・警報・注意報API仕様書」を参照下さい。
レスポンス例
レスポンスイメージ (mode=sを指定してステータス情報のみを取得した場合の例)
{"HeadlineText":"南部平野部、北部平野部では、28日昼過ぎまで強風に注意してください。北部平野部では、27日夜遅くまで高波に注意してください。", "PublishingOffice":"宮崎地方気象台", "ReportDateTime":"2016-12-27T15:54:00+09:00", "area": {"code":"4540200", "name":"新富町", "status": {"02":"0", "03":"0", "04":"0", "05":"0", "06":"0", "07":"0", "08":"0", "10":"0", "12":"0", "13":"0", "14":"0", "15":"2", "16":"0", "17":"0", "18":"0", "19":"0", "20":"0", "21":"0", "22":"0", "23":"0", "24":"0", "25":"0", "26":"0", "32":"0", "33":"0", "35":"0", "36":"0", "37":"0", "38":"0"}, "warn": {"15": {"Name":"強風注意報", "Status":"継続"} } }, "point": {"code":"45402", "initime":"2016-12-27T15:54:00+09:00", "jmaURL":"http://www.jma.go.jp/jp/warn/4540200.html", "name":"新富町", "pref":"宮崎県"}, "sysinfo": {"copyright":"株式会社ハレックス", "edittime":"2016-12-27T15:56:09+09:00", "title":"市区町村特別警報・警報・注意報", "ver":"1.0"} }
ステータスコード
※APIエラーコードは、添付ファイル:「農業データ連携基盤_気象特別警報・警報・注意報API仕様書」をご参照下さい。
コード | 名称 | 値の説明 |
---|---|---|
200 | OK | リクエストが成功しました。 |
400 | Bad Request | リクエストが不正です。 |
401 | Unauthorized | 認証情報が不正です。 |
403 | Forbidden | リソースのアクセスが禁止されています。 |
404 | Forbidden | リソースが見つかりませんでした。 |
500 | Internal Server Error | サーバー内部でエラーが発生しました。 |
サンプルソースコード
ソースコード
–