All URIs are relative to https://api.mosquitoalert.com/v1
| Method | HTTP request | Description |
|---|---|---|
| create | POST /breeding-sites/ | |
| destroy | DELETE /breeding-sites/{uuid}/ | |
| list | GET /breeding-sites/ | |
| list_mine | GET /me/breeding-sites/ | |
| retrieve | GET /breeding-sites/{uuid}/ |
BreedingSite create(created_at, sent_at, location, photos, note = var.note, tags = var.tags, site_type = var.site_type, has_water = var.has_water, in_public_area = var.in_public_area, has_near_mosquitoes = var.has_near_mosquitoes, has_larvae = var.has_larvae)
library(MosquitoAlert)
# prepare function argument(s)
var_created_at <- "created_at_example" # character |
var_sent_at <- "sent_at_example" # character |
var_location <- LocationRequest$new("auto", Location_point$new(123, 123)) # LocationRequest |
var_photos <- c(SimplePhotoRequest$new(123)) # array[SimplePhotoRequest] |
var_note <- "note_example" # character | Note user attached to report. (Optional)
var_tags <- c("inner_example") # array[character] | (Optional)
var_site_type <- "site_type_example" # character | Breeding site type. (Optional)
var_has_water <- "has_water_example" # character | Either if the user perceived water in the breeding site. (Optional)
var_in_public_area <- "in_public_area_example" # character | Either if the breeding site is found in a public area. (Optional)
var_has_near_mosquitoes <- "has_near_mosquitoes_example" # character | Either if the user perceived mosquitoes near the breeding site (less than 10 meters). (Optional)
var_has_larvae <- "has_larvae_example" # character | Either if the user perceived larvaes the breeding site. (Optional)
api_instance <- mosquitoalert_api$new()
# Configure API key authorization: tokenAuth
api_instance$api_client$api_keys["Authorization"] <- Sys.getenv("API_KEY")
# Configure API key authorization: cookieAuth
# api_instance$api_client$api_keys["sessionid"] <- Sys.getenv("API_KEY")
# Configure HTTP bearer authorization: jwtAuth
# api_instance$api_client$bearer_token <- Sys.getenv("BEARER_TOKEN")
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$create(var_created_at, var_sent_at, var_location, var_photos, note = var_note, tags = var_tags, site_type = var_site_type, has_water = var_has_water, in_public_area = var_in_public_area, has_near_mosquitoes = var_has_near_mosquitoes, has_larvae = var_has_larvaedata_file = "result.txt")
result <- api_instance$breeding_sites_api$create(var_created_at, var_sent_at, var_location, var_photos, note = var_note, tags = var_tags, site_type = var_site_type, has_water = var_has_water, in_public_area = var_in_public_area, has_near_mosquitoes = var_has_near_mosquitoes, has_larvae = var_has_larvae)
dput(result)| Name | Type | Description | Notes |
|---|---|---|---|
| created_at | character | ||
| sent_at | character | ||
| location | LocationRequest | ||
| photos | list( SimplePhotoRequest ) | ||
| note | character | Note user attached to report. | [optional] |
| tags | list( character ) | [optional] | |
| site_type | Enum [basin, bucket, fountain, small_container, storm_drain, well, other] | Breeding site type. | [optional] |
| has_water | character | Either if the user perceived water in the breeding site. | [optional] |
| in_public_area | character | Either if the breeding site is found in a public area. | [optional] |
| has_near_mosquitoes | character | Either if the user perceived mosquitoes near the breeding site (less than 10 meters). | [optional] |
| has_larvae | character | Either if the user perceived larvaes the breeding site. | [optional] |
tokenAuth, cookieAuth, jwtAuth
- Content-Type: multipart/form-data, application/x-www-form-urlencoded
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 400 | - | |
| 401 | - | |
| 403 | - | |
| 404 | - | |
| 201 | - |
destroy(uuid)
library(MosquitoAlert)
# prepare function argument(s)
var_uuid <- "uuid_example" # character |
api_instance <- mosquitoalert_api$new()
# Configure API key authorization: tokenAuth
api_instance$api_client$api_keys["Authorization"] <- Sys.getenv("API_KEY")
# Configure API key authorization: cookieAuth
# api_instance$api_client$api_keys["sessionid"] <- Sys.getenv("API_KEY")
# Configure HTTP bearer authorization: jwtAuth
# api_instance$api_client$bearer_token <- Sys.getenv("BEARER_TOKEN")
api_instance$breeding_sites_api$destroy(var_uuid)| Name | Type | Description | Notes |
|---|---|---|---|
| uuid | character |
void (empty response body)
tokenAuth, cookieAuth, jwtAuth
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 401 | - | |
| 403 | - | |
| 404 | - | |
| 204 | No response body | - |
PaginatedBreedingSiteList list(country_id = var.country_id, created_at_after = var.created_at_after, created_at_before = var.created_at_before, has_photos = var.has_photos, order_by = var.order_by, page = var.page, page_size = var.page_size, received_at_after = var.received_at_after, received_at_before = var.received_at_before, short_id = var.short_id, updated_at_after = var.updated_at_after, updated_at_before = var.updated_at_before, user_uuid = var.user_uuid)
library(MosquitoAlert)
# prepare function argument(s)
var_country_id <- 56 # integer | (Optional)
var_created_at_after <- "created_at_after_example" # character | Created at (Optional)
var_created_at_before <- "created_at_before_example" # character | Created at (Optional)
var_has_photos <- "has_photos_example" # character | Has any photo (Optional)
var_order_by <- c("-created_at") # array[character] | Ordenado (Optional)
var_page <- 56 # integer | A page number within the paginated result set. (Optional)
var_page_size <- 56 # integer | Number of results to return per page. (Optional)
var_received_at_after <- "received_at_after_example" # character | Received at (Optional)
var_received_at_before <- "received_at_before_example" # character | Received at (Optional)
var_short_id <- "short_id_example" # character | Short ID (Optional)
var_updated_at_after <- "updated_at_after_example" # character | Update at (Optional)
var_updated_at_before <- "updated_at_before_example" # character | Update at (Optional)
var_user_uuid <- "user_uuid_example" # character | (Optional)
api_instance <- mosquitoalert_api$new()
# Configure API key authorization: tokenAuth
api_instance$api_client$api_keys["Authorization"] <- Sys.getenv("API_KEY")
# Configure API key authorization: cookieAuth
# api_instance$api_client$api_keys["sessionid"] <- Sys.getenv("API_KEY")
# Configure HTTP bearer authorization: jwtAuth
# api_instance$api_client$bearer_token <- Sys.getenv("BEARER_TOKEN")
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$list(country_id = var_country_id, created_at_after = var_created_at_after, created_at_before = var_created_at_before, has_photos = var_has_photos, order_by = var_order_by, page = var_page, page_size = var_page_size, received_at_after = var_received_at_after, received_at_before = var_received_at_before, short_id = var_short_id, updated_at_after = var_updated_at_after, updated_at_before = var_updated_at_before, user_uuid = var_user_uuiddata_file = "result.txt")
result <- api_instance$breeding_sites_api$list(country_id = var_country_id, created_at_after = var_created_at_after, created_at_before = var_created_at_before, has_photos = var_has_photos, order_by = var_order_by, page = var_page, page_size = var_page_size, received_at_after = var_received_at_after, received_at_before = var_received_at_before, short_id = var_short_id, updated_at_after = var_updated_at_after, updated_at_before = var_updated_at_before, user_uuid = var_user_uuid)
dput(result)| Name | Type | Description | Notes |
|---|---|---|---|
| country_id | integer | [optional] | |
| created_at_after | character | Created at | [optional] |
| created_at_before | character | Created at | [optional] |
| has_photos | character | Has any photo | [optional] |
| order_by | Enum [-created_at, -received_at, created_at, received_at] | Ordenado | [optional] |
| page | integer | A page number within the paginated result set. | [optional] |
| page_size | integer | Number of results to return per page. | [optional] |
| received_at_after | character | Received at | [optional] |
| received_at_before | character | Received at | [optional] |
| short_id | character | Short ID | [optional] |
| updated_at_after | character | Update at | [optional] |
| updated_at_before | character | Update at | [optional] |
| user_uuid | character | [optional] |
tokenAuth, cookieAuth, jwtAuth
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 400 | - | |
| 401 | - | |
| 404 | - | |
| 200 | - |
PaginatedBreedingSiteList list_mine(country_id = var.country_id, created_at_after = var.created_at_after, created_at_before = var.created_at_before, has_photos = var.has_photos, order_by = var.order_by, page = var.page, page_size = var.page_size, received_at_after = var.received_at_after, received_at_before = var.received_at_before, short_id = var.short_id, updated_at_after = var.updated_at_after, updated_at_before = var.updated_at_before, user_uuid = var.user_uuid)
Get Current User's Breeding Sites
library(MosquitoAlert)
# prepare function argument(s)
var_country_id <- 56 # integer | (Optional)
var_created_at_after <- "created_at_after_example" # character | Created at (Optional)
var_created_at_before <- "created_at_before_example" # character | Created at (Optional)
var_has_photos <- "has_photos_example" # character | Has any photo (Optional)
var_order_by <- c("-created_at") # array[character] | Ordenado (Optional)
var_page <- 56 # integer | A page number within the paginated result set. (Optional)
var_page_size <- 56 # integer | Number of results to return per page. (Optional)
var_received_at_after <- "received_at_after_example" # character | Received at (Optional)
var_received_at_before <- "received_at_before_example" # character | Received at (Optional)
var_short_id <- "short_id_example" # character | Short ID (Optional)
var_updated_at_after <- "updated_at_after_example" # character | Update at (Optional)
var_updated_at_before <- "updated_at_before_example" # character | Update at (Optional)
var_user_uuid <- "user_uuid_example" # character | (Optional)
api_instance <- mosquitoalert_api$new()
# Configure HTTP bearer authorization: jwtAuth
api_instance$api_client$bearer_token <- Sys.getenv("BEARER_TOKEN")
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$list_mine(country_id = var_country_id, created_at_after = var_created_at_after, created_at_before = var_created_at_before, has_photos = var_has_photos, order_by = var_order_by, page = var_page, page_size = var_page_size, received_at_after = var_received_at_after, received_at_before = var_received_at_before, short_id = var_short_id, updated_at_after = var_updated_at_after, updated_at_before = var_updated_at_before, user_uuid = var_user_uuiddata_file = "result.txt")
result <- api_instance$breeding_sites_api$list_mine(country_id = var_country_id, created_at_after = var_created_at_after, created_at_before = var_created_at_before, has_photos = var_has_photos, order_by = var_order_by, page = var_page, page_size = var_page_size, received_at_after = var_received_at_after, received_at_before = var_received_at_before, short_id = var_short_id, updated_at_after = var_updated_at_after, updated_at_before = var_updated_at_before, user_uuid = var_user_uuid)
dput(result)| Name | Type | Description | Notes |
|---|---|---|---|
| country_id | integer | [optional] | |
| created_at_after | character | Created at | [optional] |
| created_at_before | character | Created at | [optional] |
| has_photos | character | Has any photo | [optional] |
| order_by | Enum [-created_at, -received_at, created_at, received_at] | Ordenado | [optional] |
| page | integer | A page number within the paginated result set. | [optional] |
| page_size | integer | Number of results to return per page. | [optional] |
| received_at_after | character | Received at | [optional] |
| received_at_before | character | Received at | [optional] |
| short_id | character | Short ID | [optional] |
| updated_at_after | character | Update at | [optional] |
| updated_at_before | character | Update at | [optional] |
| user_uuid | character | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 400 | - | |
| 401 | - | |
| 403 | - | |
| 404 | - | |
| 200 | - |
BreedingSite retrieve(uuid)
library(MosquitoAlert)
# prepare function argument(s)
var_uuid <- "uuid_example" # character |
api_instance <- mosquitoalert_api$new()
# Configure API key authorization: tokenAuth
api_instance$api_client$api_keys["Authorization"] <- Sys.getenv("API_KEY")
# Configure API key authorization: cookieAuth
# api_instance$api_client$api_keys["sessionid"] <- Sys.getenv("API_KEY")
# Configure HTTP bearer authorization: jwtAuth
# api_instance$api_client$bearer_token <- Sys.getenv("BEARER_TOKEN")
# to save the result into a file, simply add the optional `data_file` parameter, e.g.
# result <- api_instance$retrieve(var_uuiddata_file = "result.txt")
result <- api_instance$breeding_sites_api$retrieve(var_uuid)
dput(result)| Name | Type | Description | Notes |
|---|---|---|---|
| uuid | character |
tokenAuth, cookieAuth, jwtAuth
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 401 | - | |
| 404 | - | |
| 200 | - |