GET Api/Distributor/List/{EnergyType}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
EnergyType

integer

Default value is -1

Body Parameters

None.

Response Information

Resource Description

ResultOfDistributorList
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

ErrorMessage

Collection of string

None.

Value

DistributorList

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": {
    "DistributorDetails": [
      {
        "DistributorID": 1,
        "DistributorName": "sample string 2",
        "EnergyTypeID": 3,
        "EnergyTypeName": "sample string 4"
      },
      {
        "DistributorID": 1,
        "DistributorName": "sample string 2",
        "EnergyTypeID": 3,
        "EnergyTypeName": "sample string 4"
      }
    ],
    "Total": 1
  }
}

application/xml, text/xml

Sample:
<ResultOfDistributorListVHDxlVkh 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.Master.Objects">
    <d2p1:DistributorDetails>
      <d2p1:DistributorDetail>
        <d2p1:DistributorID>1</d2p1:DistributorID>
        <d2p1:DistributorName>sample string 2</d2p1:DistributorName>
        <d2p1:EnergyTypeID>3</d2p1:EnergyTypeID>
        <d2p1:EnergyTypeName>sample string 4</d2p1:EnergyTypeName>
      </d2p1:DistributorDetail>
      <d2p1:DistributorDetail>
        <d2p1:DistributorID>1</d2p1:DistributorID>
        <d2p1:DistributorName>sample string 2</d2p1:DistributorName>
        <d2p1:EnergyTypeID>3</d2p1:EnergyTypeID>
        <d2p1:EnergyTypeName>sample string 4</d2p1:EnergyTypeName>
      </d2p1:DistributorDetail>
    </d2p1:DistributorDetails>
    <d2p1:Total>1</d2p1:Total>
  </Value>
</ResultOfDistributorListVHDxlVkh>