addressMeterpoints

Search for all energised meterpoint's belonging to the given UPRN using ECOES & Xoserve APIs.

Arguments

electricityOnly : Boolean

If it should only return meterpoints from the ECOES EES data source.

postcode : String!


            required

The postcode of the property to search for meterpoints.

uprn : String!


            required

The UPRN of the property to search for meterpoints.

Returns

AddressMeterPointsType

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can access customer queries
OR Can use addresses api

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

query AddressMeterpoints(
  $electricityOnly: Boolean,
  $postcode: String!,
  $uprn: String!
) {
  addressMeterpoints(
    electricityOnly: $electricityOnly,
    postcode: $postcode,
    uprn: $uprn
  ) {
    electricityMeterPoints {
      ...ElectricMeterTechnicalDetailsFragment
    }
    electricityNetworkRates {
      ...ElectricityNetworkRatesFragment
    }
    gasMeterPoints {
      ...GasMeterTechnicalDetailsFragment
    }
  }
}

{
  "electricityOnly": true,
  "postcode": "while-establish-church-nice-respond",
  "uprn": "image-room-involve-everything-never"
}

{
  "data": {
    "addressMeterpoints": {
      "electricityMeterPoints": [ElectricMeterTechnicalDetails],
      "electricityNetworkRates": [ElectricityNetworkRates],
      "gasMeterPoints": [GasMeterTechnicalDetails]
    }
  }
}