delete_field: Delete Field

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

Description

delete_field deletes a field_id for a location in the aWhere platform for which you can request weather

Usage

delete_field(
  field_id,
  verbose = TRUE,
  keyToUse = awhereEnv75247$uid,
  secretToUse = awhereEnv75247$secret,
  tokenToUse = awhereEnv75247$token,
  apiAddressToUse = awhereEnv75247$apiAddress
)

Arguments

field_id	an ID of your choosing (string)
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

This script deletes a field location in the aWhere platform. This API is a "hard delete" - the field record should actually be deleted from the system. The delete should cascade, if there are associated records to a field, they are deleted as well. This applies when we design/implement "Plantings" API.

Value

- a print text that informs if the query succeded or not

References

https://docs.awhere.com/knowledge-base-docs/delete-a-field/

Examples

## Not run: delete_field("field123")

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