GET api/WebApiOdata/GetPreferredGroupShoppers?providerID={providerID}&groupID={groupID}&searchShopperString={searchShopperString}&onlyGroup={onlyGroup}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
providerID | integer |
Required |
|
groupID | integer |
Required |
|
searchShopperString | string |
None. |
|
onlyGroup | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of PreferredGroupShopperViewModelName | Description | Type | Additional information |
---|---|---|---|
ShopperID | integer |
None. |
|
ShopperName | string |
None. |
|
CompanyName | string |
None. |
|
CompanyNameDisplay | string |
None. |
|
UserName | string |
None. |
|
Status | boolean |
None. |
|
PreferredGroupID | integer |
None. |
|
GroupName | string |
None. |
|
GroupNameDisplay | string |
None. |
|
string |
None. |
||
ShopperTypeID | integer |
None. |
Response Formats
application/json, text/json, text/html
Sample:
[ { "ShopperID": 1, "ShopperName": "sample string 2", "CompanyName": "sample string 3", "CompanyNameDisplay": "sample string 3", "UserName": "sample string 4", "Status": true, "PreferredGroupID": 6, "GroupName": "sample string 7", "GroupNameDisplay": "sample string 7", "Email": "sample string 8", "ShopperTypeID": 9 }, { "ShopperID": 1, "ShopperName": "sample string 2", "CompanyName": "sample string 3", "CompanyNameDisplay": "sample string 3", "UserName": "sample string 4", "Status": true, "PreferredGroupID": 6, "GroupName": "sample string 7", "GroupNameDisplay": "sample string 7", "Email": "sample string 8", "ShopperTypeID": 9 } ]
application/xml, text/xml
Sample:
<ArrayOfPreferredGroupShopperViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SellersCommerce.ViewModels.Shoppers"> <PreferredGroupShopperViewModel> <CompanyName>sample string 3</CompanyName> <Email>sample string 8</Email> <GroupName>sample string 7</GroupName> <PreferredGroupID>6</PreferredGroupID> <ShopperID>1</ShopperID> <ShopperName>sample string 2</ShopperName> <ShopperTypeID>9</ShopperTypeID> <Status>true</Status> <UserName>sample string 4</UserName> </PreferredGroupShopperViewModel> <PreferredGroupShopperViewModel> <CompanyName>sample string 3</CompanyName> <Email>sample string 8</Email> <GroupName>sample string 7</GroupName> <PreferredGroupID>6</PreferredGroupID> <ShopperID>1</ShopperID> <ShopperName>sample string 2</ShopperName> <ShopperTypeID>9</ShopperTypeID> <Status>true</Status> <UserName>sample string 4</UserName> </PreferredGroupShopperViewModel> </ArrayOfPreferredGroupShopperViewModel>