Register Field Metadata
For a better understanding of how you can implement the API into your software see Get Started
Description
This route is used to register metadata for your fields.
Endpoints
- /fields/metadata/register
Method type
POST
(Json only)
Parameters
name | description | type | Required | Default Value |
---|---|---|---|---|
token | Your identification token | string | required | |
field_name | Name of the field | string | required | |
start_date | Starting date for the metadata. Format:YYYY-MM-DD | string | required | |
harvest_date | Date of harvest | Geojson | optional | |
crop_type | crop type on the given dates | string | optional | |
is_cover_crop | is the crop covered | boolean | optional | |
yield_amount | Yield amount | int | optional | |
yield_unit | Unit used for the Yield amount | string | optional | |
is_tilled | Is the crop tilled ? | boolean | optional | |
tilling_type | Type of tilling for this field | string | optional |
Responses
status code | description |
---|---|
201 | The metadata has been registered successfully |
403 | Forbidden request |
Example Request
POST https://spacesense-api.ew.r.appspot.com/fields/metadata/register?token=__myToken__
Body of the request : (Json
)
{
"field_name" : "Enchi's_field",
"crop_type" : "bamboos",
"is_cover_crop" : true,
"start_date" : "2020-01-01",
"harvest_date" : "2020-01-01",
"yield_amount" : 23,
"yield_unit" : "kg",
"is_tilled" : true,
"tilling_type" : ""
}
Example Response
{
"message": "Field field-sample-3 metadata registered"
}