産地出荷量予測 > 産地出荷量予測API /ShipmentForecast/Get?area_id={都道府県コード}&subscription_key={認証キー}
- 更新日 2024-10-21
概要
API名称
産地出荷量予測API
説明
マクロデータによる都道府県単位での週間出荷量予測値を5週間先まで提供する
（キャベツ・玉ねぎ・トマト・きゅうり）
データの更新頻度
随時
カテゴリー
添付ファイル
関連メソッド
リクエスト
URL
https://api.wagri.net/API/MidoriCloud/Private/ShipmentForecast/Get?area_id={都道府県コード}&subscription_key={認証キー}
説明
マクロデータによる都道府県単位での週間出荷量予測値を5週間先まで提供する
（キャベツ・玉ねぎ・トマト・きゅうり）
HTTPメソッド
GET
パラメータ
| パラメータ | ||||
| name | description | 型 | 必須 | 備考 |
| area_id | 都道府県コード | string | ○ | JIS規格による都道府県コード 未指定のときは全都道府県を返す |
| subscription_key | 認証キー | string | ○ | みどりクラウドのAPIポータルから提供された認証キーを設定する |
みどりクラウドのAPIポータル: https://midoricloud-api.developer.azure-api.net/
呼出例
レスポンス
レイアウト
レスポンス例
| レスポンス | ||
| name | description | 型 |
| Items | 品目別出荷量予測 | Itemの配列 |
| Item のデータ定義 | |||
| 名称 | 値 | 型 | 値の説明 |
| Name | 品目名 | string | |
| Areas | 都道府県別出荷量予測 | Areaの配列 |
| Area のデータ定義 | |||
| 名称 | 値 | 型 | 値の説明 |
| Name | 産地名 | string | |
| Forecasts | 出荷量予測データ | Forecastの配列 |
| Forecast のデータ定義 | |||
| 名称 | 値 | 型 | 値の説明 |
| 10% | 出荷量予測の10%分位点 | number | 単位はkg |
| 50% | 出荷量予測の50%分位点 | number | 単位はkg |
| 90% | 出荷量予測の90%分位点 | number | 単位はkg |
| Day | 予測最終日 | string | この日より1週間前が予測の対象期間 |
ステータスコード
| ステータスコード | ||
| コード | 名称 | 値の説明 |
| 200 | OK | リクエストが成功しました。 |
| 400 | Bad Request | リクエストが不正です。 |
| 401 | Unauthorized | 認証情報が不正です。 |
| 403 | Forbidden | リソースのアクセスが禁止されています。 |
| 404 | Not Found | リソースが見つかりませんでした。 |
| 500 | Internal Server Error | サーバー内部でエラーが発生しました。 |