GET Api/Presale/Detail/{PresaleID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| PresaleID | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
ResultOfObjectPresaleData| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| Message | string |
None. |
|
| ErrorMessage | Collection of string |
None. |
|
| Value | ObjectPresaleData |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"Message": "sample string 2",
"ErrorMessage": [
"sample string 1",
"sample string 2"
],
"Value": {
"IsHasOSQuote": true,
"InitPresaleData": {
"PresaleID": 1,
"UserID": 2,
"IsInbound": true,
"CRN": "sample string 4",
"LeadID": "sample string 5",
"FirstName": "sample string 6",
"LastName": "sample string 7",
"Phone1": "sample string 8",
"Phone2": "sample string 9",
"CampaignCode": "sample string 10",
"SessionID": "sample string 11"
},
"YourInformationData": {
"PresaleID": 1,
"EnergyTypeID": 1,
"CustomerTypeID": 1,
"IsMoving": true,
"MovingDate": "sample string 2",
"IsSolar": true,
"IsSolarSystemGreater10kw": true
},
"YourDetails": {
"PresaleID": 1,
"ElecRetailerID": 1,
"GasRetailerID": 1,
"IsBill": true,
"IsAddress": true,
"FullAddress": "sample string 2",
"BuildingName": "sample string 3",
"FloorNumber": "sample string 4",
"LotNumber": "sample string 5",
"UnitNumber": "sample string 6",
"UnitType": "sample string 7",
"StreetNumber": "sample string 8",
"StreetName": "sample string 9",
"StreetTypeID": "sample string 10",
"StreetTypeName": "sample string 11",
"Postcode": "sample string 12",
"Suburb": "sample string 13",
"StateCode": "sample string 14",
"NMI": "sample string 15",
"MIRN": "sample string 16",
"ElecTariffCode": "sample string 17",
"ElecTariffType": "sample string 18",
"ElecBillStartDate": "sample string 19",
"ElecBillEndDate": "sample string 20",
"ElecBillingDays": "sample string 21",
"ElecUsageLevel": "sample string 22",
"ElecPeakUsageAmount": "sample string 23",
"ElecOffPeakUsageAmount": "sample string 24",
"ElecShoulder": "sample string 25",
"ElecCLUsage1": "sample string 26",
"ElecCLUsage2": "sample string 27",
"ElecClimateSaverUsage": "sample string 28",
"ElecCLPeakUsage": "sample string 29",
"ElecCLOffPeakUsage": "sample string 30",
"ElecCLSolarSpungeUsage": "sample string 31",
"ElecLowDemandUsage": "sample string 32",
"ElecHighDemandUsage": "sample string 33",
"ElecTotalDemandUsage": "sample string 34",
"ElecLowDemandDays": "sample string 35",
"ElecHighDemandDays": "sample string 36",
"ElecDailyDemandUsage": "sample string 37",
"ElecDemandDaysUsage": "sample string 38",
"GasBillStartDate": "sample string 39",
"GasBillEndDate": "sample string 40",
"GasBillingDays": "sample string 41",
"GasTarifCode": "sample string 42",
"GasUsageAmount": "sample string 43",
"GasOffPeakUsageAmount": "sample string 44",
"GasUsageLevel": "sample string 45",
"SolarUsage": "sample string 46",
"IsGasBill": true,
"IsLifeSupport": true,
"IsConnectInternetToNewProperty": true,
"SolarTariff": "sample string 47",
"SolarTariffFull": "sample string 48",
"Notes": "sample string 49",
"GasCostOfCustomerBill": 1.0,
"ElecCostOfCustomerBill": 1.0
},
"SelectedComparison": {
"ElectricitySelection": {
"PlanID": 1,
"PlanName": "sample string 1",
"RateID": 1,
"RetailerID": 1,
"RetailerName": "sample string 2",
"DistributorID": 1,
"DistributorName": "sample string 3",
"TermsCondition": "sample string 4"
},
"GasSelection": {
"PlanID": 1,
"PlanName": "sample string 1",
"RateID": 1,
"RetailerID": 1,
"RetailerName": "sample string 2",
"DistributorID": 1,
"DistributorName": "sample string 3",
"TermsCondition": "sample string 4"
}
}
}
}
application/xml, text/xml
Sample:
<ResultOfObjectPresaleDataJww9bCf9 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 xmlns:d2p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewPresales.Objects">
<d2p1:InitPresaleData>
<d2p1:CRN>sample string 4</d2p1:CRN>
<d2p1:CampaignCode>sample string 10</d2p1:CampaignCode>
<d2p1:FirstName>sample string 6</d2p1:FirstName>
<d2p1:IsInbound>true</d2p1:IsInbound>
<d2p1:LastName>sample string 7</d2p1:LastName>
<d2p1:LeadID>sample string 5</d2p1:LeadID>
<d2p1:Phone1>sample string 8</d2p1:Phone1>
<d2p1:Phone2>sample string 9</d2p1:Phone2>
<d2p1:PresaleID>1</d2p1:PresaleID>
<d2p1:SessionID>sample string 11</d2p1:SessionID>
<d2p1:UserID>2</d2p1:UserID>
</d2p1:InitPresaleData>
<d2p1:IsHasOSQuote>true</d2p1:IsHasOSQuote>
<d2p1:SelectedComparison>
<d2p1:ElectricitySelection>
<d2p1:DistributorID>1</d2p1:DistributorID>
<d2p1:DistributorName>sample string 3</d2p1:DistributorName>
<d2p1:PlanID>1</d2p1:PlanID>
<d2p1:PlanName>sample string 1</d2p1:PlanName>
<d2p1:RateID>1</d2p1:RateID>
<d2p1:RetailerID>1</d2p1:RetailerID>
<d2p1:RetailerName>sample string 2</d2p1:RetailerName>
<d2p1:TermsCondition>sample string 4</d2p1:TermsCondition>
</d2p1:ElectricitySelection>
<d2p1:GasSelection>
<d2p1:DistributorID>1</d2p1:DistributorID>
<d2p1:DistributorName>sample string 3</d2p1:DistributorName>
<d2p1:PlanID>1</d2p1:PlanID>
<d2p1:PlanName>sample string 1</d2p1:PlanName>
<d2p1:RateID>1</d2p1:RateID>
<d2p1:RetailerID>1</d2p1:RetailerID>
<d2p1:RetailerName>sample string 2</d2p1:RetailerName>
<d2p1:TermsCondition>sample string 4</d2p1:TermsCondition>
</d2p1:GasSelection>
</d2p1:SelectedComparison>
<d2p1:YourDetails>
<d2p1:BuildingName>sample string 3</d2p1:BuildingName>
<d2p1:ElecBillEndDate>sample string 20</d2p1:ElecBillEndDate>
<d2p1:ElecBillStartDate>sample string 19</d2p1:ElecBillStartDate>
<d2p1:ElecBillingDays>sample string 21</d2p1:ElecBillingDays>
<d2p1:ElecCLOffPeakUsage>sample string 30</d2p1:ElecCLOffPeakUsage>
<d2p1:ElecCLPeakUsage>sample string 29</d2p1:ElecCLPeakUsage>
<d2p1:ElecCLSolarSpungeUsage>sample string 31</d2p1:ElecCLSolarSpungeUsage>
<d2p1:ElecCLUsage1>sample string 26</d2p1:ElecCLUsage1>
<d2p1:ElecCLUsage2>sample string 27</d2p1:ElecCLUsage2>
<d2p1:ElecClimateSaverUsage>sample string 28</d2p1:ElecClimateSaverUsage>
<d2p1:ElecCostOfCustomerBill>1</d2p1:ElecCostOfCustomerBill>
<d2p1:ElecDailyDemandUsage>sample string 37</d2p1:ElecDailyDemandUsage>
<d2p1:ElecDemandDaysUsage>sample string 38</d2p1:ElecDemandDaysUsage>
<d2p1:ElecHighDemandDays>sample string 36</d2p1:ElecHighDemandDays>
<d2p1:ElecHighDemandUsage>sample string 33</d2p1:ElecHighDemandUsage>
<d2p1:ElecLowDemandDays>sample string 35</d2p1:ElecLowDemandDays>
<d2p1:ElecLowDemandUsage>sample string 32</d2p1:ElecLowDemandUsage>
<d2p1:ElecOffPeakUsageAmount>sample string 24</d2p1:ElecOffPeakUsageAmount>
<d2p1:ElecPeakUsageAmount>sample string 23</d2p1:ElecPeakUsageAmount>
<d2p1:ElecRetailerID>1</d2p1:ElecRetailerID>
<d2p1:ElecShoulder>sample string 25</d2p1:ElecShoulder>
<d2p1:ElecTariffCode>sample string 17</d2p1:ElecTariffCode>
<d2p1:ElecTariffType>sample string 18</d2p1:ElecTariffType>
<d2p1:ElecTotalDemandUsage>sample string 34</d2p1:ElecTotalDemandUsage>
<d2p1:ElecUsageLevel>sample string 22</d2p1:ElecUsageLevel>
<d2p1:FloorNumber>sample string 4</d2p1:FloorNumber>
<d2p1:FullAddress>sample string 2</d2p1:FullAddress>
<d2p1:GasBillEndDate>sample string 40</d2p1:GasBillEndDate>
<d2p1:GasBillStartDate>sample string 39</d2p1:GasBillStartDate>
<d2p1:GasBillingDays>sample string 41</d2p1:GasBillingDays>
<d2p1:GasCostOfCustomerBill>1</d2p1:GasCostOfCustomerBill>
<d2p1:GasOffPeakUsageAmount>sample string 44</d2p1:GasOffPeakUsageAmount>
<d2p1:GasRetailerID>1</d2p1:GasRetailerID>
<d2p1:GasTarifCode>sample string 42</d2p1:GasTarifCode>
<d2p1:GasUsageAmount>sample string 43</d2p1:GasUsageAmount>
<d2p1:GasUsageLevel>sample string 45</d2p1:GasUsageLevel>
<d2p1:IsAddress>true</d2p1:IsAddress>
<d2p1:IsBill>true</d2p1:IsBill>
<d2p1:IsConnectInternetToNewProperty>true</d2p1:IsConnectInternetToNewProperty>
<d2p1:IsGasBill>true</d2p1:IsGasBill>
<d2p1:IsLifeSupport>true</d2p1:IsLifeSupport>
<d2p1:LotNumber>sample string 5</d2p1:LotNumber>
<d2p1:MIRN>sample string 16</d2p1:MIRN>
<d2p1:NMI>sample string 15</d2p1:NMI>
<d2p1:Notes>sample string 49</d2p1:Notes>
<d2p1:Postcode>sample string 12</d2p1:Postcode>
<d2p1:PresaleID>1</d2p1:PresaleID>
<d2p1:SolarTariff>sample string 47</d2p1:SolarTariff>
<d2p1:SolarTariffFull>sample string 48</d2p1:SolarTariffFull>
<d2p1:SolarUsage>sample string 46</d2p1:SolarUsage>
<d2p1:StateCode>sample string 14</d2p1:StateCode>
<d2p1:StreetName>sample string 9</d2p1:StreetName>
<d2p1:StreetNumber>sample string 8</d2p1:StreetNumber>
<d2p1:StreetTypeID>sample string 10</d2p1:StreetTypeID>
<d2p1:StreetTypeName>sample string 11</d2p1:StreetTypeName>
<d2p1:Suburb>sample string 13</d2p1:Suburb>
<d2p1:UnitNumber>sample string 6</d2p1:UnitNumber>
<d2p1:UnitType>sample string 7</d2p1:UnitType>
</d2p1:YourDetails>
<d2p1:YourInformationData>
<d2p1:CustomerTypeID>1</d2p1:CustomerTypeID>
<d2p1:EnergyTypeID>1</d2p1:EnergyTypeID>
<d2p1:IsMoving>true</d2p1:IsMoving>
<d2p1:IsSolar>true</d2p1:IsSolar>
<d2p1:IsSolarSystemGreater10kw>true</d2p1:IsSolarSystemGreater10kw>
<d2p1:MovingDate>sample string 2</d2p1:MovingDate>
<d2p1:PresaleID>1</d2p1:PresaleID>
</d2p1:YourInformationData>
</Value>
</ResultOfObjectPresaleDataJww9bCf9>