アンケート：SurveyList
- 公開日
- 更新日 2024-11-18
利用条件
無償オプションAPI（申込必要）
概要
API名称
アンケート
カテゴリー
説明
アンケートに関するAPI
添付ファイル
ー
関連メソッド
データの更新頻度
随時
リクエスト
URL
ー
説明
ユーザ未回答のアンケート一覧を取得する。
詳細は、MAFF事務局への利用申請後に提供されるAPI利用マニュアルを参照下さい。
HTTPメソッド
GET
パラメータ
Header
| 名称 | 値 | 型 | 値の説明 |
|---|---|---|---|
| Authorization | MAFF API アクセストークン | string | 必須 ※参照 API情報「ユーザー：Login」 |
| X-Authorization | WAGRI アクセストークン | string | 必須 WAGRI のアクセストークン |
Query
| 名称 | 値 | 型 | 値の説明 |
|---|---|---|---|
| order | ソート順 | string | Enum: [ “PublishStart”, “PublishEnd” ] |
| limit | 取得件数 | integer | |
| Filterbyuserprofiles | ユーザプロファイルによるフィルタリング | boolean |
※詳細は、MAFF事務局への利用申請後に提供されるAPI利用マニュアルを参照下さい。
呼出例
ー
レスポンス
レイアウト
MAFF事務局への利用申請後に提供されるAPI利用マニュアルを参照下さい。
レスポンス例
応答結果イメージ
{
"total": 1,
"data": [
{
"survey_id": 18,
"title": "新着アンケートテスト3/2_01",
"thumbnail": "",
"deadline_date": "2020/03/07",
"isAnswerd": false,
"publish_at": "2020/03/02",
"types": [
1,
2,
3
],
"typeNames": "基本政策, ＳＤＧｓ, 国際関係"
}
]
}
ステータスコード
| コード | 名称 | 説明 |
|---|---|---|
| 400 | Bad Request | リクエストが不正です。 |
| 401 | Unauthorized | 認証情報が不正です。 |
| 403 | Forbidden | リソースのアクセスが禁止されています。 |
| 500 | Internal Server Error | サーバー内部でエラーが発生しました。 |
サンプルソースコード
プログラム記述例（WAGRI共通）
import requests
url = "https://api.wagri.net/API/Public/AgriculturalLand/SearchByCityCode"
payload = {
'CityCode': '432041'
}
headers = {
'X-Authorization': 'アクセストークン',
}
response = requests.get(url, headers=headers, params=payload)
print(response.text)
プログラム記述例（個別API）
ー