VisibleFarm

Data query

Various values, path or area data can be queried, based on the data arriving in the system and on data generated by processing. In the point below the API calls to realize these are described.

Query of sum data based on task

Query a summary type data, linked to a given task.

GET /sumbytask?filter[JWToken]=’ba1af54ec3f014f765e8172f9a86dc2a’&filter[Task]=102& filter[Property]=247 HTTP/1.1
Accept: application/vnd.api+json

When initiating the call, a Task and a Property must be provided; and optionally, by entering a partfield, you can filter the data calculated from measurements of a certain partfield.

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

POST /sumbytask HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"data":[{
"type": " sumbytask ",
"attributes": {
"Task": "102",
"Property": "247"
},
},{
"type": " sumbytask ",
"attributes": {
"Task": "103",
"Property": "248"
}
}]
}

Response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"link":[{
"self": "http://api.visiblefarm.net/sumbytask"
},
"data":[{
"type": " property ",
"id": "247",
"attributes": {
"Task": "102",
"Sum": "23425"
"Min": "145"
"Max": "267"
},
},{
"type": " property ",
"id": "248",
"attributes": {
"Task": "103",
"Sum": "155"
"Min": "100"
"Max": "155"
}
}]
}

The possible error codes

400, Bad request, Invalid function name!
400, Bad request, Related task 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)

Query of sum data based on measurement

Query a summary type data, linked to a given measurement or measurement path.

GET /sumbymeasure?filter[JWToken]=’ba1af54ec3f014f765e8172f9a86dc2a’&filter[Measure]=14555&filter[Property]=247,248 HTTP/1.1
Accept: application/vnd.api+json

When initiating the call, a Measure and a Property filter, or a certain path set (MeasurePath) and a Property must be provided.

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

POST /sumbymeasure HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"data":[{
"type": " sumbymeasure ",
"attributes": {
"Measure": "14555",
"Property": "247"
},
},{
"type": " sumbymeasure ",
"attributes": {
"Measure": "14555",
"Property": "248"
}
}]
}

Response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"link":[{
"self": "http://api.visiblefarm.net/sumbymeasure"
},
"data":[{
"type": " property ",
"id": "247",
"attributes": {
"Measure": "14555"
"Sum": "13546.0"
"Min": "1345.0"
"Max": "2345.0"
},
},{
"type": " property ",
"id": "248",
"attributes": {
"Measure": "14555"
"Sum": "155"
"Min": "144"
"Max": "155"
}
}]
}

The possible error codes

400, Bad request, Invalid function name!
400, Bad request, Related measure does not exist!
400, Bad request, Related path 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)

Path data query

Converting path information linked to a given task or measurement or measurement path into GEOJson format (MultiLineString, see: http://geojson.org/), and querying it. In case of path data and 2D format, the value of Longitude and Latitude is set in WGS-84 coordinate system, while the value of Altitude complements these in case of 3D format and is set in meters above WGS-84 ellipsoid. In case of 4D format, the value of a path point of a data type will be returned, and it will be returned using its own unit of measure defined by the property (see SAE J1939 SPN definitions).

Possible calls:

GET /2Dpathbytask?filter[JWToken]=’ba1af54ec3f014f765e8172f9a86dc2a’&filter[Task]=102 HTTP/1.1
Accept: application/vnd.api+json

When initiating the call, a Task must be provided; and optionally, by entering a partfield, you can filter the data calculated from measurements of paths bordered by a certain partfield. The return value is a 2D multistring.

GET /3Dpathbytask?filter[JWToken]=’ba1af54ec3f014f765e8172f9a86dc2a’&filter[Task]=102 HTTP/1.1
Accept: application/vnd.api+json

When initiating the call, a Task and a Property must be provided; and optionally, by entering a partfield, you can filter the data calculated from measurements of a certain partfield. The return value is a 3D multistring where the 3rd dimension is the altitude.

GET /4Dpathbytask?filter[JWToken]=’ba1af54ec3f014f765e8172f9a86dc2a’&filter[Task]=102& filter[Property]=247 HTTP/1.1
Accept: application/vnd.api+json

When initiating the call, a Task and a Property must be provided; and optionally, by entering a partfield, you can filter the data calculated from measurements of a certain partfield. The return value is a 4D multistring.

GET /2Dpathbymeasure?filter[JWToken]=’ba1af54ec3f014f765e8172f9a86dc2a’&filter[Measure]= 10236442 HTTP/1.1
Accept: application/vnd.api+json

When initiating the call, a Measure or a path (MeasurePath) must be provided. The return value is a 2D multistring.

GET /3Dpathbymeasure?filter[JWToken]=’ba1af54ec3f014f765e8172f9a86dc2a’&filter[Measure]= 10236442 HTTP/1.1
Accept: application/vnd.api+json

When initiating the call, a Measure or a path (MeasurePath) must be provided. The return value is a 3D multistring where the 3rd dimension is the altitude.

GET /3Dpathbymeasure?filter[JWToken]=’ba1af54ec3f014f765e8172f9a86dc2a’&filter[Measure]= 10236442&filter[time][notnull] HTTP/1.1
Accept: application/vnd.api+json

If a notnull time filter is added to the call, the 3rd dimension is the time of the day millisec counter instead of the altitude.

It is also possible to call the function with a property attribute

GET /3Dpathbymeasure?filter[JWToken]=’ba1af54ec3f014f765e8172f9a86dc2a’&filter[Measure]= 10236442&filter[Property]= 247 HTTP/1.1
Accept: application/vnd.api+json

When initiating the call, a Measure or a path (MeasurePath) and exactly one property must be provided. The return value is a 3D multistring where the 3rd dimension is the property value on the given position.

GET /4Dpathbymeasure?filter[JWToken]=’ba1af54ec3f014f765e8172f9a86dc2a’&filter[Measure]= 10236442&filter[Property]=247 HTTP/1.1
Accept: application/vnd.api+json

When initiating the call, a Measure and a Property or a path data (MeasurePath) and a Property must be provided. The return value is a 4D multistring where the 3rd property is the altitude.

GET /4Dpathbymeasure?filter[JWToken]=’ba1af54ec3f014f765e8172f9a86dc2a’&filter[Measure]= 10236442&filter[time][notnull]&filter[Property]=247 HTTP/1.1
Accept: application/vnd.api+json

If a notnull time filter is added to the call, the 3rd dimension is the time of the day millisec counter instead of the altitude and 4th dimension is the property value on the given position.

Response

The possible error codes

400, Bad request, Invalid function name!
400, Bad request, Related task 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)

Query cell data

The function is still in Review status!

Query a certain measurement raster (MeasureCell) in PostGIS 3D raster format.

The Longitude and Latitude values of the coordinates are in a WGS-84 coordinate system, and the third dimension is returned in its own unit of measure defined by the property of the specified cells (see SAE J1939 SPN definitions).

A Possible calls:

GET /3Drasterbymeasure?filter[JWToken]=’ba1af54ec3f014f765e8172f9a86dc2a’&filter[MeasureCell]=2324 HTTP/1.1
Accept: application/vnd.api+json

When initiating the call, a MeasureCell must be provided.

Response

The possible error codes

400, Bad request, Invalid function name!
400, Bad request, Related cell-data 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 query

Query of sum data based on task

Query a summary type data, linked to a given task.

When initiating the call, a Task and a Property must be provided; and optionally, by entering a partfield, you can filter the data calculated from measurements of a certain partfield. 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

Query of sum data based on measurement

Query a summary type data, linked to a given measurement or measurement path.

When initiating the call, a Measure and a Property filter, or a certain path set (MeasurePath) and a Property must be provided. 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

Path data query

When initiating the call, a Task must be provided; and optionally, by entering a partfield, you can filter the data calculated from measurements of paths bordered by a certain partfield. The return value is a 2D multistring.

When initiating the call, a Task and a Property must be provided; and optionally, by entering a partfield, you can filter the data calculated from measurements of a certain partfield. The return value is a 3D multistring where the 3rd dimension is the altitude.

When initiating the call, a Task and a Property must be provided; and optionally, by entering a partfield, you can filter the data calculated from measurements of a certain partfield. The return value is a 4D multistring.

When initiating the call, a Measure or a path (MeasurePath) must be provided. The return value is a 2D multistring.

When initiating the call, a Measure or a path (MeasurePath) must be provided. The return value is a 3D multistring where the 3rd dimension is the altitude.

If a notnull time filter is added to the call, the 3rd dimension is the time of the day millisec counter instead of the altitude. It is also possible to call the function with a property attribute

When initiating the call, a Measure or a path (MeasurePath) and exactly one property must be provided. The return value is a 3D multistring where the 3rd dimension is the property value on the given position.

When initiating the call, a Measure and a Property or a path data (MeasurePath) and a Property must be provided. The return value is a 4D multistring where the 3rd property is the altitude.

If a notnull time filter is added to the call, the 3rd dimension is the time of the day millisec counter instead of the altitude and 4th dimension is the property value on the given position.

Response

The possible error codes

Query cell data

When initiating the call, a MeasureCell must be provided.

Response

The possible error codes

400, Bad request, Invalid function name! 400, Bad request, Related cell-data 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)

When initiating the call, a Task and a Property must be provided; and optionally, by entering a partfield, you can filter the data calculated from measurements of a certain partfield.

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

When initiating the call, a Measure and a Property filter, or a certain path set (MeasurePath) and a Property must be provided.

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

If a notnull time filter is added to the call, the 3rd dimension is the time of the day millisec counter instead of the altitude.

It is also possible to call the function with a property attribute

400, Bad request, Invalid function name!
400, Bad request, Related cell-data 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)