Skip to content

Latest commit

 

History

History
349 lines (241 loc) · 10.7 KB

PhotosApi.md

File metadata and controls

349 lines (241 loc) · 10.7 KB

mosquito_alert.PhotosApi

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

Method HTTP request Description
prediction_create POST /photos/{uuid}/prediction/
prediction_destroy DELETE /photos/{uuid}/prediction/
prediction_retrieve GET /photos/{uuid}/prediction/
retrieve GET /photos/{uuid}/

prediction_create

PhotoPrediction prediction_create(uuid, photo_prediction_request)

Example

  • Api Key Authentication (cookieAuth):
  • Api Key Authentication (tokenAuth):
import mosquito_alert
from mosquito_alert.models.photo_prediction import PhotoPrediction
from mosquito_alert.models.photo_prediction_request import PhotoPredictionRequest
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.PhotosApi(api_client)
    uuid = 'uuid_example' # str | 
    photo_prediction_request = mosquito_alert.PhotoPredictionRequest() # PhotoPredictionRequest | 

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

Parameters

Name Type Description Notes
uuid str
photo_prediction_request PhotoPredictionRequest

Return type

PhotoPrediction

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
400 -
401 -
403 -
404 -
200 -

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

prediction_destroy

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.PhotosApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        api_instance.prediction_destroy(uuid)
    except Exception as e:
        print("Exception when calling PhotosApi->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: application/json

HTTP response details

Status code Description Response headers
401 -
403 -
404 -
204 No response body -

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

prediction_retrieve

PhotoPrediction prediction_retrieve(uuid)

Example

  • Api Key Authentication (cookieAuth):
  • Api Key Authentication (tokenAuth):
import mosquito_alert
from mosquito_alert.models.photo_prediction import PhotoPrediction
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.PhotosApi(api_client)
    uuid = 'uuid_example' # str | 

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

Parameters

Name Type Description Notes
uuid str

Return type

PhotoPrediction

Authorization

cookieAuth, tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
401 -
403 -
404 -
200 -

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

retrieve

Photo retrieve(uuid)

Example

  • Api Key Authentication (cookieAuth):
  • Api Key Authentication (tokenAuth):
import mosquito_alert
from mosquito_alert.models.photo import Photo
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.PhotosApi(api_client)
    uuid = 'uuid_example' # str | 

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

Parameters

Name Type Description Notes
uuid str

Return type

Photo

Authorization

cookieAuth, tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
401 -
403 -
404 -
200 -

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