Skip to content

Latest commit

 

History

History
324 lines (243 loc) · 13.5 KB

BreedingSitesApi.md

File metadata and controls

324 lines (243 loc) · 13.5 KB

mosquito_alert.api.BreedingSitesApi

Load the API package

import 'package:mosquito_alert/api.dart';

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/
listMine GET /me/breeding-sites/
retrieve GET /breeding-sites/{uuid}/

create

BreedingSite create(createdAt, sentAt, location, photos, note, tags, siteType, hasWater, inPublicArea, hasNearMosquitoes, hasLarvae)

Example

import 'package:mosquito_alert/api.dart';
// TODO Configure API key authorization: tokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('tokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('tokenAuth').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

final api = MosquitoAlert().getBreedingSitesApi();
final DateTime createdAt = 2013-10-20T19:20:30+01:00; // DateTime | 
final DateTime sentAt = 2013-10-20T19:20:30+01:00; // DateTime | 
final LocationRequest location = ; // LocationRequest | 
final BuiltList<SimplePhotoRequest> photos = ; // BuiltList<SimplePhotoRequest> | 
final String note = note_example; // String | Note user attached to report.
final BuiltList<String> tags = ; // BuiltList<String> | 
final String siteType = siteType_example; // String | Breeding site type.
final bool hasWater = true; // bool | Either if the user perceived water in the breeding site.
final bool inPublicArea = true; // bool | Either if the breeding site is found in a public area.
final bool hasNearMosquitoes = true; // bool | Either if the user perceived mosquitoes near the breeding site (less than 10 meters).
final bool hasLarvae = true; // bool | Either if the user perceived larvaes the breeding site.

try {
    final response = api.create(createdAt, sentAt, location, photos, note, tags, siteType, hasWater, inPublicArea, hasNearMosquitoes, hasLarvae);
    print(response);
} catch on DioException (e) {
    print('Exception when calling BreedingSitesApi->create: $e\n');
}

Parameters

Name Type Description Notes
createdAt DateTime
sentAt DateTime
location LocationRequest
photos BuiltList<SimplePhotoRequest>
note String Note user attached to report. [optional]
tags BuiltList<String> [optional]
siteType String Breeding site type. [optional]
hasWater bool Either if the user perceived water in the breeding site. [optional]
inPublicArea bool Either if the breeding site is found in a public area. [optional]
hasNearMosquitoes bool Either if the user perceived mosquitoes near the breeding site (less than 10 meters). [optional]
hasLarvae bool Either if the user perceived larvaes the breeding site. [optional]

Return type

BreedingSite

Authorization

tokenAuth, cookieAuth, jwtAuth

HTTP request headers

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

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

destroy

destroy(uuid)

Example

import 'package:mosquito_alert/api.dart';
// TODO Configure API key authorization: tokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('tokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('tokenAuth').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

final api = MosquitoAlert().getBreedingSitesApi();
final String uuid = uuid_example; // String | 

try {
    api.destroy(uuid);
} catch on DioException (e) {
    print('Exception when calling BreedingSitesApi->destroy: $e\n');
}

Parameters

Name Type Description Notes
uuid String

Return type

void (empty response body)

Authorization

tokenAuth, cookieAuth, jwtAuth

HTTP request headers

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

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

list

PaginatedBreedingSiteList list(countryId, createdAtAfter, createdAtBefore, hasPhotos, orderBy, page, pageSize, receivedAtAfter, receivedAtBefore, shortId, updatedAtAfter, updatedAtBefore, userUuid)

Example

import 'package:mosquito_alert/api.dart';
// TODO Configure API key authorization: tokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('tokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('tokenAuth').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

final api = MosquitoAlert().getBreedingSitesApi();
final int countryId = 56; // int | 
final DateTime createdAtAfter = 2013-10-20T19:20:30+01:00; // DateTime | Created at
final DateTime createdAtBefore = 2013-10-20T19:20:30+01:00; // DateTime | Created at
final bool hasPhotos = true; // bool | Has any photo
final BuiltList<String> orderBy = ; // BuiltList<String> | Ordenado  
final int page = 56; // int | A page number within the paginated result set.
final int pageSize = 56; // int | Number of results to return per page.
final DateTime receivedAtAfter = 2013-10-20T19:20:30+01:00; // DateTime | Received at
final DateTime receivedAtBefore = 2013-10-20T19:20:30+01:00; // DateTime | Received at
final String shortId = shortId_example; // String | Short ID
final DateTime updatedAtAfter = 2013-10-20T19:20:30+01:00; // DateTime | Update at
final DateTime updatedAtBefore = 2013-10-20T19:20:30+01:00; // DateTime | Update at
final String userUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 

try {
    final response = api.list(countryId, createdAtAfter, createdAtBefore, hasPhotos, orderBy, page, pageSize, receivedAtAfter, receivedAtBefore, shortId, updatedAtAfter, updatedAtBefore, userUuid);
    print(response);
} catch on DioException (e) {
    print('Exception when calling BreedingSitesApi->list: $e\n');
}

Parameters

Name Type Description Notes
countryId int [optional]
createdAtAfter DateTime Created at [optional]
createdAtBefore DateTime Created at [optional]
hasPhotos bool Has any photo [optional]
orderBy BuiltList<String> Ordenado [optional]
page int A page number within the paginated result set. [optional]
pageSize int Number of results to return per page. [optional]
receivedAtAfter DateTime Received at [optional]
receivedAtBefore DateTime Received at [optional]
shortId String Short ID [optional]
updatedAtAfter DateTime Update at [optional]
updatedAtBefore DateTime Update at [optional]
userUuid String [optional]

Return type

PaginatedBreedingSiteList

Authorization

tokenAuth, cookieAuth, jwtAuth

HTTP request headers

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

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

listMine

PaginatedBreedingSiteList listMine(countryId, createdAtAfter, createdAtBefore, hasPhotos, orderBy, page, pageSize, receivedAtAfter, receivedAtBefore, shortId, updatedAtAfter, updatedAtBefore, userUuid)

Get Current User's Breeding Sites

Example

import 'package:mosquito_alert/api.dart';

final api = MosquitoAlert().getBreedingSitesApi();
final int countryId = 56; // int | 
final DateTime createdAtAfter = 2013-10-20T19:20:30+01:00; // DateTime | Created at
final DateTime createdAtBefore = 2013-10-20T19:20:30+01:00; // DateTime | Created at
final bool hasPhotos = true; // bool | Has any photo
final BuiltList<String> orderBy = ; // BuiltList<String> | Ordenado  
final int page = 56; // int | A page number within the paginated result set.
final int pageSize = 56; // int | Number of results to return per page.
final DateTime receivedAtAfter = 2013-10-20T19:20:30+01:00; // DateTime | Received at
final DateTime receivedAtBefore = 2013-10-20T19:20:30+01:00; // DateTime | Received at
final String shortId = shortId_example; // String | Short ID
final DateTime updatedAtAfter = 2013-10-20T19:20:30+01:00; // DateTime | Update at
final DateTime updatedAtBefore = 2013-10-20T19:20:30+01:00; // DateTime | Update at
final String userUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 

try {
    final response = api.listMine(countryId, createdAtAfter, createdAtBefore, hasPhotos, orderBy, page, pageSize, receivedAtAfter, receivedAtBefore, shortId, updatedAtAfter, updatedAtBefore, userUuid);
    print(response);
} catch on DioException (e) {
    print('Exception when calling BreedingSitesApi->listMine: $e\n');
}

Parameters

Name Type Description Notes
countryId int [optional]
createdAtAfter DateTime Created at [optional]
createdAtBefore DateTime Created at [optional]
hasPhotos bool Has any photo [optional]
orderBy BuiltList<String> Ordenado [optional]
page int A page number within the paginated result set. [optional]
pageSize int Number of results to return per page. [optional]
receivedAtAfter DateTime Received at [optional]
receivedAtBefore DateTime Received at [optional]
shortId String Short ID [optional]
updatedAtAfter DateTime Update at [optional]
updatedAtBefore DateTime Update at [optional]
userUuid String [optional]

Return type

PaginatedBreedingSiteList

Authorization

jwtAuth

HTTP request headers

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

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

retrieve

BreedingSite retrieve(uuid)

Example

import 'package:mosquito_alert/api.dart';
// TODO Configure API key authorization: tokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('tokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('tokenAuth').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

final api = MosquitoAlert().getBreedingSitesApi();
final String uuid = uuid_example; // String | 

try {
    final response = api.retrieve(uuid);
    print(response);
} catch on DioException (e) {
    print('Exception when calling BreedingSitesApi->retrieve: $e\n');
}

Parameters

Name Type Description Notes
uuid String

Return type

BreedingSite

Authorization

tokenAuth, cookieAuth, jwtAuth

HTTP request headers

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

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