Skip to content

Home

Jump to bottom
Doug Schmidt edited this page Nov 10, 2021 · 21 revisions

Welcome to the aquarius-sdk-net wiki!

Roadmap

The goal of the AQUARIUS SDK is to enable easy integration from .NET with public APIs from the entire AQUARIUS suite of products.

  • AQUARIUS Time-Series (AQTS)
  • AQUARIUS Samples (AQS)
  • AQUARIUS WebPortal (AQWP) (coming soon)

The AQUARIUS SDK currently supports two target platforms: .NET 4.7.2 and .NET Standard 2.0 to reach the largest customer audience.

Getting started

Make sure your application is targeting either the .NET 4.7.2 Framework, or a .NET Standard 2.0 platform like .NET Core 2.0, .NET Core 3.0, or .NET 5.

Download on NuGet

This will install the Aquarius.SDK package, and its dependencies.

The main assembly consumed by your code will be Aquarius.Client.dll.

0. SDK design philosophy

  1. Should I consume the REST API endpoints directly?
  2. Do I have to use the SDK?
  3. Does the SDK change my data?
  4. What are the benefits of using the SDK?
  5. What are the drawbacks of using the SDK?
  6. Do you have an SDK for programming language X?
  7. When should I upgrade my SDK version?

1. AQTS client concepts

  1. Authentication
  2. Standard Request/Response DTO Pattern
  3. Error Handling
  4. Service Models
  5. Helper classes
  6. Version checking
  7. Adaptive polling
  8. Long-running sessions
  9. Response timeouts
  10. Unit testing your integration

2. AQTS code examples

  1. Finding the unique ID of a time-series
  2. Creating a time-series
  3. Creating a derived time-series
  4. Appending points to a basic time-series
  5. Appending points to a reflected time-series
  6. Monitoring changes to a time-series
  7. Retrieving all the locations on an AQTS server
  8. Uploading an external report
  9. Downloading a visit or location attachment
  10. VB.NET Support

3. Troubleshooting tips

  1. Capture your HTTP traffic
  2. Logging error responses

4. AQSamples client concepts

  1. AQSamples Authentication
  2. AQSamples Standard Request/Response DTO Pattern
  3. AQSamples Error Handling
  4. AQSamples Service Models
  5. AQSamples Helper classes
  6. AQSamples Version checking
  7. AQSamples Paginated GET requests
  8. AQSamples File uploads

Still have questions? Feel free to raise an issue or contact our Support Team

  1. SDK design philosophy
    1. Should I consume the REST API endpoints directly?
    2. Do I have to use the SDK?
    3. Does the SDK change my data?
    4. What are the benefits of using the SDK?
    5. What are the drawbacks of using the SDK?
    6. Do you have an SDK for programming language X?
    7. When should I upgrade my SDK version?
  2. AQTS client concepts
    1. Authentication
    2. Standard Request/Response DTO Pattern
    3. Error Handling
    4. Service Models
    5. Helper classes
    6. Version checking
    7. Adaptive polling
    8. Long-running sessions
    9. Response timeouts
    10. Unit testing your integration
  3. AQTS code examples
    1. Finding the unique ID of a time-series
    2. Creating a time-series
    3. Creating a derived time-series
    4. Appending points to a basic time-series
    5. Appending points to a reflected time-series
    6. Monitoring changes to a time-series
    7. Retrieving all the locations on an AQTS server
    8. Uploading an external report
    9. Downloading a visit or location attachment
    10. VB.NET Support
  4. Troubleshooting tips
    1. Capture your HTTP traffic
    2. Logging error responses
    3. Using the SDK through a proxy
  5. AQSamples client concepts
    1. AQSamples Authentication
    2. AQSamples Standard Request/Response DTO Pattern
    3. AQSamples Error Handling
    4. AQSamples Service Models
    5. AQSamples Helper classes
    6. AQSamples Version checking
    7. AQSamples Paginated GET requests
    8. AQSamples File uploads
Clone this wiki locally