All URIs are relative to https://api.mosquitoalert.com/v1
| Method | HTTP request | Description |
|---|---|---|
| list | GET /partners/ | |
| retrieve | GET /partners/{id}/ |
PaginatedPartnerList list(page = var.page, page_size = var.page_size)
library(MosquitoAlert)
# prepare function argument(s)
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)
api_instance <- mosquitoalert_api$new()
# Configure API key authorization: cookieAuth
api_instance$api_client$api_keys["sessionid"] <- Sys.getenv("API_KEY")
# Configure API key authorization: tokenAuth
# api_instance$api_client$api_keys["Authorization"] <- 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(page = var_page, page_size = var_page_sizedata_file = "result.txt")
result <- api_instance$partners_api$list(page = var_page, page_size = var_page_size)
dput(result)| Name | Type | Description | Notes |
|---|---|---|---|
| page | integer | A page number within the paginated result set. | [optional] |
| page_size | integer | Number of results to return per page. | [optional] |
cookieAuth, tokenAuth, jwtAuth
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 401 | - | |
| 403 | - | |
| 404 | - | |
| 200 | - |
Partner retrieve(id)
library(MosquitoAlert)
# prepare function argument(s)
var_id <- 56 # integer | A unique integer value identifying this organization pin.
api_instance <- mosquitoalert_api$new()
# Configure API key authorization: cookieAuth
api_instance$api_client$api_keys["sessionid"] <- Sys.getenv("API_KEY")
# Configure API key authorization: tokenAuth
# api_instance$api_client$api_keys["Authorization"] <- 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_iddata_file = "result.txt")
result <- api_instance$partners_api$retrieve(var_id)
dput(result)| Name | Type | Description | Notes |
|---|---|---|---|
| id | integer | A unique integer value identifying this organization pin. |
cookieAuth, tokenAuth, jwtAuth
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 401 | - | |
| 403 | - | |
| 404 | - | |
| 200 | - |