get_fields: Get Fields

In aWhereAPI/aWhere-R-Library: API calls for aWhere API

Description

get_fields calls Get Field Locations Endpoint of API

Usage

get_fields(
  field_id = "",
  offset = "",
  limit = 10,
  requestAllFields = TRUE,
  keyToUse = awhereEnv75247$uid,
  secretToUse = awhereEnv75247$secret,
  tokenToUse = awhereEnv75247$token,
  apiAddressToUse = awhereEnv75247$apiAddress
)

Arguments

field_id	Either a field id to retrieve information for that specific field or an empty string to retrieve information on all fields associated with the user's aWhere API account (string - optional)
offset	The number of objects to skip before returning objects. Used in conjunction with offset to paginate. (optional)
limit	The number of results to include on each of page of listed fields. Used in conjunction with offset to paginate. (optional)
requestAllFields	Causes function to execute logic to return all of a users fields using the minimum number of API calls based on the limit parameter. If used, offset must be set to default value (optional)
keyToUse	aWhere API key to use. For advanced use only. Most users will not need to use this parameter (optional)
secretToUse	aWhere API secret to use. For advanced use only. Most users will not need to use this parameter (optional)
tokenToUse	aWhere API token to use. For advanced use only. Most users will not need to use this parameter (optional)
apiAddressToUse	Address of aWhere API to use. For advanced use only. Most users will not need to use this parameter (optional)

Details

Fields are how you manage the locations for which you're tracking weather, agronomics, models, and progress over growing seasons in the aWhere API. By registering a field, you create a quick way to consistently reference locations across all of our APIs, and allow our modeling APIs to better operate and tune to the conditions and status of each specific field.

Before using aWhere's APIs you'll need to register the field locations. This is a one-time step. Every field has an ID that you define, plus a latitude and longitude. Fields are universal across all of our APIs, and as you provide information about a field, some APIs (such as agronomics and models) can leverage that detail internally to more easily and seamlessly calculate information for you.

Value

- data.frame containing information about requested field(s)

References

https://docs.awhere.com/knowledge-base-docs/get-field-locations/

Examples

## Not run: get_fields('field_test')
         get_fields()

## End(Not run)

aWhereAPI/aWhere-R-Library documentation built on Nov. 5, 2021, 3:35 a.m.