SynErgie EFDM Interface - Messaging (Notification Receiver Perspetive) 0.0.4

The SynErgie EFDM Interface supports messaging to notify company systems about events in the SynErgie company platform. The company systems thereby get notified about updates in energy flexiblity processes.

Description of Tags: #EFDM Notifications: Operations intended to be served by the EFDM Interface. The EFDM Interface thus comprises the part of the EFMS Interface notifications that can be consumed by company systems that provide flexibility. #Internal EFDM Notifications: Operations exclusively tagged with "#Internal EFDM Notifications" are served by the full EFMS Interface and receiveable by internal services within the SynErgie Company Platform.

Disclaimer: This software is developed and provided as part of a research project. It is intended solely for scientific and experimental purposes. The software is in an early stage of development and is not suitable for production use, particularly in safety-critical or commercial applications. Use of this software is entirely at the user's own risk. No warranty is provided regarding its functionality, security, availability, or fitness for any particular purpose. The source code is made available under the Apache License 2.0 on an "as-is" basis, without any express or implied warranties. There is no guarantee that the software will be further developed or maintained beyond the duration of the research project. Users are responsible for assessing whether modifications or further development are necessary before using the software in any capacity.

Operations

  • RECEIVE notification/flexibilitySpace/added

    Topic to send and receive notifications about added flexibility spaces.

    Receive information about an added flexibility space.

    Operation IDconsumeAllFlexibilitySpaceAddedNotifications
    object

    Accepts the following message:

    Flexibility Space Info

    Information about a flexibility space.

    Message IDflexibilitySpaceInfo
    object

    Examples

  • RECEIVE notification/flexibilitySpace/{flexibilitySpaceId}/updated

    Topic to send and receive notifications about an updated flexibility space.

    Receive information about an updated flexibility space.

    Operation IDconsumeFlexibilitySpaceUpdatedNotifications
    object
    flexibilitySpaceId
    required
    string

    The ID of the flexibility space.

    object

    Accepts the following message:

    Flexibility Space Info

    Information about a flexibility space.

    Message IDflexibilitySpaceInfo
    object

    Examples

  • RECEIVE notification/flexibilitySpace/{flexibilitySpaceId}/deleted

    Topic to send and receive notifications about a deleted flexibility space.

    Receive information about a deleted flexibility space.

    Operation IDconsumeFlexibilitySpaceDeletedNotifications
    object
    flexibilitySpaceId
    required
    string

    The ID of the flexibility space.

    object

    Accepts the following message:

    Flexibility Space Info

    Information about a flexibility space.

    Message IDflexibilitySpaceInfo
    object

    Examples

  • RECEIVE notification/flexibilitySpace/{flexibilitySpaceId}/reserved

    Topic to send and receive notifications about a reserved flexibility space.

    Receive information about a reserved flexibility space.

    Operation IDconsumeFlexibilitySpaceReservedNotifications
    object
    flexibilitySpaceId
    required
    string

    The ID of the flexibility space.

    object

    Accepts the following message:

    Flexibility Space Info

    Information about a flexibility space.

    Message IDflexibilitySpaceInfo
    object

    Examples

  • RECEIVE notification/flexibilitySpace/{flexibilitySpaceId}/flexibleLoadMeasurePackage/executionRequested

    Topic to send and receive notifications about requested executions of flexible load measure packages.

    Receive information about a requested execution of a flexible load measure package.

    Operation IDconsumeFlexibleLoadMeasurePackageExecutionRequestedNotifications
    object
    flexibilitySpaceId
    required
    string

    The ID of the flexibility space.

    object

    Accepts the following message:

    Flexible Load Measure Package Info

    Information about a flexible load measure package.

    Message IDflexibleLoadMeasurePackageInfo
    object

    Examples

  • RECEIVE notification/flexibilitySpace/{flexibilitySpaceId}/flexibleLoadMeasure/executionLogUpdated

    Topic to send and receive notifications about updated execution log of flexible load measures.

    Receive information about an updated execution log of a flexible load measure.

    Operation IDconsumeFlexibleLoadMeasureExecutionLogUpdatedNotifications
    object
    flexibilitySpaceId
    required
    string

    The ID of the flexibility space.

    object

    Accepts the following message:

    Execution Log Entry Info

    Information about an entry in the execution log of a flexible load measure.

    Message IDexecutionLogEntryInfo
    object

    Examples

  • RECEIVE notification/flexibilitySpace/{flexibilitySpaceId}/flexibleLoadMeasure/executionException

    Topic to send and receive notifications about exceptions during the execution of flexible load measures.

    Receive information about an exception during the execution of a flexible load measure.

    Operation IDconsumeFlexibleLoadMeasureExecutionExceptionNotifications
    object
    flexibilitySpaceId
    required
    string

    The ID of the flexibility space.

    object

    Accepts the following message:

    Flexible Load Measure Execution Exception

    Informs about an exception during the execution of a flexible load measure.

    Message IDflexibleLoadMeasureExecutionException
    object

    Examples

  • RECEIVE notification/flexibilitySpace/{flexibilitySpaceId}/flexibleLoadMeasurePackage/executionRequestCanceled

    Topic to send and receive notifications about canceled execution requests for flexible load measure packages.

    Receive information about a canceled execution request of a flexible load measure package.

    Operation IDconsumeFlexibleLoadMeasurePackageExecutionRequestCanceledNotifications
    object
    flexibilitySpaceId
    required
    string

    The ID of the flexibility space.

    object

    Accepts the following message:

    Flexible Load Measure Package Info

    Information about a flexible load measure package.

    Message IDflexibleLoadMeasurePackageInfo
    object

    Examples

Messages

  • #1Flexibility Space Info

    Information about a flexibility space.

    Message IDflexibilitySpaceInfo
    object
  • #2Flexible Load Measure Package Info

    Information about a flexible load measure package.

    Message IDflexibleLoadMeasurePackageInfo
    object
  • #3Flexible Load Measure Info

    Information about a flexible load measure.

    Message IDflexibleLoadMeasureInfo
    object
  • #4Execution Log Entry Info

    Information about an entry in the execution log of a flexible load measure.

    Message IDexecutionLogEntryInfo
    object
  • #5Flexible Load Measure Execution Exception

    Informs about an exception during the execution of a flexible load measure.

    Message IDflexibleLoadMeasureExecutionException
    object

Schemas

  • object
  • object
  • object
  • object
  • object