BMSnet.Client 2.0.3

BMSnet.Client

A .NET client library for accessing BMSnet APIs, including Data Model and Time Series operations through a unified client interface.

Installation

What's New in Version 2.0

• Unified Client: Single BMSnetClient class instead of multiple specialized clients (DataModelClient, TimeSeriesClient)
• Simplified API: All operations (entities, time series, etc.) available through one client
• Same Great Features: Token caching, entity caching, flexible configuration, and DI support

Configuration

The library uses the Options pattern for configuration. You need to provide your OAuth credentials and optionally customize endpoints and scopes.

Option 1: Direct Instantiation

Read-Only Access

Option 2: Dependency Injection (Recommended)

Option 3: Configuration from appsettings.json

Configuration Scenarios

Custom Environment

For testing against a different environment:

Different API Version

To use a different API version:

Configuration Options

Available Scope Constants

• BMSnetClientOptions.DataApiScope = "bmsnetdataapi" - Full read/write access
• BMSnetClientOptions.DataApiReadOnlyScope = "bmsnetdataapi_readonly" - Read-only access

Available Default URIs

• BMSnetClientOptions.DefaultTokenEndpoint - Default OAuth token endpoint
• BMSnetClientOptions.DefaultDataApiBaseUrl - Default Data API base URL

Entity Caching

Enable entity caching to avoid repeated API calls for the same entity:

Note: Cache is automatically invalidated when you update or delete an entity.

Azure Functions Integration

For optimal performance in Azure Functions, register the client as a singleton:

Usage Examples

Entity Operations

Query Entities

Response

Get Single Entity

Response

Create Entity

Response

Delete Entity

Response

Time Series Operations

Get Time Series Data

Response

Post Time Series Data

Response

Helper Methods

// Example C# code for helper methods
public class ExampleHelper
{
    public int Add(int a, int b)
    {
        return a + b;
    }
}

Response

Thread Safety

The BMSnetClient is thread-safe. Token refresh is protected by internal locking mechanisms, making it safe to use as a singleton in web applications and Azure Functions.

Migration from Version 1.x

If you're upgrading from version 1.x:

• Replace DataModelClient with BMSnetClient
• Replace TimeSeriesClient with BMSnetClient
• All methods remain the same
• Update your DI registration to use the new class name

License

MIT