POST request/Til/Direct
Gets the Tariff Information Label (Til) for a specific tariff.
Request Information
URI Parameters
None.
Body Parameters
The til detail binding model.
TilDetailBindingModelName | Description | Type | Additional information |
---|---|---|---|
DecimalPlaces | DecimalPlaces |
None. |
|
Economy7Percentage | decimal number |
Required Range: inclusive between 0 and 100 |
|
Postcode | string |
Required Data type: PostalCode |
|
ProposedPayMethod | PayMethod |
Required |
|
SwitchType | SwitchType |
Required |
|
TariffId | integer |
Required |
|
TariffValidToDate | date |
None. |
Request Formats
application/json, text/json
Sample:
{ "postcode": "sample string 1", "switchType": "DualConsolidatedToDualConsolidated", "proposedPayMethod": "MonthlyDirectDebit", "tariffId": 2, "economy7Percentage": 3.0, "tariffValidToDate": "2025-04-04T10:46:53.6351311+00:00", "decimalPlaces": "Zero" }
application/xml, text/xml
Sample:
<TilDetailBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.BindingModel"> <DecimalPlaces>Zero</DecimalPlaces> <Economy7Percentage>3</Economy7Percentage> <Postcode>sample string 1</Postcode> <ProposedPayMethod>MonthlyDirectDebit</ProposedPayMethod> <SwitchType>DualConsolidatedToDualConsolidated</SwitchType> <TariffId>2</TariffId> <TariffValidToDate>2025-04-04T10:46:53.6351311+00:00</TariffValidToDate> </TilDetailBindingModel>
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="ProposedPayMethod" MonthlyDirectDebit --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TariffId" 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Economy7Percentage" 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TariffValidToDate" 2025-04-04T10:46:53.6351311+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="DecimalPlaces" Zero --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
SampleTilDtoResponseName | Description | Type | Additional information |
---|---|---|---|
ApiVersion | string |
None. |
|
TilDto | TilDto |
None. |
|
Uri | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "apiVersion": "sample string 1", "uri": "sample string 2", "tilDto": { "electricityTariffInformationLabel": { "supplier": "sample string 1", "tariffName": "sample string 2", "tariffType": "sample string 3", "paymentMethod": "sample string 4", "unitRateDay": "sample string 5", "unitRateDayPrimary": "sample string 6", "unitRateDaySecondary": "sample string 7", "unitRateNight": "sample string 8", "standingCharge": "sample string 9", "tariffEndsOn": "sample string 10", "priceGuaranteedUntil": "sample string 11", "exitFees": "sample string 12", "discountsAndAdditionalCharges": [ "sample string 1", "sample string 2" ], "additionalProductsAndServices": [ "sample string 1", "sample string 2" ], "assumedAnnualConsumption": "sample string 13", "assumedAnnualCost": "sample string 14", "tariffComparisonRate": "sample string 15", "caveat": "sample string 16", "fixedMonths": 64, "fixedDynamic": true }, "gasTariffInformationLabel": { "supplier": "sample string 1", "tariffName": "sample string 2", "tariffType": "sample string 3", "paymentMethod": "sample string 4", "unitRate": "sample string 5", "unitRatePrimary": "sample string 6", "unitRateSecondary": "sample string 7", "standingCharge": "sample string 8", "tariffEndsOn": "sample string 9", "priceGuaranteedUntil": "sample string 10", "exitFees": "sample string 11", "discountsAndAdditionalCharges": [ "sample string 1", "sample string 2" ], "additionalProductsAndServices": [ "sample string 1", "sample string 2" ], "assumedAnnualConsumption": "sample string 12", "assumedAnnualCost": "sample string 13", "tariffComparisonRate": "sample string 14", "caveat": "sample string 15", "fixedMonths": 64, "fixedDynamic": true } } }
application/xml, text/xml
Sample:
<SampleTilDtoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.TariffInformationLabel"> <ApiVersion>sample string 1</ApiVersion> <TilDto> <ElectricityTariffInformationLabel> <AdditionalProductsAndServices xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </AdditionalProductsAndServices> <AssumedAnnualConsumption>sample string 13</AssumedAnnualConsumption> <AssumedAnnualCost>sample string 14</AssumedAnnualCost> <Caveat>sample string 16</Caveat> <DiscountsAndAdditionalCharges xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </DiscountsAndAdditionalCharges> <ExitFees>sample string 12</ExitFees> <FixedDynamic>true</FixedDynamic> <FixedMonths>64</FixedMonths> <PaymentMethod>sample string 4</PaymentMethod> <PriceGuaranteedUntil>sample string 11</PriceGuaranteedUntil> <StandingCharge>sample string 9</StandingCharge> <Supplier>sample string 1</Supplier> <TariffComparisonRate>sample string 15</TariffComparisonRate> <TariffEndsOn>sample string 10</TariffEndsOn> <TariffName>sample string 2</TariffName> <TariffType>sample string 3</TariffType> <UnitRateDay>sample string 5</UnitRateDay> <UnitRateDayPrimary>sample string 6</UnitRateDayPrimary> <UnitRateDaySecondary>sample string 7</UnitRateDaySecondary> <UnitRateNight>sample string 8</UnitRateNight> </ElectricityTariffInformationLabel> <GasTariffInformationLabel> <AdditionalProductsAndServices xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </AdditionalProductsAndServices> <AssumedAnnualConsumption>sample string 12</AssumedAnnualConsumption> <AssumedAnnualCost>sample string 13</AssumedAnnualCost> <Caveat>sample string 15</Caveat> <DiscountsAndAdditionalCharges xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </DiscountsAndAdditionalCharges> <ExitFees>sample string 11</ExitFees> <FixedDynamic>true</FixedDynamic> <FixedMonths>64</FixedMonths> <PaymentMethod>sample string 4</PaymentMethod> <PriceGuaranteedUntil>sample string 10</PriceGuaranteedUntil> <StandingCharge>sample string 8</StandingCharge> <Supplier>sample string 1</Supplier> <TariffComparisonRate>sample string 14</TariffComparisonRate> <TariffEndsOn>sample string 9</TariffEndsOn> <TariffName>sample string 2</TariffName> <TariffType>sample string 3</TariffType> <UnitRate>sample string 5</UnitRate> <UnitRatePrimary>sample string 6</UnitRatePrimary> <UnitRateSecondary>sample string 7</UnitRateSecondary> </GasTariffInformationLabel> </TilDto> <Uri>sample string 2</Uri> </SampleTilDtoResponse>
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="TilDto.ElectricityTariffInformationLabel.Supplier" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.TariffName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.TariffType" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.PaymentMethod" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.UnitRateDay" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.UnitRateDayPrimary" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.UnitRateDaySecondary" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.UnitRateNight" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.StandingCharge" sample string 9 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.TariffEndsOn" sample string 10 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.PriceGuaranteedUntil" sample string 11 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.ExitFees" sample string 12 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.DiscountsAndAdditionalCharges[0]" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.DiscountsAndAdditionalCharges[1]" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.AdditionalProductsAndServices[0]" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.AdditionalProductsAndServices[1]" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.AssumedAnnualConsumption" sample string 13 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.AssumedAnnualCost" sample string 14 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.TariffComparisonRate" sample string 15 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.Caveat" sample string 16 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.FixedMonths" 64 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.ElectricityTariffInformationLabel.FixedDynamic" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.Supplier" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.TariffName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.TariffType" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.PaymentMethod" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.UnitRate" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.UnitRatePrimary" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.UnitRateSecondary" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.StandingCharge" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.TariffEndsOn" sample string 9 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.PriceGuaranteedUntil" sample string 10 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.ExitFees" sample string 11 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.DiscountsAndAdditionalCharges[0]" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.DiscountsAndAdditionalCharges[1]" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.AdditionalProductsAndServices[0]" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.AdditionalProductsAndServices[1]" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.AssumedAnnualConsumption" sample string 12 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.AssumedAnnualCost" sample string 13 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.TariffComparisonRate" sample string 14 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.Caveat" sample string 15 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.FixedMonths" 64 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TilDto.GasTariffInformationLabel.FixedDynamic" True --MultipartDataMediaFormatterBoundary1q2w3e--