POST api/Customer/GetCustomerGridDropDownOptions
Request Information
URI Parameters
None.
Body Parameters
CustomerGridRequestData| Name | Description | Type | Additional information |
|---|---|---|---|
| GroupId | string |
None. |
|
| SegmentId | string |
None. |
|
| RepId | string |
None. |
|
| IncludeOnlyCustomersWithPendingUsers | boolean |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| Zip | string |
None. |
|
| Category | string |
None. |
|
| SearchTerm | string |
None. |
|
| NoSalesActive | boolean |
None. |
|
| NoSalesDays | integer |
None. |
|
| ActiveLastActive | boolean |
None. |
|
| ActiveLastMonths | integer |
None. |
|
| NewCustomersActive | boolean |
None. |
|
| InventoryOnly | boolean |
None. |
|
| PaginatedGridData | StandardPaginatedGridData |
None. |
Request Formats
application/json, text/json
Sample:
{
"GroupId": "sample string 1",
"SegmentId": "sample string 2",
"RepId": "sample string 3",
"IncludeOnlyCustomersWithPendingUsers": true,
"City": "sample string 5",
"State": "sample string 6",
"Zip": "sample string 7",
"Category": "sample string 8",
"SearchTerm": "sample string 9",
"NoSalesActive": true,
"NoSalesDays": 11,
"ActiveLastActive": true,
"ActiveLastMonths": 13,
"NewCustomersActive": true,
"InventoryOnly": true,
"PaginatedGridData": {
"PageSize": 1,
"CurrentPage": 2,
"SortColumn": "sample string 3",
"SortDirection": "sample string 4"
}
}
application/xml, text/xml
Sample:
<CustomerGridRequestData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
<ActiveLastActive>true</ActiveLastActive>
<ActiveLastMonths>13</ActiveLastMonths>
<Category>sample string 8</Category>
<City>sample string 5</City>
<GroupId>sample string 1</GroupId>
<IncludeOnlyCustomersWithPendingUsers>true</IncludeOnlyCustomersWithPendingUsers>
<InventoryOnly>true</InventoryOnly>
<NewCustomersActive>true</NewCustomersActive>
<NoSalesActive>true</NoSalesActive>
<NoSalesDays>11</NoSalesDays>
<PaginatedGridData>
<CurrentPage>2</CurrentPage>
<PageSize>1</PageSize>
<SortColumn>sample string 3</SortColumn>
<SortDirection>sample string 4</SortDirection>
</PaginatedGridData>
<RepId>sample string 3</RepId>
<SearchTerm>sample string 9</SearchTerm>
<SegmentId>sample string 2</SegmentId>
<State>sample string 6</State>
<Zip>sample string 7</Zip>
</CustomerGridRequestData>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CustomerFilterSet| Name | Description | Type | Additional information |
|---|---|---|---|
| SegmentOptions | Collection of JustNameValue |
None. |
|
| GroupOptions | Collection of JustNameValue |
None. |
|
| RepOptions | Collection of JustNameValue |
None. |
|
| CityOptions | Collection of JustNameValue |
None. |
|
| StateOptions | Collection of JustNameValue |
None. |
|
| ZipOptions | Collection of JustNameValue |
None. |
|
| CategoryOptions | Collection of JustNameValue |
None. |
Response Formats
application/json, text/json
Sample:
{
"SegmentOptions": [
{
"Name": "sample string 1",
"Value": "sample string 2",
"ContactName": "sample string 3"
},
{
"Name": "sample string 1",
"Value": "sample string 2",
"ContactName": "sample string 3"
}
],
"GroupOptions": [
{
"Name": "sample string 1",
"Value": "sample string 2",
"ContactName": "sample string 3"
},
{
"Name": "sample string 1",
"Value": "sample string 2",
"ContactName": "sample string 3"
}
],
"RepOptions": [
{
"Name": "sample string 1",
"Value": "sample string 2",
"ContactName": "sample string 3"
},
{
"Name": "sample string 1",
"Value": "sample string 2",
"ContactName": "sample string 3"
}
],
"CityOptions": [
{
"Name": "sample string 1",
"Value": "sample string 2",
"ContactName": "sample string 3"
},
{
"Name": "sample string 1",
"Value": "sample string 2",
"ContactName": "sample string 3"
}
],
"StateOptions": [
{
"Name": "sample string 1",
"Value": "sample string 2",
"ContactName": "sample string 3"
},
{
"Name": "sample string 1",
"Value": "sample string 2",
"ContactName": "sample string 3"
}
],
"ZipOptions": [
{
"Name": "sample string 1",
"Value": "sample string 2",
"ContactName": "sample string 3"
},
{
"Name": "sample string 1",
"Value": "sample string 2",
"ContactName": "sample string 3"
}
],
"CategoryOptions": [
{
"Name": "sample string 1",
"Value": "sample string 2",
"ContactName": "sample string 3"
},
{
"Name": "sample string 1",
"Value": "sample string 2",
"ContactName": "sample string 3"
}
]
}
application/xml, text/xml
Sample:
<CustomerFilterSet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
<CategoryOptions>
<JustNameValue>
<ContactName>sample string 3</ContactName>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</JustNameValue>
<JustNameValue>
<ContactName>sample string 3</ContactName>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</JustNameValue>
</CategoryOptions>
<CityOptions>
<JustNameValue>
<ContactName>sample string 3</ContactName>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</JustNameValue>
<JustNameValue>
<ContactName>sample string 3</ContactName>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</JustNameValue>
</CityOptions>
<GroupOptions>
<JustNameValue>
<ContactName>sample string 3</ContactName>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</JustNameValue>
<JustNameValue>
<ContactName>sample string 3</ContactName>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</JustNameValue>
</GroupOptions>
<RepOptions>
<JustNameValue>
<ContactName>sample string 3</ContactName>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</JustNameValue>
<JustNameValue>
<ContactName>sample string 3</ContactName>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</JustNameValue>
</RepOptions>
<SegmentOptions>
<JustNameValue>
<ContactName>sample string 3</ContactName>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</JustNameValue>
<JustNameValue>
<ContactName>sample string 3</ContactName>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</JustNameValue>
</SegmentOptions>
<StateOptions>
<JustNameValue>
<ContactName>sample string 3</ContactName>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</JustNameValue>
<JustNameValue>
<ContactName>sample string 3</ContactName>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</JustNameValue>
</StateOptions>
<ZipOptions>
<JustNameValue>
<ContactName>sample string 3</ContactName>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</JustNameValue>
<JustNameValue>
<ContactName>sample string 3</ContactName>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</JustNameValue>
</ZipOptions>
</CustomerFilterSet>