Énumérations (mesures, rôles, états)

GET /reference/enums

• Scope catalog:read
• Clé API x-api-key
• URL de base https://api.hub.akuasense.com/v1

Paramètres de requête

• lang string

  Langue des label, et du nom par défaut d’une sonde (name : « Probe 3 », « Sonde 3 »). Les code ne varient jamais. Une culture sans traduction retombe sur son nom français.

  Valeurs : enfr
  Par défaut : en

Réponse

200

Énumérations fixes

• measurement_types tableau d’object toujours présent
  Afficher les 2 attributs Masquer les attributs

  • code string toujours présent

    Grandeur mesurée par un capteur : humidity, humidité du sol ; temperature, température du sol ; tensio, tension de l’eau du sol, mesurée par une sonde tensiométrique. En entrée, tension — l’ancien code de tensio — reste accepté.

    Valeurs : humiditytemperaturetensio
  • label string toujours présent
• company_roles tableau d’object toujours présent
  Afficher les 2 attributs Masquer les attributs

  • code string toujours présent

    Rôle d’un membre dans une société. OWNER et MANAGER peuvent écrire, VIEWER ne fait que lire. Seul un OWNER gère les membres (scope users:admin).

    Valeurs : OWNERMANAGERVIEWER
  • label string toujours présent
• agronomic_states tableau d’object toujours présent
  Afficher les 2 attributs Masquer les attributs

  • code string toujours présent

    État hydrique du sol, tel que le rend GET /modules/{id}/agronomic-state.

    Valeurs : saturatedcomfortstress
  • label string toujours présent
• irrigation_systems tableau d’object toujours présent
  Afficher les 2 attributs Masquer les attributs

  • code string toujours présent

    Type de matériel. Détermine la valeur par défaut de la fraction de sol mouillée (FAO-56 table 20) : drip 0,35 · micro_sprinkler 0,60 · tous les autres 1,00.

    Valeurs : dripmicro_sprinklersprinklerpivotgravitymanualother
  • label string toujours présent
• irrigation_input_modes tableau d’object toujours présent
  Afficher les 2 attributs Masquer les attributs

  • code string toujours présent

    Comment l’apport est déclaré. duration n’exige AUCUNE configuration (c’est le mode de repli universel) mais ne produit une dose que si le débit est connu ; depth_mm est pris tel quel ; volume_m3 exige la surface irriguée.

    Valeurs : durationdepth_mmvolume_m3
  • label string toujours présent
• irrigation_event_statuses tableau d’object toujours présent
  Afficher les 2 attributs Masquer les attributs

  • code string toujours présent

    planned = prévu, done = réalisé, skipped = annulé (jamais affiché sur les graphes).

    Valeurs : planneddoneskipped
  • label string toujours présent
• irrigation_event_sources tableau d’object toujours présent
  Afficher les 2 attributs Masquer les attributs

  • code string toujours présent

    D’où vient la ligne. manual = saisie dans le hub · schedule = occurrence matérialisée par un programme · api = cette API · mcp = assistant IA. En lecture seule : la source est posée par la surface qui écrit.

    Valeurs : manualscheduleapimcp
  • label string toujours présent
• irrigation_schedule_freqs tableau d’object toujours présent
  Afficher les 2 attributs Masquer les attributs

  • code string toujours présent
    Valeurs : dailyweekly
  • label string toujours présent
• irrigation_confirmation_policies tableau d’object toujours présent
  Afficher les 2 attributs Masquer les attributs

  • code string toujours présent
    Valeurs : automanual
  • label string toujours présent
• irrigation_warnings tableau d’object toujours présent
  Afficher les 2 attributs Masquer les attributs

  • code string toujours présent

    Pourquoi la dose n’a pas pu être calculée, ou sur quelle hypothèse elle repose. AUCUN n’est bloquant : l’arrosage est enregistré quoi qu’il arrive, waterMm restant simplement null.

    Valeurs : NO_INSTALLATIONMISSING_FLOW_RATEMISSING_IRRIGATED_AREADEFAULT_FRACTION_WETTED
  • label string toujours présent

Erreurs

• 401

  Non authentifié

• 403

  Scope insuffisant ou ressource hors société

GET /reference/enums

cURL JavaScript Python

curl https://api.hub.akuasense.com/v1/reference/enums \
  -H "x-api-key: VOTRE_CLE_API"

const response = await fetch(
  'https://api.hub.akuasense.com/v1/reference/enums',
  {
    headers: {
      'x-api-key': 'VOTRE_CLE_API',
    },
  },
);
const data = await response.json();

import requests

response = requests.get(
    "https://api.hub.akuasense.com/v1/reference/enums",
    headers={"x-api-key": "VOTRE_CLE_API"},
)
data = response.json()

Réponse

200 401 403

{
  "measurement_types": [
    {
      "code": "humidity",
      "label": "Humidity"
    },
    {
      "code": "temperature",
      "label": "Temperature"
    },
    {
      "code": "tensio",
      "label": "Tension"
    }
  ],
  "company_roles": [
    {
      "code": "OWNER",
      "label": "Owner"
    },
    {
      "code": "MANAGER",
      "label": "Manager"
    },
    {
      "code": "VIEWER",
      "label": "Viewer"
    }
  ],
  "agronomic_states": [
    {
      "code": "saturated",
      "label": "Saturated"
    },
    {
      "code": "comfort",
      "label": "Comfort"
    },
    {
      "code": "stress",
      "label": "Stress"
    }
  ],
  "irrigation_systems": [
    {
      "code": "drip",
      "label": "Drip"
    },
    {
      "code": "micro_sprinkler",
      "label": "Micro-sprinkler"
    },
    {
      "code": "sprinkler",
      "label": "Sprinkler"
    },
    {
      "code": "pivot",
      "label": "Pivot"
    },
    {
      "code": "gravity",
      "label": "Gravity / flood"
    },
    {
      "code": "manual",
      "label": "Manual watering"
    },
    {
      "code": "other",
      "label": "Other"
    }
  ],
  "irrigation_input_modes": [
    {
      "code": "duration",
      "label": "Duration"
    },
    {
      "code": "depth_mm",
      "label": "Depth (mm)"
    },
    {
      "code": "volume_m3",
      "label": "Volume (m³)"
    }
  ],
  "irrigation_event_statuses": [
    {
      "code": "planned",
      "label": "Planned"
    },
    {
      "code": "done",
      "label": "Done"
    },
    {
      "code": "skipped",
      "label": "Skipped"
    }
  ],
  "irrigation_event_sources": [
    {
      "code": "manual",
      "label": "Manual entry"
    },
    {
      "code": "schedule",
      "label": "Schedule occurrence"
    },
    {
      "code": "api",
      "label": "REST API"
    },
    {
      "code": "mcp",
      "label": "MCP assistant"
    }
  ],
  "irrigation_schedule_freqs": [
    {
      "code": "daily",
      "label": "Every N days"
    },
    {
      "code": "weekly",
      "label": "Chosen weekdays"
    }
  ],
  "irrigation_confirmation_policies": [
    {
      "code": "auto",
      "label": "Auto-confirm past occurrences"
    },
    {
      "code": "manual",
      "label": "Confirm each occurrence by hand"
    }
  ],
  "irrigation_warnings": [
    {
      "code": "NO_INSTALLATION",
      "label": "No irrigation setup covers this date — the watering is recorded without a dose"
    },
    {
      "code": "MISSING_FLOW_RATE",
      "label": "Flow rate missing: a duration cannot be converted into mm"
    },
    {
      "code": "MISSING_IRRIGATED_AREA",
      "label": "Irrigated area missing: a volume cannot be converted into mm"
    },
    {
      "code": "DEFAULT_FRACTION_WETTED",
      "label": "Wetted fraction taken from the system default (FAO-56 table 20)"
    }
  ]
}

application/json

{
  "type": "string",
  "title": "string",
  "status": 401,
  "detail": "string",
  "code": "string"
}

application/problem+json · exemple généré depuis le schéma

{
  "type": "string",
  "title": "string",
  "status": 403,
  "detail": "string",
  "code": "string"
}

application/problem+json · exemple généré depuis le schéma