POST request/Estimation/Usage

Returns the applicable data points in order to capture the consumer’s estimated energy usage. Returns the estimated consumption in kWh based on the estimation data captured and the type of quote being rendered. See ‘Switch Request’ API for available consumer energy quote scenarios.

Request Information

URI Parameters

None.

Body Parameters

The usage.

UsageBindingModel vUnicorn

Name	Type	Additional information
BedroomCountId	integer	Required
EnergyEfficiencyId	integer	Required
FuelUseTypeId	integer	Required
HouseTypeId	integer	Required
OccupancyFrequencyId	integer	Required
Postcode	string	Required Data type: PostalCode
SwitchType	SwitchType	Required

Request Formats

application/json, text/json

Sample:

{
  "postcode": "sample string 1",
  "switchType": "DualConsolidatedToDualConsolidated",
  "houseTypeId": 1,
  "bedroomCountId": 1,
  "occupancyFrequencyId": 1,
  "energyEfficiencyId": 1,
  "fuelUseTypeId": 1
}

application/xml, text/xml

Sample:

<UsageBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Unicorn.BindingModel">
  <BedroomCountId>1</BedroomCountId>
  <EnergyEfficiencyId>1</EnergyEfficiencyId>
  <FuelUseTypeId>1</FuelUseTypeId>
  <HouseTypeId>1</HouseTypeId>
  <OccupancyFrequencyId>1</OccupancyFrequencyId>
  <Postcode>sample string 1</Postcode>
  <SwitchType>DualConsolidatedToDualConsolidated</SwitchType>
</UsageBindingModel>

multipart/form-data

Sample:

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

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

DualConsolidatedToDualConsolidated
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="HouseTypeId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="BedroomCountId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="OccupancyFrequencyId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="EnergyEfficiencyId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="FuelUseTypeId"

1
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

SampleEstimatedUsageDtoResponse

Name	Type	Additional information
ApiVersion	string	None.
EstimatedUsageDto	EstimatedUsageDto	None.
Uri	string	None.

Response Formats

application/json, text/json

Sample:

{
  "apiVersion": "sample string 1",
  "uri": "sample string 2",
  "estimatedUsageDto": {
    "gasUsage": 1,
    "electricityUsage": 2
  }
}

application/xml, text/xml

Sample:

<SampleEstimatedUsageDtoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.Estimation">
  <ApiVersion>sample string 1</ApiVersion>
  <EstimatedUsageDto>
    <ElectricityUsage>2</ElectricityUsage>
    <GasUsage>1</GasUsage>
  </EstimatedUsageDto>
  <Uri>sample string 2</Uri>
</SampleEstimatedUsageDtoResponse>

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="EstimatedUsageDto.GasUsage"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="EstimatedUsageDto.ElectricityUsage"

2
--MultipartDataMediaFormatterBoundary1q2w3e--