予察情報API(地域一覧取得):getmstprefecture
- 更新日 2024-03-07
概要
API名称
説明
都道府県の防除所が公開している病害虫の発生予察情報を提供いたします。
・都道府県のホームページ等で公開している情報です。
・本APIで提供される情報の改変は一切行わないでください。
・本APIは令和7年3月末まで、無料でご利用いただけます。
・本APIご利用のお申し込みは、添付ファイルの「予察情報API利用規約」をご確認のうえ、「予察情報API利用申請書」を
(株)ファーム・アライアンスマネジメント(support@farmalliance.net)までご提出お願いいたします。
データの更新頻度
カテゴリー
添付ファイル
リクエスト
URL
https://api.wagri.net/API/Individual/fam/yosatsuinfo/getmstprefecture?page={page}
説明
HTTPメソッド
パラメータ
認証(AUTHORIZATION)
キー |
値 |
X-YosatsuAPI-Token |
{User_Token} |
ヘッダー(HEADERS)
キー |
値 |
X-Authorization |
{WAGR_Token} |
パラメータ(PARAMS)
名称 |
値 |
型 |
値の説明 |
page |
ページ番号 |
数値 |
ページング(0=全件) |
呼出例
https://api.wagri.net/API/Individual/fam/yosatsuinfo/getmstprefecture?page=1
レスポンス
レイアウト
以下に、ご提供いただいたAPIレスポンスデータのマークダウン形式でのドキュメントを作成します。
都道府県マスタデータ API レスポンス
このAPIは、都道府県と関連する地域情報、ブロック情報などを取得します。
レスポンスデータ
名称 |
型 |
説明 |
total_count |
数値 |
検索結果の合計数 |
page_size |
数値 |
ページ当たりの構成数 |
page |
数値 |
ページ数 |
content |
配列 |
検索結果 |
content 配列の要素は以下のプロパティを持つオブジェクトです。
MstPrefecture(都道府県情報)
名称 |
型 |
説明 |
ID |
文字列 |
ID |
UCD |
文字列 |
ユニークコード |
MCD |
文字列 |
マスタコード |
NAME |
文字列 |
名称(都道府県名) |
ARCLS |
文字列 |
地域区分 |
ARCD |
文字列 |
地域コード |
CRDT |
文字列 |
初回登録日時 |
F_CRCD |
文字列 |
初回登録者コード |
CHDT |
文字列 |
最終更新日時 |
F_CHCD |
文字列 |
最終更新者コード |
ISDEL |
文字列 |
削除フラグ |
ISAVL |
文字列 |
有効フラグ |
AREA |
配列 |
地域情報 |
AREA 配列の要素は以下のプロパティを持つオブジェクトです。
MstArea(地域情報)
名称 |
型 |
説明 |
ID |
文字列 |
ID |
UCD |
文字列 |
ユニークコード |
MCD |
文字列 |
マスタコード |
F_HYUCD |
文字列 |
HYUコード |
NAME |
文字列 |
名称 |
ADDR |
文字列 |
住所 |
LATTD |
文字列 |
緯度 |
名称 |
型 |
説明 |
LONTD |
文字列 |
経度 |
RANGE |
文字列 |
範囲 |
PATHCOLOR |
文字列 |
境界色 |
CRDT |
文字列 |
初回登録日時 |
F_CRCD |
文字列 |
初回登録者コード |
CHDT |
文字列 |
最終更新日時 |
F_CHCD |
文字列 |
最終更新者コード |
ISDEL |
文字列 |
削除フラグ |
ISAVL |
文字列 |
有効フラグ |
レスポンス例
{ "status": 200, "total_count": 55, "page_size": 10, "page": 1, "content": [ { "MstPrefecture": { "ID": 3, "UCD": 80001, "MCD": 2, "NAME": "青森県", "ARCLS": 0, "ARCD": 91, "CRDT": "2021-10-08 10:00:00", "F_CRCD": 0, "CHDT": "2021-10-08 10:00:00", "F_CHCD": 0, "ISDEL": 0, "ISAVL": 1, "AREA": [ { "MstArea": { "ID": 2, "UCD": 80001, "MCD": 2, "F_HYUCD": 2, "NAME": "県央", "ADRS": "青森県青森市", "LATTD": "40.65042744226816", "LONTD": "140.84164063277177", "RANGE": "40.6566021475421, 140.80657383306158:40.6577090689991, 140.85858723027837:40.64221049731512, 140.85944553716314:40.63823759480051, 140.82682987554205:40.64533654945107, 140.80777546270025", "PATHCOLOR": "#FF0000", "CRDT": "2021-12-07 09:58:17", "F_CRCD": 0, "CHDT": "2021-12-07 09:58:17", "F_CHCD": 0, "ISDEL": 0, "ISAVL": 1 }, "MstApp": { "MCD": 2, "NAME": "青森県" } }, { "MstArea": { "ID": 3, "UCD": 80001, "MCD": 3, "F_HYUCD": 2, "NAME": "県北", "ADRS": "9X69+99 青森県むつ市", "LATTD": "41.3609449748375", "LONTD": "140.96847583139532", "RANGE": "41.51767644332137, 140.9221726404422:41.162991189248736, 140.78209695684845:41.23738745448279, 141.13365945684845:41.392107977844546, 141.17760476934845:41.47035950526102, 141.09520730841095", "PATHCOLOR": "#FF0000", "CRDT": "2021-12-07 09:58:52", "F_CRCD": 0, "CHDT": "2021-12-07 09:58:52", "F_CHCD": 0, "ISDEL": 0, "ISAVL": 1 }, "MstApp": { "MCD": 2, "NAME": "青森県" } } ] }, "MstBlock": { "NAME": "東北地方" } }
ステータスコード
コード |
名称 |
値の説明 |
200 |
OK |
リクエストが成功しました。 |
400 |
Bad Request |
リクエストが不正です。 |
401 |
Unauthorized |
認証情報が不正です。 |
403 |
Forbidden |
リソースのアクセスが禁止されています。 |
404 |
Not Found |
リソースが見つかりませんでした。 |
500 |
Internal Server Error |
サーバー内部でエラーが発生しました。 |
サンプルソースコード
ソースコード
Python(requestsモジュール)でのサンプルコード
import requests url = "https://api.wagri.net/API/Individual/fam/yosatsuinfo/getmstprefecture?page=1" payload = {} headers = { 'X-Authorization': '{WAGRI_Token}', 'X-YosatsuAPI-Token': 'User_Token', 'Cookie': 'ARRAffinity={}; ARRAffinitySameSite={}' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)