GET Api/CRN/Detail?CRN={CRN}&email={email}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CRN | string |
Required |
|
| string |
None. |
Body Parameters
None.
Response Information
Resource Description
ResultOfChurn| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| Message | string |
None. |
|
| ErrorMessage | Collection of string |
None. |
|
| Value | Churn |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"Message": "sample string 2",
"ErrorMessage": [
"sample string 1",
"sample string 2"
],
"Value": {
"ChurnID": "sample string 1",
"CRN": "sample string 2",
"TitleID": 1,
"TitleName": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"CustomerName": "sample string 6",
"Phone1": "sample string 7",
"Phone2": "sample string 8",
"FlatUnitNumber": "sample string 9",
"StreetNumber": "sample string 10",
"StreetName": "sample string 11",
"Suburb": "sample string 12",
"StateName": "sample string 13",
"DateOfBirth": "sample string 14",
"BusinessName": "sample string 15",
"ABN": "sample string 16",
"CustomerTypeID": 17,
"CustomerTypeCode": "sample string 18",
"Email": "sample string 19",
"IDType": "sample string 20",
"IDNumber": "sample string 21",
"StreetType": "sample string 22",
"IDExpiryDate": "sample string 23",
"IDFirstName": "sample string 24",
"IDMiddleName": "sample string 25",
"IDLastName": "sample string 26",
"IDColour": "sample string 27",
"IDExpiry": "sample string 28",
"IDRefNumber": "sample string 29",
"IDState": "sample string 30",
"ElecMeterNumber": "sample string 31",
"GasMeterNumber": "sample string 32",
"PostalCode": "sample string 33",
"NMI": "sample string 34",
"MIRN": "sample string 35",
"CurrentRetailerID": 1,
"CurrentRetailer": "sample string 36",
"ChosenPlan": "sample string 37",
"SaleDate": "sample string 38",
"EnergyType": "sample string 39",
"FeedInType": "sample string 40",
"ChurnStatus": "sample string 41",
"IsSolar": true,
"ElectricityUsage": "sample string 42",
"TariffCode": "sample string 43",
"AgentName": "sample string 44",
"MovingDate": "sample string 45",
"ChurnStatusGas": "sample string 46"
}
}
application/xml, text/xml
Sample:
<ResultOfChurnVHDxlVkh 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.Master.Objects">
<d2p1:ABN>sample string 16</d2p1:ABN>
<d2p1:AgentName>sample string 44</d2p1:AgentName>
<d2p1:BusinessName>sample string 15</d2p1:BusinessName>
<d2p1:CRN>sample string 2</d2p1:CRN>
<d2p1:ChosenPlan>sample string 37</d2p1:ChosenPlan>
<d2p1:ChurnID>sample string 1</d2p1:ChurnID>
<d2p1:ChurnStatus>sample string 41</d2p1:ChurnStatus>
<d2p1:ChurnStatusGas>sample string 46</d2p1:ChurnStatusGas>
<d2p1:CurrentRetailer>sample string 36</d2p1:CurrentRetailer>
<d2p1:CurrentRetailerID>1</d2p1:CurrentRetailerID>
<d2p1:CustomerName>sample string 6</d2p1:CustomerName>
<d2p1:CustomerTypeCode>sample string 18</d2p1:CustomerTypeCode>
<d2p1:CustomerTypeID>17</d2p1:CustomerTypeID>
<d2p1:DateOfBirth>sample string 14</d2p1:DateOfBirth>
<d2p1:ElecMeterNumber>sample string 31</d2p1:ElecMeterNumber>
<d2p1:ElectricityUsage>sample string 42</d2p1:ElectricityUsage>
<d2p1:Email>sample string 19</d2p1:Email>
<d2p1:EnergyType>sample string 39</d2p1:EnergyType>
<d2p1:FeedInType>sample string 40</d2p1:FeedInType>
<d2p1:FirstName>sample string 4</d2p1:FirstName>
<d2p1:FlatUnitNumber>sample string 9</d2p1:FlatUnitNumber>
<d2p1:GasMeterNumber>sample string 32</d2p1:GasMeterNumber>
<d2p1:IDColour>sample string 27</d2p1:IDColour>
<d2p1:IDExpiry>sample string 28</d2p1:IDExpiry>
<d2p1:IDExpiryDate>sample string 23</d2p1:IDExpiryDate>
<d2p1:IDFirstName>sample string 24</d2p1:IDFirstName>
<d2p1:IDLastName>sample string 26</d2p1:IDLastName>
<d2p1:IDMiddleName>sample string 25</d2p1:IDMiddleName>
<d2p1:IDNumber>sample string 21</d2p1:IDNumber>
<d2p1:IDRefNumber>sample string 29</d2p1:IDRefNumber>
<d2p1:IDState>sample string 30</d2p1:IDState>
<d2p1:IDType>sample string 20</d2p1:IDType>
<d2p1:IsSolar>true</d2p1:IsSolar>
<d2p1:LastName>sample string 5</d2p1:LastName>
<d2p1:MIRN>sample string 35</d2p1:MIRN>
<d2p1:MovingDate>sample string 45</d2p1:MovingDate>
<d2p1:NMI>sample string 34</d2p1:NMI>
<d2p1:Phone1>sample string 7</d2p1:Phone1>
<d2p1:Phone2>sample string 8</d2p1:Phone2>
<d2p1:PostalCode>sample string 33</d2p1:PostalCode>
<d2p1:SaleDate>sample string 38</d2p1:SaleDate>
<d2p1:StateName>sample string 13</d2p1:StateName>
<d2p1:StreetName>sample string 11</d2p1:StreetName>
<d2p1:StreetNumber>sample string 10</d2p1:StreetNumber>
<d2p1:StreetType>sample string 22</d2p1:StreetType>
<d2p1:Suburb>sample string 12</d2p1:Suburb>
<d2p1:TariffCode>sample string 43</d2p1:TariffCode>
<d2p1:TitleID>1</d2p1:TitleID>
<d2p1:TitleName>sample string 3</d2p1:TitleName>
</Value>
</ResultOfChurnVHDxlVkh>