AXaxle
3. Sites

Get Site Eligibility

Changed on

Read-only eligibility breakdown for a site and its assets. Returns the list of propositions the site can enrol in, along with per-asset eligibility detail.

get/entities/site/{site_id}/eligibility

Request

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

Path parameters

site_idstring uuid required

Response

Successful Response

eligible_propositionsstring[]
site_idstring uuid required

Example response

{
  "site_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "assets": [
    {
      "asset_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
      "external_id": "charger-001",
      "propositions": [
        {
          "proposition": "limited_pause"
        }
      ]
    }
  ]
}

Changes

  • b0b07b1dbf12Revision changes
    • warning

      added the new meter_id_not_found enum value to the ///// response property for the response status

    • warning

      added the new meter_id_not_set enum value to the ///// response property for the response status

    • warning

      added the new mpan_not_set enum value to the ///// response property for the response status

    • warning

      added the new postcode_not_in_eligible_area enum value to the ///// response property for the response status

    • warning

      added the new price_curve enum value to the //// response property for the response status

    • warning

      added the new price_curve enum value to the / response property for the response status