VisibleFarm

Data processing

Visiblefarm system can carry out geographical and statistical calculations, summaries and processes on the data arriving in the system. In the point below the API calls to realize these are described.

Finding intersected partfields by the path

It returns a specific measurement path, or the list of partfields touched by a path data set, or it carries out an inspection for a specific partfield.

GET /fieldsbypath?filter[JWToken]=’ba1af54ec3f014f765e8172f9a86dc2a’&filter[MeasurePath] =34252790 HTTP/1.1
Accept: application/vnd.api+json

A measurement (Measure) or a path (MeasurePath) can be specified at call, and as an option, one or more partfields can be specified, which act as filters.

You can send a GET call or a POST call, in which more than one query data can be specified.

POST /fieldsbypath HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"data":[{
"type": " fieldsbypath ",
"attributes": {
"MeasurePath": "34252790"
},
},{
"type": " fieldsbypath ",
"attributes": {
"Measure": "135372"
}
}]
}

Response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"link":[{
"self": "http://api.visiblefarm.net/fieldsbypath"
},
"data":[{
"type": "partfield",
"id": "130",
"attributes": {
"MeasurePath": "34252790",
"PartFieldName": "WETZL-1-16",
"Length": "12453.2",
}
},{
"type": "partfield",
"id": "131",
"attributes": {
"MeasurePath": "34252790",
"PartFieldName": "WETZL-1-17",
"Length": "345.3",
}
},{
"type": "partfield",
"id": "141",
"attributes": {
"MeasurePath": "135372",
"PartFieldName": "WETZL-2-1",
"Length": "145.3",
}
},{
"type": "partfield",
"id": "142",
"attributes": {
"MeasurePath": "135372",
"PartFieldName": "WETZL-2-2",
"Length": "235.2",
}
}]
}

The possible error codes

400, Bad request, Invalid function name!
400, Bad request, Related path does not exist.!
403, Forbidden, the user is not authorized for this function!
403, Forbidden, the given JSON Web Token (JWT) is invalid!
500, Internal server error, An error has been occurred (error text)

Splitting the path to partfields

It creates multiple partial paths, based on a specific measurement path or path data set, which specifies the jobs carried out on the given partfields and the paths of in-between runs.

GET /splitpathbyfield?filter[JWToken]=’ba1af54ec3f014f765e8172f9a86dc2a’ &filter[MeasurePath]=34252790 HTTP/1.1

Accept: application/vnd.api+json

A measurement (Measure) or a path (MeasurePath) can be specified at call, and as an option, one or more partfields can be specified, which will be broken down. If this latter is not specified, all of the partfields involved in the path will be used.

New measurements and linked path records will be created upon executing, and all of these will be calculated type. If a calculated data to be created by a new record had already existed in the system, the results of the previous calculation will be deleted, and only the new results will be saved in the database.

Response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"link":[{
"self": "http://api.visiblefarm.net/splitpathbyfield"
},
"data":[{
"type": "measurepath",
"id": "34252792",
"attributes": {
"Count": "210"
},
"relationships": {
"measure": {
"data": { "id": "128", "type": "measure" }
}
}
},{
"type": "measurepath",
"id": "34252793",
"attributes": {
"Count": "4350",
},
"relationships": {
"measure": {
"data": { "id": "129", "type": "measure" }
}
}
},{
}
},{
"type": "measurepath",
"id": "34252794",
"attributes": {
"Count": "132"
},
"relationships": {
"measure": {
"data": { "id": "130", "type": "measure" }
}
}
},{
}
},{
"type": "measurepath",
"id": "34252795",
"attributes": {
"Count": "266"
},
"relationships": {
"measure": {
"data": { "id": "131", "type": "measure" }
}
}
}]
}

Interpreting the response:

Upon execution, 4 new measurements, and the linked data set was created:

Run: measurement is not linked to the partfield, StartTime and StopTime is calculated from the original path. The Device, DeviceEquipment and Task fields remain unchanged. The linked path data set contains 210 points.

Job carried out on the partfield. If queried the Measure, you can see (in present example) that the calculation was applied to Partfield 130. StartTime and StopTime are the times of entry and exit. The Device, DeviceEquipment and Task fields remain unchanged. The linked path data set contains 4350 points and is continuous between the entry and exit points. The bends and short pauses and return outside the partfield are part of the path.

Job carried out on the partfield. If queried the Measure, you can see (in present example) that the calculation was applied to Partfield 131. StartTime and StopTime are the times of entry and exit. The Device, DeviceEquipment and Task fields remain unchanged. The linked path data set contains 132 points and is continuous between the entry and exit points. The bends and short pauses and return outside the partfield are part of the path.

Run: measurement is not linked to the partfield, StartTime and StopTime is calculated from the original path. The Device, DeviceEquipment and Task fields remain unchanged. The linked path data set contains 266 points.

The possible error codes

400, Bad request, Invalid function name!
400, Bad request, Related path does not exist.!
403, Forbidden, the user is not authorized for this function!
403, Forbidden, the given JSON Web Token (JWT) is invalid!
500, Internal server error, An error has been occurred (error text)

Calculating the sum distance covered

It returns the length of the path covered, or the path covered by the path data set, in meters. The calculation can be carried out filtered on a certain partfield. In this case the sum distance between the entry and exit points is calculated (the bends and short pauses and returns outside the partfield are part of the path).

GET /lengthsbypath?filter[JWToken]=’ba1af54ec3f014f765e8172f9a86dc2a’&filter[MeasurePath]= 34252790 HTTP/1.1
Accept: application/vnd.api+json

A measurement (Measure) or a path (MeasurePath) can be specified at call, and as an option, one partfield can be specified, which act as filters.

You can send a single GET call or a POST call which more than one query data can be specified.

POST /lengthbypath HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"data":[{
"type": " lengthbypath ",
"attributes": {
"MeasurePath": "34252790"
},
},{
"type": " lengthbypath ",
"attributes": {
"Measure": "135372"
}
}]
}

Response

The possible error codes

400, Bad request, Invalid function name!
400, Bad request, Related path does not exist.!
403, Forbidden, the user is not authorized for this function!
403, Forbidden, the given JSON Web Token (JWT) is invalid!
500, Internal server error, An error has been occurred (error text)

Calculating sum gross area

It returns the size of the gross sum area of the path covered, or the path covered by the path data set, in square meters. The system takes the working width from the device data or from active working width data (dynamic). If neither is available, the system will use the WorkingWidth (value in meters) specified at call. If that is not available either, the call will return an error message.

During the calculations, the bends and short pauses and returns outside the partfield, and overlaps are calculated as well.

The calculation can be carried out filtered on a certain partfield. In this case the sum gross area between the entry and exit points is calculated.

GET /areabypath?filter[JWToken]=’ba1af54ec3f014f765e8172f9a86dc2a’&filter[MeasurePath]= 34252790 HTTP/1.1
Accept: application/vnd.api+json

A measurement (Measure) or a path (MeasurePath) can be specified at call, and as an option, one partfield can be specified, which act as filters. A further WorkingWidth value can be set among the filter values; it will be used by the system to calculate the working width, if there is no other data.

You can send a single GET call or a POST call which more than one query data can be specified.

POST /areabypath HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"data":[{
"type": " areabypath ",
"attributes": {
"MeasurePath": "34252790"
},
},{
"type": " areabypath ",
"attributes": {
"Measure": "135372"
}
}]
}

Response

The possible error codes

400, Bad request, Invalid function name!
400, Bad request, Related path does not exist.!
400, Bad request, working width is unkown!
403, Forbidden, the user is not authorized for this function!
403, Forbidden, the given JSON Web Token (JWT) is invalid!
500, Internal server error, An error has been occurred (error text)

Calculating the sum net area

It returns the size of the net sum area of the path covered, or the path covered by the path data set, in square meters. The system takes the working width from the device data or from active working width data (dynamic). If neither is available, the system will use the WorkingWidth (value in meters) specified at call. If that is not available either, the call will return an error message.

In the calculations the overlaps are not taken into the calculation. The calculation can be carried out filtered on a certain partfield. In this case the sum net area between the entry and exit points is calculated; the bends and short pauses and returns outside the partfield, and overlaps are not included in the calculations.

GET /netareabypath?filter[JWToken]=’ba1af54ec3f014f765e8172f9a86dc2a’&filter[MeasurePath]= 34252790 HTTP/1.1
Accept: application/vnd.api+json

A measurement (Measure) or a path (MeasurePath) can be specified at call, and as an option, one partfield can be specified, which act as filters. A further WorkingWidth value can be set among the filter values; it will be used by the system to calculate the working width, if there is no other data.

POST /netareabypath HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"data":[{
"type": " netareabypath ",
"attributes": {
"MeasurePath": "34252790"
},
},{
"type": " netareabypath ",
"attributes": {
"Measure": "135372"
}
}]
}

Response

The possible error codes

400, Bad request, Invalid function name!
400, Bad request, Related path does not exist.!
400, Bad request, working width is unkown!
403, Forbidden, the user is not authorized for this function!
403, Forbidden, the given JSON Web Token (JWT) is invalid!
500, Internal server error, An error has been occurred (error text)

Generating cell information

The system can, based on data of a specific measurement or path data set, generate a grid data set (raster) which can be used as a map layer, or can be base data for various template searches.

The size of the area of the raster generated is calculated automatically based on the data sets associated; its default resolution is 1 m, which can be modified on the admin interface.

GET /gridbymeasure?filter[JWToken]=’ba1af54ec3f014f765e8172f9a86dc2a’&filter[MeasurePath]= 34252790 HTTP/1.1
Accept: application/vnd.api+json

For the function call a measure-property pair are required, or one or more measure value-path and optional a field which acts as a filter.

Response

The possible error codes

400, Bad request, Invalid function name!
400, Bad request, Related path does not exist.!
400, Bad request, Related measure does not exist!
400, Bad request, Related property does not exist!
403, Forbidden, the user is not authorized for this function!
403, Forbidden, the given JSON Web Token (JWT) is invalid!
500, Internal server error, An error has been occurred (error text)

Importing IsoXML data packet

The function is still in Review status!

The system is capable to import taskdata data packet defined in ISO11783:10 international standard. Defined master data, task descriptions and measurement lines are processed and imported in the data packet. When loading the data, the system merges the new and existing data based on individual data, and refreshes only the data fields containing new values, but does not delete any other fields or master data records.

POST /importisoxml HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"data":[{
"type": " isoxml ",
"zip": "[isoxml package content in zipped bytestring format]"
}]
}

Response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"link":[{
"self": "http://api.visiblefarm.net/importxml"
},
"data":[{
"type": " task ",
"id": "301",
"attributes": {
"TaskName": "TASK_22082017",
"TaskStatus": "Closed",
},
},{
"type": " task ",
"id": "302",
"attributes": {
"TaskName": "TASK_22082017",
"TaskStatus": "Paused",
},
}]
}

The possible error codes

400, Bad request, Invalid function name!
400, Bad request, Invalid IsoXML format!
403, Forbidden, the user is not authorized for this function!
403, Forbidden, the given JSON Web Token (JWT) is invalid!
500, Internal server error, An error has been occurred (error text)

Exporting IsoXML data packet

The function is still in Review status!

The system is capable to export data linked to one or more tasks as taskdata data packet format defined in ISO11783:10 international standard. The exported format does not contain external files, only taskdata.xml contents. The description of partfields and cultural zones will be part of the description in polygon format.

GET /exportisoxml?filter[JWToken]=’ba1af54ec3f014f765e8172f9a86dc2a’&filter[Task]=12,13 HTTP/1.1
Accept: application/vnd.api+json

For the function call one or more task idnetifier are required. Only the related master data and measure data records will be exported into the result xml package.

Response

The possible error codes

400, Bad request, Invalid function name!
400, Bad request, Related task does not exist!
403, Forbidden, the user is not authorized for this function!
403, Forbidden, the given JSON Web Token (JWT) is invalid!
500, Internal server error, An error has been occurred (error text)

Data processing

Finding intersected partfields by the path

It returns a specific measurement path, or the list of partfields touched by a path data set, or it carries out an inspection for a specific partfield.

A measurement (Measure) or a path (MeasurePath) can be specified at call, and as an option, one or more partfields can be specified, which act as filters. You can send a GET call or a POST call, in which more than one query data can be specified.

Response

The possible error codes

Splitting the path to partfields

It creates multiple partial paths, based on a specific measurement path or path data set, which specifies the jobs carried out on the given partfields and the paths of in-between runs.

Response

Interpreting the response:

The possible error codes

400, Bad request, Invalid function name! 400, Bad request, Related path does not exist.! 403, Forbidden, the user is not authorized for this function! 403, Forbidden, the given JSON Web Token (JWT) is invalid! 500, Internal server error, An error has been occurred (error text)

Calculating the sum distance covered

A measurement (Measure) or a path (MeasurePath) can be specified at call, and as an option, one partfield can be specified, which act as filters. You can send a single GET call or a POST call which more than one query data can be specified.

Response

The possible error codes

400, Bad request, Invalid function name! 400, Bad request, Related path does not exist.! 403, Forbidden, the user is not authorized for this function! 403, Forbidden, the given JSON Web Token (JWT) is invalid! 500, Internal server error, An error has been occurred (error text)

Calculating sum gross area

Response

The possible error codes

Calculating the sum net area

A measurement (Measure) or a path (MeasurePath) can be specified at call, and as an option, one partfield can be specified, which act as filters. A further WorkingWidth value can be set among the filter values; it will be used by the system to calculate the working width, if there is no other data.

Response

The possible error codes

Generating cell information

For the function call a measure-property pair are required, or one or more measure value-path and optional a field which acts as a filter.

Response

The possible error codes

Importing IsoXML data packet

Response

The possible error codes

400, Bad request, Invalid function name! 400, Bad request, Invalid IsoXML format! 403, Forbidden, the user is not authorized for this function! 403, Forbidden, the given JSON Web Token (JWT) is invalid! 500, Internal server error, An error has been occurred (error text)

Exporting IsoXML data packet

For the function call one or more task idnetifier are required. Only the related master data and measure data records will be exported into the result xml package.

Response

The possible error codes

400, Bad request, Invalid function name! 400, Bad request, Related task does not exist! 403, Forbidden, the user is not authorized for this function! 403, Forbidden, the given JSON Web Token (JWT) is invalid! 500, Internal server error, An error has been occurred (error text)

A measurement (Measure) or a path (MeasurePath) can be specified at call, and as an option, one or more partfields can be specified, which act as filters.

You can send a GET call or a POST call, in which more than one query data can be specified.

400, Bad request, Invalid function name!
400, Bad request, Related path does not exist.!
403, Forbidden, the user is not authorized for this function!
403, Forbidden, the given JSON Web Token (JWT) is invalid!
500, Internal server error, An error has been occurred (error text)

A measurement (Measure) or a path (MeasurePath) can be specified at call, and as an option, one partfield can be specified, which act as filters.

You can send a single GET call or a POST call which more than one query data can be specified.

400, Bad request, Invalid function name!
400, Bad request, Related path does not exist.!
403, Forbidden, the user is not authorized for this function!
403, Forbidden, the given JSON Web Token (JWT) is invalid!
500, Internal server error, An error has been occurred (error text)

400, Bad request, Invalid function name!
400, Bad request, Invalid IsoXML format!
403, Forbidden, the user is not authorized for this function!
403, Forbidden, the given JSON Web Token (JWT) is invalid!
500, Internal server error, An error has been occurred (error text)

400, Bad request, Invalid function name!
400, Bad request, Related task does not exist!
403, Forbidden, the user is not authorized for this function!
403, Forbidden, the given JSON Web Token (JWT) is invalid!
500, Internal server error, An error has been occurred (error text)