Ayyeka Wavelet - Using the Ayyeka SOAP API Methods

143 pages

Save Page as PDF

To Next Page

To Previous Page

www.ayyeka.com | +1 (310) 876-8040 | info@ayyeka.com 123

Using the Ayyeka SOAP API Methods

The methods available for SOAP API access to Ayyeka data are listed and explained in the SOAP API Reference

window of the Ayyeka UI.

To access the page, click API in the sidebar, then select API Documentation > SOAP API Reference.

Figure 117: SOAP API Reference window

Main Page

Table of Contents2
Notices7
- Trademark Acknowledgments7
- FCC Notice7
- Compliance Information7
Glossary8
Introduction9
- Scope9
- Related Documentation9
Product Overview10
- Wavelet Kits11
- Wavelet Device11
- Sensor Integration11
- User Interface12
Installing the Wavelet Kit13
- Assembling the Wavelet Kit13
- Connecting to an External Power Source13
- Turning the Wavelet on14
Ayyeka Web-Based Data Management System15
- Accessing the Data Management System15
- Understanding Sites' Hierarchy15
- Understanding User Roles17
  - Account Roles17
  - Organization Roles17
- Getting Started17
Using the Ayyeka Visualization Window19
- Viewing Site Information21
- Understanding the Data Stream Chart23
- Comparing Data Streams24
Generating Reports26
- Stream History Report26
- Aggregation Report28
- Custom Stream History Report31
Managing Sites34
- Viewing a Site34
- Editing a Site35
  - Changing the Site Name and Organization35
  - Changing the Site Location37
Managing Devices38
- Managing Device Configuration39
  - Setting the Device Transmission Intervals39
  - Setting the Device Sampling Interval42
- Viewing the Files Sent and Received by the Device42
- Viewing the Device Event Log42
- Viewing the Commands Sent to the Device43
- Viewing the Health of the Device44
- Viewing Device Cellular Information45
- Managing Device Technical Alerts45
- Setting the Device Reporting Profile50
- Setting up Live Notifications52
  - Cancelling Live Notifications53
Managing Data Streams55
- Viewing a Data Stream55
- Editing a Data Stream56
- Hiding a Data Stream58
- Viewing and Filtering Samples60
- Configuring Data Stream Thresholds62
- Viewing and Editing the Treatment of Raw Data75
- Managing a Stream's Sampling Interval81
Managing Organizations89
- Adding an Organization89
- Editing an Organization91
Managing Users92
- Viewing the List of Users92
- Inviting a New User93
- Editing, Disabling or Deleting a User98
- Adding Existing Users to Organization(S)99
Managing User Groups101
- Adding a User Group102
- Assigning a User to a Group104
- Removing a User from a Group105
- Editing a Group105
Sharing Sites and Accounts106
- Sharing Sites with any User106
- Sharing an Account with any Ayyeka User108
Setting Personal Preferences110
- Setting Your Own User Details110
- Customizing Your User Interface Display115
Using the Ayyeka API117
- Using the Ayyeka REST API117
  - Gaining Access to Ayyeka Data Via the REST API117
  - Using the Ayyeka REST API Methods121
- Using the Ayyeka SOAP API122
  - Gaining Access to Ayyeka Data Via the SOAP API122
  - Using the Ayyeka SOAP API Methods123
Maintenance124
- Wavelet Battery Replacement124
  - Battery Replacement Instructions124
Troubleshooting126
- Wavelet Device Does Not Turn on126
- LED Light Status Indicators127
  - Leds Status Indications127
  - Accessing the Interface Board Leds128
- Technical Support - Contact Information129
Faq130
- Is the Wavelet Activator Unique Per Device130
- Why Are Updated GPS Coordinates Not Appearing in the UI130
- What Is the Recommended Range for the Device Cellular Signal130
- How Can I Change the Destination Server Address131
- Why Are Device Configuration Changes Not Taking Effect132
  - Rebooting a Device132
Specifications133
- Wavelet Specifications133
- Wavelet Mechanical Drawings136

Ayyeka Wavelet - Using the Ayyeka SOAP API Methods

Table of Contents