VisibleFarm

Measurement data

Measurements are a data set derived or arriving at a certain period, linked to a specific device and/or task and/or partfield and/or device equipment.

Measurement might be summarized data of a certain period, or an array of points data assigned to specific geographical points and time-stamps, and it might be uploaded to the system from a given data source, or the system itself derives them, based on data processing functions.

The upload of input data is not linked to a single partfield, so in the next subchapters the possible input methods carried out directly by data sources are described.

Create a measurement

All measurement data upload is linked to a Measure record. For the measure-relevant API interface definition, the description of general master data management in Chapter 4.2 is applicable. WorkDate - the date of the measurement automatically starts on the date value of the start time. If an uploaded measurement value would hang over to the next calendar day, the system automatically creates a new measure record with the new date.

POST /measure HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"data":[{
"type": "measure",
"attributes": {
"Task_ID": "3",
"StartTime": "2018-06-02T08:00:00.000Z ",
"StopTime": "2018-06-02T10:00:00.000Z ",
"Worker_ID": "10",
}
}]
}

Response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"link":[{
"self": "http://api.visiblefarm.net/measure"
},
"data":[{
"type": "measure",
"id": "123",
"attributes": {
"StartTime": "2018-06-02T08:00:00.000Z ",
"StopTime": "2018-06-02T10:00:00.000Z ",
"WorkDate": "2018-06-02",
"ElementNumber": "0"
},
"relationships": {
"task": {
"data": { "id": "3", "type": "task" }
},
"worker": {
"data": { "id": "10", "type": "worker" }
},
}
}]
}

In case of errors
The possible error codes

400, Bad request, Invalid type name!
400, Bad request, StartTime is invalid.
400, Bad request, StopTime is invalid.
400, Bad request, Related device does not exist.!
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)

Create a measurement summary

Summarized data of a specific measurement. It is an option to provide the data source device, and the system automatically records this among the devices assigned to the measurement.

POST /measuretotal HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"data":[{
"type": "measuretotal",
"attributes": {
"Measure_ID": "123",
"Property_ID": "247",
"StartValue": "132400",
"StopValue": "134900",
"TotalValue": "2500",
"Device": "1703"
}
}]
}

Response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"link":[{
"self": "http://api.visiblefarm.net/measuretotal"
},
"data":[{
"type": "measuretotal",
"id": "1236453",
"attributes": {
"Measure_ID": "123",
"Property_ID": "247",
"StartValue": "132400",
"StopValue": "134900",
"TotalValue": "2500",
}
}]
}

In case of errors
The possible error codes

400, Bad request, Invalid type name!
400, Bad request, StartValue is invalid.
400, Bad request, StopValue is invalid.
400, Bad request, TotalValue is mandatory.
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)

Create a measurement point

A data point of a specific measurement; it might be compiled of values of multiple data types (see individual recording of measurement values). Time-stamp and geographical expansion (availability area) can be assigned to the measurement point but it is not mandatory.

For measurement data from moving devices forming a pathlike measurement, it is recommended to upload not measurement points but measurement paths.

To enter geographical location, set GEOJson 3D point type (see: Point, http://geojson.org/ ), where the value of Longitude and Latitude is set in WGS-84 coordinate system, while the value of Altitude is set in meters above WGS-84 ellipsoid.

POST /measurepoint HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"data":[{
"type": "measurepoint",
"attributes": {
"Measure_ID": "123",
"Position":
{
"type": "Point",
"coordinates":
[
17.342210,
46,234320,
23,453
]
},
"TimeStamp": "2018-06-02T09:12:23.200Z ",
"Range": "12.000"
}
}]
}

Comment:
The „Range” defines the vaild area of the measurement in meter (for example a working width).

Response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"link":[{
"self": "http://api.visiblefarm.net/measuretotal"
},
"data":[{
"type": "measurepoint",
"id": "345463",
"attributes": {
"TimeStamp": "2018-06-02T09:12:23.200Z "
},
"relationships": {
"measure": {
"data": { "id": "123", "type": "measure" }
}
}
}]
}

In case of errors
The possible error codes

400, Bad request, Invalid type name!
400, Bad request, Position is invalid.
400, Bad request, Timestamp is invalid.
400, Bad request, TotalValue is mandatory.
400, Bad request, Related measure 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)

Create a measurement values

Uploading values of a specific measurement point.

It is an option to provide the data source device or equipment.

POST /measurevalue HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"data":[{
"type": "measurevalue ",
"attributes": {
"MeasurePoint_ID": "345463",
"Device_ID": "1703",
"Property_ID": "247",
"Value": "132405"
}
}]
}

Response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"link":[{
"self": "http://api.visiblefarm.net/measurevalue"
},
"data":[{
"type": "measurevalue",
"id": "3473637002",
"attributes": {
"Value": "132403”
},
"relationships": {
"measurepoint": {
"data": { "id": "345463", "type": "measurepoint" }
},
"property": {
"data": { "id": "247", "type": "property" }
}
}
}]
}

In case of errors
The possible error codes

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

Create a measurement-path

Path type position data set linked to a specific measurement, originating from a moving device; it can be continuously built up.

To enter the path, set GEOJson 3D polyline type (see: Linestring, http://geojson.org/), where the value of Longitude and Latitude is set in WGS-84 coordinate system, while the value of Altitude is set in meters above WGS-84 ellipsoid.

It is possible to set start- and stop time for the path. If start-time is missing, the system automatically uses the last existed stop-time in the measurement’s pathes. If the stop-time is missing, the system automatically uses the timestamp of the uploading.

It is an option to provide the data source device, and the system automatically assigns it to the measurement (DeviceAllocation).

POST /measurepath HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"data":[{
"type": "measurepath ",
"attributes": {
"Measure_ID": "123",
"Device": "1703",
"StartTime": "2018-06-02T08:12:00.000Z",
"StopTime": "2018-06-02T08:13:00.000Z",
"Path": {
"type": "LineString ",
"coordinates": [
[
17.342210,
46.234320,
23.453
],[
17.342211,
46.234322,
23.454
]
]
}
}
}]
}

Response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"link":[{
"self": "http://api.visiblefarm.net/measurpath"
},
"data":[{
"type": "measurpath",
"id": "14252790",
"attributes": {
"Count": "2",
"Length": "12.4",
},
"relationships": {
"measure": {
"data": { "id": "123", "type": "measure" }
}
}
}]
}

In case of errors
The possible error codes

400, Bad request, Invalid type name!
400, Bad request, PointValue is invalid.
400, Bad request, Related measure 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)

Update a measurement-path

Expanding the path linked to a given measurement with a point or a section.

It is possible to set a stop time for the path update. If it is missing, the system automatically uses the timestamp of the uploading.

To enter the path, set GEOJson 3D polyline type (see: Linestring, http://geojson.org/), where the value of Longitude and Latitude is set in WGS-84 coordinate system, while the value of Altitude is set in meters above WGS-84 ellipsoid.

PATCH / measurepath/14252790 HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"data":[{
"type": "measurepath ",
"id": "14252790",
"attributes": {
"Path": {
"type": "LineString ",
"coordinates": [
[
17.342212,
46.234323,
23.453
] ]
}
}
}]
}

Response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"link":[{
"self": "http://api.visiblefarm.net/measurepath"
},
"data":[{
"type": "measurepath",
"id": "14252790",
"attributes": {
"Path": "3",
"Length": "15.3"
},
"relationships": {
"measure": {
"data": { "id": "123", "type": "measure" }
}
}
}]
}

In case of errors
The possible error codes

400, Bad request, Invalid type name!
400, Bad request, PointValue is invalid.
400, Bad request, Related measure 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)

Create a measurement-path with value

Path type measurement data set of a specific measurement, originating from a moving device; it can be continuously built up.

If there is already a stored measure-path for the given measurement with the same property, and the last point of the old path is the same as the first point of the data-set, the function rather appends the section instead of creating a new measurement-path.

To enter the path, set GEOJson 4D polyline type (see: Linestring, http://geojson.org/), where the value of Longitude and Latitude is set in WGS-84 coordinate system, while the value of Altitude is set in meters above WGS-84 ellipsoid, the 4th dimension is the value according to the given data type. If the given data type (Property_ID) is 0, the 4th dimension is the identification number of the measurement point describing the given point (see Combined measurement path data).

It is possible to set start- and stop time for the path. If start-time is missing, the system automatically uses the last existed stop-time in the measurement’s pathes. If the stop-time is missing, the system automatically uses the timestamp of the uploading.

It is an option to provide the data source device, and the system automatically assigns it to the measurement (DeviceAllocation).

The system automatically creates a 3D measure-path with measure-points and value recors to store the originally 4D data.

POST /measurevaluepath HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"data":[{
"type": "measurepath ",
"attributes": {
"StartTime": "2018-06-02T08:12:00.000Z",
"StopTime": "2018-06-02T08:13:00.000Z",
"Measure_ID": "123",
"Property_ID": "247",
"PathAndValue": {
"type": "LineString ",
"coordinates": [
[
17.342210,
46.234320,
23.453
132402
],[
17.342211,
46.234322,
23.454
132403
]
]
}
}
}]
}

Response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"link":[{
"self": "http://api.visiblefarm.net/measurvaluepath"
},
"data":[{
"type": "measurepath",
"id": "34252790",
"attributes": {
"PathAndValue": "2"
},
"relationships": {
"measure": {
"data": { "id": "123", "type": "measure" }
},
"property": {
"data": { "id": "247", "type": "property" }
}
}
}]
}

In case of errors
The possible error codes

400, Bad request, Invalid type name!
400, Bad request, PointValue is invalid.
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)

Update a measurement-path with value

Expanding the path of a given measurement with a point or a section.

It is possible to set a stop time for the path update. If it is missing, the system automatically uses the timestamp of the uploading.

To enter the path, set GEOJson 4D polyline type (see: Linestring, http://geojson.org/), where the value of Longitude and Latitude is set in WGS-84 coordinate system, while the value of Altitude is set in meters above WGS-84 ellipsoid, the 4th dimension is the value according to the given data type.

PATCH / measurevaluepath/34252790 HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"data":[{
"type": "measurepath ",
"id": "34252790",
"attributes": {
"PathAndValue": {
"type": "LineString ",
"coordinates": [
[
17.342212,
46.234323,
23.453,
132403
] ]
}
}
}]
}

Response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"link":[{
"self": "http://api.visiblefarm.net/measurvaluepath"
},
"data":[{
"type": "measurepath",
"id": "34252790",
"attributes": {
"PathAndValue": "3"
},
"relationships": {
"measure": {
"data": { "id": "123", "type": "measure" }
},
"property": {
"data": { "id": "123", "type": "property" }
}
}
}]
}

In case of errors
The possible error codes

400, Bad request, Invalid type name!
400, Bad request, PointValue is invalid.
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)

Create a combined measurement data

Multiple path type measurement data set of a specific measurement, originating from multiple moving devices; similarly, to the description in the previous chapter, it can be continuously built up.

If there is already a stored measure-path for the given measurement, and the last point of the old path is the same as the first point of the data-set, the function rather appends the section instead of creating a new measurement-path.

To enter the path, the value of Longitude and Latitude is set in WGS-84 coordinate system, while the value of Altitude is set in meters above WGS-84 ellipsoid. It is mandatory to have a time stamp after these in each case; next there is the listing of the values measured, carried out by providing the Property_Id (first value) and Value (second value), and optionally stating the data source Device (third value). Instead of this latter parameter, in case all of the measured values originate from the same device, it can be entered among the global data, so it is not necessary any longer to specify it by measured values.

Next to the coordinates it is possible to set a “range” value, which describes the applied width during the given path for all of the values. It can be used as the working-width of the device or a valid range of a sensor. The parameter is optional.

POST /measurevaluepathExt HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"data":[{
"type": "measurepath ",
"attributes": {
"Measure_ID": "123",
"PathAndValues": {
"range": 6.0,
"coordinates": [
[
"lon": 17.342210,
"lat": 46.234320,
"alt": 23.453,
"time": "2018-06-02T09:12:23.200Z",
"values": [
[
247
132405
1703
],[
1498
23000
1703
]
]
},{
"lon": 17.342211,
"lat": 46.234322,
"alt": 23.454,
"time": "2018-06-02T09:12:24.200Z",
"values": [
[
247
132408
1703
],[
2340
11500
]
]
}
]
}
}
}]
}

Response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"link":[{
"self": "http://api.visiblefarm.net/measurevaluepathext"
},
"data":[{
"type": "measurepath",
"id": "34252790",
"attributes": {
"PathAndValue": "2"
},
"relationships": {
"measure": {
"data": { "id": "123", "type": "measure" }
},
"property": {
"data": { "id": "247", "type": "property" }
"data": { "id": "1498", "type": "property" }
"data": { "id": "2340", "type": "property" }
}
}
}]
}

In case of errors
The possible error codes

400, Bad request, Invalid type name!
400, Bad request, Position is invalid.
400, Bad request, Timestamp is invalid.
400, Bad request, Related measure 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)

Update a combined measurement data

Append a point or section to an already created measurement-data set.

To enter the path, the value of Longitude and Latitude is set in WGS-84 coordinate system, while the value of Altitude is set in meters above WGS-84 ellipsoid. It is mandatory to have a time stamp after these in each case; next there is the listing of the values measured, carried out by providing the Property_Id (first value) and Value (second value), and optionally stating the data source Device (third value). Instead of this latter parameter, in case all of the measured values originate from the same device, it can be entered among the global data, so it is not necessary any longer to specify it by measured values.

PATCH / measurevaluepathext/34252790 HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"data":[{
"type": "measurepath ",
"id": "34252790",
"attributes": {
"PathAndValue": {
"coordinates": [
[
"lon": 17.342212,
"lat": 46.234322,
"alt": 23.454,
"time": "2018-06-02T09:12:25.200Z",
"values": [
[
247,
132410,
1703
],[
2340,
11500
]
]
}
]
}
}
}]
}

Response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"meta":{
"JWToken": "ba1af54ec3f014f765e8172f9a86dc2a"
},
"link":[{
"self": "http://api.visiblefarm.net/measurvaluepathext"
},
"data":[{
"type": "measurepath",
"id": "34252790",
"attributes": {
"PathAndValue": "3"
},
"relationships": {
"measure": {
"data": { "id": "123", "type": "measure" }
},
"property": {
"data": { "id": "247", "type": "property" }
"data": { "id": "2340", "type": "property" }
}
}
}]
}

In case of errors
The possible error codes

400, Bad request, Invalid type name!
400, Bad request, PointValue is invalid.
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)

Measurement data

Create a measurement

Response

In case of errorsThe possible error codes

Create a measurement summary

Summarized data of a specific measurement. It is an option to provide the data source device, and the system automatically records this among the devices assigned to the measurement.

Response

In case of errorsThe possible error codes

Create a measurement point

Comment: The „Range” defines the vaild area of the measurement in meter (for example a working width).

Response

In case of errorsThe possible error codes

Create a measurement values

Uploading values of a specific measurement point. It is an option to provide the data source device or equipment.

Response

In case of errorsThe possible error codes

Create a measurement-path

Response

In case of errorsThe possible error codes

Update a measurement-path

Response

In case of errorsThe possible error codes

Create a measurement-path with value

Response

In case of errorsThe possible error codes

Update a measurement-path with value

Response

In case of errorsThe possible error codes

Create a combined measurement data

Response

In case of errorsThe possible error codes

Update a combined measurement data

Response

In case of errorsThe possible error codes

In case of errors
The possible error codes

In case of errors
The possible error codes

Comment:
The „Range” defines the vaild area of the measurement in meter (for example a working width).

In case of errors
The possible error codes

Uploading values of a specific measurement point.

It is an option to provide the data source device or equipment.

In case of errors
The possible error codes

In case of errors
The possible error codes

In case of errors
The possible error codes

In case of errors
The possible error codes

In case of errors
The possible error codes

In case of errors
The possible error codes

In case of errors
The possible error codes