AXaxle
8. Examples

Get Example Dispatch Event

Get an example dispatch event.

Returns a pre-filled DispatchEvent object that can be used as a reference for the expected format and structure of dispatch events.

get/examples/dispatch-event

Request

  • Base URL
    https://api-sandbox.axle.energy
  • URL
    https://api-sandbox.axle.energy/examples/dispatch-event
  • Auth
    OAuth 2
    Password
    Token URL: auth/token-form

Response

Example dispatch event

asset_idstring uuid required

Asset or aggregate to which this event pertains

event_idstring uuid required

UID of this event

issued_timestampstring date-time required

When the event was published (UTC)

event_timestampstring date-time required

When the event occurred, if different from publication (UTC)

market_idstring required

Market from which this dispatch originates

level_kwnumber required

Desired power output of asset

from_timestring date-time required

Start time of event (UTC)

to_timestring date-time required

End time of event (UTC)

Changes

No recorded changes to this operation across all 2 revisions of this API.