POST Api/InternetSales/SignUp?isLocal={isLocal}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
isLocal

boolean

Default value is True

Body Parameters

ParamInsertInternetSalesWithComparisson
NameDescriptionTypeAdditional information
SignupParam

ParamInsertInternetSales

None.
ComparisonData

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "SignupParam": {
    "PresaleID": 1,
    "SignupSessionID": "sample string 2",
    "PlanID": 3,
    "SalesEnergyTypeID": 4,
    "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"
    },
    "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"
    },
    "IsSolar": true,
    "MoveIn": true,
    "SalesType": "sample string 6",
    "InternetDetail": {
      "RetailerID": 1,
      "EnergyTypeID": 2,
      "PlanID": 3,
      "ConnectionDetail": {
        "MovingDate": "sample string 1"
      },
      "RetailerPortalReferenceNumber": "sample string 4"
    },
    "SaleGuid": "sample string 7",
    "AgentID": 1
  },
  "ComparisonData": "sample string 1"
}

application/xml, text/xml

Sample: 
<ParamInsertInternetSalesWithComparisson xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewSales.Parameters">
  <ComparisonData>sample string 1</ComparisonData>
  <SignupParam>
    <AgentID>1</AgentID>
    <ContactDetail>
      <Email>sample string 3</Email>
      <LandlineNumber>sample string 1</LandlineNumber>
      <MobileNumber>sample string 2</MobileNumber>
    </ContactDetail>
    <CustomerDetail>
      <DateOfBirth>sample string 4</DateOfBirth>
      <FirstName>sample string 1</FirstName>
      <LastName>sample string 3</LastName>
      <MiddleName>sample string 2</MiddleName>
      <Title>1</Title>
    </CustomerDetail>
    <InternetDetail>
      <ConnectionDetail>
        <MovingDate>sample string 1</MovingDate>
      </ConnectionDetail>
      <EnergyTypeID>2</EnergyTypeID>
      <PlanID>3</PlanID>
      <RetailerID>1</RetailerID>
      <RetailerPortalReferenceNumber>sample string 4</RetailerPortalReferenceNumber>
    </InternetDetail>
    <IsPostalAddress>true</IsPostalAddress>
    <IsSolar>true</IsSolar>
    <MainAddressDetail>
      <AddressType>sample string 14</AddressType>
      <BoxNumber>sample string 12</BoxNumber>
      <BoxType>sample string 11</BoxType>
      <BuildingName>sample string 10</BuildingName>
      <FlatUnitNumber>sample string 2</FlatUnitNumber>
      <FloorNumber>sample string 9</FloorNumber>
      <FullAddress>sample string 1</FullAddress>
      <LotNumber>sample string 8</LotNumber>
      <PostCode>sample string 7</PostCode>
      <StateCode>sample string 6</StateCode>
      <StreetName>sample string 4</StreetName>
      <StreetNumber>sample string 3</StreetNumber>
      <StreetTypeID>1</StreetTypeID>
      <Suburb>sample string 5</Suburb>
      <UnitType>sample string 13</UnitType>
    </MainAddressDetail>
    <MoveIn>true</MoveIn>
    <PlanID>3</PlanID>
    <PostalAddressDetail>
      <AddressType>sample string 14</AddressType>
      <BoxNumber>sample string 12</BoxNumber>
      <BoxType>sample string 11</BoxType>
      <BuildingName>sample string 10</BuildingName>
      <FlatUnitNumber>sample string 2</FlatUnitNumber>
      <FloorNumber>sample string 9</FloorNumber>
      <FullAddress>sample string 1</FullAddress>
      <LotNumber>sample string 8</LotNumber>
      <PostCode>sample string 7</PostCode>
      <StateCode>sample string 6</StateCode>
      <StreetName>sample string 4</StreetName>
      <StreetNumber>sample string 3</StreetNumber>
      <StreetTypeID>1</StreetTypeID>
      <Suburb>sample string 5</Suburb>
      <UnitType>sample string 13</UnitType>
    </PostalAddressDetail>
    <PresaleID>1</PresaleID>
    <SaleGuid>sample string 7</SaleGuid>
    <SalesEnergyTypeID>4</SalesEnergyTypeID>
    <SalesType>sample string 6</SalesType>
    <SignupSessionID>sample string 2</SignupSessionID>
  </SignupParam>
</ParamInsertInternetSalesWithComparisson>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultOfSalesSummaryResult
NameDescriptionTypeAdditional information
Success

boolean

None.
Message

string

None.
ErrorMessage

Collection of string

None.
Value

SalesSummaryResult

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": {
    "SalesID": 1,
    "GasSalesID": 1,
    "ElecCRN": "sample string 1",
    "GasCRN": "sample string 2",
    "InternetCRN": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "PlanName": "sample string 6",
    "RetailerName": "sample string 7"
  }
}

application/xml, text/xml

Sample: 
<ResultOfSalesSummaryResult7mwieEeK 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:ElecCRN>sample string 1</d2p1:ElecCRN>
    <d2p1:FirstName>sample string 4</d2p1:FirstName>
    <d2p1:GasCRN>sample string 2</d2p1:GasCRN>
    <d2p1:GasSalesID>1</d2p1:GasSalesID>
    <d2p1:InternetCRN>sample string 3</d2p1:InternetCRN>
    <d2p1:LastName>sample string 5</d2p1:LastName>
    <d2p1:PlanName>sample string 6</d2p1:PlanName>
    <d2p1:RetailerName>sample string 7</d2p1:RetailerName>
    <d2p1:SalesID>1</d2p1:SalesID>
  </Value>
</ResultOfSalesSummaryResult7mwieEeK>