POST PoolService/Leads/GetPoolServiceLeads
Get a list of the requested leads options(New , Pending , Won Or Lost).
Request Information
URI Parameters
None.
Body Parameters
LeadRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| StoreNumber |
The store number |
integer |
None. |
| LeadStatus |
Type of lead (New , Pending , Won or Lost) |
string |
None. |
| ResultOffset |
The number to offset the result with. If NumberOfRecords = 500 and RecordsLimit = 100 the ResultOffset should be 100 for result between(200 and 300) |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"StoreNumber": 1,
"LeadStatus": "sample string 2",
"ResultOffset": 3
}
application/xml, text/xml
Sample:
<LeadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API_PSLeads.Controllers"> <LeadStatus>sample string 2</LeadStatus> <ResultOffset>3</ResultOffset> <StoreNumber>1</StoreNumber> </LeadRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |