POST request/Switch/Pro/Key

Returns the consumer switching key for the energy quote along with all details captured necessary for the consumer to be switched.

Request Information

URI Parameters

None.

Body Parameters

The switch pro binding model.

SwitchKeyBindingModel

Name	Type	Additional information
IsTou	boolean	None.
SwitchId	integer	Required
SwitchPlan	Dictionary of ConsumptionType [key] and TariffPlan [value]	Required
SwitchType	SwitchType	Required

Request Formats

application/json, text/json

Sample:

{
  "switchType": "DualConsolidatedToDualConsolidated",
  "switchPlan": {
    "electricity": {
      "tariffId": 1,
      "payMethod": "MonthlyDirectDebit"
    }
  },
  "switchId": 1,
  "isTou": true
}

application/xml, text/xml

Sample:

<SwitchKeyBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.BindingModel">
  <IsTou>true</IsTou>
  <SwitchId>1</SwitchId>
  <SwitchPlan xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfNullableOfConsumptionTypeEBsE6hz0TariffPlaniNCYp_P09>
      <d2p1:Key>Electricity</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.Switch">
        <d4p1:PayMethod>MonthlyDirectDebit</d4p1:PayMethod>
        <d4p1:TariffId>1</d4p1:TariffId>
      </d2p1:Value>
    </d2p1:KeyValueOfNullableOfConsumptionTypeEBsE6hz0TariffPlaniNCYp_P09>
  </SwitchPlan>
  <SwitchType>DualConsolidatedToDualConsolidated</SwitchType>
</SwitchKeyBindingModel>

multipart/form-data

Sample:

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

DualConsolidatedToDualConsolidated
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SwitchPlan[0].Key"

Electricity
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SwitchPlan[0].Value.TariffId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SwitchPlan[0].Value.PayMethod"

MonthlyDirectDebit
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SwitchId"

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

True
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

GeniusSwitchKeyDtoResponse

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

Response Formats

application/json, text/json

Sample:

{
  "apiVersion": "sample string 1",
  "uri": "sample string 2",
  "geniusSwitchKeyDto": {
    "switchKey": "sample string 1",
    "info": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<GeniusSwitchKeyDtoResponse 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>
  <GeniusSwitchKeyDto xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.Dto">
    <d2p1:Info>sample string 2</d2p1:Info>
    <d2p1:SwitchKey>sample string 1</d2p1:SwitchKey>
  </GeniusSwitchKeyDto>
  <Uri>sample string 2</Uri>
</GeniusSwitchKeyDtoResponse>

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="GeniusSwitchKeyDto.SwitchKey"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="GeniusSwitchKeyDto.Info"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e--