API Conta Ovos

Consultez et envoyez les données d'ovitrap, d'îlot et de visite sur le terrain directement depuis votre système. Cette page documente tous les points de terminaison publics et privés disponibles.

/fr-lu/apiDemander une clé API

À propos de l'API

Cette API a des points de terminaison public et privé. L'API publique renvoie des données sur la latitude, la longitude et le nombre d'œufs pour chaque commune participante au fil du temps, sans nécessiter d'authentification. L'API privée n'est recommandée que pour les applications qui fonctionnent en partenariat avec Conta Ovos, car elle expose des données sensibles et vous permet d'insérer, de modifier et de supprimer des enregistrements.

Authentification et clés

Pour utiliser l'API privée, vous aurez besoin d'une clé d'accès (key). Pour l'acheter, envoyez un email à contaovosdengue@gmail.com déclarant :

  • Pourquoi avez-vous besoin d'un accès API ?
  • Quel niveau d'accès est requis (municipal, régional, étatique ou national) ;
  • De quelle région géographique faites-vous partie ?

La clé est composée de 45 lettres aléatoires et doit être envoyé en paramètre key de chaque demande privée. Le périmètre géographique et le plan lié à la clé (api_access_municipality_id, state_id, region_id, country_id, plan) définir automatiquement les enregistrements qu'elle peut lire ou modifier — une clé municipale, par exemple, ne peut lire ou modifier que les données de la municipalité elle-même.

Où envoyer la clé : a key est toujours lu à partir de la chaîne de requête URL (?key=SUA_CHAVE), y compris les points de terminaison POST. L'envoyer uniquement dans le corps du formulaire entraîne 404 "Wrong key". Les autres champs POST continuent d'apparaître dans le corps de la requête.
Pagination: les paramètres page acceptez un maximum de 100 sur les points de terminaison prenant en charge la pagination. Les valeurs invalides ou manquantes prennent la page 1.

Codes de réponse

Tous les points de terminaison suivent le même modèle d'état HTTP :

CodeSignification
200Demande traitée avec succès.
400Paramètre obligatoire manquant ou dans un format invalide.
403La ressource renseignée n'appartient pas au périmètre (ville/état/région) de la clé utilisée.
404Clé invalide (Wrong key) ou ressource introuvable.
409Un enregistrement existe déjà pour cette combinaison identifiant, année et semaine.
500Erreur interne lors du traitement de la demande.

Points de terminaison publics

GET/api/lastcountingpublicPublique

Derniers décomptes publiés

Renvoie les derniers décomptes publiés par emplacement (ville, état ou pays), avec le nombre d'œufs et les données sur les ovitraps.

Paramètres

NomTaperDescription
statestringCode d'état. Exemple: state=RJ.
municipalitystringNom de la commune. Exemple: municipality=Ponta Pora
countrystringNom du pays. Exemple: country=Brasil. En cas d'omission, cela implique "Brésil".
pageintPage de pagination (par défaut 1, maximum 100).
idintAffiche uniquement les occurrences de l'identifiant donné. Exemple: id=7876.
datedateAffiche les occurrences à partir de la date d'inclusion. Exemple: date=2025-01-01.
date_collectdateAffiche les occurrences à partir de la date de collecte. Exemple: date_collect=2024-12-12.
date_startdateDate de début pour filtrer les décomptes. Exemple: date_start=2025-01-01.
date_enddateDate de fin pour filtrer les décomptes. Exemple: date_end=2025-12-31.

Note: Si aucun paramètre de localisation n'est envoyé, le point de terminaison renvoie les derniers décomptes du Brésil.

Réponses spécifiques :
  • 400 — lorsqu'une des dates envoyées n'est pas au format YYYY-MM-DD. La réponse apporte la liste des champs invalides dans invalid_fields.

Exemple de demande

curl -G -d "municipality=Ponta%20Pora" \
  /fr-lu/api/lastcountingpublic

curl -G -d "state=MG" \
  /fr-lu/api/lastcountingpublic

Exemple de réponse

[
  {
    "state_name": "Minas Gerais",
    "state_code": "MG",
    "municipality": "Ponta Pora",
    "municipality_code": "5006606",
    "eggs": 42,
    "week": 3,
    "year": 2025,
    "time": "2025-01-20 14:32:10",
    "counting_id": 118342,
    "ovitrap_website_id": 981,
    "ovitrap_id": "97",
    "latitude": -7.000000,
    "longitude": -8.000000,
    "date": "2025-01-20",
    "date_collect": "2025-01-27"
  }
]
GET/api/getmunicipalityblocksvisitpublicPublique

Visites dans les îlots

Renvoie les données sur les visites (actions de traitement) effectuées par îlots — une ligne par visite et non par îlot.

Paramètres

NomTaperDescription
statestringCode d'état. Exemple: state=RJ.
municipalitystringNom de la commune. Exemple: municipality=Ponta Pora
countrystringNom du pays. Exemple: country=Brasil. En cas d'omission, cela implique "Brésil".
pageintPage de pagination (par défaut 1, maximum 100).

Exemple de demande

curl -G -d "municipality=Vista%20Alegre" \
  /fr-lu/api/getmunicipalityblocksvisitpublic

curl -G -d "state=MS" \
  /fr-lu/api/getmunicipalityblocksvisitpublic

Exemple de réponse

[
  {
    "block_id": 4521,
    "block_actions_mean": 3.4,
    "block_coordinates": "[[-7.123, -34.845], [-7.124, -34.846]]",
    "municipality": "Vista Alegre",
    "municipality_code": "5007117",
    "state_name": "Mato Grosso do Sul",
    "state_code": "MS",
    "action_land_total_total": 21,
    "action_land_residence_total": 10,
    "action_land_commercial_total": 5,
    "action_land_empty_total": 3,
    "action_land_strategy_total": 1,
    "action_land_another_total": 2,
    "action_address_district": "Centro",
    "action_address_sector": "Setor 04",
    "action_deposit_a1_quantity": 4,
    "action_deposit_a2_quantity": 2,
    "action_deposit_b_quantity": 5,
    "action_deposit_c_quantity": 1,
    "action_deposit_d1_quantity": 0,
    "action_deposit_d2_quantity": 3,
    "action_deposit_e_quantity": 0,
    "action_observation": "Foco encontrado em pneus nos fundos do imovel.",
    "latitude": -7.123456,
    "longitude": -34.845678
  }
]
GET/api/getmunicipalityblockspublic-2Publique

Îlots enregistrés

Renvoie les îlots enregistrés dans la commune — une ligne par îlot, avec le polygone, le total des propriétés par type et le nombre moyen de parts.

Nouveau point de terminaison. Si vous recherchez des visites effectuées par îlots, utilisez /api/getmunicipalityblocksvisitpublic. Comme il s’agit d’un point de terminaison public, la réponse n’inclut pas l’agent responsable de l'îlot ni les identifiants utilisateur/équipe.

Paramètres

NomTaperDescription
statestringCode d'état. Exemple: state=RJ.
municipalitystringNom de la commune. Exemple: municipality=Ponta Pora
countrystringNom du pays. Exemple: country=Brasil. En cas d'omission, cela implique "Brésil".
pageintPage de pagination (par défaut 1, maximum 100).

Exemple de demande

curl -G -d "municipality=Alta%20Floresta" \
  /fr-lu/api/getmunicipalityblockspublic-2

curl -G -d "state=MT" \
  /fr-lu/api/getmunicipalityblockspublic-2

Exemple de réponse

[
  {
    "block_id": 118342,
    "block_group_id": "1",
    "block_datetime": "Mon, 09 Sep 2024 10:12:41 GMT",
    "latitude": -9.849042,
    "longitude": -56.065069,
    "block_coordinates": "[{\"lat\":-9.849042,\"lng\":-56.065069}, ...]",
    "block_address_district": "DISTRITO INDUSTRIAL",
    "block_address_sector": "DISTRITO INDUSTRIAL",
    "block_municipality_id": 5566,
    "block_active": 1,
    "block_actions_mean": 22,
    "block_land_total": 24,
    "block_land_residence": 18,
    "block_land_commercial": 4,
    "block_land_empty": 2,
    "block_land_strategy": 0,
    "block_land_another": 0,
    "municipality": "Alta Floresta",
    "municipality_code": "5100250",
    "state_name": "Mato Grosso",
    "state_code": "MT"
  }
]
GET/api/getmunicipalityedlspublicPublique

EDL enregistrées

Renvoie les données des EDL (points stratégiques qui reçoivent une maintenance périodique des agents) enregistrés par municipalité.

Paramètres

NomTaperDescription
statestringCode d'état. Exemple: state=RJ.
municipalitystringNom de la commune. Exemple: municipality=Ponta Pora
countrystringNom du pays. Exemple: country=Brasil. En cas d'omission, cela implique "Brésil".
pageintPage de pagination (par défaut 1, maximum 100).

Exemple de demande

curl -G -d "municipality=Vista%20Alegre" \
  /fr-lu/api/getmunicipalityedlspublic

curl -G -d "state=MS" \
  /fr-lu/api/getmunicipalityedlspublic

Exemple de réponse

[
  {
    "edl_id": 1832,
    "edl_group_id": "104",
    "edl_address_datetime": "2025-02-11 09:15:00",
    "edl_lat": -7.123456,
    "edl_lng": -34.845678,
    "edl_municipality_id": 5007117,
    "group_id": 12,
    "user_id": 348,
    "edl_responsable_agent": "João da Silva",
    "edl_block_group_id": "12",
    "edl_responsable_home": "Maria Souza",
    "edl_date": "2025-02-11",
    "edl_water_mean": 1.8,
    "municipality": "Vista Alegre",
    "municipality_code": "5007117",
    "state_name": "Mato Grosso do Sul",
    "state_code": "MS"
  }
]
GET/api/getmunicipalityedlmaintenancepublicPublique

Entretien EDL

Renvoie les données sur la maintenance effectuée sur les EDL, y compris l'observation enregistrée lors de chaque maintenance.

Remplace/api/getmunicipalityedlvisitspublic. Les EDL reçoivent de l'entretien, pas des visites - les champs sont passés de edl_visit_* à edl_maintenance_*. L'ancienne URL continue de fonctionner et continue de renvoyer les anciens noms, afin de ne pas interrompre les intégrations en production, mais elle est interrompue.

Paramètres

NomTaperDescription
statestringCode d'état. Exemple: state=RJ.
municipalitystringNom de la commune. Exemple: municipality=Ponta Pora
countrystringNom du pays. Exemple: country=Brasil. En cas d'omission, cela implique "Brésil".
pageintPage de pagination (par défaut 1, maximum 100).

Exemple de demande

curl -G -d "municipality=Vista%20Alegre" \
  /fr-lu/api/getmunicipalityedlmaintenancepublic

curl -G -d "state=MS" \
  /fr-lu/api/getmunicipalityedlmaintenancepublic

Exemple de réponse

[
  {
    "edl_maintenance_id": 9021,
    "edl_id": 1832,
    "edl_maintenance_time_week": 7,
    "edl_maintenance_time_year": 2025,
    "edl_maintenance_datetime": "2025-02-11 09:20:00",
    "edl_maintenance_user_id": 348,
    "edl_maintenance_observation": "Sem foco encontrado no local.",
    "edl_maintenance_observation_id": 3,
    "edl_maintenance_water_level": 0.5,
    "edl_maintenance_lat": -7.123456,
    "edl_maintenance_lng": -34.845678,
    "edl_maintenance_municipality_id": 5007117,
    "edl_maintenance_region_id": 4,
    "edl_maintenance_state_id": 24,
    "edl_maintenance_country_id": 1,
    "edl_maintenance_date": "2025-02-11",
    "edl_maintenance_observation_name": "Sem foco",
    "edl_maintenance_observation_number": 3,
    "municipality": "Vista Alegre",
    "municipality_code": "5007117",
    "state_name": "Mato Grosso do Sul",
    "state_code": "MS"
  }
]
GET/api/getmunicipalityovitrapspublicPublique

Ovitraps enregistrés

Renvoie les données des ovitraps (points de surveillance des œufs) enregistrés par municipalité.

Paramètres

NomTaperDescription
statestringCode d'état. Exemple: state=RJ.
municipalitystringNom de la commune. Exemple: municipality=Ponta Pora
countrystringNom du pays. Exemple: country=Brasil. En cas d'omission, cela implique "Brésil".
pageintPage de pagination (par défaut 1, maximum 100).

Exemple de demande

curl -G -d "municipality=Vista%20Alegre" \
  /fr-lu/api/getmunicipalityovitrapspublic

curl -G -d "state=MS" \
  /fr-lu/api/getmunicipalityovitrapspublic

Exemple de réponse

[
  {
    "ovitrap_id": 4471,
    "ovitrap_group_id": "97",
    "ovitrap_datetime": "2025-01-20 14:32:10",
    "ovitrap_lat": -7.123456,
    "ovitrap_lng": -34.845678,
    "ovitrap_lat_lng_error": 0,
    "ovitrap_municipality_id": 5007117,
    "group_id": 12,
    "user_id": 348,
    "ovitrap_eggs_mean": 12.5,
    "ovitrap_block_id": 4521,
    "municipality": "Vista Alegre",
    "municipality_code": "5007117",
    "state_name": "Mato Grosso do Sul",
    "state_code": "MS"
  }
]
GET/api/getmunicipalityplacespublicPublique

Propriétés (places)

Renvoie les propriétés (points stratégiques et propriétés spéciales) enregistrées par commune.

Paramètres

NomTaperDescription
statestringCode d'état. Exemple: state=RJ.
municipalitystringNom de la commune. Exemple: municipality=Ponta Pora
countrystringNom du pays. Exemple: country=Brasil. En cas d'omission, cela implique "Brésil".
pageintPage de pagination (par défaut 1, maximum 100).

Exemple de demande

curl -G -d "municipality=Vista%20Alegre" \
  /fr-lu/api/getmunicipalityplacespublic

curl -G -d "state=MS" \
  /fr-lu/api/getmunicipalityplacespublic

Exemple de réponse

[
  {
    "place_id": 771,
    "user_id": 348,
    "place_address_district": "Centro",
    "place_address_sector": "Setor 04",
    "place_datetime": "2025-02-05 10:00:00",
    "place_address_lat": -7.123456,
    "place_address_lng": -34.845678,
    "place_municipality_id": 5007117,
    "place_region_id": 4,
    "place_state_id": 24,
    "place_country_id": 1,
    "place_type_id": 2,
    "place_name": "Ferro-velho Bom Preço",
    "place_coordinates": "[[-7.123, -34.845], [-7.124, -34.846]]",
    "place_subtype": 5,
    "place_area": 320.5,
    "municipality": "Vista Alegre",
    "municipality_code": "5007117",
    "state_name": "Mato Grosso do Sul",
    "state_code": "MS"
  }
]

Points de terminaison privés

Tous les points de terminaison ci-dessous nécessitent le paramètre key avec votre clé API.

GET/api/lastcountingPrivé

Derniers décomptes publiés

Renvoie les derniers décomptes publiés dans le cadre de la clé, avec le nombre d'œufs, les données ovitrap et l'utilisateur responsable.

Paramètres

NomTaperDescription
keystringVotre clé API. Définit la portée des décomptes renvoyés.
pageintPage de pagination (par défaut 1, maximum 100).
date_startdateDate de début pour filtrer les décomptes. Exemple: date_start=2025-01-01.
date_enddateDate de fin pour filtrer les décomptes. Exemple: date_end=2025-12-31.
Réponses spécifiques :
  • 400 — lorsqu'une des dates envoyées n'est pas au format YYYY-MM-DD. La réponse apporte la liste des champs invalides dans invalid_fields.

Exemple de demande

curl -G -d "key=KEY&page=1" \
  /fr-lu/api/lastcounting

Exemple de réponse

[
  {
    "state_name": "Minas Gerais",
    "state_code": "MG",
    "municipality": "Ponta Pora",
    "municipality_code": "5006606",
    "eggs": 42,
    "week": 3,
    "year": 2025,
    "time": "2025-01-20 14:32:10",
    "user": "Joao da Silva",
    "counting_id": 118342,
    "ovitrap_website_id": 981,
    "ovitrap_id": "97",
    "district": "Centro",
    "street": "Rua das Flores",
    "number": "123",
    "complement": "",
    "loc_inst": "",
    "sector": "Setor 04",
    "latitude": -7.000000,
    "longitude": -8.000000,
    "date": "2025-01-20",
    "date_collect": "2025-01-27"
  }
]
GET/api/getmunicipalityedlsPrivé

EDL enregistrées

Renvoie les données des EDL (points stratégiques visités périodiquement par les agents) dans la portée géographique de la clé. Le périmètre est automatiquement défini par le plan lié à la clé — communale, régionale, étatique ou nationale — et il n'est pas nécessaire d'informer la commune, l'état ou le pays dans la demande.

Paramètres

NomTaperDescription
keystringVotre clé API. Définit la portée géographique des EDL renvoyées.
pageintPage de pagination (par défaut 1, maximum 100).

Exemple de demande

curl -G -d "key=KEY&page=1" \
  /fr-lu/api/getmunicipalityedls

Exemple de réponse

[
  {
    "edl_id": 1832,
    "edl_group_id": "104",
    "edl_address_datetime": "2025-02-11 09:15:00",
    "edl_lat": -7.123456,
    "edl_lng": -34.845678,
    "edl_municipality_id": 5007117,
    "group_id": 12,
    "user_id": 348,
    "edl_responsable_agent": "João da Silva",
    "edl_block_group_id": "12",
    "edl_responsable_home": "Maria Souza",
    "edl_date": "2025-02-11",
    "edl_water_mean": 1.8,
    "municipality": "Vista Alegre",
    "municipality_code": "5007117",
    "state_name": "Mato Grosso do Sul",
    "state_code": "MS"
  }
]
GET/api/getmunicipalityedlvisitsPrivé

Entretien EDL

Attention : les champs de réponse de ce point de terminaison privé continuent avec le préfixe edl_visit_*. Seul le point de terminaison public équivalent a commencé à utiliser edl_maintenance_*.

Renvoie les données sur les visites effectuées aux EDL dans la portée géographique de la clé, y compris l'observation enregistrée lors de chaque visite. Le périmètre est automatiquement défini par le plan lié à la clé — communale, régionale, étatique ou nationale — et il n'est pas nécessaire d'informer la commune, l'état ou le pays dans la demande.

Paramètres

NomTaperDescription
keystringVotre clé API. Définit la portée géographique des visites retournées.
pageintPage de pagination (par défaut 1, maximum 100).

Exemple de demande

curl -G -d "key=KEY&page=1" \
  /fr-lu/api/getmunicipalityedlvisits

Exemple de réponse

[
  {
    "edl_visit_id": 9021,
    "edl_id": 1832,
    "edl_visit_time_week": 7,
    "edl_visit_time_year": 2025,
    "edl_visit_datetime": "2025-02-11 09:20:00",
    "edl_visit_user_id": 348,
    "edl_visit_observation": "Sem foco encontrado no local.",
    "edl_visit_observation_id": 3,
    "edl_visit_water_level": 0.5,
    "edl_visit_lat": -7.123456,
    "edl_visit_lng": -34.845678,
    "edl_visit_municipality_id": 5007117,
    "edl_visit_region_id": 4,
    "edl_visit_state_id": 24,
    "edl_visit_country_id": 1,
    "edl_visit_date": "2025-02-11",
    "edl_visit_observation_name": "Sem foco",
    "edl_visit_observation_number": 3,
    "municipality": "Vista Alegre",
    "municipality_code": "5007117",
    "state_name": "Mato Grosso do Sul",
    "state_code": "MS"
  }
]
GET/api/getmunicipalityblocksPrivé

Visitas em quarteirões

Renvoie des données sur les actions (visites de traitement) réalisées par îlots dans le périmètre géographique de la clé. Le périmètre est automatiquement défini par le plan lié à la clé — communale, régionale, étatique ou nationale — et il n'est pas nécessaire d'informer la commune, l'état ou le pays dans la demande.

Paramètres

NomTaperDescription
keystringVotre clé API. Définit la portée géographique des actions renvoyées.
pageintPage de pagination (par défaut 1, maximum 100).

Exemple de demande

curl -G -d "key=KEY&page=1" \
  /fr-lu/api/getmunicipalityblocks

Exemple de réponse

[
  {
    "block_id": 4521,
    "block_actions_mean": 3.4,
    "block_coordinates": "[[-7.123, -34.845], [-7.124, -34.846]]",
    "municipality": "Vista Alegre",
    "municipality_code": "5007117",
    "state_name": "Mato Grosso do Sul",
    "state_code": "MS",
    "action_land_total_total": 21,
    "action_land_residence_total": 10,
    "action_land_commercial_total": 5,
    "action_land_empty_total": 3,
    "action_land_strategy_total": 1,
    "action_land_another_total": 2,
    "action_address_district": "Centro",
    "action_address_sector": "Setor 04",
    "action_deposit_a1_quantity": 4,
    "action_deposit_a2_quantity": 2,
    "action_deposit_b_quantity": 5,
    "action_deposit_c_quantity": 1,
    "action_deposit_d1_quantity": 0,
    "action_deposit_d2_quantity": 3,
    "action_deposit_e_quantity": 0,
    "action_observation": "Foco encontrado em pneus nos fundos do imovel.",
    "latitude": -7.123456,
    "longitude": -34.845678
  }
]
GET/api/getmunicipalityovitrapsPrivé

Ovitraps enregistrés

Renvoie les données des ovitraps (points de surveillance des œufs) dans la portée géographique de la clé. Le périmètre est automatiquement défini par le plan lié à la clé — communale, régionale, étatique ou nationale — et il n'est pas nécessaire d'informer la commune, l'état ou le pays dans la demande.

Paramètres

NomTaperDescription
keystringVotre clé API. Définit la portée géographique des ovitraps renvoyés.
pageintPage de pagination (par défaut 1, maximum 100).

Exemple de demande

curl -G -d "key=KEY&page=1" \
  /fr-lu/api/getmunicipalityovitraps

Exemple de réponse

[
  {
    "ovitrap_id": 4471,
    "ovitrap_group_id": "97",
    "ovitrap_datetime": "2025-01-20 14:32:10",
    "ovitrap_lat": -7.123456,
    "ovitrap_lng": -34.845678,
    "ovitrap_lat_lng_error": 0,
    "ovitrap_municipality_id": 5007117,
    "group_id": 12,
    "user_id": 348,
    "ovitrap_eggs_mean": 12.5,
    "ovitrap_block_id": 4521,
    "municipality": "Vista Alegre",
    "municipality_code": "5007117",
    "state_name": "Mato Grosso do Sul",
    "state_code": "MS"
  }
]
GET/api/getmunicipalityplacesPrivé

Propriétés (places)

Renvoie les propriétés (points stratégiques et propriétés spéciales) dans le périmètre géographique de la clé. Le périmètre est défini automatiquement par le forfait lié à la clé — communal, régional, étatique ou national — il n'est donc pas nécessaire d'indiquer la commune, l'État ou le pays dans la requête.

Paramètres

NomTaperDescription
keystringVotre clé API. Définit la portée géographique des points renvoyés.
pageintPage de pagination (par défaut 1, maximum 100).

Exemple de demande

curl -G -d "key=KEY&page=1" \
  /fr-lu/api/getmunicipalityplaces

Exemple de réponse

[
  {
    "place_id": 771,
    "user_id": 348,
    "place_address_district": "Centro",
    "place_address_sector": "Setor 04",
    "place_datetime": "2025-02-05 10:00:00",
    "place_address_lat": -7.123456,
    "place_address_lng": -34.845678,
    "place_municipality_id": 5007117,
    "place_region_id": 4,
    "place_state_id": 24,
    "place_country_id": 1,
    "place_type_id": 2,
    "place_name": "Ferro-velho Bom Preço",
    "place_coordinates": "[[-7.123, -34.845], [-7.124, -34.846]]",
    "place_subtype": 5,
    "place_area": 320.5,
    "municipality": "Vista Alegre",
    "municipality_code": "5007117",
    "state_name": "Mato Grosso do Sul",
    "state_code": "MS"
  }
]
POST/api/postcountingPrivé

Lire la soumission

Envoie la lecture d'un ovitrap. Il est possible d'envoyer des données à un ovitrap existant ou d'envoyer les données et d'installer un nouvel ovitrap en même temps.

Paramètres

NomTaperDescription
keystringVotre clé API. Définit la portée de la soumission.

Exemple de demande

curl -X POST \
  "/fr-lu/api/postcounting?key=KEY"

Pour une expédition standard, où il n'est pas nécessaire d'installer un nouvel ovitrap, envoyez les champs suivants (tout est obligatoire) dans le corps de la demande (form):

{
  "ovitrap_group_id": 97,
  "ovitrap_lat": -7.000000,
  "ovitrap_lng": -8.000000,
  "date": "2025-01-20",
  "counting_observation_id": 1,
  "counting_observation": "caso o counting_observation_id seja 9",
  "counting_eggs": 5
}

Tableau avec les identifiants de chaque type d'observation (counting_observation_id):

IDSignification
1Aucune observation
2Intervalle entre l'installation et la collecte plus long que prévu
3Ovitrap ou palette manquante
4Ovitrap ou palette cassée
5Ovitrap ou palette retirée
6Ovitrap sec
7Maison fermée
8Ovitrap rempli d'eau
9Ovitrap avec peu d'eau
10Une autre observation

Pour installer un nouvel ovitrap à côté de l'envoi, obligatoire les champs : ovitrap_lat, ovitrap_lng, ovitrap_group_id

{
  "ovitrap_group_id": 96,
  "ovitrap_address_district": "Distrito",
  "ovitrap_address_street": "Rua",
  "ovitrap_address_number": "Numero",
  "ovitrap_address_complement": "Complemento",
  "ovitrap_address_loc_inst": "",
  "ovitrap_lat": -7.000000,
  "ovitrap_lng": -8.000000,
  "ovitrap_address_sector": "Setor",
  "ovitrap_responsable": "Responsavel",
  "ovitrap_block_id": "Quarteirao",
  "ovitrap_type_id": 1,
  "date": "2025-01-20",
  "counting_date_collect": "2025-01-27",
  "counting_observation_id": 1,
  "counting_observation": "caso o counting_observation_id seja 9",
  "counting_eggs": 5
}

Tableau avec les identifiants de chaque type d'ovitrap (ovitrap_type_id): envoyer 1 à l’ovitrap urbain et 2 à l’ovitrap rural. Le champ est facultatif et, lorsqu'il n'est pas envoyé, l'ovitrap est installé comme urbain :

IDSignification
1Ovitrap urbain (standard)
2Ovitrap rural
Réponses spécifiques :
  • 400 — lorsqu'un des champs obligatoires n'est pas envoyé : ovitrap_lat, ovitrap_lng, ovitrap_group_id, date
  • 400 — quand le ovitrap_type_id envoyé n’est ni 1 ni 2.
  • 400 — lorsqu'une des dates envoyées n'est pas au format YYYY-MM-DD. La réponse apporte la liste des champs invalides dans invalid_fields.
  • 404 — Il existe déjà un décompte pour cet ovitrap, année et semaine.
POST/api/postdeletecountingPrivé

Supprimer la lecture

Supprime la lecture d'un ovitrap.

Paramètres

NomTaperDescription
keystringVotre clé API. Définit la portée de la suppression.

Exemple de demande

curl -X POST \
  "/fr-lu/api/postdeletecounting?key=KEY"

Données requises dans le corps de la demande (form):

{
  "ovitrap_group_id": 97,
  "date": "2025-01-20"
}
Réponses spécifiques :
  • 400 — quand date n'est pas envoyé.
  • 400 — lorsqu'une des dates envoyées n'est pas au format YYYY-MM-DD. La réponse apporte la liste des champs invalides dans invalid_fields.
POST/api/postdeleteovitrapPrivé

Supprimer l'ovitrap

Retirez un ovitrap.

Paramètres

NomTaperDescription
keystringVotre clé API.

Exemple de demande

curl -X POST \
  "/fr-lu/api/postdeleteovitrap?key=KEY"

Données requises dans le corps de la demande (form):

{
  "ovitrap_group_id": 97
}
POST/api/postactionPrivé

Insérer une visite

Enregistrez une visite/action dans un îlot. Pour ajouter la visite à un îlot existant, envoyez le champ block_id. S'il n'existe pas, utilisez block_group_id — le système créera automatiquement l'îlot. Ce point de terminaison permet uniquement l'insertion d'îlots situés dans la municipalité du demandeur.

Paramètres

NomTaperDescription
keystringVotre clé API.

Exemple de demande

curl -X POST \
  "/fr-lu/api/postaction?key=KEY"

Données envoyées form ou des paramètres de requête, en utilisant block_id:

{
  "block_id": 97,
  "date": "2025-01-20",
  "block_land_residence": 10,
  "action_land_residence_out": 2,
  "action_land_residence_breedings": 1,
  "action_land_residence_treated": 1,

  "block_land_commercial": 5,
  "action_land_commercial_out": 0,
  "action_land_commercial_breedings": 0,
  "action_land_commercial_treated": 0,

  "block_land_empty": 3,
  "action_land_empty_out": 1,
  "action_land_empty_breedings": 2,
  "action_land_empty_treated": 1,

  "block_land_strategy": 1,
  "action_land_strategy_out": 0,
  "action_land_strategy_breedings": 0,
  "action_land_strategy_treated": 0,

  "block_land_special": 0,
  "action_land_special_out": 0,
  "action_land_special_breedings": 0,
  "action_land_special_treated": 0,

  "block_land_another": 2,
  "action_land_another_out": 0,
  "action_land_another_breedings": 0,
  "action_land_another_treated": 0,

  "action_deposit_a1_quantity": 4,
  "action_deposit_a1_eliminated": 2,
  "action_deposit_a1_treated": 1,
  "action_deposit_a1_larvicid": 10,

  "action_deposit_a2_quantity": 2,
  "action_deposit_a2_eliminated": 1,
  "action_deposit_a2_treated": 0,
  "action_deposit_a2_larvicid": 0,

  "action_deposit_b_quantity": 5,
  "action_deposit_b_eliminated": 5,
  "action_deposit_b_treated": 0,
  "action_deposit_b_larvicid": 0,

  "action_deposit_c_quantity": 1,
  "action_deposit_c_eliminated": 0,
  "action_deposit_c_treated": 1,
  "action_deposit_c_larvicid": 5,

  "action_deposit_d1_quantity": 0,
  "action_deposit_d1_eliminated": 0,
  "action_deposit_d1_treated": 0,
  "action_deposit_d1_larvicid": 0,

  "action_deposit_d2_quantity": 3,
  "action_deposit_d2_eliminated": 1,
  "action_deposit_d2_treated": 2,
  "action_deposit_d2_larvicid": 15,

  "action_deposit_e_quantity": 0,
  "action_deposit_e_eliminated": 0,
  "action_deposit_e_treated": 0,
  "action_deposit_e_larvicid": 0,

  "action_observation": "Visita realizada conforme cronograma. Foco encontrado em pneus nos fundos do imovel."
}

Opter pour block_group_id (îlot pas encore enregistré), envoyez également les données de l'îlot lui-même :

{
  "block_group_id": 97,
  "date": "2025-01-20",
  "block_address_district": "Centro Historico",
  "block_address_sector": "Setor 04 - Norte",
  "block_coordinates": "[[-7.123, -34.845], [-7.124, -34.846]]",
  "block_lat": -7.123456,
  "block_lng": -34.845678,
  "block_responsable": "Joao da Silva",

  "block_land_residence": 10,
  "action_land_residence_out": 2,
  "action_land_residence_breedings": 1,
  "action_land_residence_treated": 1,

  "block_land_commercial": 5,
  "action_land_commercial_out": 0,
  "action_land_commercial_breedings": 0,
  "action_land_commercial_treated": 0,

  "block_land_empty": 3,
  "action_land_empty_out": 1,
  "action_land_empty_breedings": 2,
  "action_land_empty_treated": 1,

  "block_land_strategy": 1,
  "action_land_strategy_out": 0,
  "action_land_strategy_breedings": 0,
  "action_land_strategy_treated": 0,

  "block_land_special": 0,
  "action_land_special_out": 0,
  "action_land_special_breedings": 0,
  "action_land_special_treated": 0,

  "block_land_another": 2,
  "action_land_another_out": 0,
  "action_land_another_breedings": 0,
  "action_land_another_treated": 0,

  "action_deposit_a1_quantity": 4,
  "action_deposit_a1_eliminated": 2,
  "action_deposit_a1_treated": 1,
  "action_deposit_a1_larvicid": 10,

  "action_deposit_a2_quantity": 2,
  "action_deposit_a2_eliminated": 1,
  "action_deposit_a2_treated": 0,
  "action_deposit_a2_larvicid": 0,

  "action_deposit_b_quantity": 5,
  "action_deposit_b_eliminated": 5,
  "action_deposit_b_treated": 0,
  "action_deposit_b_larvicid": 0,

  "action_deposit_c_quantity": 1,
  "action_deposit_c_eliminated": 0,
  "action_deposit_c_treated": 1,
  "action_deposit_c_larvicid": 5,

  "action_deposit_d1_quantity": 0,
  "action_deposit_d1_eliminated": 0,
  "action_deposit_d1_treated": 0,
  "action_deposit_d1_larvicid": 0,

  "action_deposit_d2_quantity": 3,
  "action_deposit_d2_eliminated": 1,
  "action_deposit_d2_treated": 2,
  "action_deposit_d2_larvicid": 15,

  "action_deposit_e_quantity": 0,
  "action_deposit_e_eliminated": 0,
  "action_deposit_e_treated": 0,
  "action_deposit_e_larvicid": 0,

  "action_observation": "Area com alta densidade de recipientes descartaveis."
}
Réponses spécifiques :
  • 400 — quand date n’est pas envoyé ou lorsqu’un des champs numériques n’est pas un numéro valide.
  • 400 — lorsqu'une des dates envoyées n'est pas au format YYYY-MM-DD. La réponse apporte la liste des champs invalides dans invalid_fields.
  • 400 — quand block_group_id n'est pas envoyé lors de la création d'un nouvel îlot.
  • 403 — quand le block_id informé n'appartient pas à la commune clé.
  • 409 — lorsqu'il y a déjà une visite pour cet îlot, cette année et cette semaine.
POST/api/postdeleteactionPrivé

Supprimer la visite

Supprime une visite d'un îlot.

Paramètres

NomTaperDescription
keystringVotre clé API.

Exemple de demande

curl -X POST \
  "/fr-lu/api/postdeleteaction?key=KEY"

Données requises dans le corps de la demande (form):

{
  "block_group_id": 97,
  "date": "2025-01-20"
}
Réponses spécifiques :
  • 400 — quand date n'est pas envoyé.
  • 400 — lorsqu'une des dates envoyées n'est pas au format YYYY-MM-DD. La réponse apporte la liste des champs invalides dans invalid_fields.
POST/api/postdeleteblockPrivé

Supprimer l'îlot

Supprime un îlot.

Paramètres

NomTaperDescription
keystringVotre clé API.

Exemple de demande

curl -X POST \
  "/fr-lu/api/postdeleteblock?key=KEY"

Données requises dans le corps de la demande (form):

{
  "block_group_id": 97
}