vipunen_api: vipunen_api

Description Usage Arguments Details Value Examples

View source: R/vipunen-api.R

Description

Make a request to one of the Vipunen API's endopoints. The base url is http://api.vipunen.fi to which a specific url defined by path is appended.

Usage

1

Arguments

path

character url to be appended to the host.

Details

This is a low-level function intended to be used by other higher level functions in the package.

Value

vipunen_api (S3) object with the following attributes:

content

a list of parsed JSON content.

path

path provided to get the resonse.

response

the original response object.

Examples

1
2
# Get available resources
vipunen_api("api/resources")

rOpenGov/vipunen documentation built on Oct. 14, 2021, 1:32 p.m.