FoodSecurityApi.md

FoodSecurityApi

All URIs are relative to https://api.wfp.org/vam-data-bridges/1.3.1

Method	HTTP request	Description
FoodSecurityListGet	GET /FoodSecurity/List

FoodSecurityListGet

IpcValuePagedResult FoodSecurityListGet(iso3 = var.iso3, year = var.year, page = 1, env = var.env)

Data Controller - Wael Attia API Integration Pattern - This endpoint uses Hey Jude pattern

Example

library(DataBridgesAPIr)

# prepare function argument(s)
var_iso3 <- "iso3_example" # character | The country ISO3 code (Optional)
var_year <- 56 # integer |  (Optional)
var_page <- 1 # integer |  (Optional)
var_env <- "env_example" # character | Environment.   * `prod` - api.vam.wfp.org   * `dev` - dev.api.vam.wfp.org (Optional)

api_instance <- FoodSecurityApi$new()
# Configure OAuth2 access token for authorization: default
api_instance$api_client$access_token <- Sys.getenv("ACCESS_TOKEN")
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$FoodSecurityListGet(iso3 = var_iso3, year = var_year, page = var_page, env = var_envdata_file = "result.txt")
result <- api_instance$FoodSecurityListGet(iso3 = var_iso3, year = var_year, page = var_page, env = var_env)
dput(result)

Parameters

Name	Type	Description	Notes
iso3	character	The country ISO3 code	[optional]
year	integer		[optional]
page	integer		[optional] [default to 1]
env	Enum [prod, dev]	Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org	[optional]

Return type

IpcValuePagedResult

Authorization

default

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/json, text/plain

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-