Is open311 API ok? — o311

Checks whether an open311 API mounted by o311_api is reachable and returns a valid requests response.

Usage

o311_ok(error = FALSE)

Arguments

error

[logical]

Whether to return a logical or the error message describing why the API is not ok.

Value

A logical describing whether the API is reachable or not. If error = TRUE, returns the corresponding error object if one occurs.

Examples

# \donttest{
# check if Bonn API is reachable
o311_api("Bonn")
o311_ok()
#> [1] TRUE

# check if Helsinki API is reachable - fails
o311_add_endpoint(
  name = "Helsinki",
  root = "asiointi.hel.fi/palautews/rest/v1/"
)

o311_api("Helsinki")
o311_ok()
#> [1] FALSE

# return error message
try(o311_ok(error = TRUE))
#> Error in curl::curl_fetch_memory(req) : 
#>   Couldn't resolve host name [asiointi.hel.fi]: Could not resolve host: asiointi.hel.fi

# reset endpoints database
o311_reset_endpoints()
# }