Détail d'un module

GET /modules/{id}

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

Paramètres de chemin

• id integer obligatoire

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

Le module

• id integer toujours présent
• uid string toujours présent

  Identifiant technique du module, celui que transmet le boîtier.

• name string peut être null toujours présent

  Nom de la sonde, tel que le hub l’affiche : celui que le client lui a donné, sinon son nom par défaut — « Probe 3 », « Sonde 3 » selon lang. Unique dans la société. null : le module n’a ni nom ni numéro — un tensiomètre, par exemple.

• serialHex string peut être null toujours présent

  Numéro de série matériel, en hexadécimal. null si non renseigné.

• category string peut être null toujours présent

  SOIL_PROBE : sonde de sol, humidité et température par profondeur. TENSIOMETER : sonde tensiométrique. WEATHER_STATION : station météo.

  Valeurs : SOIL_PROBETENSIOMETERWEATHER_STATIONnull
• location ModuleLocation peut être null toujours présent

  Position DÉCLARÉE de la sonde — celle qui pilote la météo et les graphes. null : sonde non positionnée ; elle se place sur la carte du hub.

  Afficher les 5 attributs Masquer les attributs

  • lat number toujours présent

    Latitude WGS 84, en degrés décimaux.

  • lon number toujours présent

    Longitude WGS 84, en degrés décimaux.

  • source string toujours présent

    manual : placée à la main. seeded : reprise, une fois, d’une position GPS plausible du boîtier. gateway : reprise automatiquement du GPS du nouveau boîtier, après que la sonde a changé de boîtier.

    Valeurs : manualseededgateway
  • stale boolean toujours présent

    true : la sonde a changé de boîtier, ou en a été détachée, depuis la déclaration — position à reconfirmer.

  • driftMeters integer peut être null toujours présent

    Écart avec la dernière position GPS du boîtier, en mètres. null si le GPS du boîtier est muet.

• parcelId integer peut être null toujours présent

  Parcelle de rattachement. null si aucune.

• sensors tableau de ModuleSensor toujours présent

  Un capteur du module. Une sonde de sol en porte deux par profondeur : humidité et température.

  Afficher les 4 attributs Masquer les attributs

  • id integer toujours présent
  • type string peut être null toujours présent

    Grandeur mesurée.

    Valeurs : humiditytemperaturetensio
  • depth number peut être null toujours présent

    Profondeur, en cm (0 = surface).

  • label string peut être null toujours présent

    Libellé libre. null si non renseigné.

• currentGateway object peut être null toujours présent

  Boîtier 4G auquel le module est branché : c’est lui qui transmet ses mesures. null : branché sur aucun boîtier.

  Afficher les 2 attributs Masquer les attributs

  • id integer toujours présent
  • imei string toujours présent

    IMEI du boîtier.

Erreurs

• 400

  Paramètre invalide

  invalid_id
• 401

  Non authentifié

• 403

  Scope insuffisant ou ressource hors société

• 404

  Module introuvable : possédé, mais jamais mis en service

  not_found

GET /modules/{id}

cURL JavaScript Python

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

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

import requests

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

Réponse

200 400 401 403 404

{
  "id": 256,
  "uid": "DEMO-MOD-008",
  "name": "Probe 1",
  "serialHex": null,
  "category": "SOIL_PROBE",
  "location": {
    "lat": 48.995762,
    "lon": 1.775296,
    "source": "manual",
    "stale": false,
    "driftMeters": 0
  },
  "parcelId": null,
  "sensors": [
    {
      "id": 982,
      "type": "humidity",
      "depth": 0,
      "label": null
    },
    {
      "id": 983,
      "type": "humidity",
      "depth": 15,
      "label": null
    },
    {
      "id": 984,
      "type": "humidity",
      "depth": 30,
      "label": null
    },
    {
      "id": 985,
      "type": "humidity",
      "depth": 45,
      "label": null
    },
    {
      "id": 986,
      "type": "humidity",
      "depth": 60,
      "label": null
    },
    {
      "id": 987,
      "type": "temperature",
      "depth": 0,
      "label": null
    },
    {
      "id": 988,
      "type": "temperature",
      "depth": 15,
      "label": null
    },
    {
      "id": 989,
      "type": "temperature",
      "depth": 30,
      "label": null
    },
    {
      "id": 990,
      "type": "temperature",
      "depth": 45,
      "label": null
    },
    {
      "id": 991,
      "type": "temperature",
      "depth": 60,
      "label": null
    }
  ],
  "currentGateway": {
    "id": 191,
    "imei": "DEMO-GW-006"
  }
}

application/json

{
  "type": "string",
  "title": "string",
  "status": 400,
  "detail": "string",
  "code": "invalid_id"
}

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

{
  "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

{
  "type": "string",
  "title": "string",
  "status": 404,
  "detail": "string",
  "code": "not_found"
}

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