wastd_GET | R Documentation |
Call the WAStD API serializer's list view with given GET
parameters, parse the response's features into a nested list.
This function requires the WAStD API to return the results in a key
features
(if GeoJSON) or data
(if JSON).
wastd_GET( serializer, query = list(), format = "json", max_records = NULL, chunk_size = 1000, parse = FALSE, api_url = get_wastdr_api_url(), api_token = get_wastdr_api_token(), api_un = get_wastdr_api_un(), api_pw = get_wastdr_api_pw(), verbose = wastdr::get_wastdr_verbose() )
serializer |
(character) WAStD API serializer name (required)
Possible values see |
query |
A list of GET parameters, default: list().
The |
format |
The desired API output format, default: "json". |
max_records |
The maximum number of records retrieved. If left at default (NULL), all records are returned. Default: NULL. |
chunk_size |
The number of records to retrieve in each paginated
response. A specified but smaller |
parse |
Whether to parse data (TRUE) or not (FALSE, default). |
api_url |
(character) The WAStD API URL,
default |
api_token |
(character) The WAStD API token,
default |
api_un |
(character) A WAStD API username,
default |
api_pw |
(character) A WAStD API password,
default |
verbose |
Whether to show debug messages. Default: wastdr::get_wastdr_verbose() |
stable
An S3 object of class 'wastd_api_response' containing:
data: The parsed response content
serializer: The called serializer, e.g. 'supra'
url: The called URL
date: The timestamp of the request
status_code: The HTTP status code of the request
Other api:
build_auth()
,
download_minimal_wastd_turtledata()
,
download_wastd_sites()
,
download_wastd_turtledata()
,
download_wastd_users()
,
export_wastd_turtledata()
,
filter_wastd_turtledata_area()
,
filter_wastd_turtledata_seasons()
,
filter_wastd_turtledata()
,
handle_http_status()
,
wastd_POST()
,
wastd_bulk_post()
,
wastd_chunk_post()
,
wastd_create_update_skip()
,
wastd_parse()
,
wastd_post_one()
## Not run: track_records <- wastd_GET("turtle-nest-encounters") tag_records <- wastd_GET("animal-encounters") hatched_nest_records <- wastd_GET("turtle-nest-encounters", query = list(nest_type = "hatched-nest") ) ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.