POST Api/Solar/SolarTariff/List
Request Information
URI Parameters
None.
Body Parameters
ParamGetTariffCodeList| Name | Description | Type | Additional information |
|---|---|---|---|
| Postcode | string |
None. |
|
| Suburb | string |
None. |
|
| NMI | string |
None. |
|
| CustomerTypeID | integer |
None. |
|
| IsSolar | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Postcode": "sample string 1",
"Suburb": "sample string 2",
"NMI": "sample string 3",
"CustomerTypeID": 4,
"IsSolar": true
}
application/xml, text/xml
Sample:
<ParamGetTariffCodeList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewTariffMappings.Parameters"> <CustomerTypeID>4</CustomerTypeID> <IsSolar>true</IsSolar> <NMI>sample string 3</NMI> <Postcode>sample string 1</Postcode> <Suburb>sample string 2</Suburb> </ParamGetTariffCodeList>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResultOfListOfSolarTariffMappingDetail| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| Message | string |
None. |
|
| ErrorMessage | Collection of string |
None. |
|
| Value | Collection of SolarTariffMappingDetail |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"Message": "sample string 2",
"ErrorMessage": [
"sample string 1",
"sample string 2"
],
"Value": [
{
"STFIG": "sample string 1",
"STMName": "sample string 2"
},
{
"STFIG": "sample string 1",
"STMName": "sample string 2"
}
]
}
application/xml, text/xml
Sample:
<ResultOfArrayOfSolarTariffMappingDetailcyEWbz0W 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.NewTariffMappings.Objects">
<d2p1:SolarTariffMappingDetail>
<d2p1:STFIG>sample string 1</d2p1:STFIG>
<d2p1:STMName>sample string 2</d2p1:STMName>
</d2p1:SolarTariffMappingDetail>
<d2p1:SolarTariffMappingDetail>
<d2p1:STFIG>sample string 1</d2p1:STFIG>
<d2p1:STMName>sample string 2</d2p1:STMName>
</d2p1:SolarTariffMappingDetail>
</Value>
</ResultOfArrayOfSolarTariffMappingDetailcyEWbz0W>