POST Api/Sales/Fields/List

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerTypeID	integer	Required
RetailerID	integer	Required
EnergyTypeID	integer	Required
PostCode	string	Required
IsMoving	boolean	Required
PlanID	integer	None.
NMI	string	None.
MIRN	string	None.
DistributorName	string	None.
GasDistributorName	string	None.
MovingDate	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerTypeID": 1,
  "RetailerID": 2,
  "EnergyTypeID": 3,
  "PostCode": "sample string 4",
  "IsMoving": true,
  "PlanID": 1,
  "NMI": "sample string 6",
  "MIRN": "sample string 7",
  "DistributorName": "sample string 8",
  "GasDistributorName": "sample string 9",
  "MovingDate": "sample string 10"
}

application/xml, text/xml

Sample:

<ParamSalesFields xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewSales.Parameters">
  <CustomerTypeID>1</CustomerTypeID>
  <DistributorName>sample string 8</DistributorName>
  <EnergyTypeID>3</EnergyTypeID>
  <GasDistributorName>sample string 9</GasDistributorName>
  <IsMoving>true</IsMoving>
  <MIRN>sample string 7</MIRN>
  <MovingDate>sample string 10</MovingDate>
  <NMI>sample string 6</NMI>
  <PlanID>1</PlanID>
  <PostCode>sample string 4</PostCode>
  <RetailerID>2</RetailerID>
</ParamSalesFields>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultOfSalesFieldsResult

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

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": {
    "SalesFieldList": [
      {
        "FieldID": 1,
        "FieldName": "sample string 2",
        "FieldLabel": "sample string 3",
        "IsVisible": true
      },
      {
        "FieldID": 1,
        "FieldName": "sample string 2",
        "FieldLabel": "sample string 3",
        "IsVisible": true
      }
    ],
    "BusinessTypeList": [
      {
        "BusinessTypeID": 1,
        "BusiessTypeName": "sample string 2"
      },
      {
        "BusinessTypeID": 1,
        "BusiessTypeName": "sample string 2"
      }
    ],
    "PreferredTimeList": [
      {
        "PrefTimeID": 1,
        "PrefTimeName": "sample string 2"
      },
      {
        "PrefTimeID": 1,
        "PrefTimeName": "sample string 2"
      }
    ],
    "ConcessionTypeList": [
      {
        "ConcessionTypeID": 1,
        "ConcessionTypeName": "sample string 2"
      },
      {
        "ConcessionTypeID": 1,
        "ConcessionTypeName": "sample string 2"
      }
    ],
    "ConcessionIssuerList": [
      {
        "ConcessionIssuerID": 1,
        "ConcessionIssuerName": "sample string 2"
      },
      {
        "ConcessionIssuerID": 1,
        "ConcessionIssuerName": "sample string 2"
      }
    ],
    "IDTypeList": [
      {
        "IDTypeID": 1,
        "IDTypeName": "sample string 2"
      },
      {
        "IDTypeID": 1,
        "IDTypeName": "sample string 2"
      }
    ],
    "StateList": [
      {
        "StateID": 1,
        "StateCode": "sample string 2",
        "StateName": "sample string 3"
      },
      {
        "StateID": 1,
        "StateCode": "sample string 2",
        "StateName": "sample string 3"
      }
    ],
    "CountryList": [
      {
        "CountryID": 1,
        "CountryName": "sample string 2"
      },
      {
        "CountryID": 1,
        "CountryName": "sample string 2"
      }
    ],
    "MediaPreferenceList": [
      {
        "MediaPreferenceID": 1,
        "MediaPreferenceName": "sample string 2"
      },
      {
        "MediaPreferenceID": 1,
        "MediaPreferenceName": "sample string 2"
      }
    ],
    "StreetTypeList": [
      {
        "StreetTypeID": 1,
        "StreetName": "sample string 2",
        "STName": "sample string 3"
      },
      {
        "StreetTypeID": 1,
        "StreetName": "sample string 2",
        "STName": "sample string 3"
      }
    ],
    "LifeSupportMachineTypeList": [
      {
        "LSMTypeID": "sample string 1",
        "LSMTypeName": "sample string 2"
      },
      {
        "LSMTypeID": "sample string 1",
        "LSMTypeName": "sample string 2"
      }
    ],
    "InspectionTimeHours": [
      {
        "InspectionID": "sample string 1",
        "InspectionName": "sample string 2"
      },
      {
        "InspectionID": "sample string 1",
        "InspectionName": "sample string 2"
      }
    ],
    "SolarFeedIns": [
      {
        "SolarFeedID": "sample string 1",
        "SolarFeedName": "sample string 2",
        "SolarFeedMessage": "sample string 3"
      },
      {
        "SolarFeedID": "sample string 1",
        "SolarFeedName": "sample string 2",
        "SolarFeedMessage": "sample string 3"
      }
    ],
    "SolarType": [
      {
        "SolarTypeID": "sample string 1",
        "SolarTypeName": "sample string 2"
      },
      {
        "SolarTypeID": "sample string 1",
        "SolarTypeName": "sample string 2"
      }
    ],
    "PreviousBills": [
      {
        "PreviousBillID": "sample string 1",
        "PreviousBillName": "sample string 2"
      },
      {
        "PreviousBillID": "sample string 1",
        "PreviousBillName": "sample string 2"
      }
    ],
    "HowMuchGreenpower": [
      {
        "ID": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "ID": "sample string 1",
        "Name": "sample string 2"
      }
    ],
    "LifeSupportEquipments": [
      {
        "LSEID": "sample string 1",
        "LSEName": "sample string 2"
      },
      {
        "LSEID": "sample string 1",
        "LSEName": "sample string 2"
      }
    ],
    "PublicHolidays": [
      {
        "ID": 1,
        "Year": 2,
        "Month": 3,
        "Day": 4,
        "IsWeekend": true,
        "Holiday": "sample string 5",
        "State": "sample string 6"
      },
      {
        "ID": 1,
        "Year": 2,
        "Month": 3,
        "Day": 4,
        "IsWeekend": true,
        "Holiday": "sample string 5",
        "State": "sample string 6"
      }
    ],
    "Anzsics": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "BoxTypes": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "BillsFrequencies": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "SignUpSummary": "sample string 1",
    "RateSection": "sample string 2",
    "TermsCondition": "sample string 3",
    "ConnectionFee": "sample string 4",
    "SDFIConnectionFee": "sample string 5",
    "IsPassCutOffTime": true,
    "WastedTruckFee": 1.0,
    "GasUnplugFee": 1.0,
    "WastedTruckGasFee": 1.0
  }
}

application/xml, text/xml

Sample:

<ResultOfSalesFieldsResult7mwieEeK 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:Anzsics xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
      <d3p1:KeyValuePairOfstringstring>
        <d3p1:key>sample string 1</d3p1:key>
        <d3p1:value>sample string 2</d3p1:value>
      </d3p1:KeyValuePairOfstringstring>
      <d3p1:KeyValuePairOfstringstring>
        <d3p1:key>sample string 1</d3p1:key>
        <d3p1:value>sample string 2</d3p1:value>
      </d3p1:KeyValuePairOfstringstring>
    </d2p1:Anzsics>
    <d2p1:BillsFrequencies xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
      <d3p1:KeyValuePairOfstringstring>
        <d3p1:key>sample string 1</d3p1:key>
        <d3p1:value>sample string 2</d3p1:value>
      </d3p1:KeyValuePairOfstringstring>
      <d3p1:KeyValuePairOfstringstring>
        <d3p1:key>sample string 1</d3p1:key>
        <d3p1:value>sample string 2</d3p1:value>
      </d3p1:KeyValuePairOfstringstring>
    </d2p1:BillsFrequencies>
    <d2p1:BoxTypes xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
      <d3p1:KeyValuePairOfstringstring>
        <d3p1:key>sample string 1</d3p1:key>
        <d3p1:value>sample string 2</d3p1:value>
      </d3p1:KeyValuePairOfstringstring>
      <d3p1:KeyValuePairOfstringstring>
        <d3p1:key>sample string 1</d3p1:key>
        <d3p1:value>sample string 2</d3p1:value>
      </d3p1:KeyValuePairOfstringstring>
    </d2p1:BoxTypes>
    <d2p1:BusinessTypeList xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Master.Objects">
      <d3p1:BusinessTypeDetail>
        <d3p1:BusiessTypeName>sample string 2</d3p1:BusiessTypeName>
        <d3p1:BusinessTypeID>1</d3p1:BusinessTypeID>
      </d3p1:BusinessTypeDetail>
      <d3p1:BusinessTypeDetail>
        <d3p1:BusiessTypeName>sample string 2</d3p1:BusiessTypeName>
        <d3p1:BusinessTypeID>1</d3p1:BusinessTypeID>
      </d3p1:BusinessTypeDetail>
    </d2p1:BusinessTypeList>
    <d2p1:ConcessionIssuerList xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Master.Objects">
      <d3p1:ConcessionIssuerDetail>
        <d3p1:ConcessionIssuerID>1</d3p1:ConcessionIssuerID>
        <d3p1:ConcessionIssuerName>sample string 2</d3p1:ConcessionIssuerName>
      </d3p1:ConcessionIssuerDetail>
      <d3p1:ConcessionIssuerDetail>
        <d3p1:ConcessionIssuerID>1</d3p1:ConcessionIssuerID>
        <d3p1:ConcessionIssuerName>sample string 2</d3p1:ConcessionIssuerName>
      </d3p1:ConcessionIssuerDetail>
    </d2p1:ConcessionIssuerList>
    <d2p1:ConcessionTypeList xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Master.Objects">
      <d3p1:ConcessionTypeDetail>
        <d3p1:ConcessionTypeID>1</d3p1:ConcessionTypeID>
        <d3p1:ConcessionTypeName>sample string 2</d3p1:ConcessionTypeName>
      </d3p1:ConcessionTypeDetail>
      <d3p1:ConcessionTypeDetail>
        <d3p1:ConcessionTypeID>1</d3p1:ConcessionTypeID>
        <d3p1:ConcessionTypeName>sample string 2</d3p1:ConcessionTypeName>
      </d3p1:ConcessionTypeDetail>
    </d2p1:ConcessionTypeList>
    <d2p1:ConnectionFee>sample string 4</d2p1:ConnectionFee>
    <d2p1:CountryList xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Master.Objects">
      <d3p1:CountryDetail>
        <d3p1:CountryID>1</d3p1:CountryID>
        <d3p1:CountryName>sample string 2</d3p1:CountryName>
      </d3p1:CountryDetail>
      <d3p1:CountryDetail>
        <d3p1:CountryID>1</d3p1:CountryID>
        <d3p1:CountryName>sample string 2</d3p1:CountryName>
      </d3p1:CountryDetail>
    </d2p1:CountryList>
    <d2p1:GasUnplugFee>1</d2p1:GasUnplugFee>
    <d2p1:HowMuchGreenpower xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Master.Objects">
      <d3p1:GreenPower>
        <d3p1:ID>sample string 1</d3p1:ID>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:GreenPower>
      <d3p1:GreenPower>
        <d3p1:ID>sample string 1</d3p1:ID>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:GreenPower>
    </d2p1:HowMuchGreenpower>
    <d2p1:IDTypeList xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Master.Objects">
      <d3p1:IDTypeDetail>
        <d3p1:IDTypeID>1</d3p1:IDTypeID>
        <d3p1:IDTypeName>sample string 2</d3p1:IDTypeName>
      </d3p1:IDTypeDetail>
      <d3p1:IDTypeDetail>
        <d3p1:IDTypeID>1</d3p1:IDTypeID>
        <d3p1:IDTypeName>sample string 2</d3p1:IDTypeName>
      </d3p1:IDTypeDetail>
    </d2p1:IDTypeList>
    <d2p1:InspectionTimeHours xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Master.Objects">
      <d3p1:InspectionTimeHoursDetail>
        <d3p1:InspectionID>sample string 1</d3p1:InspectionID>
        <d3p1:InspectionName>sample string 2</d3p1:InspectionName>
      </d3p1:InspectionTimeHoursDetail>
      <d3p1:InspectionTimeHoursDetail>
        <d3p1:InspectionID>sample string 1</d3p1:InspectionID>
        <d3p1:InspectionName>sample string 2</d3p1:InspectionName>
      </d3p1:InspectionTimeHoursDetail>
    </d2p1:InspectionTimeHours>
    <d2p1:IsPassCutOffTime>true</d2p1:IsPassCutOffTime>
    <d2p1:LifeSupportEquipments xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Master.Objects">
      <d3p1:LifeSupportEquipment>
        <d3p1:LSEID>sample string 1</d3p1:LSEID>
        <d3p1:LSEName>sample string 2</d3p1:LSEName>
      </d3p1:LifeSupportEquipment>
      <d3p1:LifeSupportEquipment>
        <d3p1:LSEID>sample string 1</d3p1:LSEID>
        <d3p1:LSEName>sample string 2</d3p1:LSEName>
      </d3p1:LifeSupportEquipment>
    </d2p1:LifeSupportEquipments>
    <d2p1:LifeSupportMachineTypeList xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Master.Objects">
      <d3p1:LifeSupportMachineTypeDetail>
        <d3p1:LSMTypeID>sample string 1</d3p1:LSMTypeID>
        <d3p1:LSMTypeName>sample string 2</d3p1:LSMTypeName>
      </d3p1:LifeSupportMachineTypeDetail>
      <d3p1:LifeSupportMachineTypeDetail>
        <d3p1:LSMTypeID>sample string 1</d3p1:LSMTypeID>
        <d3p1:LSMTypeName>sample string 2</d3p1:LSMTypeName>
      </d3p1:LifeSupportMachineTypeDetail>
    </d2p1:LifeSupportMachineTypeList>
    <d2p1:MediaPreferenceList xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Master.Objects">
      <d3p1:MediaPreferenceDetail>
        <d3p1:MediaPreferenceID>1</d3p1:MediaPreferenceID>
        <d3p1:MediaPreferenceName>sample string 2</d3p1:MediaPreferenceName>
      </d3p1:MediaPreferenceDetail>
      <d3p1:MediaPreferenceDetail>
        <d3p1:MediaPreferenceID>1</d3p1:MediaPreferenceID>
        <d3p1:MediaPreferenceName>sample string 2</d3p1:MediaPreferenceName>
      </d3p1:MediaPreferenceDetail>
    </d2p1:MediaPreferenceList>
    <d2p1:PreferredTimeList xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Master.Objects">
      <d3p1:PreferedTimeDetail>
        <d3p1:PrefTimeID>1</d3p1:PrefTimeID>
        <d3p1:PrefTimeName>sample string 2</d3p1:PrefTimeName>
      </d3p1:PreferedTimeDetail>
      <d3p1:PreferedTimeDetail>
        <d3p1:PrefTimeID>1</d3p1:PrefTimeID>
        <d3p1:PrefTimeName>sample string 2</d3p1:PrefTimeName>
      </d3p1:PreferedTimeDetail>
    </d2p1:PreferredTimeList>
    <d2p1:PreviousBills xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Master.Objects">
      <d3p1:PreviousBill>
        <d3p1:PreviousBillID>sample string 1</d3p1:PreviousBillID>
        <d3p1:PreviousBillName>sample string 2</d3p1:PreviousBillName>
      </d3p1:PreviousBill>
      <d3p1:PreviousBill>
        <d3p1:PreviousBillID>sample string 1</d3p1:PreviousBillID>
        <d3p1:PreviousBillName>sample string 2</d3p1:PreviousBillName>
      </d3p1:PreviousBill>
    </d2p1:PreviousBills>
    <d2p1:PublicHolidays xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.DB">
      <d3p1:PublicHoliday>
        <d3p1:Day>4</d3p1:Day>
        <d3p1:Holiday>sample string 5</d3p1:Holiday>
        <d3p1:ID>1</d3p1:ID>
        <d3p1:IsWeekend>true</d3p1:IsWeekend>
        <d3p1:Month>3</d3p1:Month>
        <d3p1:State>sample string 6</d3p1:State>
        <d3p1:Year>2</d3p1:Year>
      </d3p1:PublicHoliday>
      <d3p1:PublicHoliday>
        <d3p1:Day>4</d3p1:Day>
        <d3p1:Holiday>sample string 5</d3p1:Holiday>
        <d3p1:ID>1</d3p1:ID>
        <d3p1:IsWeekend>true</d3p1:IsWeekend>
        <d3p1:Month>3</d3p1:Month>
        <d3p1:State>sample string 6</d3p1:State>
        <d3p1:Year>2</d3p1:Year>
      </d3p1:PublicHoliday>
    </d2p1:PublicHolidays>
    <d2p1:RateSection>sample string 2</d2p1:RateSection>
    <d2p1:SDFIConnectionFee>sample string 5</d2p1:SDFIConnectionFee>
    <d2p1:SalesFieldList xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Objects">
      <d3p1:SalesField>
        <d3p1:FieldID>1</d3p1:FieldID>
        <d3p1:FieldLabel>sample string 3</d3p1:FieldLabel>
        <d3p1:FieldName>sample string 2</d3p1:FieldName>
        <d3p1:IsVisible>true</d3p1:IsVisible>
      </d3p1:SalesField>
      <d3p1:SalesField>
        <d3p1:FieldID>1</d3p1:FieldID>
        <d3p1:FieldLabel>sample string 3</d3p1:FieldLabel>
        <d3p1:FieldName>sample string 2</d3p1:FieldName>
        <d3p1:IsVisible>true</d3p1:IsVisible>
      </d3p1:SalesField>
    </d2p1:SalesFieldList>
    <d2p1:SignUpSummary>sample string 1</d2p1:SignUpSummary>
    <d2p1:SolarFeedIns xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Master.Objects">
      <d3p1:SolarFeedInsDetail>
        <d3p1:SolarFeedID>sample string 1</d3p1:SolarFeedID>
        <d3p1:SolarFeedMessage>sample string 3</d3p1:SolarFeedMessage>
        <d3p1:SolarFeedName>sample string 2</d3p1:SolarFeedName>
      </d3p1:SolarFeedInsDetail>
      <d3p1:SolarFeedInsDetail>
        <d3p1:SolarFeedID>sample string 1</d3p1:SolarFeedID>
        <d3p1:SolarFeedMessage>sample string 3</d3p1:SolarFeedMessage>
        <d3p1:SolarFeedName>sample string 2</d3p1:SolarFeedName>
      </d3p1:SolarFeedInsDetail>
    </d2p1:SolarFeedIns>
    <d2p1:SolarType xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Master.Objects">
      <d3p1:SolarType>
        <d3p1:SolarTypeID>sample string 1</d3p1:SolarTypeID>
        <d3p1:SolarTypeName>sample string 2</d3p1:SolarTypeName>
      </d3p1:SolarType>
      <d3p1:SolarType>
        <d3p1:SolarTypeID>sample string 1</d3p1:SolarTypeID>
        <d3p1:SolarTypeName>sample string 2</d3p1:SolarTypeName>
      </d3p1:SolarType>
    </d2p1:SolarType>
    <d2p1:StateList xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Master.Objects">
      <d3p1:StateDetail>
        <d3p1:StateCode>sample string 2</d3p1:StateCode>
        <d3p1:StateID>1</d3p1:StateID>
        <d3p1:StateName>sample string 3</d3p1:StateName>
      </d3p1:StateDetail>
      <d3p1:StateDetail>
        <d3p1:StateCode>sample string 2</d3p1:StateCode>
        <d3p1:StateID>1</d3p1:StateID>
        <d3p1:StateName>sample string 3</d3p1:StateName>
      </d3p1:StateDetail>
    </d2p1:StateList>
    <d2p1:StreetTypeList xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Master.Objects">
      <d3p1:StreetTypeDetail>
        <d3p1:STName>sample string 3</d3p1:STName>
        <d3p1:StreetName>sample string 2</d3p1:StreetName>
        <d3p1:StreetTypeID>1</d3p1:StreetTypeID>
      </d3p1:StreetTypeDetail>
      <d3p1:StreetTypeDetail>
        <d3p1:STName>sample string 3</d3p1:STName>
        <d3p1:StreetName>sample string 2</d3p1:StreetName>
        <d3p1:StreetTypeID>1</d3p1:StreetTypeID>
      </d3p1:StreetTypeDetail>
    </d2p1:StreetTypeList>
    <d2p1:TermsCondition>sample string 3</d2p1:TermsCondition>
    <d2p1:WastedTruckFee>1</d2p1:WastedTruckFee>
    <d2p1:WastedTruckGasFee>1</d2p1:WastedTruckGasFee>
  </Value>
</ResultOfSalesFieldsResult7mwieEeK>