POST request/Switch/Pro/Complete

Completes consumer’s switch to a new energy supplier.

Request Information

URI Parameters

None.

Body Parameters

The switch completion information binding model.

SwitchCompleteBindingModel
NameDescriptionTypeAdditional information
IsTou

boolean

None.

SwitchCompleteOption

SwitchCompleteOption

None.

SwitchKey

string

Required

Max length: 50

Min length: 1

Request Formats

application/json, text/json

Sample:
{
  "switchCompleteOption": "None",
  "switchKey": "sample string 1",
  "isTou": true
}

application/xml, text/xml

Sample:
<SwitchCompleteBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.BindingModel">
  <IsTou>true</IsTou>
  <SwitchKey>sample string 1</SwitchKey>
  <SwitchCompleteOption>None</SwitchCompleteOption>
</SwitchCompleteBindingModel>

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SwitchCompleteOption"

None
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SwitchKey"

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

True
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

GeniusSwitchedDtoResponse
NameDescriptionTypeAdditional information
ApiVersion

string

None.

GeniusSwitchedDto

GeniusSwitchedDto

None.

Uri

string

None.

Response Formats

application/json, text/json

Sample:
{
  "apiVersion": "sample string 1",
  "uri": "sample string 2",
  "geniusSwitchedDto": {
    "referenceNumbers": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "firstName": "sample string 1",
    "lastName": "sample string 2",
    "supplier": "sample string 3",
    "title": "sample string 4",
    "uuid": "sample string 5",
    "switchId": 6
  }
}

application/xml, text/xml

Sample:
<GeniusSwitchedDtoResponse 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>
  <GeniusSwitchedDto xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.Dto">
    <SwitchId xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.Switch">6</SwitchId>
    <d2p1:FirstName>sample string 1</d2p1:FirstName>
    <d2p1:LastName>sample string 2</d2p1:LastName>
    <d2p1:ReferenceNumbers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:ReferenceNumbers>
    <d2p1:Supplier>sample string 3</d2p1:Supplier>
    <d2p1:Title>sample string 4</d2p1:Title>
    <d2p1:uuid>sample string 5</d2p1:uuid>
  </GeniusSwitchedDto>
  <Uri>sample string 2</Uri>
</GeniusSwitchedDtoResponse>

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="GeniusSwitchedDto.ReferenceNumbers[0].Key"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="GeniusSwitchedDto.ReferenceNumbers[0].Value"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="GeniusSwitchedDto.ReferenceNumbers[1].Key"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="GeniusSwitchedDto.ReferenceNumbers[1].Value"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="GeniusSwitchedDto.FirstName"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="GeniusSwitchedDto.LastName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="GeniusSwitchedDto.Supplier"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="GeniusSwitchedDto.Title"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="GeniusSwitchedDto.uuid"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="GeniusSwitchedDto.SwitchId"

6
--MultipartDataMediaFormatterBoundary1q2w3e--