POST Api/Sales/Powershop/SignUp

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
accountSetup	AccountSetup	None.
accountHolder	AccountHolder	None.
login	Login	None.
businessDetails	BusinessDetails	None.
SecondaryAccountHolders	Collection of SecondaryAccountHolder	None.
propertyInformation	PropertyInformation	None.
PostalAddress	Address	None.
utilityDetails	Collection of UtilityDetails	None.
promotion	Promotion	None.
vulnerabilities	Vulnerabilities	None.
paymentDetails	PaymentDetails	None.
ConcessionCards	Collection of ConcessionCard	None.
EligibleForConcessions	boolean	None.
SupportRequest	string	None.
TermsAndConditionsAcceptedAt	string	None.

Request Formats

application/json, text/json

Sample:

{
  "accountSetup": {
    "AccountType": "sample string 1"
  },
  "accountHolder": {
    "AccountType": "sample string 1",
    "Title": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "DateOfBirth": "sample string 5",
    "PhoneNumber": "sample string 6"
  },
  "login": {
    "Email": "sample string 1"
  },
  "businessDetails": {
    "Name": "sample string 1",
    "RegisteredBusinessNumber": "sample string 2",
    "AnzsicCode": "sample string 3",
    "PhoneNumber": "sample string 4",
    "IsTaxRegistered": true
  },
  "SecondaryAccountHolders": [
    {
      "Title": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "DateOfBirth": "sample string 4",
      "PhoneNumber": "sample string 5"
    },
    {
      "Title": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "DateOfBirth": "sample string 4",
      "PhoneNumber": "sample string 5"
    }
  ],
  "propertyInformation": {
    "SupplyAddress": {
      "FlatNumber": "sample string 1",
      "FlatType": "sample string 2",
      "FloorNumber": "sample string 3",
      "FloorType": "sample string 4",
      "HouseNumber": 5,
      "HouseNumberSuffix": "sample string 6",
      "StreetName": "sample string 7",
      "StreetType": "sample string 8",
      "StreetSuffix": "sample string 9",
      "Postcode": "sample string 10",
      "Suburb": "sample string 11",
      "Region": "sample string 12"
    },
    "CurrentSituation": "sample string 1",
    "Hazards": {
      "Dog": true,
      "ElectricFence": true,
      "Caution": true,
      "ElectricalSafetyIssue": true,
      "AsbestosFuse": true,
      "AsbestosBoard": true,
      "Other": "sample string 1"
    }
  },
  "PostalAddress": {
    "FlatNumber": "sample string 1",
    "FlatType": "sample string 2",
    "FloorNumber": "sample string 3",
    "FloorType": "sample string 4",
    "HouseNumber": 5,
    "HouseNumberSuffix": "sample string 6",
    "StreetName": "sample string 7",
    "StreetType": "sample string 8",
    "StreetSuffix": "sample string 9",
    "Postcode": "sample string 10",
    "Suburb": "sample string 11",
    "Region": "sample string 12"
  },
  "utilityDetails": [
    {
      "UtilityType": "sample string 1",
      "ConnectionNumber": "sample string 2",
      "CurrentSupplier": "sample string 3",
      "ProposedStartDate": "sample string 4",
      "IsConnectionCurrentlyActive": true,
      "MeterDetails": {
        "MeterLocationNotes": "sample string 1"
      },
      "EstimatedBilling": {
        "Cost": 1,
        "Period": "sample string 2"
      },
      "vulnerabilityDetails": {
        "DependencyType": "sample string 1",
        "MedicalReason": "sample string 2",
        "MedicalDetailsDisclaimerAcceptedAt": "sample string 3",
        "LifeSupportEquipment": "sample string 4"
      }
    },
    {
      "UtilityType": "sample string 1",
      "ConnectionNumber": "sample string 2",
      "CurrentSupplier": "sample string 3",
      "ProposedStartDate": "sample string 4",
      "IsConnectionCurrentlyActive": true,
      "MeterDetails": {
        "MeterLocationNotes": "sample string 1"
      },
      "EstimatedBilling": {
        "Cost": 1,
        "Period": "sample string 2"
      },
      "vulnerabilityDetails": {
        "DependencyType": "sample string 1",
        "MedicalReason": "sample string 2",
        "MedicalDetailsDisclaimerAcceptedAt": "sample string 3",
        "LifeSupportEquipment": "sample string 4"
      }
    }
  ],
  "promotion": {
    "PromotionCode": "sample string 1",
    "PromotionTermsAndConditionsAcceptedAt": "sample string 2"
  },
  "vulnerabilities": {
    "DependencyType": "sample string 1",
    "MedicalReason": "sample string 2",
    "MedicalDetailsDisclaimerAcceptedAt": "sample string 3",
    "LifeSupportEquipment": "sample string 4"
  },
  "paymentDetails": {
    "Card": {
      "CardType": "sample string 1",
      "MaskedCardNumber": "sample string 2",
      "ExpiryDate": "sample string 3",
      "CardholderName": "sample string 4",
      "Token": "sample string 5",
      "TermsAndConditionsAcceptedAt": "sample string 6",
      "Preferred": true
    },
    "DirectDebit": {
      "AccountName": "sample string 1",
      "BankNumber": "sample string 2",
      "BranchNumber": "sample string 3",
      "AccountNumber": "sample string 4",
      "TermsAndConditionsAcceptedAt": "sample string 5",
      "Preferred": true
    },
    "AmountInformation": {
      "Amount": 1.0,
      "CurrencyInformation": "sample string 2",
      "MerchantReference": "sample string 3"
    },
    "Callback": {
      "Url": "sample string 1"
    }
  },
  "ConcessionCards": [
    {
      "CustomerReferenceNumber": "sample string 1",
      "ConcessionEvidenceType": "sample string 2",
      "StartDate": "sample string 3",
      "EndDate": "sample string 4",
      "FirstName": "sample string 5",
      "LastName": "sample string 6",
      "AgreedToCcesValidation": true,
      "ConfirmedResidence": true,
      "Concessions": [
        {
          "ConcessionType": "sample string 1",
          "StartDate": "sample string 2",
          "EndDate": "sample string 3",
          "Value": 1.0
        },
        {
          "ConcessionType": "sample string 1",
          "StartDate": "sample string 2",
          "EndDate": "sample string 3",
          "Value": 1.0
        }
      ]
    },
    {
      "CustomerReferenceNumber": "sample string 1",
      "ConcessionEvidenceType": "sample string 2",
      "StartDate": "sample string 3",
      "EndDate": "sample string 4",
      "FirstName": "sample string 5",
      "LastName": "sample string 6",
      "AgreedToCcesValidation": true,
      "ConfirmedResidence": true,
      "Concessions": [
        {
          "ConcessionType": "sample string 1",
          "StartDate": "sample string 2",
          "EndDate": "sample string 3",
          "Value": 1.0
        },
        {
          "ConcessionType": "sample string 1",
          "StartDate": "sample string 2",
          "EndDate": "sample string 3",
          "Value": 1.0
        }
      ]
    }
  ],
  "EligibleForConcessions": true,
  "SupportRequest": "sample string 1",
  "TermsAndConditionsAcceptedAt": "sample string 2"
}

application/xml, text/xml

Sample:

<PowershopParamModels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Powershop">
  <ConcessionCards>
    <PowershopParamModels.ConcessionCard>
      <AgreedToCcesValidation>true</AgreedToCcesValidation>
      <ConcessionEvidenceType>sample string 2</ConcessionEvidenceType>
      <Concessions>
        <PowershopParamModels.Concession>
          <ConcessionType>sample string 1</ConcessionType>
          <EndDate>sample string 3</EndDate>
          <StartDate>sample string 2</StartDate>
          <Value>1</Value>
        </PowershopParamModels.Concession>
        <PowershopParamModels.Concession>
          <ConcessionType>sample string 1</ConcessionType>
          <EndDate>sample string 3</EndDate>
          <StartDate>sample string 2</StartDate>
          <Value>1</Value>
        </PowershopParamModels.Concession>
      </Concessions>
      <ConfirmedResidence>true</ConfirmedResidence>
      <CustomerReferenceNumber>sample string 1</CustomerReferenceNumber>
      <EndDate>sample string 4</EndDate>
      <FirstName>sample string 5</FirstName>
      <LastName>sample string 6</LastName>
      <StartDate>sample string 3</StartDate>
    </PowershopParamModels.ConcessionCard>
    <PowershopParamModels.ConcessionCard>
      <AgreedToCcesValidation>true</AgreedToCcesValidation>
      <ConcessionEvidenceType>sample string 2</ConcessionEvidenceType>
      <Concessions>
        <PowershopParamModels.Concession>
          <ConcessionType>sample string 1</ConcessionType>
          <EndDate>sample string 3</EndDate>
          <StartDate>sample string 2</StartDate>
          <Value>1</Value>
        </PowershopParamModels.Concession>
        <PowershopParamModels.Concession>
          <ConcessionType>sample string 1</ConcessionType>
          <EndDate>sample string 3</EndDate>
          <StartDate>sample string 2</StartDate>
          <Value>1</Value>
        </PowershopParamModels.Concession>
      </Concessions>
      <ConfirmedResidence>true</ConfirmedResidence>
      <CustomerReferenceNumber>sample string 1</CustomerReferenceNumber>
      <EndDate>sample string 4</EndDate>
      <FirstName>sample string 5</FirstName>
      <LastName>sample string 6</LastName>
      <StartDate>sample string 3</StartDate>
    </PowershopParamModels.ConcessionCard>
  </ConcessionCards>
  <EligibleForConcessions>true</EligibleForConcessions>
  <PostalAddress>
    <FlatNumber>sample string 1</FlatNumber>
    <FlatType>sample string 2</FlatType>
    <FloorNumber>sample string 3</FloorNumber>
    <FloorType>sample string 4</FloorType>
    <HouseNumber>5</HouseNumber>
    <HouseNumberSuffix>sample string 6</HouseNumberSuffix>
    <Postcode>sample string 10</Postcode>
    <Region>sample string 12</Region>
    <StreetName>sample string 7</StreetName>
    <StreetSuffix>sample string 9</StreetSuffix>
    <StreetType>sample string 8</StreetType>
    <Suburb>sample string 11</Suburb>
  </PostalAddress>
  <SecondaryAccountHolders>
    <PowershopParamModels.SecondaryAccountHolder>
      <DateOfBirth>sample string 4</DateOfBirth>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 3</LastName>
      <PhoneNumber>sample string 5</PhoneNumber>
      <Title>sample string 1</Title>
    </PowershopParamModels.SecondaryAccountHolder>
    <PowershopParamModels.SecondaryAccountHolder>
      <DateOfBirth>sample string 4</DateOfBirth>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 3</LastName>
      <PhoneNumber>sample string 5</PhoneNumber>
      <Title>sample string 1</Title>
    </PowershopParamModels.SecondaryAccountHolder>
  </SecondaryAccountHolders>
  <SupportRequest>sample string 1</SupportRequest>
  <TermsAndConditionsAcceptedAt>sample string 2</TermsAndConditionsAcceptedAt>
  <accountHolder>
    <AccountType>sample string 1</AccountType>
    <DateOfBirth>sample string 5</DateOfBirth>
    <FirstName>sample string 3</FirstName>
    <LastName>sample string 4</LastName>
    <PhoneNumber>sample string 6</PhoneNumber>
    <Title>sample string 2</Title>
  </accountHolder>
  <accountSetup>
    <AccountType>sample string 1</AccountType>
  </accountSetup>
  <businessDetails>
    <AnzsicCode>sample string 3</AnzsicCode>
    <IsTaxRegistered>true</IsTaxRegistered>
    <Name>sample string 1</Name>
    <PhoneNumber>sample string 4</PhoneNumber>
    <RegisteredBusinessNumber>sample string 2</RegisteredBusinessNumber>
  </businessDetails>
  <login>
    <Email>sample string 1</Email>
  </login>
  <paymentDetails>
    <AmountInformation>
      <Amount>1</Amount>
      <CurrencyInformation>sample string 2</CurrencyInformation>
      <MerchantReference>sample string 3</MerchantReference>
    </AmountInformation>
    <Callback>
      <Url>sample string 1</Url>
    </Callback>
    <Card>
      <CardType>sample string 1</CardType>
      <CardholderName>sample string 4</CardholderName>
      <ExpiryDate>sample string 3</ExpiryDate>
      <MaskedCardNumber>sample string 2</MaskedCardNumber>
      <Preferred>true</Preferred>
      <TermsAndConditionsAcceptedAt>sample string 6</TermsAndConditionsAcceptedAt>
      <Token>sample string 5</Token>
    </Card>
    <DirectDebit>
      <AccountName>sample string 1</AccountName>
      <AccountNumber>sample string 4</AccountNumber>
      <BankNumber>sample string 2</BankNumber>
      <BranchNumber>sample string 3</BranchNumber>
      <Preferred>true</Preferred>
      <TermsAndConditionsAcceptedAt>sample string 5</TermsAndConditionsAcceptedAt>
    </DirectDebit>
  </paymentDetails>
  <promotion>
    <PromotionCode>sample string 1</PromotionCode>
    <PromotionTermsAndConditionsAcceptedAt>sample string 2</PromotionTermsAndConditionsAcceptedAt>
  </promotion>
  <propertyInformation>
    <CurrentSituation>sample string 1</CurrentSituation>
    <Hazards>
      <AsbestosBoard>true</AsbestosBoard>
      <AsbestosFuse>true</AsbestosFuse>
      <Caution>true</Caution>
      <Dog>true</Dog>
      <ElectricFence>true</ElectricFence>
      <ElectricalSafetyIssue>true</ElectricalSafetyIssue>
      <Other>sample string 1</Other>
    </Hazards>
    <SupplyAddress>
      <FlatNumber>sample string 1</FlatNumber>
      <FlatType>sample string 2</FlatType>
      <FloorNumber>sample string 3</FloorNumber>
      <FloorType>sample string 4</FloorType>
      <HouseNumber>5</HouseNumber>
      <HouseNumberSuffix>sample string 6</HouseNumberSuffix>
      <Postcode>sample string 10</Postcode>
      <Region>sample string 12</Region>
      <StreetName>sample string 7</StreetName>
      <StreetSuffix>sample string 9</StreetSuffix>
      <StreetType>sample string 8</StreetType>
      <Suburb>sample string 11</Suburb>
    </SupplyAddress>
  </propertyInformation>
  <utilityDetails>
    <PowershopParamModels.UtilityDetails>
      <ConnectionNumber>sample string 2</ConnectionNumber>
      <CurrentSupplier>sample string 3</CurrentSupplier>
      <EstimatedBilling>
        <Cost>1</Cost>
        <Period>sample string 2</Period>
      </EstimatedBilling>
      <IsConnectionCurrentlyActive>true</IsConnectionCurrentlyActive>
      <MeterDetails>
        <MeterLocationNotes>sample string 1</MeterLocationNotes>
      </MeterDetails>
      <ProposedStartDate>sample string 4</ProposedStartDate>
      <UtilityType>sample string 1</UtilityType>
      <vulnerabilityDetails>
        <DependencyType>sample string 1</DependencyType>
        <LifeSupportEquipment>sample string 4</LifeSupportEquipment>
        <MedicalDetailsDisclaimerAcceptedAt>sample string 3</MedicalDetailsDisclaimerAcceptedAt>
        <MedicalReason>sample string 2</MedicalReason>
      </vulnerabilityDetails>
    </PowershopParamModels.UtilityDetails>
    <PowershopParamModels.UtilityDetails>
      <ConnectionNumber>sample string 2</ConnectionNumber>
      <CurrentSupplier>sample string 3</CurrentSupplier>
      <EstimatedBilling>
        <Cost>1</Cost>
        <Period>sample string 2</Period>
      </EstimatedBilling>
      <IsConnectionCurrentlyActive>true</IsConnectionCurrentlyActive>
      <MeterDetails>
        <MeterLocationNotes>sample string 1</MeterLocationNotes>
      </MeterDetails>
      <ProposedStartDate>sample string 4</ProposedStartDate>
      <UtilityType>sample string 1</UtilityType>
      <vulnerabilityDetails>
        <DependencyType>sample string 1</DependencyType>
        <LifeSupportEquipment>sample string 4</LifeSupportEquipment>
        <MedicalDetailsDisclaimerAcceptedAt>sample string 3</MedicalDetailsDisclaimerAcceptedAt>
        <MedicalReason>sample string 2</MedicalReason>
      </vulnerabilityDetails>
    </PowershopParamModels.UtilityDetails>
  </utilityDetails>
  <vulnerabilities>
    <DependencyType>sample string 1</DependencyType>
    <LifeSupportEquipment>sample string 4</LifeSupportEquipment>
    <MedicalDetailsDisclaimerAcceptedAt>sample string 3</MedicalDetailsDisclaimerAcceptedAt>
    <MedicalReason>sample string 2</MedicalReason>
  </vulnerabilities>
</PowershopParamModels>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultOfString

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

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": "sample string 3"
}

application/xml, text/xml

Sample:

<ResultOfstring 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>sample string 3</Value>
</ResultOfstring>