POST request/Switch/Pro/Detail/Terms-And-Conditions

Returns a set of specific energy supplier consents (opt in/out) captures for a consumer switching energy to provide as mandatory and/or optional.

Request Information

URI Parameters

None.

Body Parameters

The switch completion binding model.

SwitchCompletionInfoBindingModel
NameDescriptionTypeAdditional 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

RequiredTermsAndConditionsDtoResponse
NameDescriptionTypeAdditional information
ApiVersion

string

None.
RequiredTermsAndConditionsDto

RequiredTermsAndConditionsDto

None.
Uri

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "apiVersion": "sample string 1",
  "uri": "sample string 2",
  "requiredTermsAndConditionsDto": {
    "requiredTermsAndConditions": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample: 
<RequiredTermsAndConditionsDtoResponse 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>
  <RequiredTermsAndConditionsDto xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.Dto">
    <d2p1:RequiredTermsAndConditions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:RequiredTermsAndConditions>
  </RequiredTermsAndConditionsDto>
  <Uri>sample string 2</Uri>
</RequiredTermsAndConditionsDtoResponse>

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="RequiredTermsAndConditionsDto.RequiredTermsAndConditions[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="RequiredTermsAndConditionsDto.RequiredTermsAndConditions[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e--