POST v3/SalesRep/Customers/Search
Request Information
URI Parameters
None.
Body Parameters
CustomerSearchModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
None. |
|
| Number | integer |
None. |
|
| Skip | integer |
None. |
|
| Top | integer |
None. |
|
| SortByName | boolean |
None. |
|
| Descending | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"Number": 2,
"Skip": 3,
"Top": 4,
"SortByName": true,
"Descending": true
}
application/xml, text/xml
Sample:
<CustomerSearchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Go4Gold.WebAPI.Models"> <Descending>true</Descending> <Name>sample string 1</Name> <Number>2</Number> <Skip>3</Skip> <SortByName>true</SortByName> <Top>4</Top> </CustomerSearchModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of CustomerModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ParentNumber | integer |
None. |
|
| ParentBranchNumber | integer |
None. |
|
| Number | integer |
None. |
|
| BranchNumber | integer |
None. |
|
| Name | string |
None. |
|
| SalesRepCode | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ParentNumber": 1,
"ParentBranchNumber": 2,
"Number": 3,
"BranchNumber": 4,
"Name": "sample string 5",
"SalesRepCode": "sample string 6"
},
{
"ParentNumber": 1,
"ParentBranchNumber": 2,
"Number": 3,
"BranchNumber": 4,
"Name": "sample string 5",
"SalesRepCode": "sample string 6"
}
]
application/xml, text/xml
Sample:
<ArrayOfCustomerModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Go4Gold.WebAPI.Models">
<CustomerModel>
<BranchNumber>4</BranchNumber>
<Name>sample string 5</Name>
<Number>3</Number>
<ParentBranchNumber>2</ParentBranchNumber>
<ParentNumber>1</ParentNumber>
<SalesRepCode>sample string 6</SalesRepCode>
</CustomerModel>
<CustomerModel>
<BranchNumber>4</BranchNumber>
<Name>sample string 5</Name>
<Number>3</Number>
<ParentBranchNumber>2</ParentBranchNumber>
<ParentNumber>1</ParentNumber>
<SalesRepCode>sample string 6</SalesRepCode>
</CustomerModel>
</ArrayOfCustomerModel>