POST api/client/search

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BusinessPartnerCode	string	None.
Surname	string	None.
FirstName	string	None.
ClientID	integer	None.
ClientName	string	None.
ClientStatusID	integer	None.
BusinessTypeID	integer	None.
County	string	None.
Corporate	boolean	None.
ExternalRef	string	None.
SupplierID	integer	None.
Postcode	string	None.
Town	string	None.
AllocatedUserID	integer	None.
Address	string	None.
MaxElectricMeters	integer	None.
MinElectricMeters	integer	None.
MaxElectricUsage	integer	None.
MinElectricUsage	integer	None.
MaxGasMeters	integer	None.
MinGasMeters	integer	None.
MaxGasUsage	integer	None.
MinGasUsage	integer	None.
MaxNumSites	integer	None.
MinNumSites	integer	None.
MprNumber	string	None.
MpanNumber	string	None.
LoggedFromDate	string	None.
LoggedToDate	string	None.
ProductID	integer	None.
IsVerified	boolean	None.
SortIndex	integer	None.
UserTypeID	string	None.

Request Formats

application/json, text/json

Sample:

{
  "BusinessPartnerCode": "sample string 1",
  "Surname": "sample string 2",
  "FirstName": "sample string 3",
  "ClientID": 4,
  "ClientName": "sample string 5",
  "ClientStatusID": 6,
  "BusinessTypeID": 7,
  "County": "sample string 8",
  "Corporate": true,
  "ExternalRef": "sample string 10",
  "SupplierID": 11,
  "Postcode": "sample string 12",
  "Town": "sample string 13",
  "AllocatedUserID": 14,
  "Address": "sample string 15",
  "MaxElectricMeters": 16,
  "MinElectricMeters": 17,
  "MaxElectricUsage": 18,
  "MinElectricUsage": 19,
  "MaxGasMeters": 20,
  "MinGasMeters": 21,
  "MaxGasUsage": 22,
  "MinGasUsage": 23,
  "MaxNumSites": 24,
  "MinNumSites": 25,
  "MprNumber": "sample string 26",
  "MpanNumber": "sample string 27",
  "LoggedFromDate": "sample string 28",
  "LoggedToDate": "sample string 29",
  "ProductID": 30,
  "IsVerified": true,
  "SortIndex": 32,
  "UserTypeID": "sample string 33"
}

application/xml, text/xml

Sample:

<ClientSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PricingWebAPI.Models">
  <Address>sample string 15</Address>
  <AllocatedUserID>14</AllocatedUserID>
  <BusinessPartnerCode>sample string 1</BusinessPartnerCode>
  <BusinessTypeID>7</BusinessTypeID>
  <ClientID>4</ClientID>
  <ClientName>sample string 5</ClientName>
  <ClientStatusID>6</ClientStatusID>
  <Corporate>true</Corporate>
  <County>sample string 8</County>
  <ExternalRef>sample string 10</ExternalRef>
  <FirstName>sample string 3</FirstName>
  <IsVerified>true</IsVerified>
  <LoggedFromDate>sample string 28</LoggedFromDate>
  <LoggedToDate>sample string 29</LoggedToDate>
  <MaxElectricMeters>16</MaxElectricMeters>
  <MaxElectricUsage>18</MaxElectricUsage>
  <MaxGasMeters>20</MaxGasMeters>
  <MaxGasUsage>22</MaxGasUsage>
  <MaxNumSites>24</MaxNumSites>
  <MinElectricMeters>17</MinElectricMeters>
  <MinElectricUsage>19</MinElectricUsage>
  <MinGasMeters>21</MinGasMeters>
  <MinGasUsage>23</MinGasUsage>
  <MinNumSites>25</MinNumSites>
  <MpanNumber>sample string 27</MpanNumber>
  <MprNumber>sample string 26</MprNumber>
  <Postcode>sample string 12</Postcode>
  <ProductID>30</ProductID>
  <SortIndex>32</SortIndex>
  <SupplierID>11</SupplierID>
  <Surname>sample string 2</Surname>
  <Town>sample string 13</Town>
  <UserTypeID>sample string 33</UserTypeID>
</ClientSearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.