POST request/Switch/Pro/Info/Terms-And-Conditions
Returns consumer supplier opt/in out consents.
Request Information
URI Parameters
None.
Body Parameters
The switch completion 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
TermsAndConditionsInfoDtoResponseName | Description | Type | Additional information |
---|---|---|---|
ApiVersion | string |
None. |
|
TermsAndConditionsInfoDto | TermsAndConditionsInfoDto |
None. |
|
Uri | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "apiVersion": "sample string 1", "uri": "sample string 2", "termsAndConditionsInfoDto": { "mprnNumber": "sample string 1", "gasSmartMeterInstalled": true, "mpanNumber": "sample string 3", "electricitySmartMeterInstalled": true, "gasMainsConnectionToo": true, "suppliersTermsAndConditionsAreAccepted": true, "hasMedicalConditionOrIndividualRequirement": true, "specialNeeds": "sample string 8", "happyToReceiveCreditCheck": true, "happyWithNpowerTerms": true, "happyToHaveDebtInformationAccessed": true, "hasElectricityDebt": true, "hasGasDebt": true, "switchAfterCoolingOfPeriod": true, "preferredCommunicationMethod": "sample string 15", "preferredCommunicationFormat": "sample string 16", "supplierMaySendImportantAccountChangesViaEmail": true, "emailUpdatesByMyUtilitygenius": true, "preferredSwitchDate": "2025-04-04T10:55:54.7030745+00:00", "onlinePassword": "sample string 19", "eonRewardsWanted": true, "eonPriceAlertsWanted": true, "eonPaperlessBillingWanted": true, "isSharedInfo": true, "billingPreference": "Paper", "prePaymentMeter": "sample string 24", "tescoClubCardNumber": "sample string 25", "coOperativeMembershipNumber": "sample string 26", "interestedInJoiningTheCoOperative": true, "referral": "sample string 28", "supplierMaySendRemindersAndUpdatesViaTelephoneAboutAccount": true, "supplierMaySendRemindersAndUpdatesViaEmailAboutAccount": true, "supplierMaySendUpdatesThatMayBeOfInterestViaDayPhone": true, "supplierMaySendUpdatesThatMayBeOfInterestViaEveningPhone": true, "supplierMaySendUpdatesThatMayBeOfInterestViaMobilePhone": true, "supplierMaySendUpdatesThatMayBeOfInterestViaSms": true, "supplierMaySendUpdatesThatMayBeOfInterestViaEmail": true, "supplierMaySendUpdatesThatMayBeOfInterestViaPost": true, "supplierMaySendUpdatesThatMayBeOfInterestViaFaceToFace": true, "campaignCode": "sample string 38", "yesIamOnAGreenDeal": true, "ovoFoundationOption": "NoDonation", "ovoSecurityQuestion": "WhatWouldBeYourSuperpowerIfYouHadOne", "ovoSecurityAnswer": "sample string 40", "communicationPreferenceOverride": "None", "allUpdatesRemindersAndThirdPartyOverride": true, "allUpdatesRemindersOverride": true } }
application/xml, text/xml
Sample:
<TermsAndConditionsInfoDtoResponse 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> <TermsAndConditionsInfoDto xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.Dto"> <d2p1:AllUpdatesRemindersAndThirdPartyOverride>true</d2p1:AllUpdatesRemindersAndThirdPartyOverride> <d2p1:AllUpdatesRemindersOverride>true</d2p1:AllUpdatesRemindersOverride> <d2p1:BillingPreference>Paper</d2p1:BillingPreference> <d2p1:CampaignCode>sample string 38</d2p1:CampaignCode> <d2p1:CoOperativeMembershipNumber>sample string 26</d2p1:CoOperativeMembershipNumber> <d2p1:CommunicationPreferenceOverride>None</d2p1:CommunicationPreferenceOverride> <d2p1:ElectricitySmartMeterInstalled>true</d2p1:ElectricitySmartMeterInstalled> <d2p1:EmailUpdatesByMyUtilitygenius>true</d2p1:EmailUpdatesByMyUtilitygenius> <d2p1:EonPaperlessBillingWanted>true</d2p1:EonPaperlessBillingWanted> <d2p1:EonPriceAlertsWanted>true</d2p1:EonPriceAlertsWanted> <d2p1:EonRewardsWanted>true</d2p1:EonRewardsWanted> <d2p1:GasMainsConnectionToo>true</d2p1:GasMainsConnectionToo> <d2p1:GasSmartMeterInstalled>true</d2p1:GasSmartMeterInstalled> <d2p1:HappyToHaveDebtInformationAccessed>true</d2p1:HappyToHaveDebtInformationAccessed> <d2p1:HappyToReceiveCreditCheck>true</d2p1:HappyToReceiveCreditCheck> <d2p1:HappyWithNpowerTerms>true</d2p1:HappyWithNpowerTerms> <d2p1:HasElectricityDebt>true</d2p1:HasElectricityDebt> <d2p1:HasGasDebt>true</d2p1:HasGasDebt> <d2p1:HasMedicalConditionOrIndividualRequirement>true</d2p1:HasMedicalConditionOrIndividualRequirement> <d2p1:InterestedInJoiningTheCoOperative>true</d2p1:InterestedInJoiningTheCoOperative> <d2p1:IsSharedInfo>true</d2p1:IsSharedInfo> <d2p1:MpanNumber>sample string 3</d2p1:MpanNumber> <d2p1:MprnNumber>sample string 1</d2p1:MprnNumber> <d2p1:OnlinePassword>sample string 19</d2p1:OnlinePassword> <d2p1:OvoFoundationOption>NoDonation</d2p1:OvoFoundationOption> <d2p1:OvoSecurityAnswer>sample string 40</d2p1:OvoSecurityAnswer> <d2p1:OvoSecurityQuestion>WhatWouldBeYourSuperpowerIfYouHadOne</d2p1:OvoSecurityQuestion> <d2p1:PrePaymentMeter>sample string 24</d2p1:PrePaymentMeter> <d2p1:PreferredCommunicationFormat>sample string 16</d2p1:PreferredCommunicationFormat> <d2p1:PreferredCommunicationMethod>sample string 15</d2p1:PreferredCommunicationMethod> <d2p1:PreferredSwitchDate>2025-04-04T10:55:54.7030745+00:00</d2p1:PreferredSwitchDate> <d2p1:Referral>sample string 28</d2p1:Referral> <d2p1:SpecialNeeds>sample string 8</d2p1:SpecialNeeds> <d2p1:SupplierMaySendImportantAccountChangesViaEmail>true</d2p1:SupplierMaySendImportantAccountChangesViaEmail> <d2p1:SupplierMaySendRemindersAndUpdatesViaEmailAboutAccount>true</d2p1:SupplierMaySendRemindersAndUpdatesViaEmailAboutAccount> <d2p1:SupplierMaySendRemindersAndUpdatesViaTelephoneAboutAccount>true</d2p1:SupplierMaySendRemindersAndUpdatesViaTelephoneAboutAccount> <d2p1:SupplierMaySendUpdatesThatMayBeOfInterestViaDayPhone>true</d2p1:SupplierMaySendUpdatesThatMayBeOfInterestViaDayPhone> <d2p1:SupplierMaySendUpdatesThatMayBeOfInterestViaEmail>true</d2p1:SupplierMaySendUpdatesThatMayBeOfInterestViaEmail> <d2p1:SupplierMaySendUpdatesThatMayBeOfInterestViaEveningPhone>true</d2p1:SupplierMaySendUpdatesThatMayBeOfInterestViaEveningPhone> <d2p1:SupplierMaySendUpdatesThatMayBeOfInterestViaFaceToFace>true</d2p1:SupplierMaySendUpdatesThatMayBeOfInterestViaFaceToFace> <d2p1:SupplierMaySendUpdatesThatMayBeOfInterestViaMobilePhone>true</d2p1:SupplierMaySendUpdatesThatMayBeOfInterestViaMobilePhone> <d2p1:SupplierMaySendUpdatesThatMayBeOfInterestViaPost>true</d2p1:SupplierMaySendUpdatesThatMayBeOfInterestViaPost> <d2p1:SupplierMaySendUpdatesThatMayBeOfInterestViaSms>true</d2p1:SupplierMaySendUpdatesThatMayBeOfInterestViaSms> <d2p1:SuppliersTermsAndConditionsAreAccepted>true</d2p1:SuppliersTermsAndConditionsAreAccepted> <d2p1:SwitchAfterCoolingOfPeriod>true</d2p1:SwitchAfterCoolingOfPeriod> <d2p1:TescoClubCardNumber>sample string 25</d2p1:TescoClubCardNumber> <d2p1:YesIamOnAGreenDeal>true</d2p1:YesIamOnAGreenDeal> </TermsAndConditionsInfoDto> <Uri>sample string 2</Uri> </TermsAndConditionsInfoDtoResponse>
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="TermsAndConditionsInfoDto.MprnNumber" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.GasSmartMeterInstalled" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.MpanNumber" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.ElectricitySmartMeterInstalled" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.GasMainsConnectionToo" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.SuppliersTermsAndConditionsAreAccepted" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.HasMedicalConditionOrIndividualRequirement" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.SpecialNeeds" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.HappyToReceiveCreditCheck" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.HappyWithNpowerTerms" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.HappyToHaveDebtInformationAccessed" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.HasElectricityDebt" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.HasGasDebt" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.SwitchAfterCoolingOfPeriod" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.PreferredCommunicationMethod" sample string 15 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.PreferredCommunicationFormat" sample string 16 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.SupplierMaySendImportantAccountChangesViaEmail" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.EmailUpdatesByMyUtilitygenius" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.PreferredSwitchDate" 2025-04-04T10:55:54.7030745+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.OnlinePassword" sample string 19 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.EonRewardsWanted" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.EonPriceAlertsWanted" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.EonPaperlessBillingWanted" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.IsSharedInfo" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.BillingPreference" Paper --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.PrePaymentMeter" sample string 24 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.TescoClubCardNumber" sample string 25 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.CoOperativeMembershipNumber" sample string 26 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.InterestedInJoiningTheCoOperative" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.Referral" sample string 28 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.SupplierMaySendRemindersAndUpdatesViaTelephoneAboutAccount" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.SupplierMaySendRemindersAndUpdatesViaEmailAboutAccount" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.SupplierMaySendUpdatesThatMayBeOfInterestViaDayPhone" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.SupplierMaySendUpdatesThatMayBeOfInterestViaEveningPhone" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.SupplierMaySendUpdatesThatMayBeOfInterestViaMobilePhone" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.SupplierMaySendUpdatesThatMayBeOfInterestViaSms" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.SupplierMaySendUpdatesThatMayBeOfInterestViaEmail" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.SupplierMaySendUpdatesThatMayBeOfInterestViaPost" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.SupplierMaySendUpdatesThatMayBeOfInterestViaFaceToFace" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.CampaignCode" sample string 38 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.YesIamOnAGreenDeal" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.OvoFoundationOption" NoDonation --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.OvoSecurityQuestion" WhatWouldBeYourSuperpowerIfYouHadOne --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.OvoSecurityAnswer" sample string 40 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.CommunicationPreferenceOverride" None --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.AllUpdatesRemindersAndThirdPartyOverride" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TermsAndConditionsInfoDto.AllUpdatesRemindersOverride" True --MultipartDataMediaFormatterBoundary1q2w3e--