API Conta Ovos

Consulte e envie dados de ovitrampas, quarteirões e visitas de campo diretamente do seu sistema. Esta página documenta todos os endpoints públicos e privados disponíveis.

/pt-pt/apiSolicitar chave de API

Sobre a API

Esta API possui endpoints públicos e privados. A API pública devolve dados de latitude, longitude e quantidade de ovos de cada município participante ao longo do tempo, sem necessidade de autenticação. A API privada é recomendada apenas para aplicativos que trabalham em parceria com o Conta Ovos, pois ela expõe dados sensíveis e permite inserir, alterar e remover registros.

Autenticação e chaves

Para utilizar a API privada você precisará de uma chave de acesso (key). Para adquiri-la, envie um e-mail para contaovosdengue@gmail.com informando:

  • Por que você precisa de acesso à API;
  • Qual o nível de acesso necessário (municipal, regional, estadual ou país);
  • De qual região geográfica você faz parte.

A chave é composta por 45 letras aleatórias e deve ser enviada no parâmetro key de cada requisição privada. O escopo geográfico e o plano vinculados à chave (api_access_municipality_id, state_id, region_id, country_id, plan) definem automaticamente quais registros ela pode ler ou alterar — uma chave municipal, por exemplo, só consegue ler ou modificar dados do próprio município.

Onde enviar a chave: a key é sempre lida da query string da URL (?key=SUA_CHAVE), inclusive nos endpoints POST. Enviá-la apenas no corpo do formulário resulta em 404 "Wrong key". Os demais campos do POST continuam indo no corpo da requisição.
Paginação: os parâmetros page aceitam no máximo 100 nos endpoints que suportam paginação. Valores inválidos ou ausentes assumem a página 1.

Códigos de resposta

Todos os endpoints seguem o mesmo padrão de status HTTP:

CódigoSignificado
200Requisição processada com sucesso.
400Parâmetro obrigatório ausente ou em formato inválido.
403O recurso informado não pertence ao escopo (município/estado/região) da chave utilizada.
404Chave inválida (Wrong key) ou recurso não encontrado.
409Já existe um registro para essa combinação de identificador, ano e semana.
500Erro interno ao processar a requisição.

Endpoints Públicos

GET/api/lastcountingpublicPúblico

Últimas contagens lançadas

Retorna as últimas contagens lançadas por localização (municipal, estadual ou país), com o número de ovos e os dados da ovitrampa.

Parâmetros

NomeTipoDescrição
statestringCódigo do estado. Exemplo: state=RJ.
municipalitystringNome do município. Exemplo: municipality=Ponta Pora
countrystringNome do país. Exemplo: country=Brasil. Se omitido, assume "Brasil".
pageintPágina de paginação (padrão 1, máximo 100).
idintExibe apenas ocorrências a partir do id informado. Exemplo: id=7876.
datedateExibe ocorrências a partir da data de inclusão. Exemplo: date=2025-01-01.
date_collectdateExibe ocorrências a partir da data de coleta. Exemplo: date_collect=2024-12-12.
date_startdateData inicial para filtrar as contagens. Exemplo: date_start=2025-01-01.
date_enddateData final para filtrar as contagens. Exemplo: date_end=2025-12-31.

Obs.: se nenhum parâmetro de localização for enviado, o endpoint devolve as últimas contagens do Brasil.

Respostas específicas:
  • 400 — quando alguma das datas enviadas não está no formato YYYY-MM-DD. A resposta traz a lista dos campos inválidos em invalid_fields.

Exemplo de requisição

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

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

Exemplo de resposta

[
  {
    "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/getmunicipalityblocksvisitpublicPúblico

Visitas em Quarteirões

Retorna os dados das visitas (ações de tratamento) realizadas em quarteirões — uma linha por visita, não por quarteirão.

Parâmetros

NomeTipoDescrição
statestringCódigo do estado. Exemplo: state=RJ.
municipalitystringNome do município. Exemplo: municipality=Ponta Pora
countrystringNome do país. Exemplo: country=Brasil. Se omitido, assume "Brasil".
pageintPágina de paginação (padrão 1, máximo 100).

Exemplo de requisição

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

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

Exemplo de resposta

[
  {
    "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-2Público

Quarteirões cadastrados

Retorna os quarteirões (blocks) cadastrados no município — uma linha por quarteirão, com o polígono, os totais de imóveis por tipo e a média de ações.

Endpoint novo. Se você procura as visitas realizadas em quarteirões, use /api/getmunicipalityblocksvisitpublic. Por ser um endpoint público, a resposta não inclui o agente responsável pelo quarteirão nem identificadores de usuário/equipe.

Parâmetros

NomeTipoDescrição
statestringCódigo do estado. Exemplo: state=RJ.
municipalitystringNome do município. Exemplo: municipality=Ponta Pora
countrystringNome do país. Exemplo: country=Brasil. Se omitido, assume "Brasil".
pageintPágina de paginação (padrão 1, máximo 100).

Exemplo de requisição

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

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

Exemplo de resposta

[
  {
    "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/getmunicipalityedlspublicPúblico

EDLs cadastrados

Retorna os dados dos EDLs (pontos estratégicos que recebem manutenção periódica dos agentes) cadastrados por município.

Parâmetros

NomeTipoDescrição
statestringCódigo do estado. Exemplo: state=RJ.
municipalitystringNome do município. Exemplo: municipality=Ponta Pora
countrystringNome do país. Exemplo: country=Brasil. Se omitido, assume "Brasil".
pageintPágina de paginação (padrão 1, máximo 100).

Exemplo de requisição

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

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

Exemplo de resposta

[
  {
    "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/getmunicipalityedlmaintenancepublicPúblico

Manutenções de EDLs

Retorna os dados das manutenções realizadas nos EDLs, incluindo a observação registrada em cada manutenção.

Substitui/api/getmunicipalityedlvisitspublic. EDLs recebem manutenções, não visitas — os campos passaram de edl_visit_* para edl_maintenance_*. A URL antiga continua funcionando e continua devolvendo os nomes antigos, para não quebrar integrações em produção, mas está descontinuada.

Parâmetros

NomeTipoDescrição
statestringCódigo do estado. Exemplo: state=RJ.
municipalitystringNome do município. Exemplo: municipality=Ponta Pora
countrystringNome do país. Exemplo: country=Brasil. Se omitido, assume "Brasil".
pageintPágina de paginação (padrão 1, máximo 100).

Exemplo de requisição

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

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

Exemplo de resposta

[
  {
    "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/getmunicipalityovitrapspublicPúblico

Ovitrampas cadastradas

Retorna os dados das ovitrampas (pontos de monitoramento de ovos) cadastradas por município.

Parâmetros

NomeTipoDescrição
statestringCódigo do estado. Exemplo: state=RJ.
municipalitystringNome do município. Exemplo: municipality=Ponta Pora
countrystringNome do país. Exemplo: country=Brasil. Se omitido, assume "Brasil".
pageintPágina de paginação (padrão 1, máximo 100).

Exemplo de requisição

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

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

Exemplo de resposta

[
  {
    "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/getmunicipalityplacespublicPúblico

Imóveis (places)

Retorna os imóveis (pontos estratégicos e imóveis especiais) cadastrados por município.

Parâmetros

NomeTipoDescrição
statestringCódigo do estado. Exemplo: state=RJ.
municipalitystringNome do município. Exemplo: municipality=Ponta Pora
countrystringNome do país. Exemplo: country=Brasil. Se omitido, assume "Brasil".
pageintPágina de paginação (padrão 1, máximo 100).

Exemplo de requisição

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

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

Exemplo de resposta

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

Endpoints Privados

Todos os endpoints abaixo exigem o parâmetro key com a sua chave de API.

GET/api/lastcountingPrivado

Últimas contagens lançadas

Retorna as últimas contagens lançadas dentro do escopo da chave, com número de ovos, dados da ovitrampa e o usuário responsável.

Parâmetros

NomeTipoDescrição
keystringSua chave de API. Define o escopo das contagens retornadas.
pageintPágina de paginação (padrão 1, máximo 100).
date_startdateData inicial para filtrar as contagens. Exemplo: date_start=2025-01-01.
date_enddateData final para filtrar as contagens. Exemplo: date_end=2025-12-31.
Respostas específicas:
  • 400 — quando alguma das datas enviadas não está no formato YYYY-MM-DD. A resposta traz a lista dos campos inválidos em invalid_fields.

Exemplo de requisição

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

Exemplo de resposta

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

EDLs cadastrados

Retorna os dados dos EDLs (pontos estratégicos visitados periodicamente pelos agentes) dentro do escopo geográfico da chave. O escopo é definido automaticamente pelo plano vinculado à chave — municipal, regional, estadual ou país — não sendo necessário informar município, estado ou país na requisição.

Parâmetros

NomeTipoDescrição
keystringSua chave de API. Define o escopo geográfico dos EDLs retornados.
pageintPágina de paginação (padrão 1, máximo 100).

Exemplo de requisição

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

Exemplo de resposta

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

Manutenções de EDLs

Atenção: os campos da resposta deste endpoint privado continuam com o prefixo edl_visit_*. Apenas o endpoint público equivalente passou a usar edl_maintenance_*.

Retorna os dados das visitas realizadas aos EDLs dentro do escopo geográfico da chave, incluindo a observação registrada em cada visita. O escopo é definido automaticamente pelo plano vinculado à chave — municipal, regional, estadual ou país — não sendo necessário informar município, estado ou país na requisição.

Parâmetros

NomeTipoDescrição
keystringSua chave de API. Define o escopo geográfico das visitas retornadas.
pageintPágina de paginação (padrão 1, máximo 100).

Exemplo de requisição

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

Exemplo de resposta

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

Visitas em quarteirões

Retorna os dados das ações (visitas de tratamento) realizadas em quarteirões dentro do escopo geográfico da chave. O escopo é definido automaticamente pelo plano vinculado à chave — municipal, regional, estadual ou país — não sendo necessário informar município, estado ou país na requisição.

Parâmetros

NomeTipoDescrição
keystringSua chave de API. Define o escopo geográfico das ações retornadas.
pageintPágina de paginação (padrão 1, máximo 100).

Exemplo de requisição

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

Exemplo de resposta

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

Ovitrampas cadastradas

Retorna os dados das ovitrampas (pontos de monitoramento de ovos) dentro do escopo geográfico da chave. O escopo é definido automaticamente pelo plano vinculado à chave — municipal, regional, estadual ou país — não sendo necessário informar município, estado ou país na requisição.

Parâmetros

NomeTipoDescrição
keystringSua chave de API. Define o escopo geográfico das ovitrampas retornadas.
pageintPágina de paginação (padrão 1, máximo 100).

Exemplo de requisição

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

Exemplo de resposta

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

Imóveis (places)

Retorna os imóveis (pontos estratégicos e imóveis especiais) dentro do escopo geográfico da chave. O escopo é definido automaticamente pelo plano vinculado à chave — municipal, regional, estadual ou país — não sendo necessário informar município, estado ou país na requisição.

Parâmetros

NomeTipoDescrição
keystringSua chave de API. Define o escopo geográfico dos pontos retornados.
pageintPágina de paginação (padrão 1, máximo 100).

Exemplo de requisição

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

Exemplo de resposta

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

Envio de leitura

Envia a leitura de uma ovitrampa. É possível enviar dados para uma ovitrampa já existente ou enviar os dados e instalar uma nova ovitrampa ao mesmo tempo.

Parâmetros

NomeTipoDescrição
keystringSua chave de API. Define o escopo do envio.

Exemplo de requisição

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

Para o envio padrão, onde não é preciso instalar uma nova ovitrampa, envie os seguintes campos (todos obrigatórios) no corpo da requisição (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
}

Tabela com os IDs de cada tipo de observação (counting_observation_id):

IDSignificado
1Sem observações
2Intervalo entre instalação e coleta maior que o previsto
3Ovitrampa ou paleta desaparecida
4Ovitrampa ou paleta quebrada
5Ovitrampa ou paleta removida
6Ovitrampa seca
7Casa fechada
8Ovitrampa cheia de água
9Ovitrampa com pouca água
10Outra observação

Para instalar uma nova ovitrampa junto do envio, são obrigatórios os campos: 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
}

Tabela com os IDs de cada tipo de ovitrampa (ovitrap_type_id): envie 1 para ovitrampa urbana e 2 para ovitrampa rural. O campo é opcional e, quando não enviado, a ovitrampa é instalada como urbana:

IDSignificado
1Ovitrampa urbana (padrão)
2Ovitrampa rural
Respostas específicas:
  • 400 — quando algum dos campos obrigatórios não é enviado: ovitrap_lat, ovitrap_lng, ovitrap_group_id, date
  • 400 — quando o ovitrap_type_id enviado não é 1 nem 2.
  • 400 — quando alguma das datas enviadas não está no formato YYYY-MM-DD. A resposta traz a lista dos campos inválidos em invalid_fields.
  • 404 — já existe uma contagem para essa ovitrampa, ano e semana.
POST/api/postdeletecountingPrivado

Deletar leitura

Remove a leitura de uma ovitrampa.

Parâmetros

NomeTipoDescrição
keystringSua chave de API. Define o escopo da remoção.

Exemplo de requisição

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

Dados necessários no corpo da requisição (form):

{
  "ovitrap_group_id": 97,
  "date": "2025-01-20"
}
Respostas específicas:
  • 400 — quando date não é enviado.
  • 400 — quando alguma das datas enviadas não está no formato YYYY-MM-DD. A resposta traz a lista dos campos inválidos em invalid_fields.
POST/api/postdeleteovitrapPrivado

Deletar ovitrampa

Remove uma ovitrampa.

Parâmetros

NomeTipoDescrição
keystringSua chave de API.

Exemplo de requisição

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

Dados necessários no corpo da requisição (form):

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

Inserir visita

Registra uma visita/ação em um quarteirão. Para adicionar a visita a um quarteirão já existente, envie o campo block_id. Caso ele não exista, use block_group_id — o sistema criará o quarteirão automaticamente. Este endpoint só permite a inserção de quarteirões que estejam dentro do município do solicitante.

Parâmetros

NomeTipoDescrição
keystringSua chave de API.

Exemplo de requisição

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

Dados enviados em form ou query parameters, usando 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."
}

Optando por block_group_id (quarteirão ainda não cadastrado), envie também os dados do próprio quarteirão:

{
  "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."
}
Respostas específicas:
  • 400 — quando date não é enviado ou quando um dos campos numéricos não é um número válido.
  • 400 — quando alguma das datas enviadas não está no formato YYYY-MM-DD. A resposta traz a lista dos campos inválidos em invalid_fields.
  • 400 — quando block_group_id não é enviado ao criar um novo quarteirão.
  • 403 — quando o block_id informado não pertence ao município da chave.
  • 409 — quando já existe uma visita para esse quarteirão, ano e semana.
POST/api/postdeleteactionPrivado

Deletar visita

Remove uma visita de um quarteirão.

Parâmetros

NomeTipoDescrição
keystringSua chave de API.

Exemplo de requisição

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

Dados necessários no corpo da requisição (form):

{
  "block_group_id": 97,
  "date": "2025-01-20"
}
Respostas específicas:
  • 400 — quando date não é enviado.
  • 400 — quando alguma das datas enviadas não está no formato YYYY-MM-DD. A resposta traz a lista dos campos inválidos em invalid_fields.
POST/api/postdeleteblockPrivado

Deletar quarteirão

Remove um quarteirão.

Parâmetros

NomeTipoDescrição
keystringSua chave de API.

Exemplo de requisição

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

Dados necessários no corpo da requisição (form):

{
  "block_group_id": 97
}