o311_query: Query an open311 endpoint

View source: R/query.R

o311_queryR Documentation

Query an open311 endpoint

Description

Low-level function to perform a generic request to the API currently attached by o311_api. Some open311 implementations support unique operations that are not included in the official documentation. This function can be used to access these URL paths.

Usage

o311_query(path, ..., simplify = TRUE)

Arguments

path

Path appendix used to access endpoint-specific operations.

...

Additional query parameters.

simplify

Whether to simplify the output using jsonlite::toJSON(..., simplify = TRUE).

Details

You can set options(r311_echo = TRUE) to display all requests sent using o311_query.

Value

The parsed query output, either as a list or dataframe.

Examples

o311_api("rostock")

# manually query discovery
o311_query(path = "discovery", simplify = FALSE)

# query a custom path defined by the Klarschiff API
o311_query(path = "areas")


r311 documentation built on April 15, 2025, 1:12 a.m.