first draft haulmkilling API documentation

This commit is contained in:
2020-05-11 09:44:46 +02:00
parent c46574580b
commit 85641e652d
3 changed files with 236 additions and 3 deletions

View File

@@ -21,10 +21,11 @@ For the currently available public FarmMaps API you can take a look at swagger:
* Optional steps
* *Create cropfield through FarmMaps API*
* Item 'vnd.farmmaps.itemtype.cropfield' must be created with its data as specified in the api.
* Task 'vnd.farmmaps.task.workflow' needs to be executed to aggregate all needed data.
* Task 'vnd.farmmaps.task.workflow' can be executed if needed executed to aggregate all needed data.
* This is an asynchronous process and can take a while before all data is collected in FarmMaps.
* *Upload own data*
* IF shape data, convert to geotiff.
* Querying predefined herbicide agents (for input constants if none available beforehand)
* Task 'vnd.farmmaps.task.vraherbicide' must be executed to create an application map.
* Task 'vnd.farmmaps.task.taskmap' can be executed to create a taskmap.
* Download item data (tiff of shape)
@@ -94,7 +95,7 @@ GET /api/v1/items/?it=vnd.farmmaps.package.vra.herbicide
}
```
Response 400 Tasktype not found
Response 400 Itemtype not found
Response 401 Not authenticated
Response 403 No READ permissions in item
Response 404 Items not found
@@ -169,4 +170,4 @@ Response 404 Item not found
In case the data is available it can be downloaded with the File API.
> Request
```javascript
GET /api/v1/items/{itemcode}/data
GET /api/v1/items/{itemcode}/data