AXaxle
3. Sites

Check Eligibility

Changed on

Check whether an MPAN, optionally combined with an asset model, is eligible for enrolment. No data is persisted.

post/entities/site/check-eligibility

Request

  • Base URL
    https://api-sandbox.axle.energy
  • URL
    https://api-sandbox.axle.energy/entities/site/check-eligibility
  • Auth
    OAuth 2
    Password
    Token URL: auth/token-form

Request body

mpanstring required

Meter Point Administration Number. Used to determine whether the site is half-hourly settled.

asset_modelstring

Optional value of the AssetModel to evaluate against. Required for CoP11-route eligibility; half-hourly settled sites qualify regardless of asset model.

Example request

{
  "mpan": "1234567890123",
  "asset_model": "axle_charger_v1"
}

Response

Eligibility evaluated

is_half_hourly_settledboolean required

Whether the site is half-hourly settled.

Example response

{
  "propositions": [
    {
      "proposition": "limited_pause"
    }
  ]
}

Changes