api_wiseconn

REST_API_documentation_to_access_to_the_Wiseconn_platform__All_rights_reserved_brIn_case_of_bad_usage_or_an_anomaly_detection_Wiseconn_will_contact_the_API_Key_responsable_to_normalize_the_situation__TimestampsAll_the_timestamp_you_need_to_avoid_the_Z_at_

Usage no npm install needed!

<script type="module">
  import apiWiseconn from 'https://cdn.skypack.dev/api_wiseconn';
</script>

README

api_wiseconn

ApiWiseconn - JavaScript client for api_wiseconn REST API documentation to access to the Wiseconn platform. All rights reserved.
In case of bad usage or an anomaly detection, Wiseconn will contact the API Key responsable to normalize the situation. # Timestamps All the timestamp you need to avoid the Z at the end. This is a know issue and we are working on implement the best way to resolve that. All the timestamps are referenced to the Farm Timezome. You can check the Farm Method to get the Farm Timezone # Cross-Origin Resource Sharing This API doesn't support Cross-Origin Resource Sharing (CORS). # What's new - Hydraulics related in each Real Irrigation - Add Pump Ids to all zones no matter if has pump selection or not. - Remove the contract limits. # Authentication This SDK is automatically generated by the Swagger Codegen project:

  • API version: 2.4.8
  • Package version: 2.4.8
  • Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install api_wiseconn --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var ApiWiseconn = require('api_wiseconn');
var defaultClient = ApiWiseconn.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['api_key'] = "Token"

var api = new ApiWiseconn.AlarmsApi()
var id = 56; // {Number} Farm identifier
var initTime = new Date("2013-10-20T19:20:30+01:00"); // {Date} Initial date for querying the data
var endTime = new Date("2013-10-20T19:20:30+01:00"); // {Date} End date for querying the data

api.farmsIdAlarmsTriggeredGet(id, initTime, endTime).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://apiv2.wiseconn.com/

Class Method HTTP request Description
ApiWiseconn.AlarmsApi farmsIdAlarmsTriggeredGet GET /farms/{id}/alarms/triggered List Farm Triggered Alarms
ApiWiseconn.AlarmsApi zonesIdAlarmsTriggeredGet GET /zones/{id}/alarms/triggered List Zone Triggered Alarms
ApiWiseconn.AlertsApi farmsIdAlertsTriggeredGet GET /farms/{id}/alerts/triggered List triggered Farm Alerts
ApiWiseconn.AlertsApi zonesIdAlertsTriggeredGet GET /zones/{id}/alerts/triggered List triggered Zones Alerts
ApiWiseconn.FarmsApi farmsGet GET /farms List Farms
ApiWiseconn.FarmsApi farmsIdAlarmsTriggeredGet GET /farms/{id}/alarms/triggered List Farm Triggered Alarms
ApiWiseconn.FarmsApi farmsIdAlertsTriggeredGet GET /farms/{id}/alerts/triggered List triggered Farm Alerts
ApiWiseconn.FarmsApi farmsIdConnectionsGet GET /farms/{id}/connections List Farm Connections
ApiWiseconn.FarmsApi farmsIdGet GET /farms/{id} Get a Farm
ApiWiseconn.FarmsApi farmsIdHydraulicsGet GET /farms/{id}/hydraulics List Farm Hydraulics
ApiWiseconn.FarmsApi farmsIdIrrigationsDelete DELETE /farms/{id}/irrigations Delete group irrigations
ApiWiseconn.FarmsApi farmsIdIrrigationsGet GET /farms/{id}/irrigations List Farm Scheduled Irrigations
ApiWiseconn.FarmsApi farmsIdMeasuresGet GET /farms/{id}/measures List Farm's Measures
ApiWiseconn.FarmsApi farmsIdNodesGet GET /farms/{id}/nodes List Farm Nodes
ApiWiseconn.FarmsApi farmsIdPumpSystemsGet GET /farms/{id}/pumpSystems List Farm Pump Systems
ApiWiseconn.FarmsApi farmsIdPut PUT /farms/{id} Update a Farm
ApiWiseconn.FarmsApi farmsIdRealIrrigationsGet GET /farms/{id}/realIrrigations List Farm Irrigations
ApiWiseconn.FarmsApi farmsIdWebhookPost POST /farms/{id}/webhook Webhook test method
ApiWiseconn.FarmsApi farmsIdWebhookPut PUT /farms/{id}/webhook Update Webhook URL
ApiWiseconn.FarmsApi farmsIdZonesGet GET /farms/{id}/zones List Farm Zones
ApiWiseconn.HydraulicsApi farmsIdHydraulicsGet GET /farms/{id}/hydraulics List Farm Hydraulics
ApiWiseconn.HydraulicsApi hydraulicsIdChildrenGet GET /hydraulics/{id}/children Get a Hydraulic's Children
ApiWiseconn.HydraulicsApi hydraulicsIdGet GET /hydraulics/{id} Get a Hydraulic
ApiWiseconn.HydraulicsApi zonesIdHydraulicsGet GET /zones/{id}/hydraulics Get a Zone's Hydraulics
ApiWiseconn.IrrigationsApi farmsIdIrrigationsDelete DELETE /farms/{id}/irrigations Delete group irrigations
ApiWiseconn.IrrigationsApi farmsIdIrrigationsGet GET /farms/{id}/irrigations List Farm Scheduled Irrigations
ApiWiseconn.IrrigationsApi farmsIdRealIrrigationsGet GET /farms/{id}/realIrrigations List Farm Irrigations
ApiWiseconn.IrrigationsApi irrigationsIdDelete DELETE /irrigations/{id} Delete a Scheduled Irrigation
ApiWiseconn.IrrigationsApi irrigationsIdGet GET /irrigations/{id} Get a Scheduled Irrigation
ApiWiseconn.IrrigationsApi irrigationsIdPatch PATCH /irrigations/{id} Irrigation Action
ApiWiseconn.IrrigationsApi irrigationsIdPut PUT /irrigations/{id} Update a Scheduled Irrigation
ApiWiseconn.IrrigationsApi irrigationsIdRealIrrigationsGet GET /irrigations/{id}/realIrrigations List Real Irrigations
ApiWiseconn.IrrigationsApi irrigationsPost POST /irrigations Create Scheduled Irrigation
ApiWiseconn.IrrigationsApi pumpSystemsIdIrrigationsGet GET /pumpSystems/{id}/irrigations List Pump Systems Scheduled Irrigations
ApiWiseconn.IrrigationsApi pumpSystemsIdRealIrrigationsGet GET /pumpSystems/{id}/realIrrigations List Pump Systems Irrigations
ApiWiseconn.IrrigationsApi realIrrigationsIdGet GET /realIrrigations/{id} Get a Real Irrigation
ApiWiseconn.IrrigationsApi zonesIdIrrigationsGet GET /zones/{id}/irrigations List Zone Scheduled Irrigations
ApiWiseconn.IrrigationsApi zonesIdRealIrrigationsGet GET /zones/{id}/realIrrigations List Zone Irrigations
ApiWiseconn.MeasuresApi farmsIdMeasuresGet GET /farms/{id}/measures List Farm's Measures
ApiWiseconn.MeasuresApi measuresIdDataGet GET /measures/{id}/data List the Measurements Data
ApiWiseconn.MeasuresApi measuresIdGet GET /measures/{id} Get a Measure
ApiWiseconn.MeasuresApi nodesIdMeasuresGet GET /nodes/{id}/measures List Node's Measures
ApiWiseconn.MeasuresApi zonesIdMeasuresGet GET /zones/{id}/measures List Zone's Measures
ApiWiseconn.NodesApi farmsIdNodesGet GET /farms/{id}/nodes List Farm Nodes
ApiWiseconn.NodesApi nodesIdGet GET /nodes/{id} Get a Node
ApiWiseconn.NodesApi nodesIdMeasuresGet GET /nodes/{id}/measures List Node's Measures
ApiWiseconn.PumpSystemsApi farmsIdPumpSystemsGet GET /farms/{id}/pumpSystems List Farm Pump Systems
ApiWiseconn.PumpSystemsApi pumpSystemsIdGet GET /pumpSystems/{id} Get a Pump System
ApiWiseconn.PumpSystemsApi pumpSystemsIdIrrigationsGet GET /pumpSystems/{id}/irrigations List Pump Systems Scheduled Irrigations
ApiWiseconn.PumpSystemsApi pumpSystemsIdRealIrrigationsGet GET /pumpSystems/{id}/realIrrigations List Pump Systems Irrigations
ApiWiseconn.PumpSystemsApi pumpSystemsIdTanksGet GET /pumpSystems/{id}/tanks List Pump Systems Fertilizer Tanks
ApiWiseconn.PumpSystemsApi pumpSystemsIdZonesGet GET /pumpSystems/{id}/zones List Pump System Zones
ApiWiseconn.ZonesApi farmsIdZonesGet GET /farms/{id}/zones List Farm Zones
ApiWiseconn.ZonesApi pumpSystemsIdZonesGet GET /pumpSystems/{id}/zones List Pump System Zones
ApiWiseconn.ZonesApi zonesIdAlarmsTriggeredGet GET /zones/{id}/alarms/triggered List Zone Triggered Alarms
ApiWiseconn.ZonesApi zonesIdAlertsTriggeredGet GET /zones/{id}/alerts/triggered List triggered Zones Alerts
ApiWiseconn.ZonesApi zonesIdGet GET /zones/{id} Get a Zone
ApiWiseconn.ZonesApi zonesIdHydraulicsGet GET /zones/{id}/hydraulics Get a Zone's Hydraulics
ApiWiseconn.ZonesApi zonesIdIrrigationsGet GET /zones/{id}/irrigations List Zone Scheduled Irrigations
ApiWiseconn.ZonesApi zonesIdMeasuresGet GET /zones/{id}/measures List Zone's Measures
ApiWiseconn.ZonesApi zonesIdPut PUT /zones/{id} Update a Zone
ApiWiseconn.ZonesApi zonesIdRealIrrigationsGet GET /zones/{id}/realIrrigations List Zone Irrigations

Documentation for Models

Documentation for Authorization

apiKey

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