GET request/Estimation/detail/all

Used to estimate consumer household energy usage if they otherwise do not know their actual consumption and/or spend. The other option in conjunction to actuals and estimation, is to offer the consumer a default set of consumption values i.e. ‘High’, ‘Med’, ‘Low’. These values should be maintained as governed by Ofgem. N.b. If the property has a 2 rate Economy 7 meter, the night consumption must be captured when asking for actuals.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

EstimationDropDownResponse

Name	Type	Additional information
ApiVersion	string	None.
Response	EstimationDropDowns	None.
Uri	string	None.

Response Formats

application/json, text/json

Sample:

{
  "apiVersion": "sample string 1",
  "uri": "sample string 2",
  "response": {
    "bedRooms": [
      {
        "id": 1,
        "name": "sample string 2"
      },
      {
        "id": 1,
        "name": "sample string 2"
      }
    ],
    "fuelUseTypes": [
      {
        "id": 1,
        "name": "sample string 2"
      },
      {
        "id": 1,
        "name": "sample string 2"
      }
    ],
    "houseTypes": [
      {
        "id": 1,
        "name": "sample string 2"
      },
      {
        "id": 1,
        "name": "sample string 2"
      }
    ],
    "occupancyFrequencies": [
      {
        "id": 1,
        "name": "sample string 2"
      },
      {
        "id": 1,
        "name": "sample string 2"
      }
    ],
    "energyEfficiencies": [
      {
        "id": 1,
        "name": "sample string 2"
      },
      {
        "id": 1,
        "name": "sample string 2"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<EstimationDropDownResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.DtoResponse">
  <ApiVersion>sample string 1</ApiVersion>
  <Response xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.Dto">
    <d2p1:BedRooms>
      <d2p1:BedroomCount>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:BedroomCount>
      <d2p1:BedroomCount>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:BedroomCount>
    </d2p1:BedRooms>
    <d2p1:EnergyEfficiencies>
      <d2p1:EnergyEfficiency>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:EnergyEfficiency>
      <d2p1:EnergyEfficiency>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:EnergyEfficiency>
    </d2p1:EnergyEfficiencies>
    <d2p1:FuelUseTypes>
      <d2p1:FuelUseType>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:FuelUseType>
      <d2p1:FuelUseType>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:FuelUseType>
    </d2p1:FuelUseTypes>
    <d2p1:HouseTypes>
      <d2p1:HouseType>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:HouseType>
      <d2p1:HouseType>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:HouseType>
    </d2p1:HouseTypes>
    <d2p1:OccupancyFrequencies>
      <d2p1:OccupancyFrequency>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:OccupancyFrequency>
      <d2p1:OccupancyFrequency>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:OccupancyFrequency>
    </d2p1:OccupancyFrequencies>
  </Response>
  <Uri>sample string 2</Uri>
</EstimationDropDownResponse>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ApiVersion"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Uri"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.BedRooms[0].Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.BedRooms[0].Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.BedRooms[1].Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.BedRooms[1].Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.FuelUseTypes[0].Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.FuelUseTypes[0].Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.FuelUseTypes[1].Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.FuelUseTypes[1].Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.HouseTypes[0].Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.HouseTypes[0].Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.HouseTypes[1].Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.HouseTypes[1].Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.OccupancyFrequencies[0].Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.OccupancyFrequencies[0].Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.OccupancyFrequencies[1].Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.OccupancyFrequencies[1].Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.EnergyEfficiencies[0].Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.EnergyEfficiencies[0].Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.EnergyEfficiencies[1].Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Response.EnergyEfficiencies[1].Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e--