POST request/Switch/Pro/Info/Switch-Plan
Returns consumer’s desired new energy tariff plan. Tariff details can be shown during a consumer switching energy dependent on how the consumer switching journey is built.
Request Information
URI Parameters
None.
Body Parameters
The switch completion information binding model.
SwitchCompletionInfoBindingModelName | Description | Type | Additional information |
---|---|---|---|
IsTou | boolean |
None. |
|
SwitchKey | string |
Required Max length: 50 Min length: 1 |
Request Formats
application/json, text/json
Sample:
{ "switchKey": "sample string 1", "isTou": true }
application/xml, text/xml
Sample:
<SwitchCompletionInfoBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.Sample"> <IsTou xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.BindingModel">true</IsTou> <SwitchKey xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.BindingModel">sample string 1</SwitchKey> </SwitchCompletionInfoBindingModel>
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SwitchKey" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IsTou" True --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
GeniusSwitchPlanInfoDtoResponseName | Description | Type | Additional information |
---|---|---|---|
ApiVersion | string |
None. |
|
GeniusSwitchPlanInfoDto | GeniusSwitchPlanInfoDto |
None. |
|
Uri | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "apiVersion": "sample string 1", "uri": "sample string 2", "geniusSwitchPlanInfoDto": { "geniusSwitchPlanInfo": { "customerId": 1, "title": "sample string 1", "firstName": "sample string 2", "lastName": "sample string 3", "email": "sample string 4", "postcode": "sample string 5", "switchPlanInfo": { "electricity": { "tariffId": 1, "payMethod": "MonthlyDirectDebit" } }, "switchPlanInfoDto": { "electricity": { "isGreen": true, "isGreenCertified": true, "hasOnlineManagement": true, "hasPaperBilling": true, "isFixed": true, "isFixedFromEnergyStartDate": true, "hasCancellationFee": true, "hasWinterPremium": true, "hasRewardScheme": true, "willExpireSoon": true, "isPartOfAGroupSwitch": true, "hasWarmHomeDiscount": true, "isEconomy7": true, "tariffDetails": [ "sample string 1", "sample string 2" ], "rewardDetails": [ "sample string 1", "sample string 2" ], "usage": 14, "cost": 15.0, "costYear1": 16.0, "costYear2": 17.0, "costYear3": 18.0, "costYear4": 19.0, "costYear5": 20.0, "discount": 21.0, "discountYear1": 22.0, "discountYear2": 23.0, "discountYear3": 24.0, "discountYear4": 25.0, "discountYear5": 26.0, "savings": 27.0, "savingsYear1": 28.0, "savingsYear2": 29.0, "savingsYear3": 30.0, "savingsYear4": 31.0, "savingsYear5": 32.0, "tcr": 33.0, "economy7Percentage": 34.0, "greenPercentage": 35.0, "supplierLogoUrl": "sample string 36", "supplierTosUrl": "sample string 37", "tariffTosUrl": "sample string 38", "supplierDescription": "sample string 39", "cancellationFeeDetail": "sample string 40", "supplierId": 41, "tariffName": "sample string 42", "supplierName": "sample string 43", "fixedMonths": 64, "tariffId": 44, "payMethod": "MonthlyDirectDebit" } }, "switchId": 6 } } }
application/xml, text/xml
Sample:
<GeniusSwitchPlanInfoDtoResponse 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> <GeniusSwitchPlanInfoDto xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.Dto"> <d2p1:GeniusSwitchPlanInfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.Switch"> <d3p1:SwitchId>6</d3p1:SwitchId> <d3p1:CustomerId>1</d3p1:CustomerId> <d3p1:Email>sample string 4</d3p1:Email> <d3p1:FirstName>sample string 2</d3p1:FirstName> <d3p1:LastName>sample string 3</d3p1:LastName> <d3p1:Postcode>sample string 5</d3p1:Postcode> <d3p1:SwitchPlanInfo xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:KeyValueOfConsumptionTypeTariffPlanfwlpDnU9> <d4p1:Key>Electricity</d4p1:Key> <d4p1:Value> <d3p1:PayMethod>MonthlyDirectDebit</d3p1:PayMethod> <d3p1:TariffId>1</d3p1:TariffId> </d4p1:Value> </d4p1:KeyValueOfConsumptionTypeTariffPlanfwlpDnU9> </d3p1:SwitchPlanInfo> <d3p1:SwitchPlanInfoDto xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:KeyValueOfConsumptionTypeTariffPlanDetailfwlpDnU9> <d4p1:Key>Electricity</d4p1:Key> <d4p1:Value> <d3p1:PayMethod>MonthlyDirectDebit</d3p1:PayMethod> <d3p1:TariffId>44</d3p1:TariffId> <d3p1:CancellationFeeDetail>sample string 40</d3p1:CancellationFeeDetail> <d3p1:Cost>15</d3p1:Cost> <d3p1:CostYear1>16</d3p1:CostYear1> <d3p1:CostYear2>17</d3p1:CostYear2> <d3p1:CostYear3>18</d3p1:CostYear3> <d3p1:CostYear4>19</d3p1:CostYear4> <d3p1:CostYear5>20</d3p1:CostYear5> <d3p1:Discount>21</d3p1:Discount> <d3p1:DiscountYear1>22</d3p1:DiscountYear1> <d3p1:DiscountYear2>23</d3p1:DiscountYear2> <d3p1:DiscountYear3>24</d3p1:DiscountYear3> <d3p1:DiscountYear4>25</d3p1:DiscountYear4> <d3p1:DiscountYear5>26</d3p1:DiscountYear5> <d3p1:Economy7Percentage>34</d3p1:Economy7Percentage> <d3p1:FixedMonths>64</d3p1:FixedMonths> <d3p1:GreenPercentage>35</d3p1:GreenPercentage> <d3p1:HasCancellationFee>true</d3p1:HasCancellationFee> <d3p1:HasOnlineManagement>true</d3p1:HasOnlineManagement> <d3p1:HasPaperBilling>true</d3p1:HasPaperBilling> <d3p1:HasRewardScheme>true</d3p1:HasRewardScheme> <d3p1:HasWarmHomeDiscount>true</d3p1:HasWarmHomeDiscount> <d3p1:HasWinterPremium>true</d3p1:HasWinterPremium> <d3p1:IsEconomy7>true</d3p1:IsEconomy7> <d3p1:IsFixed>true</d3p1:IsFixed> <d3p1:IsFixedFromEnergyStartDate>true</d3p1:IsFixedFromEnergyStartDate> <d3p1:IsGreen>true</d3p1:IsGreen> <d3p1:IsGreenCertified>true</d3p1:IsGreenCertified> <d3p1:IsPartOfAGroupSwitch>true</d3p1:IsPartOfAGroupSwitch> <d3p1:RewardDetails> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </d3p1:RewardDetails> <d3p1:Savings>27</d3p1:Savings> <d3p1:SavingsYear1>28</d3p1:SavingsYear1> <d3p1:SavingsYear2>29</d3p1:SavingsYear2> <d3p1:SavingsYear3>30</d3p1:SavingsYear3> <d3p1:SavingsYear4>31</d3p1:SavingsYear4> <d3p1:SavingsYear5>32</d3p1:SavingsYear5> <d3p1:SupplierDescription>sample string 39</d3p1:SupplierDescription> <d3p1:SupplierId>41</d3p1:SupplierId> <d3p1:SupplierLogoUrl>sample string 36</d3p1:SupplierLogoUrl> <d3p1:SupplierName>sample string 43</d3p1:SupplierName> <d3p1:SupplierTosUrl>sample string 37</d3p1:SupplierTosUrl> <d3p1:TariffDetails> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </d3p1:TariffDetails> <d3p1:TariffName>sample string 42</d3p1:TariffName> <d3p1:TariffTosUrl>sample string 38</d3p1:TariffTosUrl> <d3p1:Tcr>33</d3p1:Tcr> <d3p1:Usage>14</d3p1:Usage> <d3p1:WillExpireSoon>true</d3p1:WillExpireSoon> </d4p1:Value> </d4p1:KeyValueOfConsumptionTypeTariffPlanDetailfwlpDnU9> </d3p1:SwitchPlanInfoDto> <d3p1:Title>sample string 1</d3p1:Title> </d2p1:GeniusSwitchPlanInfo> </GeniusSwitchPlanInfoDto> <Uri>sample string 2</Uri> </GeniusSwitchPlanInfoDtoResponse>
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="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.CustomerId" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.Title" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.FirstName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.LastName" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.Email" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.Postcode" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfo[0].Key" Electricity --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfo[0].Value.TariffId" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfo[0].Value.PayMethod" MonthlyDirectDebit --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Key" Electricity --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.IsGreen" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.IsGreenCertified" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.HasOnlineManagement" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.HasPaperBilling" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.IsFixed" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.IsFixedFromEnergyStartDate" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.HasCancellationFee" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.HasWinterPremium" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.HasRewardScheme" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.WillExpireSoon" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.IsPartOfAGroupSwitch" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.HasWarmHomeDiscount" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.IsEconomy7" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.TariffDetails[0]" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.TariffDetails[1]" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.RewardDetails[0]" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.RewardDetails[1]" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.Usage" 14 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.Cost" 15 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.CostYear1" 16 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.CostYear2" 17 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.CostYear3" 18 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.CostYear4" 19 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.CostYear5" 20 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.Discount" 21 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.DiscountYear1" 22 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.DiscountYear2" 23 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.DiscountYear3" 24 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.DiscountYear4" 25 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.DiscountYear5" 26 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.Savings" 27 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.SavingsYear1" 28 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.SavingsYear2" 29 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.SavingsYear3" 30 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.SavingsYear4" 31 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.SavingsYear5" 32 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.Tcr" 33 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.Economy7Percentage" 34 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.GreenPercentage" 35 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.SupplierLogoUrl" sample string 36 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.SupplierTosUrl" sample string 37 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.TariffTosUrl" sample string 38 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.SupplierDescription" sample string 39 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.CancellationFeeDetail" sample string 40 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.SupplierId" 41 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.TariffName" sample string 42 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.SupplierName" sample string 43 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.FixedMonths" 64 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.TariffId" 44 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchPlanInfoDto[0].Value.PayMethod" MonthlyDirectDebit --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeniusSwitchPlanInfoDto.GeniusSwitchPlanInfo.SwitchId" 6 --MultipartDataMediaFormatterBoundary1q2w3e--