POST Api/Presale/UpdateNote
Request Information
URI Parameters
None.
Body Parameters
ParamUpdatePresaleYourDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| PresaleID | integer |
None. |
|
| ElecRetailerID | integer |
None. |
|
| GasRetailerID | integer |
None. |
|
| IsBill | boolean |
None. |
|
| IsAddress | boolean |
None. |
|
| FullAddress | string |
None. |
|
| UnitNumber | string |
None. |
|
| UnitType | string |
None. |
|
| StreetNumber | string |
None. |
|
| StreetName | string |
None. |
|
| StreetTypeID | integer |
None. |
|
| Postcode | string |
None. |
|
| Suburb | string |
None. |
|
| StateCode | string |
None. |
|
| NMI | string |
None. |
|
| MIRN | string |
None. |
|
| ElecTariffCode | string |
None. |
|
| ElecBillStartDate | string |
None. |
|
| ElecBillEndDate | string |
None. |
|
| ElecBillDays | string |
None. |
|
| ElecUsageLevel | string |
None. |
|
| ElecPeakUsageAmount | string |
None. |
|
| ElecOffPeakUsageAmount | string |
None. |
|
| ElecShoulder | string |
None. |
|
| ElecCLUsage1 | string |
None. |
|
| ElecCLUsage2 | string |
None. |
|
| ElecClimateSaverUsage | string |
None. |
|
| GasBillStartDate | string |
None. |
|
| GasBillEndDate | string |
None. |
|
| GasBillDays | string |
None. |
|
| GasTarifCode | string |
None. |
|
| GasUsageAmount | string |
None. |
|
| GasOffPeakUsageAmount | string |
None. |
|
| GasUsageLevel | string |
None. |
|
| SolarUsage | string |
None. |
|
| IsGasBill | boolean |
None. |
|
| SolarTariff | string |
None. |
|
| SolarTariffFull | string |
None. |
|
| Notes | string |
None. |
|
| AgentID | integer |
None. |
|
| IsUpdateGas | boolean |
None. |
|
| IsUpdateElec | boolean |
None. |
|
| ElecCLPeakUsage | string |
None. |
|
| ElecCLOffPeakUsage | string |
None. |
|
| ElecCLSolarSpungeUsage | string |
None. |
|
| ElecLowDemandUsage | string |
None. |
|
| ElecHighDemandUsage | string |
None. |
|
| ElecTotalDemandUsage | string |
None. |
|
| ElecDailyDemandUsage | string |
None. |
|
| ElecDemandDaysUsage | string |
None. |
|
| ElecLowDemandDays | string |
None. |
|
| ElecHighDemandDays | string |
None. |
|
| IsMoving | boolean |
None. |
|
| MovingDate | string |
None. |
|
| IsConnectedElectricityAndGas | boolean |
None. |
|
| IsLookEnergyPlans | boolean |
None. |
|
| CurrentInternetRetailerID | integer |
None. |
|
| IsUpdateInternet | boolean |
None. |
|
| ElecCostOfCustomerBill | decimal number |
None. |
|
| GasCostOfCustomerBill | decimal number |
None. |
Request Formats
application/json, text/json
Sample:
{
"PresaleID": 1,
"ElecRetailerID": 1,
"GasRetailerID": 1,
"IsBill": true,
"IsAddress": true,
"FullAddress": "sample string 4",
"UnitNumber": "sample string 5",
"UnitType": "sample string 6",
"StreetNumber": "sample string 7",
"StreetName": "sample string 8",
"StreetTypeID": 9,
"Postcode": "sample string 10",
"Suburb": "sample string 11",
"StateCode": "sample string 12",
"NMI": "sample string 13",
"MIRN": "sample string 14",
"ElecTariffCode": "sample string 15",
"ElecBillStartDate": "sample string 16",
"ElecBillEndDate": "sample string 17",
"ElecBillDays": "sample string 18",
"ElecUsageLevel": "sample string 19",
"ElecPeakUsageAmount": "sample string 20",
"ElecOffPeakUsageAmount": "sample string 21",
"ElecShoulder": "sample string 22",
"ElecCLUsage1": "sample string 23",
"ElecCLUsage2": "sample string 24",
"ElecClimateSaverUsage": "sample string 25",
"GasBillStartDate": "sample string 26",
"GasBillEndDate": "sample string 27",
"GasBillDays": "sample string 28",
"GasTarifCode": "sample string 29",
"GasUsageAmount": "sample string 30",
"GasOffPeakUsageAmount": "sample string 31",
"GasUsageLevel": "sample string 32",
"SolarUsage": "sample string 33",
"IsGasBill": true,
"SolarTariff": "sample string 34",
"SolarTariffFull": "sample string 35",
"Notes": "sample string 36",
"AgentID": 1,
"IsUpdateGas": true,
"IsUpdateElec": true,
"ElecCLPeakUsage": "sample string 37",
"ElecCLOffPeakUsage": "sample string 38",
"ElecCLSolarSpungeUsage": "sample string 39",
"ElecLowDemandUsage": "sample string 40",
"ElecHighDemandUsage": "sample string 41",
"ElecTotalDemandUsage": "sample string 42",
"ElecDailyDemandUsage": "sample string 43",
"ElecDemandDaysUsage": "sample string 44",
"ElecLowDemandDays": "sample string 45",
"ElecHighDemandDays": "sample string 46",
"IsMoving": true,
"MovingDate": "sample string 47",
"IsConnectedElectricityAndGas": true,
"IsLookEnergyPlans": true,
"CurrentInternetRetailerID": 1,
"IsUpdateInternet": true,
"ElecCostOfCustomerBill": 1.0,
"GasCostOfCustomerBill": 1.0
}
application/xml, text/xml
Sample:
<ParamUpdatePresaleYourDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewPresales.Parameters"> <AgentID>1</AgentID> <CurrentInternetRetailerID>1</CurrentInternetRetailerID> <ElecBillDays>sample string 18</ElecBillDays> <ElecBillEndDate>sample string 17</ElecBillEndDate> <ElecBillStartDate>sample string 16</ElecBillStartDate> <ElecCLOffPeakUsage>sample string 38</ElecCLOffPeakUsage> <ElecCLPeakUsage>sample string 37</ElecCLPeakUsage> <ElecCLSolarSpungeUsage>sample string 39</ElecCLSolarSpungeUsage> <ElecCLUsage1>sample string 23</ElecCLUsage1> <ElecCLUsage2>sample string 24</ElecCLUsage2> <ElecClimateSaverUsage>sample string 25</ElecClimateSaverUsage> <ElecCostOfCustomerBill>1</ElecCostOfCustomerBill> <ElecDailyDemandUsage>sample string 43</ElecDailyDemandUsage> <ElecDemandDaysUsage>sample string 44</ElecDemandDaysUsage> <ElecHighDemandDays>sample string 46</ElecHighDemandDays> <ElecHighDemandUsage>sample string 41</ElecHighDemandUsage> <ElecLowDemandDays>sample string 45</ElecLowDemandDays> <ElecLowDemandUsage>sample string 40</ElecLowDemandUsage> <ElecOffPeakUsageAmount>sample string 21</ElecOffPeakUsageAmount> <ElecPeakUsageAmount>sample string 20</ElecPeakUsageAmount> <ElecRetailerID>1</ElecRetailerID> <ElecShoulder>sample string 22</ElecShoulder> <ElecTariffCode>sample string 15</ElecTariffCode> <ElecTotalDemandUsage>sample string 42</ElecTotalDemandUsage> <ElecUsageLevel>sample string 19</ElecUsageLevel> <FullAddress>sample string 4</FullAddress> <GasBillDays>sample string 28</GasBillDays> <GasBillEndDate>sample string 27</GasBillEndDate> <GasBillStartDate>sample string 26</GasBillStartDate> <GasCostOfCustomerBill>1</GasCostOfCustomerBill> <GasOffPeakUsageAmount>sample string 31</GasOffPeakUsageAmount> <GasRetailerID>1</GasRetailerID> <GasTarifCode>sample string 29</GasTarifCode> <GasUsageAmount>sample string 30</GasUsageAmount> <GasUsageLevel>sample string 32</GasUsageLevel> <IsAddress>true</IsAddress> <IsBill>true</IsBill> <IsConnectedElectricityAndGas>true</IsConnectedElectricityAndGas> <IsGasBill>true</IsGasBill> <IsLookEnergyPlans>true</IsLookEnergyPlans> <IsMoving>true</IsMoving> <IsUpdateElec>true</IsUpdateElec> <IsUpdateGas>true</IsUpdateGas> <IsUpdateInternet>true</IsUpdateInternet> <MIRN>sample string 14</MIRN> <MovingDate>sample string 47</MovingDate> <NMI>sample string 13</NMI> <Notes>sample string 36</Notes> <Postcode>sample string 10</Postcode> <PresaleID>1</PresaleID> <SolarTariff>sample string 34</SolarTariff> <SolarTariffFull>sample string 35</SolarTariffFull> <SolarUsage>sample string 33</SolarUsage> <StateCode>sample string 12</StateCode> <StreetName>sample string 8</StreetName> <StreetNumber>sample string 7</StreetNumber> <StreetTypeID>9</StreetTypeID> <Suburb>sample string 11</Suburb> <UnitNumber>sample string 5</UnitNumber> <UnitType>sample string 6</UnitType> </ParamUpdatePresaleYourDetails>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResultOfBoolean| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| Message | string |
None. |
|
| ErrorMessage | Collection of string |
None. |
|
| Value | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"Message": "sample string 2",
"ErrorMessage": [
"sample string 1",
"sample string 2"
],
"Value": true
}
application/xml, text/xml
Sample:
<ResultOfboolean xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Common.Returns">
<ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ErrorMessage>
<Message>sample string 2</Message>
<Success>true</Success>
<Value>true</Value>
</ResultOfboolean>