Nematool API

Documented Nematool API for integration with other applications
More information: https://nematool.com/API
Contact Info: hello@nematool.com/API
Version: 1.0.0
BasePath:/Nematool/1.0.0
All rights reserved
https://nematool.com/Nematool-UserLicenseAgreement.pdf

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

Authentication

Crops

Default

Fcmtoken

Fields

Guests

Notifications

PredictionModels

Sensors

Sigpac

Solarization

User

Authentication

Up 
post /request_restore_code/
Petición para recuperar contraseña (forgotPassword)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ForgotPassword (optional)
Body Parameter —

Return type

ForgotPassword

Example data

Content-Type: application/json
{
  "email" : "email"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Petición exitosa ForgotPassword
Up 
post /auth/oauth/token/#1
Login - Obtiene un token de acceso para el resto de llamadas (login)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body LoginRequest (optional)
Body Parameter — Datos de acceso

Return type

LoginResponse

Example data

Content-Type: application/json
{
  "access_token" : "access_token",
  "refresh_token" : "refresh_token",
  "scope" : "scope",
  "token_type" : "token_type",
  "expires_in" : 0.8008281904610115
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Acceso exitoso LoginResponse
Up 
post /auth/oauth/token/#2
Refresca el token de acceso (oauthtoken)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body RefreshTokenRequest (optional)
Body Parameter — Datos de acceso

Return type

LoginResponse

Example data

Content-Type: application/json
{
  "access_token" : "access_token",
  "refresh_token" : "refresh_token",
  "scope" : "scope",
  "token_type" : "token_type",
  "expires_in" : 0.8008281904610115
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Acceso exitoso LoginResponse

Crops

Up 
get /crops/
Obtiene listado de cultivos (getCrops)

Query parameters

page (optional)
Query Parameter —
page_size (optional)
Query Parameter —

Return type

CropPaged

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Listado de cultivos CropPaged

Default

Up 
get /check-country/
Comprueba el pais (checkCountry)

Return type

Country

Example data

Content-Type: application/json
{
  "country_code" : "country_code"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Pais Country

Fcmtoken

Up 
post /devices/gcm/
Petición para dar de alta el token FCM (createFCMToken)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CreateFCMTokenRQ (optional)
Body Parameter —

Responses

200

Petición exitosa
Up 
patch /devices/gcm/{id}/unlink/
Petición para desvincular token FCM (unlinkFCMProfile)

Path parameters

id (required)
Path Parameter —

Responses

200

Operacion exitosa
Up 
patch /devices/gcm/{id}/profile/
Petición para actualziar el token FCM (updateFCMProfile)

Path parameters

id (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body UpdateDeviceProfileRQ (optional)
Body Parameter —

Responses

200

Operacion exitosa

Fields

Up 
post /fields/
Crea una nueva parcela (createField)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body NewFieldRQ (optional)
Body Parameter —

Return type

FieldRS

Example data

Content-Type: application/json
{
  "area" : {
    "coordinates" : [ 6.027456183070403, 6.027456183070403 ],
    "type" : "type"
  },
  "owner" : {
    "phone" : "phone",
    "last_name" : "last_name",
    "groups" : [ "groups", "groups" ],
    "id" : 0.8008281904610115,
    "date_joined" : "2000-01-23",
    "first_name" : "first_name",
    "email" : "email"
  },
  "city" : 5.962133916683182,
  "created" : "2000-01-23",
  "keys" : [ {
    "kind" : 9.965781217890562,
    "term" : "term",
    "id" : "id",
    "label" : "label"
  }, {
    "kind" : 9.965781217890562,
    "term" : "term",
    "id" : "id",
    "label" : "label"
  } ],
  "active_solarization" : {
    "started" : "2000-01-23",
    "finished" : "2000-01-23",
    "id" : 9.369310271410669,
    "degrees" : 6.683562403749608
  },
  "prediction_models" : [ {
    "thresholds" : [ null, null ],
    "field" : 4.145608029883936,
    "last_log_entry" : {
      "date" : "2000-01-23",
      "generation" : 1.2315135367772556,
      "eggs" : 1.0246457001441578,
      "threshold" : {
        "lower" : 1.1730742509559433,
        "upper" : 4.965218492984954,
        "is_risky" : true,
        "risk" : 5.025004791520295,
        "id" : 7.457744773683766,
        "label" : "label"
      },
      "id" : 7.386281948385884,
      "ratio_complete_cycle" : 1.4894159098541704,
      "ratio_eggs" : 6.84685269835264
    },
    "name" : "name",
    "started" : "2000-01-23",
    "finished" : "2000-01-23",
    "id" : 2.027123023002322
  }, {
    "thresholds" : [ null, null ],
    "field" : 4.145608029883936,
    "last_log_entry" : {
      "date" : "2000-01-23",
      "generation" : 1.2315135367772556,
      "eggs" : 1.0246457001441578,
      "threshold" : {
        "lower" : 1.1730742509559433,
        "upper" : 4.965218492984954,
        "is_risky" : true,
        "risk" : 5.025004791520295,
        "id" : 7.457744773683766,
        "label" : "label"
      },
      "id" : 7.386281948385884,
      "ratio_complete_cycle" : 1.4894159098541704,
      "ratio_eggs" : 6.84685269835264
    },
    "name" : "name",
    "started" : "2000-01-23",
    "finished" : "2000-01-23",
    "id" : 2.027123023002322
  } ],
  "aggregation" : 5.637376656633329,
  "sensors" : [ {
    "current_rssi" : 5.962133916683182,
    "current_rssi_timestamp" : "2000-01-23",
    "tst_serial_number" : "tst_serial_number",
    "is_activated" : true,
    "serial" : "serial",
    "current_battery_timestamp" : "2000-01-23",
    "interpolation_period" : 5.637376656633329,
    "id" : 0.8008281904610115,
    "position" : {
      "coordinates" : [ 6.027456183070403, 6.027456183070403 ],
      "type" : "type"
    },
    "current_battery" : 1.4658129805029452
  }, {
    "current_rssi" : 5.962133916683182,
    "current_rssi_timestamp" : "2000-01-23",
    "tst_serial_number" : "tst_serial_number",
    "is_activated" : true,
    "serial" : "serial",
    "current_battery_timestamp" : "2000-01-23",
    "interpolation_period" : 5.637376656633329,
    "id" : 0.8008281904610115,
    "position" : {
      "coordinates" : [ 6.027456183070403, 6.027456183070403 ],
      "type" : "type"
    },
    "current_battery" : 1.4658129805029452
  } ],
  "province" : 1.4658129805029452,
  "polygon" : 7.061401241503109,
  "zone" : 2.3021358869347655,
  "plot" : 9.301444243932576,
  "enclosure" : 3.616076749251911,
  "name" : "name",
  "id" : 0.8008281904610115,
  "crop" : 6.027456183070403
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Peticion exitosa FieldRS
Up 
delete /fields/{field_id}/
(deleteField)

Path parameters

field_id (required)
Path Parameter —

Responses

200

Operacion exitosa
Up 
get /fields/{field_id}/
(getField)

Path parameters

field_id (required)
Path Parameter —

Return type

FieldRS

Example data

Content-Type: application/json
{
  "area" : {
    "coordinates" : [ 6.027456183070403, 6.027456183070403 ],
    "type" : "type"
  },
  "owner" : {
    "phone" : "phone",
    "last_name" : "last_name",
    "groups" : [ "groups", "groups" ],
    "id" : 0.8008281904610115,
    "date_joined" : "2000-01-23",
    "first_name" : "first_name",
    "email" : "email"
  },
  "city" : 5.962133916683182,
  "created" : "2000-01-23",
  "keys" : [ {
    "kind" : 9.965781217890562,
    "term" : "term",
    "id" : "id",
    "label" : "label"
  }, {
    "kind" : 9.965781217890562,
    "term" : "term",
    "id" : "id",
    "label" : "label"
  } ],
  "active_solarization" : {
    "started" : "2000-01-23",
    "finished" : "2000-01-23",
    "id" : 9.369310271410669,
    "degrees" : 6.683562403749608
  },
  "prediction_models" : [ {
    "thresholds" : [ null, null ],
    "field" : 4.145608029883936,
    "last_log_entry" : {
      "date" : "2000-01-23",
      "generation" : 1.2315135367772556,
      "eggs" : 1.0246457001441578,
      "threshold" : {
        "lower" : 1.1730742509559433,
        "upper" : 4.965218492984954,
        "is_risky" : true,
        "risk" : 5.025004791520295,
        "id" : 7.457744773683766,
        "label" : "label"
      },
      "id" : 7.386281948385884,
      "ratio_complete_cycle" : 1.4894159098541704,
      "ratio_eggs" : 6.84685269835264
    },
    "name" : "name",
    "started" : "2000-01-23",
    "finished" : "2000-01-23",
    "id" : 2.027123023002322
  }, {
    "thresholds" : [ null, null ],
    "field" : 4.145608029883936,
    "last_log_entry" : {
      "date" : "2000-01-23",
      "generation" : 1.2315135367772556,
      "eggs" : 1.0246457001441578,
      "threshold" : {
        "lower" : 1.1730742509559433,
        "upper" : 4.965218492984954,
        "is_risky" : true,
        "risk" : 5.025004791520295,
        "id" : 7.457744773683766,
        "label" : "label"
      },
      "id" : 7.386281948385884,
      "ratio_complete_cycle" : 1.4894159098541704,
      "ratio_eggs" : 6.84685269835264
    },
    "name" : "name",
    "started" : "2000-01-23",
    "finished" : "2000-01-23",
    "id" : 2.027123023002322
  } ],
  "aggregation" : 5.637376656633329,
  "sensors" : [ {
    "current_rssi" : 5.962133916683182,
    "current_rssi_timestamp" : "2000-01-23",
    "tst_serial_number" : "tst_serial_number",
    "is_activated" : true,
    "serial" : "serial",
    "current_battery_timestamp" : "2000-01-23",
    "interpolation_period" : 5.637376656633329,
    "id" : 0.8008281904610115,
    "position" : {
      "coordinates" : [ 6.027456183070403, 6.027456183070403 ],
      "type" : "type"
    },
    "current_battery" : 1.4658129805029452
  }, {
    "current_rssi" : 5.962133916683182,
    "current_rssi_timestamp" : "2000-01-23",
    "tst_serial_number" : "tst_serial_number",
    "is_activated" : true,
    "serial" : "serial",
    "current_battery_timestamp" : "2000-01-23",
    "interpolation_period" : 5.637376656633329,
    "id" : 0.8008281904610115,
    "position" : {
      "coordinates" : [ 6.027456183070403, 6.027456183070403 ],
      "type" : "type"
    },
    "current_battery" : 1.4658129805029452
  } ],
  "province" : 1.4658129805029452,
  "polygon" : 7.061401241503109,
  "zone" : 2.3021358869347655,
  "plot" : 9.301444243932576,
  "enclosure" : 3.616076749251911,
  "name" : "name",
  "id" : 0.8008281904610115,
  "crop" : 6.027456183070403
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Info de parcela FieldRS
Up 
get /fields/
(getFields)

Query parameters

page (optional)
Query Parameter —
page_size (optional)
Query Parameter —

Return type

FieldPaged

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Lista de parcelas FieldPaged
Up 
put /fields/
(updateField)

Query parameters

token (required)
Query Parameter — Usuario de la parcela
field_id (required)
Query Parameter — Id de la parcela

Return type

FieldRS

Example data

Content-Type: application/json
{
  "area" : {
    "coordinates" : [ 6.027456183070403, 6.027456183070403 ],
    "type" : "type"
  },
  "owner" : {
    "phone" : "phone",
    "last_name" : "last_name",
    "groups" : [ "groups", "groups" ],
    "id" : 0.8008281904610115,
    "date_joined" : "2000-01-23",
    "first_name" : "first_name",
    "email" : "email"
  },
  "city" : 5.962133916683182,
  "created" : "2000-01-23",
  "keys" : [ {
    "kind" : 9.965781217890562,
    "term" : "term",
    "id" : "id",
    "label" : "label"
  }, {
    "kind" : 9.965781217890562,
    "term" : "term",
    "id" : "id",
    "label" : "label"
  } ],
  "active_solarization" : {
    "started" : "2000-01-23",
    "finished" : "2000-01-23",
    "id" : 9.369310271410669,
    "degrees" : 6.683562403749608
  },
  "prediction_models" : [ {
    "thresholds" : [ null, null ],
    "field" : 4.145608029883936,
    "last_log_entry" : {
      "date" : "2000-01-23",
      "generation" : 1.2315135367772556,
      "eggs" : 1.0246457001441578,
      "threshold" : {
        "lower" : 1.1730742509559433,
        "upper" : 4.965218492984954,
        "is_risky" : true,
        "risk" : 5.025004791520295,
        "id" : 7.457744773683766,
        "label" : "label"
      },
      "id" : 7.386281948385884,
      "ratio_complete_cycle" : 1.4894159098541704,
      "ratio_eggs" : 6.84685269835264
    },
    "name" : "name",
    "started" : "2000-01-23",
    "finished" : "2000-01-23",
    "id" : 2.027123023002322
  }, {
    "thresholds" : [ null, null ],
    "field" : 4.145608029883936,
    "last_log_entry" : {
      "date" : "2000-01-23",
      "generation" : 1.2315135367772556,
      "eggs" : 1.0246457001441578,
      "threshold" : {
        "lower" : 1.1730742509559433,
        "upper" : 4.965218492984954,
        "is_risky" : true,
        "risk" : 5.025004791520295,
        "id" : 7.457744773683766,
        "label" : "label"
      },
      "id" : 7.386281948385884,
      "ratio_complete_cycle" : 1.4894159098541704,
      "ratio_eggs" : 6.84685269835264
    },
    "name" : "name",
    "started" : "2000-01-23",
    "finished" : "2000-01-23",
    "id" : 2.027123023002322
  } ],
  "aggregation" : 5.637376656633329,
  "sensors" : [ {
    "current_rssi" : 5.962133916683182,
    "current_rssi_timestamp" : "2000-01-23",
    "tst_serial_number" : "tst_serial_number",
    "is_activated" : true,
    "serial" : "serial",
    "current_battery_timestamp" : "2000-01-23",
    "interpolation_period" : 5.637376656633329,
    "id" : 0.8008281904610115,
    "position" : {
      "coordinates" : [ 6.027456183070403, 6.027456183070403 ],
      "type" : "type"
    },
    "current_battery" : 1.4658129805029452
  }, {
    "current_rssi" : 5.962133916683182,
    "current_rssi_timestamp" : "2000-01-23",
    "tst_serial_number" : "tst_serial_number",
    "is_activated" : true,
    "serial" : "serial",
    "current_battery_timestamp" : "2000-01-23",
    "interpolation_period" : 5.637376656633329,
    "id" : 0.8008281904610115,
    "position" : {
      "coordinates" : [ 6.027456183070403, 6.027456183070403 ],
      "type" : "type"
    },
    "current_battery" : 1.4658129805029452
  } ],
  "province" : 1.4658129805029452,
  "polygon" : 7.061401241503109,
  "zone" : 2.3021358869347655,
  "plot" : 9.301444243932576,
  "enclosure" : 3.616076749251911,
  "name" : "name",
  "id" : 0.8008281904610115,
  "crop" : 6.027456183070403
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Info de parcela FieldRS

Guests

Up 
delete /guests/{guestId}/
Elimina a un invitado (deleteGuest)

Path parameters

guestId (required)
Path Parameter —

Responses

200

Operación exitosa
Up 
get /guests/
Obtiene listdo de invitados (getGuests)

Query parameters

page (optional)
Query Parameter —
page_size (optional)
Query Parameter —
field (required)
Query Parameter —
user (required)
Query Parameter —

Return type

GuestPaged

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Listado de invitados GuestPaged
Up 
post /guests/
Comparte parcela (shareFieldWith)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ShareFieldRQ (optional)
Body Parameter —

Responses

200

Operación exitosa

Notifications

Up 
get /notifications/
Obtiene el listado de alertas (getAlerts)

Query parameters

page (optional)
Query Parameter —
page_size (optional)
Query Parameter —

Return type

AlertPaged

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Listado de alertas AlertPaged
Up 
patch /notifications/{id}/
Marca como leida una determinada notificación (markAlertAsRead)

Path parameters

id (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body NotificationReadRQ (optional)
Body Parameter —

Responses

200

Operación exitosa

PredictionModels

Up 
post /nematool/prediction_models/
Inicia el modelo de predicción de una determinada parcela (startPredictionModel)

Consumes

This API call consumes the following media types via the Content-Type request header:

Form parameters

field (optional)
Form Parameter —

Return type

PredictionModel

Example data

Content-Type: application/json
{
  "thresholds" : [ null, null ],
  "field" : 4.145608029883936,
  "last_log_entry" : {
    "date" : "2000-01-23",
    "generation" : 1.2315135367772556,
    "eggs" : 1.0246457001441578,
    "threshold" : {
      "lower" : 1.1730742509559433,
      "upper" : 4.965218492984954,
      "is_risky" : true,
      "risk" : 5.025004791520295,
      "id" : 7.457744773683766,
      "label" : "label"
    },
    "id" : 7.386281948385884,
    "ratio_complete_cycle" : 1.4894159098541704,
    "ratio_eggs" : 6.84685269835264
  },
  "name" : "name",
  "started" : "2000-01-23",
  "finished" : "2000-01-23",
  "id" : 2.027123023002322
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Operacion exitosa PredictionModel
Up 
put /nematool/prediction_models/{predictionId}/stop/
Detiene el modelo de predicción (stopPredictionModel)

Path parameters

predictionId (required)
Path Parameter —

Responses

200

Operacion exitosa

Sensors

Up 
post /sensor_fields/
Asocia un sensor a una parcela (assignSensorToField)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SensorFieldAssociationRQ (optional)
Body Parameter —

Responses

200

Operacion exitosa
Up 
post /sensors/
Da de alta un sensor (createSensor)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SensorRQ (optional)
Body Parameter —

Return type

Sensor

Example data

Content-Type: application/json
{
  "current_rssi" : 5.962133916683182,
  "current_rssi_timestamp" : "2000-01-23",
  "tst_serial_number" : "tst_serial_number",
  "is_activated" : true,
  "serial" : "serial",
  "current_battery_timestamp" : "2000-01-23",
  "interpolation_period" : 5.637376656633329,
  "id" : 0.8008281904610115,
  "position" : {
    "coordinates" : [ 6.027456183070403, 6.027456183070403 ],
    "type" : "type"
  },
  "current_battery" : 1.4658129805029452
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Sensor dado de alta Sensor
Up 
get /sensor_key_values/
Obtiene los valores de un determinado sensor (getLastSensorKeyValue)

Query parameters

page (optional)
Query Parameter —
page_size (optional)
Query Parameter —
ordering (optional)
Query Parameter — Criterio de ordenacion
field (required)
Query Parameter — Id de la parcela
key (required)
Query Parameter — Clave del valor a recueprar

Return type

SensorKeyValuePaged

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Valor de sensor SensorKeyValuePaged
Up 
get /sensors/
Obtiene los sensores (getSensor)

Query parameters

page (optional)
Query Parameter —
page_size (optional)
Query Parameter —
serial (optional)
Query Parameter — Sensorid para filtrar los resultados

Return type

SensorPaged

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Sensores SensorPaged
Up 
get /sensor_key_values/time_series/
Obtiene los valores de un sensor en una determinada serie temporal (getSensorValues)

Query parameters

field (required)
Query Parameter — Parcela
key (required)
Query Parameter — Clave del valor
interval (optional)
Query Parameter — Intervalo de la serie
timestamp_min (optional)
Query Parameter — Desde
timestamp_max (optional)
Query Parameter — Hasta

Return type

SensorValuesRS

Example data

Content-Type: application/json
{
  "entryList" : {
    "date" : "2000-01-23",
    "mean" : 0.8008281904610115
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Valores del sensor SensorValuesRS
Up 
patch /sensors/{id}/
Actualiza el sensor asociándolo a una localización (updateSensor)

Path parameters

id (required)
Path Parameter — Id del sensor

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SensorUpdateRQ (optional)
Body Parameter —

Return type

Sensor

Example data

Content-Type: application/json
{
  "current_rssi" : 5.962133916683182,
  "current_rssi_timestamp" : "2000-01-23",
  "tst_serial_number" : "tst_serial_number",
  "is_activated" : true,
  "serial" : "serial",
  "current_battery_timestamp" : "2000-01-23",
  "interpolation_period" : 5.637376656633329,
  "id" : 0.8008281904610115,
  "position" : {
    "coordinates" : [ 6.027456183070403, 6.027456183070403 ],
    "type" : "type"
  },
  "current_battery" : 1.4658129805029452
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Sensor actualizado Sensor

Sigpac

Up 
get /sigpac/aggregations/
Obtiene el listado de agregados sigpac (getSigpacAggregations)

Query parameters

province (required)
Query Parameter —
city (required)
Query Parameter —

Return type

array[Aggregation]

Example data

Content-Type: application/json
[ {
  "code" : 0.8008281904610115,
  "name" : "name"
}, {
  "code" : 0.8008281904610115,
  "name" : "name"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Listado de Agregados
Up 
get /sigpac/cities/
Obtiene el listado de municipios sigpac (getSigpacCities)

Query parameters

province (required)
Query Parameter —

Return type

array[City]

Example data

Content-Type: application/json
[ {
  "code" : 0.8008281904610115,
  "name" : "name"
}, {
  "code" : 0.8008281904610115,
  "name" : "name"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Listado de municipios
Up 
get /sigpac/communities/
Obtiene el listado de comunidades sigpac (getSigpacCommunities)

Return type

array[Community]

Example data

Content-Type: application/json
[ {
  "code" : 0.8008281904610115,
  "name" : "name"
}, {
  "code" : 0.8008281904610115,
  "name" : "name"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Listado de comunidades
Up 
get /sigpac/enclosures/
Obtiene el listado de recintos sigpac (getSigpacEnclosures)

Query parameters

province (required)
Query Parameter —
city (required)
Query Parameter —
aggregation (required)
Query Parameter —
zone (required)
Query Parameter —
polygon (required)
Query Parameter —
plt (required)
Query Parameter —

Return type

array[Enclosure]

Example data

Content-Type: application/json
[ {
  "code" : 0.8008281904610115,
  "name" : "name"
}, {
  "code" : 0.8008281904610115,
  "name" : "name"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Listado de Recintos
Up 
get /sigpac/plots/
Obtiene el listado de parcelas sigpac (getSigpacPlots)

Query parameters

province (required)
Query Parameter —
city (required)
Query Parameter —
aggregation (required)
Query Parameter —
zone (required)
Query Parameter —
polygon (required)
Query Parameter —

Return type

array[Plot]

Example data

Content-Type: application/json
[ {
  "code" : 0.8008281904610115,
  "name" : "name"
}, {
  "code" : 0.8008281904610115,
  "name" : "name"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Listado de Parcelas
Up 
get /sigpac/polygons/
Obtiene el listado de polígonos sigpac (getSigpacPolygons)

Query parameters

province (required)
Query Parameter —
city (required)
Query Parameter —
aggregation (required)
Query Parameter —
zone (required)
Query Parameter —

Return type

array[Polygon]

Example data

Content-Type: application/json
[ {
  "code" : 0.8008281904610115,
  "name" : "name"
}, {
  "code" : 0.8008281904610115,
  "name" : "name"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Listado de Polígonos
Up 
get /sigpac/provinces/
Obtiene el listado de provincias sigpac (getSigpacProvinces)

Query parameters

community (required)
Query Parameter —

Return type

array[Province]

Example data

Content-Type: application/json
[ {
  "code" : 0.8008281904610115,
  "name" : "name"
}, {
  "code" : 0.8008281904610115,
  "name" : "name"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Listado de provincias
Up 
get /sigpac/zones/
Obtiene el listado de zonas sigpac (getSigpacZones)

Query parameters

province (required)
Query Parameter —
city (required)
Query Parameter —
aggregation (required)
Query Parameter —

Return type

array[Zone]

Example data

Content-Type: application/json
[ {
  "code" : 0.8008281904610115,
  "name" : "name"
}, {
  "code" : 0.8008281904610115,
  "name" : "name"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Listado de Zonas

Solarization

Up 
post /nematool/solarizations/
Inicia la solarizacion de una determinada parcela (startSolarization)

Consumes

This API call consumes the following media types via the Content-Type request header:

Form parameters

field (optional)
Form Parameter —

Return type

Solarization

Example data

Content-Type: application/json
{
  "started" : "2000-01-23",
  "finished" : "2000-01-23",
  "id" : 9.369310271410669,
  "degrees" : 6.683562403749608
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Operacion exitosa Solarization
Up 
put /nematool/solarizations/{solarizationId}/stop/
Detiene el proceso de solarización (stopSolarization)

Path parameters

solarizationId (required)
Path Parameter —

Responses

200

Operacion exitosa

User

Up 
get /users/me/
Obtiene los datos del usuario (getUser)

Return type

UserRS

Example data

Content-Type: application/json
{
  "phone" : "phone",
  "last_name" : "last_name",
  "groups" : [ "groups", "groups" ],
  "id" : 0.8008281904610115,
  "date_joined" : "2000-01-23",
  "first_name" : "first_name",
  "email" : "email"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Datos de usuario UserRS
Up 
post /users/
Registra al usuario en el sistem Nematool (register)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body RegisterRequest (optional)
Body Parameter — Datos de registro

Return type

RegisterRS

Example data

Content-Type: application/json
{
  "phone" : "phone",
  "last_name" : "last_name",
  "groups" : [ "groups", "groups" ],
  "id" : 0.8008281904610115,
  "date_joined" : "date_joined",
  "first_name" : "first_name",
  "email" : "email"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Registro exitoso RegisterRS

Models

[ Jump to Methods ]

Table of Contents

  1. Aggregation
  2. AlertPaged
  3. AlertRS
  4. AreaDTO
  5. City
  6. Community
  7. Country
  8. CreateFCMTokenRQ
  9. Crop
  10. CropPaged
  11. Enclosure
  12. Event
  13. FieldPaged
  14. FieldRS
  15. ForgotPassword
  16. GeoZone
  17. Guest
  18. GuestPaged
  19. Key
  20. LogEntry
  21. LoginRequest
  22. LoginResponse
  23. NewFieldRQ
  24. NotificationReadRQ
  25. PagedRS
  26. Plot
  27. Polygon
  28. PredictionModel
  29. Province
  30. RefreshTokenRequest
  31. RegisterRS
  32. RegisterRequest
  33. Sensor
  34. SensorCreateRQ
  35. SensorFieldAssociationRQ
  36. SensorKeyValuePaged
  37. SensorKeyValueRS
  38. SensorMinMax
  39. SensorPaged
  40. SensorRQ
  41. SensorUpdateRQ
  42. SensorValue
  43. SensorValuesRS
  44. ShareFieldRQ
  45. Solarization
  46. Target
  47. Threshold
  48. UpdateDeviceProfileRQ
  49. UserRS
  50. Zone
  51. nematool_prediction_models_body
  52. nematool_solarizations_body

Aggregation Up

code (optional)
BigDecimal
name (optional)
String

AlertPaged Up

count (optional)
BigDecimal
next (optional)
BigDecimal
previous (optional)
BigDecimal
results (optional)
array[AlertRS]

AlertRS Up

id (optional)
BigDecimal
event (optional)
Event
read (optional)
Boolean

AreaDTO Up

type (optional)
String
coordinates (optional)
array[BigDecimal]

City Up

code (optional)
BigDecimal
name (optional)
String

Community Up

code (optional)
BigDecimal
name (optional)
String

Country Up

country_code (optional)
String

CreateFCMTokenRQ Up

registrtion_id (optional)
String
cloud_message_id (optional)
String
application_id
String

Crop Up

id (optional)
BigDecimal
name (optional)
BigDecimal

CropPaged Up

count (optional)
BigDecimal
next (optional)
BigDecimal
previous (optional)
BigDecimal
results (optional)
array[Crop]

Enclosure Up

code (optional)
BigDecimal
name (optional)
String

Event Up

created (optional)
date format: date
text (optional)
String
title (optional)
String
verb (optional)
String
title_loc_key (optional)
String
title_loc_args (optional)
String
body_loc_key (optional)
String
body_loc_args (optional)
String
target (optional)
Target

FieldPaged Up

count (optional)
BigDecimal
next (optional)
BigDecimal
previous (optional)
BigDecimal
results (optional)
array[FieldRS]

FieldRS Up

id (optional)
BigDecimal identificador de la parcela
name (optional)
String Nombre de la parcela
area (optional)
AreaDTO
crop (optional)
BigDecimal
province (optional)
BigDecimal
city (optional)
BigDecimal
aggregation (optional)
BigDecimal
zone (optional)
BigDecimal
polygon (optional)
BigDecimal
plot (optional)
BigDecimal
enclosure (optional)
BigDecimal
center (optional)
AreaDTO
created (optional)
date format: date
owner (optional)
UserRS
prediction_models (optional)
array[PredictionModel]
sensors (optional)
array[Sensor]
keys (optional)
array[Key]
active_solarization (optional)
Solarization
active_prediction_model (optional)
PredictionModel

ForgotPassword Up

email
String

GeoZone Up

code (optional)
BigDecimal
name (optional)
String

Guest Up

id (optional)
BigDecimal
user (optional)
UserRS

GuestPaged Up

count (optional)
BigDecimal
next (optional)
BigDecimal
previous (optional)
BigDecimal
results (optional)
array[Guest]

Key Up

id (optional)
String
term (optional)
String
label (optional)
String
kind (optional)
BigDecimal

LogEntry Up

id (optional)
BigDecimal
date (optional)
date format: date
generation (optional)
BigDecimal
eggs (optional)
BigDecimal
ratio_complete_cycle (optional)
BigDecimal
ratio_eggs (optional)
BigDecimal
threshold (optional)
Threshold

LoginRequest Up

username
String
password
String
grant_password (optional)
String

LoginResponse Up

access_token (optional)
String
expires_in (optional)
BigDecimal
token_type (optional)
String
scope (optional)
String
refresh_token (optional)
String

NewFieldRQ Up

name (optional)
String
area (optional)
AreaDTO
province (optional)
BigDecimal
city (optional)
BigDecimal
aggregation (optional)
BigDecimal
zone (optional)
BigDecimal
polygon (optional)
BigDecimal
plot (optional)
BigDecimal
enclosure (optional)
BigDecimal
crop (optional)
BigDecimal

NotificationReadRQ Up

read (optional)
Boolean

PagedRS Up

count (optional)
BigDecimal
next (optional)
BigDecimal
previous (optional)
BigDecimal

Plot Up

code (optional)
BigDecimal
name (optional)
String

Polygon Up

code (optional)
BigDecimal
name (optional)
String

PredictionModel Up

id (optional)
BigDecimal
name (optional)
String
field (optional)
BigDecimal
started (optional)
date format: date
finished (optional)
date format: date
last_log_entry (optional)
LogEntry
thresholds (optional)
array[Threshold]

Province Up

code (optional)
BigDecimal
name (optional)
String

RefreshTokenRequest Up

refresh_token
String
grant_type
String

RegisterRS Up

id (optional)
BigDecimal
email (optional)
String
first_name (optional)
String
last_name (optional)
String
phone (optional)
String
groups (optional)
array[String]
date_joined (optional)
String

RegisterRequest Up

email
String
password
String

Sensor Up

id (optional)
BigDecimal
position (optional)
AreaDTO
serial (optional)
String
tst_serial_number (optional)
String
is_activated (optional)
Boolean
current_battery (optional)
BigDecimal
current_battery_timestamp (optional)
date format: date
current_rssi (optional)
BigDecimal
current_rssi_timestamp (optional)
date format: date
interpolation_period (optional)
BigDecimal

SensorCreateRQ Up

serial (optional)
String Identificador serial del sensor

SensorFieldAssociationRQ Up

field (optional)
BigDecimal
sensor (optional)
BigDecimal

SensorKeyValuePaged Up

count (optional)
BigDecimal
next (optional)
BigDecimal
previous (optional)
BigDecimal
results (optional)
array[SensorKeyValueRS]

SensorKeyValueRS Up

id (optional)
BigDecimal
value (optional)
BigDecimal
timestamp (optional)
date format: date

SensorMinMax Up

max (optional)
BigDecimal
min (optional)
BigDecimal

SensorPaged Up

count (optional)
BigDecimal
next (optional)
BigDecimal
previous (optional)
BigDecimal
results (optional)
array[Sensor]

SensorRQ Up

serial (optional)
String

SensorUpdateRQ Up

field (optional)
BigDecimal identificador de la parcela
position (optional)
AreaDTO
interpolation_period (optional)
BigDecimal

SensorValue Up

date (optional)
date format: date
mean (optional)
BigDecimal

SensorValuesRS Up

entryList (optional)
SensorValue

ShareFieldRQ Up

field (optional)
BigDecimal Identificador de la parcela
email (optional)
String

Solarization Up

id (optional)
BigDecimal
started (optional)
date format: date
finished (optional)
date format: date
degrees (optional)
BigDecimal

Target Up

id (optional)
BigDecimal

Threshold Up

id (optional)
BigDecimal
lower (optional)
BigDecimal
upper (optional)
BigDecimal
is_risky (optional)
Boolean
label (optional)
String
risk (optional)
BigDecimal

UpdateDeviceProfileRQ Up

version (optional)
String

UserRS Up

id (optional)
BigDecimal
email (optional)
String
first_name (optional)
String
last_name (optional)
String
phone (optional)
String
groups (optional)
array[String]
date_joined (optional)
date format: date

Zone Up

code (optional)
BigDecimal
name (optional)
String

nematool_prediction_models_body Up

field (optional)
BigDecimal Id de la parcela

nematool_solarizations_body Up

field (optional)
BigDecimal Id de la parcela