POST request/Switch/Pro/hold/switch
Request Information
URI Parameters
None.
Body Parameters
HoldSwitchCompleteBindingModelName | Description | Type | Additional information |
---|---|---|---|
CompletionDate | date |
None. |
|
CustomerId | integer |
None. |
|
IsTou | boolean |
None. |
|
PaymentMethod | PayMethod |
None. |
|
SwitchKey | string |
Required Max length: 50 Min length: 1 |
|
SwitchType | SwitchType |
None. |
|
TariffId | integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "customerId": 1, "tariffId": 2, "paymentMethod": "MonthlyDirectDebit", "completionDate": "2025-04-04T00:19:50.5431525+00:00", "switchType": "DualConsolidatedToDualConsolidated", "switchKey": "sample string 4", "isTou": true }
application/xml, text/xml
Sample:
<HoldSwitchCompleteBindingModel 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 4</SwitchKey> <CompletionDate>2025-04-04T00:19:50.5431525+00:00</CompletionDate> <CustomerId>1</CustomerId> <PaymentMethod>MonthlyDirectDebit</PaymentMethod> <SwitchType>DualConsolidatedToDualConsolidated</SwitchType> <TariffId>2</TariffId> </HoldSwitchCompleteBindingModel>
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CustomerId" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TariffId" 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="PaymentMethod" MonthlyDirectDebit --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CompletionDate" 2025-04-04T00:19:50.5431525+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SwitchType" DualConsolidatedToDualConsolidated --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SwitchKey" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IsTou" True --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
booleanResponse Formats
application/json, text/json
Sample:
true
application/xml, text/xml
Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="" True --MultipartDataMediaFormatterBoundary1q2w3e--