biosys_get: Return JSON from a BioSys API endpoint

In parksandwildlife/biosysR: BioSys API Wrapper

Description

Call the BioSys API serializer's list view with given GET parameters and return the response JSON as list of lists.

Usage

biosys_get(serializer, api = "https://biosys.dbca.wa.gov.au/api",
  un = Sys.getenv("BIOSYS_UN"), pw = Sys.getenv("BIOSYS_PW"),
  query = list())

Arguments

serializer	(character) WAStD API serializer name (required). Possible values as per https://biosys.dbca.wa.gov.au/api are: projects datasets records sites
api	(character) The BioSys API URL, default https://biosys.dbca.wa.gov.au/api/
un	(character) The BioSys username, default Sys.getenv("BIOSYS_UN")
pw	(character) The BioSys password, default Sys.getenv("BIOSYS_PW")
query	(list) API query parameters for format, limit, filtering (default: list(taxon='Cheloniidae', limit=10000, format='json'))

Value

An S3 object of class 'wastd_api_response' containing:

content: The retrieved JSON as list of lists

serializer: The called serializer, e.g. 'projects'

response: The API HTTP response with all metadata

parksandwildlife/biosysR documentation built on May 15, 2019, 5:50 p.m.