Solorrow Logo
Documentation Powered by ReDoc

Solorrow API (1.0)

Download OpenAPI specification:Download

Solorrow GmbH: info@solorrow.com URL: https://www.solorrow.com/

Solorrow API - you can also explore it using SwaggerUI (developer-friendly) here

Authentication

APIKey

Security Scheme Type API Key
Header parameter name: apikey

Field map

Field map request

Request a new field map in an asynchronous process. Field maps are classified in 5 classes by default. Since the process is asynchronous, the response will contain the field_map_request_id and a location header with URL value which can be used to check the status of your request. You can use the field_map_request_id to check the status of your request, if you provide a notification_url in your request then we will send a notification to this url once the field map generation is finished with the following data.

Authorizations:
APIKey
Request Body schema: multipart/form-data
boundary
required
object

This requires a field boundary in GeoJSON format.

https://tools.ietf.org/html/rfc7946#section-3.3
notification_url
string

This is a URL where the Solorrow system will send a notification to once the processing of your request is finished.

field_map_type_id
required
integer
Value: 1

Type of field map (currently we only support field potential map which is type is 1).

numberOfClasses
integer <int32> [ 2 .. 10 ]

number of classes for the classification

Responses

202

The field map request is submitted successfully and is now in process

400

Invalid data provided

401

Unauthorized authentication token

422

The supplied boundary contains errors (gaps or overlapping lines)

post /field-maps-requests
https://api.solorrow.com/v1/field-maps-requests

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "field_map_request_id": "00000000-0000-0000-0000-000000000000"
}

Field map request status

Check the status of field map request

Authorizations:
APIKey
path Parameters
field_map_request_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

field map request ID to check it

Responses

202

The work is in-progress

303

location to get the field map.

400

Invalid data provided

401

Unauthorized authentication token

404

Field map request not found

get /field-maps-requests/{field_map_request_id}
https://api.solorrow.com/v1/field-maps-requests/{field_map_request_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "message": "string"
}

Field map

get the field map

Authorizations:
APIKey
path Parameters
field_map_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

field map ID to get

Responses

200

successful operation

400

Invalid data provided

401

Unauthorized authentication token

404

Field map not found

get /field-maps/{field_map_id}
https://api.solorrow.com/v1/field-maps/{field_map_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "features":
    [
    ],
  • "type": "FeatureCollection",
  • "histogram":
    {
    },
  • "pixel_size": 0,
  • "number_of_classes": 0,
  • "classes_step": 0,
  • "areas":
    {
    }
}

Classification

Classification request

Use this endpoint for re-classifying an field map. You can choose any number of classes within the range 2-10. Since the process is asynchronous, the response will contain the classification_request_id and a location header with URL value which can be used to check the status of your request. You can use the classification_request_id to check the status of your request, if you provide a notification_url in your request then we will send a notification to this url once the reclassification of the application map is finished with the following data.

Authorizations:
APIKey
path Parameters
field_map_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

field map ID to reclassify

Request Body schema: multipart/form-data
numberOfClasses
required
integer <int32> [ 2 .. 10 ]

number of classes for the reclassification

notification_url
string

This is a URL where the Solorrow system will send a notification to once processing the request is finished.

Responses

202

Reclassification is now in processing

400

Invalid data provided

401

Unauthorized authentication token

404

Field map Not Found

post /field-maps/{field_map_id}/classification-requests
https://api.solorrow.com/v1/field-maps/{field_map_id}/classification-requests

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "classification_request_id": "00000000-0000-0000-0000-000000000000"
}

Classification request status

Check the status of field map classification request

Authorizations:
APIKey
path Parameters
field_map_id
required
string
classification_request_id
required
string

Responses

202

The work is in-progress

303

location to get the field map classification.

400

Invalid data provided

401

Unauthorized authentication token

404

Field map or classification request not found

get /field-maps/{field_map_id}/classification-requests/{classification_request_id}
https://api.solorrow.com/v1/field-maps/{field_map_id}/classification-requests/{classification_request_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "message": "string"
}

Classification

get the field map classification

Authorizations:
APIKey
path Parameters
field_map_id
required
string
classification_id
required
string

Responses

200

successful operation

400

Invalid data provided

401

Unauthorized authentication token

404

Field map or classification not found

get /field-maps/{field_map_id}/classifications/{classification_id}
https://api.solorrow.com/v1/field-maps/{field_map_id}/classifications/{classification_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "features":
    [
    ],
  • "type": "FeatureCollection",
  • "histogram":
    {
    },
  • "pixel_size": 0,
  • "number_of_classes": 0,
  • "classes_step": 0,
  • "areas":
    {
    }
}

Taskdata

Taskdata request

This endpoint can be used to get an field map in formats for the use in machines and for printing. The file is a ZIP file which contains a PDF report, Taskdata XML (ISOBUS) and a Shape file. Example: here. Since the process is asynchronous, the response will contain a location URL which you can use to check the status of the request. After finishing generating the TaskData file, we will send it to the notification_url that provided in your request with a zip file.

Authorizations:
APIKey
path Parameters
field_map_id
required
string <uuid>
Example: 00000000-0000-0000-0000-000000000000

field map ID to get its task data

Request Body schema: multipart/form-data
customer_id
required
integer <int32>
customer_name
required
string
crop_name
required
string
machine_name
required
string
Enum: "spreader" "sprayer" "driller" "rowseeder"
field_id
required
integer
field_name
required
string
unit
required
string
Enum: "kg/ha" "l/ha" "dt/ha" "seeds/ha"
does_rates
required
ZonesDoesRates (object) or CalculateDoesRates (object)
language
string
Default: "eng"
Enum: "eng" "fr" "de" "ro"

Language to use when generating the report file.

notification_url
string

This is a URL where the Solorrow system will send a request to which contains the ZIP file once the processing of the request is finished.

Responses

202

Generating task data file is now in process

400

Invalid data provided

401

Unauthorized authentication token

404

Field map not found

post /field-maps/{field_map_id}/taskdata-requests
https://api.solorrow.com/v1/field-maps/{field_map_id}/taskdata-requests

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "taskdata_request_id": "00000000-0000-0000-0000-000000000000"
}

Taskdata request status

Check the status of taskdata request

Authorizations:
APIKey
path Parameters
field_map_id
required
string
taskdata_request_id
required
string

Responses

202

The work is in-progress

303

location to get the Taskdata files.

400

Invalid data provided

401

Unauthorized authentication token

404

Field map or taskdata request not found

get /field-maps/{field_map_id}/taskdata-requests/{taskdata_request_id}
https://api.solorrow.com/v1/field-maps/{field_map_id}/taskdata-requests/{taskdata_request_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "message": "string"
}

Taskdata

get the task data zip file

Authorizations:
APIKey
path Parameters
field-map-id
required
string
taskdata-id
required
string

Responses

200

successful operation

400

Invalid data provided

401

Unauthorized authentication token

404

Field map or taskdata not found

get /field-maps/{field-map-id}/taskdata/{taskdata-id}
https://api.solorrow.com/v1/field-maps/{field-map-id}/taskdata/{taskdata-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "message": "string"
}