API Conta Ovos

Просматривайте и отправляйте данные о ловушках, кварталах и посещениях мест непосредственно из вашей системы. На этой странице описаны все доступные общедоступные и частные конечные точки.

/ru-ru/apiЗапросить ключ API

Об API

У этого API есть конечные точки общественные и частные. Публичный API возвращает данные о широте, долготе и количестве яиц для каждого участвующего муниципалитета с течением времени без необходимости аутентификации. Частный API рекомендуется использовать только для приложений, работающих в партнерстве с Conta Ovos, поскольку он предоставляет конфиденциальные данные и позволяет вставлять, изменять и удалять записи.

Аутентификация и ключи

Для использования частного API вам понадобится ключ доступа (key). Чтобы приобрести его, отправьте письмо на адрес contaovosdengue@gmail.com заявив:

  • Зачем вам нужен доступ к API;
  • Какой уровень доступа требуется (муниципальный, региональный, штатный или национальный);
  • Частью какого географического региона вы являетесь?

Ключ состоит из 45 случайных букв и должен быть отправлен в параметре key каждого частного запроса. Географический охват и план, связанные с ключевыми (api_access_municipality_id, state_id, region_id, country_id, plan) автоматически определяет, какие записи он может читать или изменять — например, муниципальный ключ может читать или изменять данные только самого муниципалитета.

Куда отправить ключ: a key всегда читается из строки запроса URL (?key=SUA_CHAVE), включая конечные точки POST. Отправка его только в теле формы приводит к 404 "Wrong key". Остальные поля POST продолжают появляться в теле запроса.
Пагинация: параметры page примите максимум 100 на конечных точках, поддерживающих пейджинг. Неверные или отсутствующие значения занимают страницу 1.

Коды ответа

Все конечные точки следуют одному и тому же шаблону состояния HTTP:

КодЗначение
200Запрос успешно обработан.
400Обязательный параметр отсутствует или имеет неверный формат.
403Сообщаемый ресурс не принадлежит области действия (город/штат/регион) используемого ключа.
404Неверный ключ (Wrong key) или ресурс не найден.
409Запись для этой комбинации идентификатора, года и недели уже существует.
500Внутренняя ошибка при обработке запроса.

Публичные конечные точки

GET/api/lastcountingpublicОбщественный

Количество последних выпущенных

Возвращает последние данные по местоположению (город, штат или страна), а также количество яиц и данные о яйцеловках.

Параметры

ИмяТипОписание
statestringКод штата. Пример: state=RJ.
municipalitystringНазвание муниципалитета. Пример: municipality=Ponta Pora
countrystringНазвание страны. Пример: country=Brasil. Если опущено, предполагается «Бразилия».
pageintСтраница нумерации страниц (по умолчанию 1, максимум 100).
idintОтображает только вхождения с заданным идентификатором. Пример: id=7876.
datedateОтображает события с даты включения. Пример: date=2025-01-01.
date_collectdateОтображает события, начиная с даты сбора данных. Пример: date_collect=2024-12-12.
date_startdateДата начала для фильтрации счетчиков. Пример: date_start=2025-01-01.
date_enddateДата окончания для фильтрации количества. Пример: date_end=2025-12-31.

Примечание: Если параметры местоположения не отправляются, конечная точка возвращает последние данные из Бразилии.

Конкретные ответы:
  • 400 — когда какая-либо из отправленных дат не соответствует формату YYYY-MM-DD. В ответ выводится список недопустимых полей в invalid_fields.

Пример запроса

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

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

Пример ответа

[
  {
    "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Общественный

Посещения в кварталах

Возвращает данные о посещениях (лечебных действиях), выполненных кварталами — по одной строке за посещение, а не за квартал.

Параметры

ИмяТипОписание
statestringКод штата. Пример: state=RJ.
municipalitystringНазвание муниципалитета. Пример: municipality=Ponta Pora
countrystringНазвание страны. Пример: country=Brasil. Если опущено, предполагается «Бразилия».
pageintСтраница нумерации страниц (по умолчанию 1, максимум 100).

Пример запроса

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

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

Пример ответа

[
  {
    "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Общественный

Зарегистрированные кварталы

Возвращает зарегистрированные в муниципалитете кварталы — по одной строке на квартал с указанием полигона, общего количества объектов недвижимости по типам и среднего количества долей.

Новая конечная точка. Если вы ищете посещения, выполненные кварталами, используйте /api/getmunicipalityblocksvisitpublic. Поскольку это общедоступная конечная точка, ответ не включает агента, ответственного за квартал, или идентификаторы пользователя/команды.

Параметры

ИмяТипОписание
statestringКод штата. Пример: state=RJ.
municipalitystringНазвание муниципалитета. Пример: municipality=Ponta Pora
countrystringНазвание страны. Пример: country=Brasil. Если опущено, предполагается «Бразилия».
pageintСтраница нумерации страниц (по умолчанию 1, максимум 100).

Пример запроса

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

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

Пример ответа

[
  {
    "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Общественный

Зарегистрированные EDL

Возвращает данные из EDL (стратегических точек, которые получают периодическое обслуживание от агентов), зарегистрированных муниципалитетом.

Параметры

ИмяТипОписание
statestringКод штата. Пример: state=RJ.
municipalitystringНазвание муниципалитета. Пример: municipality=Ponta Pora
countrystringНазвание страны. Пример: country=Brasil. Если опущено, предполагается «Бразилия».
pageintСтраница нумерации страниц (по умолчанию 1, максимум 100).

Пример запроса

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

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

Пример ответа

[
  {
    "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Общественный

Техническое обслуживание EDL

Возвращает данные о техническом обслуживании, выполненном на EDL, включая наблюдения, записанные во время каждого обслуживания.

Заменяет/api/getmunicipalityedlvisitspublic. EDL получают обслуживание, а не посещения — поля ушли из edl_visit_* к edl_maintenance_*. Старый URL продолжает работать и продолжает возвращать старые имена, чтобы не нарушать интеграцию в продакшене, но он прекращен.

Параметры

ИмяТипОписание
statestringКод штата. Пример: state=RJ.
municipalitystringНазвание муниципалитета. Пример: municipality=Ponta Pora
countrystringНазвание страны. Пример: country=Brasil. Если опущено, предполагается «Бразилия».
pageintСтраница нумерации страниц (по умолчанию 1, максимум 100).

Пример запроса

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

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

Пример ответа

[
  {
    "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Общественный

Зарегистрированные яйцеловки

Возвращает данные из яйцеловок (точек мониторинга яиц), зарегистрированных муниципалитетом.

Параметры

ИмяТипОписание
statestringКод штата. Пример: state=RJ.
municipalitystringНазвание муниципалитета. Пример: municipality=Ponta Pora
countrystringНазвание страны. Пример: country=Brasil. Если опущено, предполагается «Бразилия».
pageintСтраница нумерации страниц (по умолчанию 1, максимум 100).

Пример запроса

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

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

Пример ответа

[
  {
    "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Общественный

Объекты (places)

Возвращает объекты (стратегические точки и особые объекты), зарегистрированные по муниципалитетам.

Параметры

ИмяТипОписание
statestringКод штата. Пример: state=RJ.
municipalitystringНазвание муниципалитета. Пример: municipality=Ponta Pora
countrystringНазвание страны. Пример: country=Brasil. Если опущено, предполагается «Бразилия».
pageintСтраница нумерации страниц (по умолчанию 1, максимум 100).

Пример запроса

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

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

Пример ответа

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

Частные конечные точки

Для всех конечных точек ниже требуется параметр key с вашим ключом API.

GET/api/lastcountingЧастный

Количество последних выпущенных

Возвращает последние данные о количестве яиц, выпущенных в рамках ключа, с указанием количества яиц, данных о ловушках и ответственного пользователя.

Параметры

ИмяТипОписание
keystringВаш API-ключ. Определяет область возвращаемых значений.
pageintСтраница нумерации страниц (по умолчанию 1, максимум 100).
date_startdateДата начала для фильтрации счетчиков. Пример: date_start=2025-01-01.
date_enddateДата окончания для фильтрации количества. Пример: date_end=2025-12-31.
Конкретные ответы:
  • 400 — когда какая-либо из отправленных дат не соответствует формату YYYY-MM-DD. В ответ выводится список недопустимых полей в invalid_fields.

Пример запроса

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

Пример ответа

[
  {
    "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/getmunicipalityedlsЧастный

Зарегистрированные EDL

Возвращает данные из EDL (стратегических точек, периодически посещаемых агентами) в пределах географической области действия ключа. Объем автоматически определяется планом, связанным с ключом — муниципальным, региональным, штатным или страновым — и нет необходимости информировать муниципалитет, штат или страну в запросе.

Параметры

ИмяТипОписание
keystringВаш API-ключ. Определяет географический охват возвращаемых EDL.
pageintСтраница нумерации страниц (по умолчанию 1, максимум 100).

Пример запроса

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

Пример ответа

[
  {
    "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/getmunicipalityedlvisitsЧастный

Техническое обслуживание EDL

Внимание: поля ответа от этой частной конечной точки продолжаются с префиксом edl_visit_*. Только эквивалентная общедоступная конечная точка начала использовать edl_maintenance_*.

Возвращает данные о посещениях EDL в пределах географического охвата ключа, включая наблюдения, записанные при каждом посещении. Объем автоматически определяется планом, связанным с ключом — муниципальным, региональным, штатным или страновым — и нет необходимости информировать муниципалитет, штат или страну в запросе.

Параметры

ИмяТипОписание
keystringВаш API-ключ. Определяет географический охват повторных посещений.
pageintСтраница нумерации страниц (по умолчанию 1, максимум 100).

Пример запроса

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

Пример ответа

[
  {
    "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/getmunicipalityblocksЧастный

Visitas em quarteirões

Возвращает данные о действиях (лечебных посещениях), выполненных в кварталах в пределах географического охвата ключа. Объем автоматически определяется планом, связанным с ключом — муниципальным, региональным, штатным или страновым — и нет необходимости информировать муниципалитет, штат или страну в запросе.

Параметры

ИмяТипОписание
keystringВаш API-ключ. Определяет географический охват возвращаемых действий.
pageintСтраница нумерации страниц (по умолчанию 1, максимум 100).

Пример запроса

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

Пример ответа

[
  {
    "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/getmunicipalityovitrapsЧастный

Зарегистрированные яйцеловки

Возвращает данные из яйцеловок (точек мониторинга яиц) в пределах географической области действия ключа. Объем автоматически определяется планом, связанным с ключом — муниципальным, региональным, штатным или страновым — и нет необходимости информировать муниципалитет, штат или страну в запросе.

Параметры

ИмяТипОписание
keystringВаш API-ключ. Устанавливает географический охват возвращаемых яйцеловок.
pageintСтраница нумерации страниц (по умолчанию 1, максимум 100).

Пример запроса

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

Пример ответа

[
  {
    "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/getmunicipalityplacesЧастный

Объекты (places)

Возвращает объекты (стратегические точки и особые объекты) в пределах географической области ключа. Область определяется автоматически планом, связанным с ключом — муниципальный, региональный, уровня штата или страны — поэтому указывать муниципалитет, штат или страну в запросе не нужно.

Параметры

ИмяТипОписание
keystringВаш API-ключ. Определяет географический охват возвращаемых точек.
pageintСтраница нумерации страниц (по умолчанию 1, максимум 100).

Пример запроса

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

Пример ответа

[
  {
    "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/postcountingЧастный

Прочитать отправленное

Отправляет чтение яйцеловки. Можно отправить данные в существующую яйцеловку или одновременно отправить данные и установить новую яйцеловку.

Параметры

ИмяТипОписание
keystringВаш API-ключ. Определяет объем представления.

Пример запроса

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

Для стандартной доставки, при которой нет необходимости устанавливать новый яйцеловитель, отправьте следующие поля: (все обязательно) в теле запроса (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
}

Таблица с идентификаторами каждого типа наблюдения (counting_observation_id):

IDЗначение
1Нет замечаний
2Интервал между установкой и сбором дольше, чем ожидалось.
3Яйцеловка или недостающая палитра
4Яйцеловка или сломанная палитра
5Яйцеварка или палитра удалены
6Сухая яйцеловка
7Закрытый дом
8Яйцеловушка, наполненная водой
9Яйцеловушка с небольшим количеством воды
10Еще одно наблюдение

Чтобы установить новую яйцеловку рядом с грузом, обязательный поля: 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
}

Таблица с идентификаторами каждого типа яйцеловок (ovitrap_type_id): отправить 1 в городскую яйцеловку и 2 в сельскую яйцеловку. Поле является необязательным и, если оно не отправлено, яйцеловушка устанавливается как городская:

IDЗначение
1Городская яйцеловка (стандартный)
2Сельская яйцеловка
Конкретные ответы:
  • 400 — когда не отправлено ни одно из обязательных полей: ovitrap_lat, ovitrap_lng, ovitrap_group_id, date
  • 400 — когда ovitrap_type_id отправлено не 1 и не 2.
  • 400 — когда какая-либо из отправленных дат не соответствует формату YYYY-MM-DD. В ответ выводится список недопустимых полей в invalid_fields.
  • 404 — Этой яйцеловке уже есть счет, год и неделя.
POST/api/postdeletecountingЧастный

Удалить чтение

Удаляет чтение из яйцеловки.

Параметры

ИмяТипОписание
keystringВаш API-ключ. Определяет объем удаления.

Пример запроса

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

Данные, необходимые в теле запроса (form):

{
  "ovitrap_group_id": 97,
  "date": "2025-01-20"
}
Конкретные ответы:
  • 400 — когда date не отправляется.
  • 400 — когда какая-либо из отправленных дат не соответствует формату YYYY-MM-DD. В ответ выводится список недопустимых полей в invalid_fields.
POST/api/postdeleteovitrapЧастный

Удалить яйцеловку

Удалить яйцеловку.

Параметры

ИмяТипОписание
keystringВаш API-ключ.

Пример запроса

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

Данные, необходимые в теле запроса (form):

{
  "ovitrap_group_id": 97
}
POST/api/postactionЧастный

Вставить визит

Зарегистрируйте посещение/действие в квартале. Чтобы добавить посещение в существующий квартал, отправьте поле block_id. Если он не существует, используйте block_group_id — система автоматически создаст квартал. Эта конечная точка позволяет вставлять только те кварталы, которые находятся в пределах муниципалитета заявителя.

Параметры

ИмяТипОписание
keystringВаш API-ключ.

Пример запроса

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

Данные отправлены form или параметры запроса, используя 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."
}

Выбор в пользу block_group_id (квартал еще не зарегистрирован), также отправьте данные самого квартала:

{
  "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."
}
Конкретные ответы:
  • 400 — когда date не отправляется или когда одно из числовых полей не является допустимым числом.
  • 400 — когда какая-либо из отправленных дат не соответствует формату YYYY-MM-DD. В ответ выводится список недопустимых полей в invalid_fields.
  • 400 — когда block_group_id не отправляется при создании нового квартала.
  • 403 — когда block_id информированный не принадлежит ключевому муниципалитету.
  • 409 — когда уже было посещение этого квартала, год и неделя.
POST/api/postdeleteactionЧастный

Удалить визит

Удаляет посещение из одного квартала.

Параметры

ИмяТипОписание
keystringВаш API-ключ.

Пример запроса

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

Данные, необходимые в теле запроса (form):

{
  "block_group_id": 97,
  "date": "2025-01-20"
}
Конкретные ответы:
  • 400 — когда date не отправляется.
  • 400 — когда какая-либо из отправленных дат не соответствует формату YYYY-MM-DD. В ответ выводится список недопустимых полей в invalid_fields.
POST/api/postdeleteblockЧастный

Удалить квартал

Удаляет квартал.

Параметры

ИмяТипОписание
keystringВаш API-ключ.

Пример запроса

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

Данные, необходимые в теле запроса (form):

{
  "block_group_id": 97
}