mosquito_alert.ObservationsApi

All URIs are relative to https://api.mosquitoalert.com/v1

Method	HTTP request	Description
observations_create	POST /observations/
observations_destroy	DELETE /observations/{uuid}/
observations_list	GET /observations/
observations_prediction_create	POST /observations/{uuid}/prediction/
observations_prediction_destroy	DELETE /observations/{uuid}/prediction/
observations_prediction_retrieve	GET /observations/{uuid}/prediction/
observations_retrieve	GET /observations/{uuid}/

observations_create

Observation observations_create(observation_request)

Example

Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):
Bearer (JWT) Authentication (jwtAuth):

import mosquito_alert
from mosquito_alert.models.observation import Observation
from mosquito_alert.models.observation_request import ObservationRequest
from mosquito_alert.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mosquitoalert.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = mosquito_alert.Configuration(
    host = "https://api.mosquitoalert.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwtAuth
configuration = mosquito_alert.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with mosquito_alert.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mosquito_alert.ObservationsApi(api_client)
    observation_request = mosquito_alert.ObservationRequest() # ObservationRequest | 

    try:
        api_response = api_instance.observations_create(observation_request)
        print("The response of ObservationsApi->observations_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObservationsApi->observations_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
observation_request	ObservationRequest

Return type

Observation

Authorization

cookieAuth, tokenAuth, jwtAuth

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

observations_destroy

observations_destroy(uuid)

Example

Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):
Bearer (JWT) Authentication (jwtAuth):

import mosquito_alert
from mosquito_alert.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mosquitoalert.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = mosquito_alert.Configuration(
    host = "https://api.mosquitoalert.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwtAuth
configuration = mosquito_alert.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with mosquito_alert.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mosquito_alert.ObservationsApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        api_instance.observations_destroy(uuid)
    except Exception as e:
        print("Exception when calling ObservationsApi->observations_destroy: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

void (empty response body)

Authorization

cookieAuth, tokenAuth, jwtAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No response body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

observations_list

PaginatedObservationList observations_list(created_at_after=created_at_after, created_at_before=created_at_before, has_photos=has_photos, has_prediction=has_prediction, has_predictions_all_photos=has_predictions_all_photos, location_country_id=location_country_id, location_nuts_2=location_nuts_2, location_nuts_3=location_nuts_3, order_by=order_by, page=page, page_size=page_size, received_at_after=received_at_after, received_at_before=received_at_before, short_id=short_id, updated_at_after=updated_at_after, updated_at_before=updated_at_before, user_uuid=user_uuid)

Example

Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):
Bearer (JWT) Authentication (jwtAuth):

import mosquito_alert
from mosquito_alert.models.paginated_observation_list import PaginatedObservationList
from mosquito_alert.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mosquitoalert.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = mosquito_alert.Configuration(
    host = "https://api.mosquitoalert.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwtAuth
configuration = mosquito_alert.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with mosquito_alert.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mosquito_alert.ObservationsApi(api_client)
    created_at_after = '2013-10-20T19:20:30+01:00' # datetime | Created at (optional)
    created_at_before = '2013-10-20T19:20:30+01:00' # datetime | Created at (optional)
    has_photos = True # bool | Has any photo (optional)
    has_prediction = True # bool | Filter observations that have an associated prediction. An observation is considered to have a prediction if a photo has been selected as reference to use the prediction from. (optional)
    has_predictions_all_photos = True # bool | Filters observations based on whether all associated photos have predictions. Set to True to include observations where every photo has a prediction; set to False to include observations where at least one photo is missing a prediction. (optional)
    location_country_id = 56 # int |  (optional)
    location_nuts_2 = 'location_nuts_2_example' # str |  (optional)
    location_nuts_3 = 'location_nuts_3_example' # str |  (optional)
    order_by = ['order_by_example'] # List[str] | Ordenamiento   (optional)
    page = 56 # int | A page number within the paginated result set. (optional)
    page_size = 56 # int | Number of results to return per page. (optional)
    received_at_after = '2013-10-20T19:20:30+01:00' # datetime | Received at (optional)
    received_at_before = '2013-10-20T19:20:30+01:00' # datetime | Received at (optional)
    short_id = 'short_id_example' # str | Short ID (optional)
    updated_at_after = '2013-10-20T19:20:30+01:00' # datetime | Update at (optional)
    updated_at_before = '2013-10-20T19:20:30+01:00' # datetime | Update at (optional)
    user_uuid = 'user_uuid_example' # str |  (optional)

    try:
        api_response = api_instance.observations_list(created_at_after=created_at_after, created_at_before=created_at_before, has_photos=has_photos, has_prediction=has_prediction, has_predictions_all_photos=has_predictions_all_photos, location_country_id=location_country_id, location_nuts_2=location_nuts_2, location_nuts_3=location_nuts_3, order_by=order_by, page=page, page_size=page_size, received_at_after=received_at_after, received_at_before=received_at_before, short_id=short_id, updated_at_after=updated_at_after, updated_at_before=updated_at_before, user_uuid=user_uuid)
        print("The response of ObservationsApi->observations_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObservationsApi->observations_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
created_at_after	datetime	Created at	[optional]
created_at_before	datetime	Created at	[optional]
has_photos	bool	Has any photo	[optional]
has_prediction	bool	Filter observations that have an associated prediction. An observation is considered to have a prediction if a photo has been selected as reference to use the prediction from.	[optional]
has_predictions_all_photos	bool	Filters observations based on whether all associated photos have predictions. Set to True to include observations where every photo has a prediction; set to False to include observations where at least one photo is missing a prediction.	[optional]
location_country_id	int		[optional]
location_nuts_2	str		[optional]
location_nuts_3	str		[optional]
order_by	List[str]	Ordenamiento	[optional]
page	int	A page number within the paginated result set.	[optional]
page_size	int	Number of results to return per page.	[optional]
received_at_after	datetime	Received at	[optional]
received_at_before	datetime	Received at	[optional]
short_id	str	Short ID	[optional]
updated_at_after	datetime	Update at	[optional]
updated_at_before	datetime	Update at	[optional]
user_uuid	str		[optional]

Return type

PaginatedObservationList

Authorization

cookieAuth, tokenAuth, jwtAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

observations_prediction_create

ObservationPrediction observations_prediction_create(uuid, observation_prediction_request)

Example

Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import mosquito_alert
from mosquito_alert.models.observation_prediction import ObservationPrediction
from mosquito_alert.models.observation_prediction_request import ObservationPredictionRequest
from mosquito_alert.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mosquitoalert.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = mosquito_alert.Configuration(
    host = "https://api.mosquitoalert.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with mosquito_alert.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mosquito_alert.ObservationsApi(api_client)
    uuid = 'uuid_example' # str | 
    observation_prediction_request = mosquito_alert.ObservationPredictionRequest() # ObservationPredictionRequest | 

    try:
        api_response = api_instance.observations_prediction_create(uuid, observation_prediction_request)
        print("The response of ObservationsApi->observations_prediction_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObservationsApi->observations_prediction_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str
observation_prediction_request	ObservationPredictionRequest

Return type

ObservationPrediction

Authorization

cookieAuth, tokenAuth

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

observations_prediction_destroy

observations_prediction_destroy(uuid)

Example

Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import mosquito_alert
from mosquito_alert.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mosquitoalert.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = mosquito_alert.Configuration(
    host = "https://api.mosquitoalert.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with mosquito_alert.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mosquito_alert.ObservationsApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        api_instance.observations_prediction_destroy(uuid)
    except Exception as e:
        print("Exception when calling ObservationsApi->observations_prediction_destroy: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

void (empty response body)

Authorization

cookieAuth, tokenAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No response body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

observations_prediction_retrieve

ObservationPrediction observations_prediction_retrieve(uuid)

Example

Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import mosquito_alert
from mosquito_alert.models.observation_prediction import ObservationPrediction
from mosquito_alert.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mosquitoalert.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = mosquito_alert.Configuration(
    host = "https://api.mosquitoalert.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with mosquito_alert.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mosquito_alert.ObservationsApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        api_response = api_instance.observations_prediction_retrieve(uuid)
        print("The response of ObservationsApi->observations_prediction_retrieve:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObservationsApi->observations_prediction_retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

ObservationPrediction

Authorization

cookieAuth, tokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

observations_retrieve

Observation observations_retrieve(uuid)

Example

Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):
Bearer (JWT) Authentication (jwtAuth):

import mosquito_alert
from mosquito_alert.models.observation import Observation
from mosquito_alert.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mosquitoalert.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = mosquito_alert.Configuration(
    host = "https://api.mosquitoalert.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwtAuth
configuration = mosquito_alert.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with mosquito_alert.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mosquito_alert.ObservationsApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        api_response = api_instance.observations_retrieve(uuid)
        print("The response of ObservationsApi->observations_retrieve:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObservationsApi->observations_retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	str

Return type

Observation

Authorization

cookieAuth, tokenAuth, jwtAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ObservationsApi.md

Latest commit

History

ObservationsApi.md

File metadata and controls

mosquito_alert.ObservationsApi

observations_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

observations_destroy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

observations_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

observations_prediction_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

observations_prediction_destroy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

observations_prediction_retrieve

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

observations_retrieve

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details