Changelog

All notable changes to this project will be documented here. This project adheres to Semantic Versioning.

[1.0.1]

Changed

  • New states introduced for Asset scheme states
    Ready
    OptOut

  • Asset update endpoint now accept attribute changes.

[1.0]

Added

  • Endpoint to create tariffs against an asset
    POST /assets/{assetUUID}/tariff

  • Endpoint to enable tariff schedules for an asset
    POST /assets/{assetUUID}/tariff/schedules/{type}

  • List tariff’s of an asset
    GET /assets/{assetUUID}/tariff/{direction}

  • List tariff schedules of an asset
    GET /assets/{assetUUID}/tariff/schedules

  • Disconnect asset tariffs
    DELETE /assets/{assetUUID}/tariff/{direction}

  • Endpoint to archive an user
    DELETE /users/{userUUID}

Changed

  • baseline property added in list event assets endpoint.

[0.9.0]

Added

  • New endpoint to archive an asset
    DELETE /assets/assetUUID

  • New endpoint to optin assets into Event Schemes

  • New endpoint to optin assets into Events

  • New endpoint to list assets under an Event Scheme

  • New endpoint to list assets under an Event

Changed

  • /assets-bulk renamed to /assets/bulk

  • assetId made optional.

  • Asset create now accept a userId

Removed

  • Removed endpoint to create a single energy consumption value

[0.5.0]

Changed

  • /assets-create-bulk renamed to /assets-bulk

  • Asset create endpoints now accepts following parameters.
    installationDate
    locationPostcode
    locationBuildingNoOrName
    locationAddress

  • asset_id made optional.

[0.4.0]

Added

  • Added Event stats endpoints to fetch event stats and event asset level stats
    /events/{event-uuid}/stats
    /events/{event-uuid}/assets/stats

[0.3.0]

Added

  • Introduced the Events & Portfolio API to manage and receive dispatch alerts and signals.

[0.2.0]

Added

  • Added new endpoints for Forecasts API.

  • Implemented a webhook for real-time baseline calculation updates.

  • Added support for retrieving future (48hr) baseline calculations in the Forecasts API.

  • Enhanced analytics capabilities with more detailed reporting metrics.

Changed

  • Improved the Smart Meters API to support bulk retrieval of half-hourly energy data.

  • Updated the consent management process in the Consent Management API for better handling of user opt-in/opt-out preferences.

  • Enhanced security protocols for API key management and authentication.

Fixed

  • Resolved an issue where the Smart Meters API would occasionally return incorrect address verification results.

  • Fixed a bug in the Forecasts API that caused baseline calculations to be delayed under heavy load.

  • Corrected event dispatch timing issues in the Events & Portfolio API.

[0.1.0]

Added

  • Initial release of the API Endpoints.

  • Launched the Forecasts API with baseline calculation capabilities.

  • Introduced the Consent Management API to handle user consent for dispatch events.

  • Introduced the Smart Meter API.

Changed

  • Updated documentation to include detailed examples for each API endpoint.