GET Api/Sales/GetEnergySignupHistoryByCRN/{crn}

Request Information

URI Parameters

Name	Description	Type	Additional information
crn		string	Required

Body Parameters

None.

Response Information

Resource Description

ResultOfEnergySignupHistoryResult

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
ErrorMessage	Collection of string	None.
Value	EnergySignupHistoryResult	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": {
    "CRN": "sample string 1",
    "LeadID": "sample string 2",
    "CampaignCode": "sample string 3",
    "CustomerDetail": {
      "Title": 1,
      "FirstName": "sample string 1",
      "MiddleName": "sample string 2",
      "LastName": "sample string 3",
      "DateOfBirth": "sample string 4"
    },
    "ContactDetail": {
      "LandlineNumber": "sample string 1",
      "MobileNumber": "sample string 2",
      "Email": "sample string 3"
    },
    "SecondaryCustomerDetail": {
      "Title": 1,
      "FirstName": "sample string 1",
      "MiddleName": "sample string 2",
      "LastName": "sample string 3",
      "DateOfBirth": "sample string 4"
    },
    "SecondaryContactDetail": {
      "LandlineNumber": "sample string 1",
      "MobileNumber": "sample string 2",
      "Email": "sample string 3"
    },
    "MainAddressDetail": {
      "FullAddress": "sample string 1",
      "FlatUnitNumber": "sample string 2",
      "StreetNumber": "sample string 3",
      "StreetName": "sample string 4",
      "StreetTypeID": 1,
      "Suburb": "sample string 5",
      "StateCode": "sample string 6",
      "PostCode": "sample string 7",
      "LotNumber": "sample string 8",
      "FloorNumber": "sample string 9",
      "BuildingName": "sample string 10",
      "BoxType": "sample string 11",
      "BoxNumber": "sample string 12",
      "UnitType": "sample string 13",
      "AddressType": "sample string 14"
    },
    "IsPostalAddress": true,
    "PostalAddressDetail": {
      "FullAddress": "sample string 1",
      "FlatUnitNumber": "sample string 2",
      "StreetNumber": "sample string 3",
      "StreetName": "sample string 4",
      "StreetTypeID": 1,
      "Suburb": "sample string 5",
      "StateCode": "sample string 6",
      "PostCode": "sample string 7",
      "LotNumber": "sample string 8",
      "FloorNumber": "sample string 9",
      "BuildingName": "sample string 10",
      "BoxType": "sample string 11",
      "BoxNumber": "sample string 12",
      "UnitType": "sample string 13",
      "AddressType": "sample string 14"
    },
    "IDCard": {
      "IDNumber": "sample string 1",
      "IDType": 2,
      "FirstName": "sample string 3",
      "MiddleName": "sample string 4",
      "LastName": "sample string 5",
      "IDColour": "sample string 6",
      "IDRefNumber": "sample string 7",
      "IDStateCode": "sample string 8",
      "IDCountry": 1,
      "IDExpiryDate": "sample string 9"
    },
    "IsConcessionCard": true,
    "ConcessionDetail": {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "MiddleName": "sample string 3",
      "CardIssuersID": 1,
      "CardTypeID": 1,
      "CardNumber": "sample string 4",
      "CardExpiryDate": "sample string 5",
      "CardStartDate": "sample string 6",
      "IsPrinciplePlace": true,
      "IsConcessionConsent": true,
      "IsOtherIndependent": true,
      "IsOtherConcession": true
    }
  }
}

application/xml, text/xml

Sample:

<ResultOfEnergySignupHistoryResult7mwieEeK 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.NewSales.Returns">
    <d2p1:CRN>sample string 1</d2p1:CRN>
    <d2p1:CampaignCode>sample string 3</d2p1:CampaignCode>
    <d2p1:ConcessionDetail xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewSales.Parameters">
      <d3p1:CardExpiryDate>sample string 5</d3p1:CardExpiryDate>
      <d3p1:CardIssuersID>1</d3p1:CardIssuersID>
      <d3p1:CardNumber>sample string 4</d3p1:CardNumber>
      <d3p1:CardStartDate>sample string 6</d3p1:CardStartDate>
      <d3p1:CardTypeID>1</d3p1:CardTypeID>
      <d3p1:FirstName>sample string 1</d3p1:FirstName>
      <d3p1:IsConcessionConsent>true</d3p1:IsConcessionConsent>
      <d3p1:IsOtherConcession>true</d3p1:IsOtherConcession>
      <d3p1:IsOtherIndependent>true</d3p1:IsOtherIndependent>
      <d3p1:IsPrinciplePlace>true</d3p1:IsPrinciplePlace>
      <d3p1:LastName>sample string 2</d3p1:LastName>
      <d3p1:MiddleName>sample string 3</d3p1:MiddleName>
    </d2p1:ConcessionDetail>
    <d2p1:ContactDetail xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewSales.Parameters">
      <d3p1:Email>sample string 3</d3p1:Email>
      <d3p1:LandlineNumber>sample string 1</d3p1:LandlineNumber>
      <d3p1:MobileNumber>sample string 2</d3p1:MobileNumber>
    </d2p1:ContactDetail>
    <d2p1:CustomerDetail xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewSales.Parameters">
      <d3p1:DateOfBirth>sample string 4</d3p1:DateOfBirth>
      <d3p1:FirstName>sample string 1</d3p1:FirstName>
      <d3p1:LastName>sample string 3</d3p1:LastName>
      <d3p1:MiddleName>sample string 2</d3p1:MiddleName>
      <d3p1:Title>1</d3p1:Title>
    </d2p1:CustomerDetail>
    <d2p1:IDCard xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewSales.Parameters">
      <d3p1:FirstName>sample string 3</d3p1:FirstName>
      <d3p1:IDColour>sample string 6</d3p1:IDColour>
      <d3p1:IDCountry>1</d3p1:IDCountry>
      <d3p1:IDExpiryDate>sample string 9</d3p1:IDExpiryDate>
      <d3p1:IDNumber>sample string 1</d3p1:IDNumber>
      <d3p1:IDRefNumber>sample string 7</d3p1:IDRefNumber>
      <d3p1:IDStateCode>sample string 8</d3p1:IDStateCode>
      <d3p1:IDType>2</d3p1:IDType>
      <d3p1:LastName>sample string 5</d3p1:LastName>
      <d3p1:MiddleName>sample string 4</d3p1:MiddleName>
    </d2p1:IDCard>
    <d2p1:IsConcessionCard>true</d2p1:IsConcessionCard>
    <d2p1:IsPostalAddress>true</d2p1:IsPostalAddress>
    <d2p1:LeadID>sample string 2</d2p1:LeadID>
    <d2p1:MainAddressDetail xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewSales.Parameters">
      <d3p1:AddressType>sample string 14</d3p1:AddressType>
      <d3p1:BoxNumber>sample string 12</d3p1:BoxNumber>
      <d3p1:BoxType>sample string 11</d3p1:BoxType>
      <d3p1:BuildingName>sample string 10</d3p1:BuildingName>
      <d3p1:FlatUnitNumber>sample string 2</d3p1:FlatUnitNumber>
      <d3p1:FloorNumber>sample string 9</d3p1:FloorNumber>
      <d3p1:FullAddress>sample string 1</d3p1:FullAddress>
      <d3p1:LotNumber>sample string 8</d3p1:LotNumber>
      <d3p1:PostCode>sample string 7</d3p1:PostCode>
      <d3p1:StateCode>sample string 6</d3p1:StateCode>
      <d3p1:StreetName>sample string 4</d3p1:StreetName>
      <d3p1:StreetNumber>sample string 3</d3p1:StreetNumber>
      <d3p1:StreetTypeID>1</d3p1:StreetTypeID>
      <d3p1:Suburb>sample string 5</d3p1:Suburb>
      <d3p1:UnitType>sample string 13</d3p1:UnitType>
    </d2p1:MainAddressDetail>
    <d2p1:PostalAddressDetail xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewSales.Parameters">
      <d3p1:AddressType>sample string 14</d3p1:AddressType>
      <d3p1:BoxNumber>sample string 12</d3p1:BoxNumber>
      <d3p1:BoxType>sample string 11</d3p1:BoxType>
      <d3p1:BuildingName>sample string 10</d3p1:BuildingName>
      <d3p1:FlatUnitNumber>sample string 2</d3p1:FlatUnitNumber>
      <d3p1:FloorNumber>sample string 9</d3p1:FloorNumber>
      <d3p1:FullAddress>sample string 1</d3p1:FullAddress>
      <d3p1:LotNumber>sample string 8</d3p1:LotNumber>
      <d3p1:PostCode>sample string 7</d3p1:PostCode>
      <d3p1:StateCode>sample string 6</d3p1:StateCode>
      <d3p1:StreetName>sample string 4</d3p1:StreetName>
      <d3p1:StreetNumber>sample string 3</d3p1:StreetNumber>
      <d3p1:StreetTypeID>1</d3p1:StreetTypeID>
      <d3p1:Suburb>sample string 5</d3p1:Suburb>
      <d3p1:UnitType>sample string 13</d3p1:UnitType>
    </d2p1:PostalAddressDetail>
    <d2p1:SecondaryContactDetail xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewSales.Parameters">
      <d3p1:Email>sample string 3</d3p1:Email>
      <d3p1:LandlineNumber>sample string 1</d3p1:LandlineNumber>
      <d3p1:MobileNumber>sample string 2</d3p1:MobileNumber>
    </d2p1:SecondaryContactDetail>
    <d2p1:SecondaryCustomerDetail xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewSales.Parameters">
      <d3p1:DateOfBirth>sample string 4</d3p1:DateOfBirth>
      <d3p1:FirstName>sample string 1</d3p1:FirstName>
      <d3p1:LastName>sample string 3</d3p1:LastName>
      <d3p1:MiddleName>sample string 2</d3p1:MiddleName>
      <d3p1:Title>1</d3p1:Title>
    </d2p1:SecondaryCustomerDetail>
  </Value>
</ResultOfEnergySignupHistoryResult7mwieEeK>