AXaxle
3. Sites

Initialise Site

Changed on

Initialise a site with one or more assets.

This endpoint upserts the site and assets (creating them if they don't exist, or filling in missing fields if they do), and returns eligibility information.

No enrollment side effects: Use the /enrol endpoint to commit to enrollment.

post/entities/site/initialise

Request

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

Request body

Example request

{
  "assets": [
    {
      "asset_model": "charger-model",
      "external_id": "charger-001",
      "installation_date": "2025-06-15",
      "properties": {
        "power_kw": 7.4
      },
      "type": "charger"
    }
  ]
}

Response

Successfully initialised site and assets

Example response

{
  "eligibility": {
    "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
    • breaking

      the request's body type changed from object to no type

    • warning

      removed the request property

    • warning

      removed the request property

    • 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

    • info

      added to the request body oneOf list

    • info

      added the non-success response with the status