espa_ordering_get_api: espa_ordering_get_api

In espa.tools: Wrappers for the USGS ESPA APIs and Earth Explorer

Description

R wrapper for USGS/EROS Ordering System GET API.

Usage

espa_ordering_get_api(request_code, json_request_content = NULL,
  usgs_eros_username, usgs_eros_password, verbose = F)

Arguments

request_code	Character. One of the requests listed at https://earthexplorer.usgs.gov/inventory/documentation/json-api
json_request_content	List. Parameters to pass to the request system.
usgs_eros_username	Character. Your USGS registration username. You can register for an account at https://espa.cr.usgs.gov
usgs_eros_password	Character. Your USGS registration password. WARNING: USING THIS WITH R IS NOT PARTICULARLY SECURE.
verbose	Logical. Verbose execution? Default=F.

Details

A function to convert requests to the USGS/EROS Ordering System URL format (GET). In general, you shouldn't need to call this directly unless you want finer command-line control over requests.

Value

List generated from the request.

Author(s)

Jonathan A. Greenberg ([e-mail]) (wrapper) and USGS ESPA Developers (API and documentation)

See Also

espa_ordering_post_api

Examples

## Not run:  
# Run the API version command:
espa_ordering_get_api(request_code="api",json_request_content=NULL,
		usgs_eros_username="myusername",usgs_eros_password="mypassword")

## End(Not run)

espa.tools documentation built on May 2, 2019, 5:54 p.m.