農作物名ガイドライン（GL3）取得API：Get/{CropNameId}
- 更新日 2024-10-21
概要
API名称
農作物名ガイドライン（GL3）取得API：Get/{CropNameId}
説明
内閣官房IT総合戦略室が提供する、農作物名ガイドライン(GL3)のデータです。農作物名ガイドライン(GL3)APIから粗飼料の名称も入手可能です。
本APIの利用にあたっては利用規約への同意の上、別途利用申請が必要ですので、ご利用の際は
農業データ連携基盤（WAGRI）利⽤・変更申請ページ」
https://wagri-subscription.db.naro.go.jp/ords/r/prd/subscription/pre-registration
からご申請をお願い申し上げます。
■API利用マニュアル・利用規約等の詳細：添付ファイル「農林水産省オープンデータAPIの利用マニュアル、利用規約」
データの更新頻度
ー
カテゴリー
添付ファイル
農林水産省オープンデータAPIの利用マニュアル、利用規約
説明
利用承諾後、APIの利用者権限を付与し、申請いただいたご担当者様のメールアドレス宛にご連絡します。
関連メソッド
リクエスト
URL
https://api.wagri.net/API/MaffOpenData/Private/GuidelinesForCropNames/Get/{CropNameId}
説明
登録されている農作物名ガイドライン(GL3)のデータを主キーにより１件指定して取得できます。 主キーはJSON形式のレスポンス情報に含まれており、Odataによるフィルター検索で取得できます。 主キー以外の条件抽出に関しても、Odataで取得可能です。
HTTPメソッド
GET
パラメータ
URLデータ定義
GuidelinesForCropNames(PK)
| 名称 | 値 | 型 | 値の説明 |
|---|---|---|---|
| CropNameId | 農作物名ID | string | Required Max Length: 8 |
URL説明
JSON型式のレスポンスに含まれており、データ1件を特定するための一意のキーとなります。
呼出例
ー
レスポンス
レイアウト
レスポンスデータ定義
GuidelinesForCropNames
| 名称 | 値 | 型 | 値の説明 |
|---|---|---|---|
| CropNameId | 農作物名ID | string | Required Max Length: 8 |
| LargeCategoryCode | 大分類コード | string, null | Max Length: 2 |
| LargeCategoryName | 大項目名 | string, null | Max Length: 30 |
| MediumCategoryCode | 中分類コード | string, null | Max Length: 4 |
| MediumCategoryName | 中分類名 | string, null | Max Length: 30 |
| CropName | 農作物名 | string, null | Max Length: 30 |
| WAGRICategoryCode1 | WAGRI分類1コード | string, null | Max Length: 6 |
| WAGRICategoryCode2 | WAGRI分類2コード | string, null | Max Length: 26 |
| FruitAndVegetablesNameCode | 青果物統一品名コード | string, null | Max Length: 5 |
| AGROVOCId | AGROVOC_ID | string, null | Max Length: 32 |
| CropVocabularyURI | 農作物語彙体系URI | string, null | Max Length: 500 |
| Thesaurus | 同義語 | string, null | Max Length: 8833 |
| ConcreteExample | 具体例 | string, null | Max Length: 8833 |
| HarvestingPart | 収穫部位 | string, null | Max Length: 100 |
| Properties | 属性項目 | string, null | Max Length: 500 |
レスポンス説明
GuidelinesForCropNames
レスポンス例
ー
ステータスコード
| コード | 名称 | 値の説明 |
|---|---|---|
| 400 | Bad Request | リクエストが不正です。 |
| 403 | Forbidden | リソースのアクセスが禁止されています。 |
| 500 | Internal Server Error | サーバー内部でエラーが発生しました。 |
| 401 | Unauthorized | 認証情報が不正です。 |
サンプルソースコード
ソースコード
ー