quincunx (version 0.1.9)

request: Request a resource from the PGS REST API

Description

Performs a GET request on the endpoint as specified by resource_url.

Usage

request(
  resource_url,
  base_url = pgs_server(),
  user_agent = user_agent_id(),
  verbose = FALSE,
  warnings = TRUE
)

Value

A named list of four elements:

resource

The URL endpoint.

code

HTTP status code.

message

A string describing the status of the response obtained: 'OK' if successful or a description of the error.

json

JSON response as string.

Arguments

resource_url

Endpoint URL. The endpoint is internally appended to the base_url. It should start with a forward slash ('/').

base_url

The PGS REST API base URL.

user_agent

User agent.

verbose

Whether to be verbose.

warnings

Whether to print warnings.