Skip to main content
POST
/
entities
/
site
/
{site_id}
/
dispatch-deconsent
Remove Site Dispatch Consent
curl --request POST \
  --url https://api-sandbox.axle.energy/entities/site/{site_id}/dispatch-deconsent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dispatch_methods": [
    "cm_infrequent_dispatch"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mpan": "<string>",
  "postcode": "<string>",
  "address": "<string>",
  "asset_ids": [],
  "markets": [
    "cm"
  ],
  "dispatch_methods": [
    "cm_infrequent_dispatch"
  ],
  "tariff": {
    "tariff_type": "single_rate",
    "tariff_cheap_start_time": "<string>",
    "tariff_cheap_end_time": "<string>"
  },
  "gave_boundary_meter_consent_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
site_id
string<uuid>
required

Body

application/json

Request model for updating dispatch consent for a site.

​
dispatch_methods
enum<string>[]
required

Dispatch methods to consent to or remove consent from. Leave empty to not consent to any dispatch methods.

Dispatch methods that a site can consent to.

Available options:
cm_infrequent_dispatch,
full_asset_schedule_control,
limited_pause

Response

Successful Response

Response model for site information.

​
id
string<uuid>
required

Axle's internal UUID for the site

​
mpan
string

Meter Point Administration Number for the site

​
postcode
string

UK postcode for the site

​
address
string

Full address for the site

​
asset_ids
string<uuid>[]

List of asset IDs associated with this site

​
markets
enum<string>[]

Markets the site is participating in

Market types available for participation.

  • CM: Capacity Market
  • DFS: Dynamic Frequency Service
  • DNO: Distribution Network Operator flexibility services
  • LCM: Local Capacity Market
  • SFFR: Static Firm Frequency Response
  • WHOLESALE: Wholesale energy market
Available options:
cm,
dfs,
dno,
lcm,
sffr,
wholesale
​
dispatch_methods
enum<string>[]

Dispatch methods allowed for the site

Dispatch methods that a site can consent to.

Available options:
cm_infrequent_dispatch,
full_asset_schedule_control,
limited_pause
​
tariff
Tariff · object

Tariff information for the site

​
gave_boundary_meter_consent_at
string<date-time>

Timestamp when boundary meter consent was given