Conta-Ovos-API

Konsultieren und senden Sie Ovitrap-, Block- und Feldbesuchsdaten direkt von Ihrem System aus. Auf dieser Seite werden alle verfügbaren öffentlichen und privaten Endpunkte dokumentiert.

/de-at/apiAPI-Schlüssel anfordern

Über die API

Diese API verfügt über Endpunkte öffentlich und privat. Die öffentliche API gibt Daten zu Breitengrad, Längengrad und Anzahl der Eier für jede teilnehmende Gemeinde im Zeitverlauf zurück, ohne dass eine Authentifizierung erforderlich ist. Die private API wird nur für Anwendungen empfohlen, die mit Conta Ovos zusammenarbeiten, da sie vertrauliche Daten offenlegt und Ihnen das Einfügen, Ändern und Entfernen von Datensätzen ermöglicht.

Authentifizierung und Schlüssel

Um die private API nutzen zu können, benötigen Sie einen Zugriffsschlüssel (key). Um es zu kaufen, senden Sie eine E-Mail an contaovosdengue@gmail.com mit der Angabe:

  • Warum benötigen Sie API-Zugriff?
  • Welche Zugangsebene ist erforderlich (kommunal, regional, staatlich oder landesweit);
  • Zu welcher geografischen Region gehören Sie?

Der Schlüssel besteht aus 45 zufällige Buchstaben und muss im Parameter mitgesendet werden key jeder privaten Anfrage. Der mit dem Schlüssel verknüpfte geografische Geltungsbereich und Plan (api_access_municipality_id, state_id, region_id, country_id, plan) definiert automatisch, welche Datensätze es lesen oder ändern kann – ein Gemeindeschlüssel kann beispielsweise nur Daten der Gemeinde selbst lesen oder ändern.

Wohin soll der Schlüssel geschickt werden: a key wird immer aus der URL-Abfragezeichenfolge gelesen (?key=SUA_CHAVE), einschließlich POST-Endpunkte. Das Senden nur im Hauptteil des Formulars führt zu 404 "Wrong key". Die anderen POST-Felder erscheinen weiterhin im Anfragetext.
Pagination: die Parameter page Akzeptieren Sie maximal 100 auf Endpunkten, die Paging unterstützen. Ungültige oder fehlende Werte nehmen Seite 1 ein.

Antwortcodes

Alle Endpunkte folgen demselben HTTP-Statusmuster:

CodeBedeutung
200Anfrage erfolgreich bearbeitet.
400Obligatorischer Parameter fehlt oder hat ein ungültiges Format.
403Die informierte Ressource gehört nicht zum Geltungsbereich (Stadt/Bundesland/Region) des verwendeten Schlüssels.
404Ungültiger Schlüssel (Wrong key) oder Ressource nicht gefunden.
409Für diese Kombination aus Kennung, Jahr und Woche ist bereits ein Datensatz vorhanden.
500Interner Fehler bei der Verarbeitung der Anfrage.

Öffentliche Endpunkte

GET/api/lastcountingpublicÖffentlich

Zuletzt veröffentlichte Zählungen

Gibt die neuesten nach Standort (Stadt, Bundesland oder Land) veröffentlichten Zählungen mit der Anzahl der Eier und den Eileiterdaten zurück.

Parameter

NameTypBeschreibung
statestringLandescode. Beispiel: state=RJ.
municipalitystringName der Gemeinde. Beispiel: municipality=Ponta Pora
countrystringLändername. Beispiel: country=Brasil. Wenn weggelassen, wird von „Brasilien“ ausgegangen.
pageintPaginierungsseite (Standard 1, maximal 100).
idintZeigt nur Vorkommen der angegebenen ID an. Beispiel: id=7876.
datedateZeigt Vorkommen ab dem Datum der Aufnahme an. Beispiel: date=2025-01-01.
date_collectdateZeigt Vorkommnisse ab dem Abholdatum an. Beispiel: date_collect=2024-12-12.
date_startdateStartdatum zum Filtern der Zählungen. Beispiel: date_start=2025-01-01.
date_enddateEnddatum zum Filtern der Anzahl. Beispiel: date_end=2025-12-31.

Notiz: Wenn keine Standortparameter gesendet werden, gibt der Endpunkt die neuesten Zählungen aus Brasilien zurück.

Konkrete Antworten:
  • 400 — wenn einer der gesendeten Datumswerte nicht im Format vorliegt YYYY-MM-DD. Die Antwort bringt die Liste der ungültigen Felder ein invalid_fields.

Beispiel anfordern

curl -G -d "municipality=Ponta%20Pora" \
  /de-at/api/lastcountingpublic

curl -G -d "state=MG" \
  /de-at/api/lastcountingpublic

Beispielantwort

[
  {
    "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/getmunicipalityblocksvisitpublicÖffentlich

Besuche in Häuserblöcken

Gibt Daten zu Besuchen (Behandlungsmaßnahmen) zurück, die in Blöcken durchgeführt werden – eine Zeile pro Besuch, nicht pro Block.

Parameter

NameTypBeschreibung
statestringLandescode. Beispiel: state=RJ.
municipalitystringName der Gemeinde. Beispiel: municipality=Ponta Pora
countrystringLändername. Beispiel: country=Brasil. Wenn weggelassen, wird von „Brasilien“ ausgegangen.
pageintPaginierungsseite (Standard 1, maximal 100).

Beispiel anfordern

curl -G -d "municipality=Vista%20Alegre" \
  /de-at/api/getmunicipalityblocksvisitpublic

curl -G -d "state=MS" \
  /de-at/api/getmunicipalityblocksvisitpublic

Beispielantwort

[
  {
    "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-2Öffentlich

Registrierte Blöcke

Gibt die in der Gemeinde registrierten Blöcke zurück – eine Zeile pro Block, mit dem Polygon, der Gesamtzahl der Grundstücke nach Typ und der durchschnittlichen Anzahl der Anteile.

Neuer Endpunkt. Wenn Sie Besuche in Blöcken suchen, verwenden Sie /api/getmunicipalityblocksvisitpublic. Da es sich um einen öffentlichen Endpunkt handelt, enthält die Antwort nicht den für die Blockierung verantwortlichen Agenten oder Benutzer-/Team-IDs.

Parameter

NameTypBeschreibung
statestringLandescode. Beispiel: state=RJ.
municipalitystringName der Gemeinde. Beispiel: municipality=Ponta Pora
countrystringLändername. Beispiel: country=Brasil. Wenn weggelassen, wird von „Brasilien“ ausgegangen.
pageintPaginierungsseite (Standard 1, maximal 100).

Beispiel anfordern

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

curl -G -d "state=MT" \
  /de-at/api/getmunicipalityblockspublic-2

Beispielantwort

[
  {
    "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/getmunicipalityedlspublicÖffentlich

Registrierte EDLs

Gibt Daten von EDLs (strategischen Punkten, die regelmäßig von Agenten gewartet werden) zurück, die von der Gemeinde registriert wurden.

Parameter

NameTypBeschreibung
statestringLandescode. Beispiel: state=RJ.
municipalitystringName der Gemeinde. Beispiel: municipality=Ponta Pora
countrystringLändername. Beispiel: country=Brasil. Wenn weggelassen, wird von „Brasilien“ ausgegangen.
pageintPaginierungsseite (Standard 1, maximal 100).

Beispiel anfordern

curl -G -d "municipality=Vista%20Alegre" \
  /de-at/api/getmunicipalityedlspublic

curl -G -d "state=MS" \
  /de-at/api/getmunicipalityedlspublic

Beispielantwort

[
  {
    "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/getmunicipalityedlmaintenancepublicÖffentlich

EDL-Wartung

Gibt Daten zu den an den EDLs durchgeführten Wartungsarbeiten zurück, einschließlich der während jeder Wartung aufgezeichneten Beobachtungen.

Ersetzt/api/getmunicipalityedlvisitspublic. EDLs erhalten Wartung, keine Besuche – die Felder sind verschwunden edl_visit_* Zu edl_maintenance_*. Die alte URL funktioniert weiterhin und gibt weiterhin die alten Namen zurück, um Integrationen in der Produktion nicht zu unterbrechen, wird jedoch eingestellt.

Parameter

NameTypBeschreibung
statestringLandescode. Beispiel: state=RJ.
municipalitystringName der Gemeinde. Beispiel: municipality=Ponta Pora
countrystringLändername. Beispiel: country=Brasil. Wenn weggelassen, wird von „Brasilien“ ausgegangen.
pageintPaginierungsseite (Standard 1, maximal 100).

Beispiel anfordern

curl -G -d "municipality=Vista%20Alegre" \
  /de-at/api/getmunicipalityedlmaintenancepublic

curl -G -d "state=MS" \
  /de-at/api/getmunicipalityedlmaintenancepublic

Beispielantwort

[
  {
    "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/getmunicipalityovitrapspublicÖffentlich

Registrierte Ovitraps

Gibt Daten von Ovitraps (Eiüberwachungsstellen) zurück, die von der Gemeinde registriert wurden.

Parameter

NameTypBeschreibung
statestringLandescode. Beispiel: state=RJ.
municipalitystringName der Gemeinde. Beispiel: municipality=Ponta Pora
countrystringLändername. Beispiel: country=Brasil. Wenn weggelassen, wird von „Brasilien“ ausgegangen.
pageintPaginierungsseite (Standard 1, maximal 100).

Beispiel anfordern

curl -G -d "municipality=Vista%20Alegre" \
  /de-at/api/getmunicipalityovitrapspublic

curl -G -d "state=MS" \
  /de-at/api/getmunicipalityovitrapspublic

Beispielantwort

[
  {
    "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/getmunicipalityplacespublicÖffentlich

Immobilien (places)

Gibt die Immobilien (strategische Punkte und besondere Immobilien) pro Gemeinde zurück.

Parameter

NameTypBeschreibung
statestringLandescode. Beispiel: state=RJ.
municipalitystringName der Gemeinde. Beispiel: municipality=Ponta Pora
countrystringLändername. Beispiel: country=Brasil. Wenn weggelassen, wird von „Brasilien“ ausgegangen.
pageintPaginierungsseite (Standard 1, maximal 100).

Beispiel anfordern

curl -G -d "municipality=Vista%20Alegre" \
  /de-at/api/getmunicipalityplacespublic

curl -G -d "state=MS" \
  /de-at/api/getmunicipalityplacespublic

Beispielantwort

[
  {
    "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"
  }
]

Private Endpunkte

Alle unten aufgeführten Endpunkte erfordern den Parameter key mit Ihrem API-Schlüssel.

GET/api/lastcountingPrivat

Zuletzt veröffentlichte Zählungen

Gibt die letzten im Rahmen des Schlüssels freigegebenen Zählungen zurück, mit Anzahl der Eier, Ovitrap-Daten und dem verantwortlichen Benutzer.

Parameter

NameTypBeschreibung
keystringIhr API-Schlüssel. Definiert den Umfang der zurückgegebenen Zählungen.
pageintPaginierungsseite (Standard 1, maximal 100).
date_startdateStartdatum zum Filtern der Zählungen. Beispiel: date_start=2025-01-01.
date_enddateEnddatum zum Filtern der Anzahl. Beispiel: date_end=2025-12-31.
Konkrete Antworten:
  • 400 — wenn einer der gesendeten Datumswerte nicht im Format vorliegt YYYY-MM-DD. Die Antwort bringt die Liste der ungültigen Felder ein invalid_fields.

Beispiel anfordern

curl -G -d "key=KEY&page=1" \
  /de-at/api/lastcounting

Beispielantwort

[
  {
    "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/getmunicipalityedlsPrivat

Registrierte EDLs

Gibt Daten von EDLs (strategische Punkte, die Agenten regelmäßig besuchen) innerhalb des geografischen Geltungsbereichs des Schlüssels zurück. Der Geltungsbereich wird automatisch durch den mit dem Schlüssel verknüpften Plan definiert – Gemeinde, Region, Staat oder Land – und es ist nicht erforderlich, die Gemeinde, den Staat oder das Land in der Anfrage zu informieren.

Parameter

NameTypBeschreibung
keystringIhr API-Schlüssel. Definiert den geografischen Bereich der zurückgegebenen EDLs.
pageintPaginierungsseite (Standard 1, maximal 100).

Beispiel anfordern

curl -G -d "key=KEY&page=1" \
  /de-at/api/getmunicipalityedls

Beispielantwort

[
  {
    "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/getmunicipalityedlvisitsPrivat

EDL-Wartung

Achtung: Die Antwortfelder von diesem privaten Endpunkt werden mit dem Präfix fortgesetzt edl_visit_*. Nur der entsprechende öffentliche Endpunkt hat mit der Verwendung begonnen edl_maintenance_*.

Gibt Daten zu Besuchen bei EDLs innerhalb des geografischen Geltungsbereichs des Schlüssels zurück, einschließlich der bei jedem Besuch aufgezeichneten Beobachtungen. Der Geltungsbereich wird automatisch durch den mit dem Schlüssel verknüpften Plan definiert – Gemeinde, Region, Staat oder Land – und es ist nicht erforderlich, die Gemeinde, den Staat oder das Land in der Anfrage zu informieren.

Parameter

NameTypBeschreibung
keystringIhr API-Schlüssel. Definiert den geografischen Bereich der wiederkehrenden Besuche.
pageintPaginierungsseite (Standard 1, maximal 100).

Beispiel anfordern

curl -G -d "key=KEY&page=1" \
  /de-at/api/getmunicipalityedlvisits

Beispielantwort

[
  {
    "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/getmunicipalityblocksPrivat

Visitas em quarteirões

Gibt Daten zu Aktionen (Behandlungsbesuchen) zurück, die in Blöcken innerhalb des geografischen Bereichs des Schlüssels durchgeführt werden. Der Geltungsbereich wird automatisch durch den mit dem Schlüssel verknüpften Plan definiert – Gemeinde, Region, Staat oder Land – und es ist nicht erforderlich, die Gemeinde, den Staat oder das Land in der Anfrage zu informieren.

Parameter

NameTypBeschreibung
keystringIhr API-Schlüssel. Definiert den geografischen Bereich der zurückgegebenen Aktionen.
pageintPaginierungsseite (Standard 1, maximal 100).

Beispiel anfordern

curl -G -d "key=KEY&page=1" \
  /de-at/api/getmunicipalityblocks

Beispielantwort

[
  {
    "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/getmunicipalityovitrapsPrivat

Registrierte Ovitraps

Gibt Daten von Ovitraps (Eiüberwachungspunkten) innerhalb des geografischen Geltungsbereichs des Schlüssels zurück. Der Geltungsbereich wird automatisch durch den mit dem Schlüssel verknüpften Plan definiert – Gemeinde, Region, Staat oder Land – und es ist nicht erforderlich, die Gemeinde, den Staat oder das Land in der Anfrage zu informieren.

Parameter

NameTypBeschreibung
keystringIhr API-Schlüssel. Legt den geografischen Bereich der zurückgegebenen Ovitraps fest.
pageintPaginierungsseite (Standard 1, maximal 100).

Beispiel anfordern

curl -G -d "key=KEY&page=1" \
  /de-at/api/getmunicipalityovitraps

Beispielantwort

[
  {
    "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/getmunicipalityplacesPrivat

Immobilien (places)

Gibt die Immobilien (strategische Punkte und besondere Immobilien) im geografischen Bereich des Schlüssels zurück. Der Bereich wird automatisch durch den mit dem Schlüssel verknüpften Plan festgelegt — kommunal, regional, bundesstaatlich oder landesweit — daher müssen Gemeinde, Bundesstaat oder Land in der Anfrage nicht angegeben werden.

Parameter

NameTypBeschreibung
keystringIhr API-Schlüssel. Definiert den geografischen Bereich der zurückgegebenen Punkte.
pageintPaginierungsseite (Standard 1, maximal 100).

Beispiel anfordern

curl -G -d "key=KEY&page=1" \
  /de-at/api/getmunicipalityplaces

Beispielantwort

[
  {
    "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/postcountingPrivat

Einreichung lesen

Sendet den Messwert einer Ovitrap. Es ist möglich, Daten an eine bestehende Ovitrap zu senden oder die Daten zu senden und gleichzeitig eine neue Ovitrap zu installieren.

Parameter

NameTypBeschreibung
keystringIhr API-Schlüssel. Definiert den Umfang der Einreichung.

Beispiel anfordern

curl -X POST \
  "/de-at/api/postcounting?key=KEY"

Für den Standardversand, bei dem die Installation einer neuen Ovitrap nicht erforderlich ist, senden Sie die folgenden Felder (alles verpflichtend) im Hauptteil der Anfrage (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
}

Tabelle mit den IDs der einzelnen Beobachtungstypen (counting_observation_id):

IDBedeutung
1Keine Beobachtungen
2Abstand zwischen Installation und Abholung länger als erwartet
3Ovitrap oder fehlende Palette
4Ovitrap oder kaputte Palette
5Ovitrap oder Palette entfernt
6Trockene Eileiter
7Geschlossenes Haus
8Mit Wasser gefüllte Ovitrap
9Ovitrap mit wenig Wasser
10Noch eine Beobachtung

Um eine neue Ovitrap neben der Sendung zu installieren, obligatorisch die Felder: 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
}

Tabelle mit den IDs der einzelnen Ovitrap-Typen (ovitrap_type_id): Senden Sie 1 an die städtische Ovitrap und 2 an die ländliche Ovitrap. Das Feld ist optional und wenn es nicht gesendet wird, wird die Ovitrap als urban installiert:

IDBedeutung
1Städtische Ovitraps (Standard)
2Ländliche Ovitrap
Konkrete Antworten:
  • 400 — wenn eines der Pflichtfelder nicht gesendet wird: ovitrap_lat, ovitrap_lng, ovitrap_group_id, date
  • 400 — wenn die ovitrap_type_id gesendet ist weder 1 noch 2.
  • 400 — wenn einer der gesendeten Datumswerte nicht im Format vorliegt YYYY-MM-DD. Die Antwort bringt die Liste der ungültigen Felder ein invalid_fields.
  • 404 — Für diese Ovitrap gibt es bereits eine Zählung, Jahr und Woche.
POST/api/postdeletecountingPrivat

Lesung löschen

Entfernt das Lesen von einer Ovitrap.

Parameter

NameTypBeschreibung
keystringIhr API-Schlüssel. Definiert den Umfang der Entfernung.

Beispiel anfordern

curl -X POST \
  "/de-at/api/postdeletecounting?key=KEY"

Im Hauptteil der Anfrage erforderliche Daten (form):

{
  "ovitrap_group_id": 97,
  "date": "2025-01-20"
}
Konkrete Antworten:
  • 400 — Wann date wird nicht gesendet.
  • 400 — wenn einer der gesendeten Datumswerte nicht im Format vorliegt YYYY-MM-DD. Die Antwort bringt die Liste der ungültigen Felder ein invalid_fields.
POST/api/postdeleteovitrapPrivat

Ovitraps löschen

Entfernen Sie eine Ovitrap.

Parameter

NameTypBeschreibung
keystringIhr API-Schlüssel.

Beispiel anfordern

curl -X POST \
  "/de-at/api/postdeleteovitrap?key=KEY"

Im Hauptteil der Anfrage erforderliche Daten (form):

{
  "ovitrap_group_id": 97
}
POST/api/postactionPrivat

Besuch einfügen

Registrieren Sie einen Besuch/eine Aktion in einem Block. Um den Besuch zu einem bestehenden Block hinzuzufügen, senden Sie das Feld block_id. Wenn es nicht existiert, verwenden Sie block_group_id — Das System erstellt den Block automatisch. Dieser Endpunkt ermöglicht nur das Einfügen von Blöcken, die innerhalb der Gemeinde des Antragstellers liegen.

Parameter

NameTypBeschreibung
keystringIhr API-Schlüssel.

Beispiel anfordern

curl -X POST \
  "/de-at/api/postaction?key=KEY"

Eingesandte Daten form oder Abfrageparameter verwenden 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."
}

Sich dafür entscheiden block_group_id (Block noch nicht registriert), senden Sie auch die Daten des Blocks selbst:

{
  "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."
}
Konkrete Antworten:
  • 400 — Wann date nicht gesendet wird oder wenn eines der numerischen Felder keine gültige Zahl ist.
  • 400 — wenn einer der gesendeten Datumswerte nicht im Format vorliegt YYYY-MM-DD. Die Antwort bringt die Liste der ungültigen Felder ein invalid_fields.
  • 400 — Wann block_group_id wird beim Erstellen eines neuen Blocks nicht gesendet.
  • 403 — wenn die block_id Die informierte Person gehört nicht zur Kerngemeinde.
  • 409 — wenn für diesen Block, dieses Jahr und diese Woche bereits ein Besuch vorliegt.
POST/api/postdeleteactionPrivat

Besuch löschen

Entfernt einen Besuch aus einem Block.

Parameter

NameTypBeschreibung
keystringIhr API-Schlüssel.

Beispiel anfordern

curl -X POST \
  "/de-at/api/postdeleteaction?key=KEY"

Im Hauptteil der Anfrage erforderliche Daten (form):

{
  "block_group_id": 97,
  "date": "2025-01-20"
}
Konkrete Antworten:
  • 400 — Wann date wird nicht gesendet.
  • 400 — wenn einer der gesendeten Datumswerte nicht im Format vorliegt YYYY-MM-DD. Die Antwort bringt die Liste der ungültigen Felder ein invalid_fields.
POST/api/postdeleteblockPrivat

Block löschen

Entfernt einen Block.

Parameter

NameTypBeschreibung
keystringIhr API-Schlüssel.

Beispiel anfordern

curl -X POST \
  "/de-at/api/postdeleteblock?key=KEY"

Im Hauptteil der Anfrage erforderliche Daten (form):

{
  "block_group_id": 97
}