swagger

Register ### Register siterwell account first #### Account management - api/1/register ## Login ### Call login api to get token from response, and set token on the page top YOUR_TOKEN field then press explore button #### Account management - api/1/login ## Response Structure ### The Envelope Every response is contained by an envelope. That is, each response has a predictable set of keys with which you can expect to interact: json { \"status\": \"success\", \"message\": \".....\", \"results\": { ... } } ## Controller and Device ### Caps(Capability), Props(Property), Status The device management API will send/receive controller/device capability and property to communicate with backend server, and all supported json values are list below http://web.siterwell.co.uk/api/apiDoc.html ##

This Dart package is automatically generated by the Swagger Codegen project:

  • API version: 1.20.1.7
  • Build package: io.swagger.codegen.languages.DartClientCodegen

Requirements

Dart 1.20.0 or later OR Flutter 0.0.20 or later

Installation & Usage

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

name: swagger
version: 1.0.0
description: Swagger API client
dependencies:
  swagger:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      version: 'any'

Local

To use the package in your local drive, please include the following in pubspec.yaml

dependencies:
  swagger:
    path: /path/to/swagger

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:swagger/api.dart';

// TODO Configure API key authorization: Token
//swagger.api.Configuration.apiKey{'Bearer'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'Bearer'} = "Bearer";

var api_instance = new AccountManagementApi();
var type = type_example; // String | Upload file type
var file = /path/to/file.txt; // MultipartFile | file to upload

try {
    var result = api_instance.apiFileUploadPOST(type, file);
    print(result);
} catch (e) {
    print("Exception when calling AccountManagementApi->apiFileUploadPOST: $e\n");
}

Documentation for API Endpoints

All URIs are relative to https://api.siterwell.co.uk

ClassMethodHTTP requestDescription
AccountManagementApiapiFileUploadPOSTPOST /api/1/users/fileupload file
AccountManagementApiapiForgotPasswordPOSTPOST /api/1/forgotPassword/User forgot password
AccountManagementApiapiLoginPOSTPOST /api/1/login/User login
AccountManagementApiapiLogoutPOSTPOST /api/1/logout/User logout
AccountManagementApiapiRegisterPOSTPOST /api/1/register/User signup
AccountManagementApiapiResendEmailPOSTPOST /api/1/resendEmail/Resend verification email
AccountManagementApiapiResetPasswordPOSTPOST /api/1/resetPassword/{tokenId}Reset password
AccountManagementApiapiUserDataPOSTPOST /api/1/userData/Update user data
AccountManagementApiapiUsersMeGETGET /api/1/users/me/Get user data
AccountManagementApiapiVerifyEmailPOSTPOST /api/1/verifyEmail/{tokenId}Verify email address
DeviceManagementApiapiControllerCtrlPOSTPOST /api/1/controllers/{controllerId}/ctrl/Control a controller
DeviceManagementApiapiControllerDELETEDELETE /api/1/controllersDelete a controller
DeviceManagementApiapiControllerGETGET /api/1/controllersGet controller info
DeviceManagementApiapiControllerPATCHPATCH /api/1/controllersUpdate a controller
DeviceManagementApiapiControllerPOSTPOST /api/1/controllersAdd a controller
DeviceManagementApiapiControllerPUTPUT /api/1/controllersPut a controller
DeviceManagementApiapiDeviceChannelCtrlPOSTPOST /api/1/controllers/{controllerId}/devices/{devId}/channels/{channelId}/ctrl/Control a channel of a specified device property
DeviceManagementApiapiDeviceCtrlPOSTPOST /api/1/controllers/{controllerId}/devices/{devId}/ctrl/Control a device property
DeviceManagementApiapiDevicesDELETEDELETE /api/1/controllers/{controllerId}/devicesDelete a controller's devices
DeviceManagementApiapiDevicesGetGET /api/1/controllers/{controllerId}/devicesGet devices info
DeviceManagementApiapiDevicesPATCHPATCH /api/1/controllers/{controllerId}/devicesUpdate a controller's devices
DeviceManagementApiapiDevicesPOSTPOST /api/1/controllers/{controllerId}/devicesAdd a controller's devices
DeviceManagementApiapiDevicesPUTPUT /api/1/controllers/{controllerId}/devicesPut a controller's devices
DeviceManagementApiapiGetControllerTimezoneGET /api/1/controllers/{controllerId}/timezoneGet timezone info
DeviceManagementApiapiGetControllerWeatherGET /api/1/controllers/{controllerId}/weatherGet weather info
EventHandleApiapiAlertPOST /api/1/event/controllers/{controllerId}/alertalert handle
EventHandleApiapiBatchHandlePOSTPOST /api/1/event/controllers/{controllerId}/batchHandleBatch handle event
EventHandleApiapiEventDefGETGET /api/1/event/def/event trigger
EventHandleApiapiEventHandlePOST /api/1/event/handleevent trigger
EventHandleApiapiHandleFilePOSTPOST /api/1/event/controllers/{controllerId}/devices/{devId}/fileHandle event with file
FamilyAccountManagementApiapiPrivilegeDELETEDELETE /api/1/controllers/{controllerId}/privilegeDelete a family account
FamilyAccountManagementApiapiPrivilegePATCHPATCH /api/1/controllers/{controllerId}/privilegeUpdate a family account
FamilyAccountManagementApiapiPrivilegePOSTPOST /api/1/controllers/{controllerId}/privilegeAdd a family account
FamilyAccountManagementApiapiPrivilegeResendMailPOST /api/1/controllers/{controllerId}/privilege/sendMailresend invite mail
FamilyAccountManagementApiapiPrivilegesGetGET /api/1/privileges/Get pre-defined family account privileges
LogManagementApiapi1LogsGetGET /api/1/logsGet all controller logs by user
LogManagementApiapiControllerLogsGETGET /api/1/controllers/{controllerId}/logsGet a controller's logs
LogManagementApiapiDeviceLogsGETGET /api/1/controllers/{controllerId}/devices/{devId}/logsGet a device's logs
LogManagementApiapiSyncLogsPOST /api/1/logs/syncsync logs
LogManagementApiapiSyncSnapshotPOSTPOST /api/1/logs/controllers/{controllerId}/devices/{devId}/sync/snapshot/Sync logs with snapshot
ReportManagementApiapiBrandReportGETGET /api/1/brands/{brandName}/reportsGet reports depends on brand name
ReportManagementApiapiBrandTypeReportGETGET /api/1/brands/{brandName}/types/{typeEnum}/reportsGet reports depends on brand name and periodical type
ReportManagementApiapiReportGETGET /api/1/reportsGet reports
ReportManagementApiapiReportSupportFieldsGETGET /api/1/reports/supportFieldsGet support fields of report
RuleManagementApiapiControllerRuleDELETEDELETE /api/1/controllers/{controllerId}/rulesDelete a controller's rules
RuleManagementApiapiControllerRulePATCHPATCH /api/1/controllers/{controllerId}/rulesUpdate a controller's rules
RuleManagementApiapiControllerRulePOSTPOST /api/1/controllers/{controllerId}/rulesAdd a controller's rules
RuleManagementApiapiControllerRuleTriggerPOST /api/1/controllers/{controllerId}/rules/{ruleId}/triggerTrigger a controller's rule manually
RuleManagementApiapiControllerRulessGETGET /api/1/controllers/{controllerId}/rulesGet a controller's rules
RuleManagementApiapiRulesGETGET /api/1/rules/Get all rules of all controllers
StreamingManagementApiapiLiveViewGETGET /api/1/controllers/{controllerId}/devices/{devId}/live/Request live view streaming from camera device
StreamingManagementApiapiPlaylistGETGET /api/1/controllers/{controllerId}/devices/{devId}/playlist/Request playlist of recording from camera device
StreamingManagementApiapiSnapshotGETGET /api/1/controllers/{controllerId}/devices/{devId}/snapshot/Request latest snapshot from camera device
StreamingManagementApiapiSnapshotPOSTPOST /api/1/controllers/{controllerId}/devices/{devId}/snapshot/Upload latest snapshot of camera device
StreamingManagementApiapiStreamingRecordsGETGET /api/1/controllers/{controllerId}/devices/{devId}/records/Retrive streaming records of camera in use
UtilityApiapiControllersFilePOSTPOST /api/1/controllers/{controllerId}/filesupload file
UtilityApiapiGeoIpGetGET /api/1/geoIp/Get geographic information from IP address
UtilityApiapiGeoIpPostPOST /api/1/geoIp/Add geographic information from mobile app
UtilityApiapiGetTimezoneGET /api/1/timezoneGet timezone info
UtilityApiapiGetVersionGET /api/1/version/Get server related version info
UtilityApiapiGetWeatherGET /api/1/weatherGet weather info
UtilityApiapiUtilUploadFilePOST /api/1/upload/fileupload file

Documentation For Models

Documentation For Authorization

Token

  • Type: API key
  • API key parameter name: Bearer
  • Location: HTTP header

Author

Libraries

swagger.api