POST api/Customer/SearchCustomers
Searches customers by posted parameters
Request Information
URI Parameters
None.
Body Parameters
SearchCustomersPostName | Description | Type | Additional information |
---|---|---|---|
SimpleSearch |
The field is used for searching by one field |
SimpleSearchCustomers |
None. |
Request Formats
application/json, text/json
Sample:
{ "SimpleSearch": { "PageIndex": 0, "PageSize": 10, "Type": 1, "Value": "Firma s.r.o." } }
application/xml, text/xml
Sample:
<SearchCustomersPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts"> <SimpleSearch> <PageIndex>0</PageIndex> <PageSize>10</PageSize> <Type>Name</Type> <Value>Firma s.r.o.</Value> </SimpleSearch> </SearchCustomersPost>
Response Information
Resource Description
SearchCustomersResultName | Description | Type | Additional information |
---|---|---|---|
Customers |
A scroll with Users. |
SearchCustomer |
None. |
Response Formats
application/json, text/json
Sample:
{ "Customers": { "PageIndex": 1, "PageSize": 2, "IsNextPage": true, "Items": [ { "Id": 1, "Name": "sample string 2", "City": "sample string 3", "Description": "sample string 4", "Emails": [ "sample string 1", "sample string 2" ], "Phones": [ "sample string 1", "sample string 2" ], "PostalCode": "sample string 5", "StreetNo": "sample string 6", "Web": "sample string 7" }, { "Id": 1, "Name": "sample string 2", "City": "sample string 3", "Description": "sample string 4", "Emails": [ "sample string 1", "sample string 2" ], "Phones": [ "sample string 1", "sample string 2" ], "PostalCode": "sample string 5", "StreetNo": "sample string 6", "Web": "sample string 7" } ] } }
application/xml, text/xml
Sample:
<SearchCustomersResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results"> <Customers> <IsNextPage>true</IsNextPage> <Items xmlns:d3p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures"> <d3p1:SearchCustomer> <d3p1:City>sample string 3</d3p1:City> <d3p1:Description>sample string 4</d3p1:Description> <d3p1:Emails xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </d3p1:Emails> <d3p1:Id>1</d3p1:Id> <d3p1:Name>sample string 2</d3p1:Name> <d3p1:Phones xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </d3p1:Phones> <d3p1:PostalCode>sample string 5</d3p1:PostalCode> <d3p1:StreetNo>sample string 6</d3p1:StreetNo> <d3p1:Web>sample string 7</d3p1:Web> </d3p1:SearchCustomer> <d3p1:SearchCustomer> <d3p1:City>sample string 3</d3p1:City> <d3p1:Description>sample string 4</d3p1:Description> <d3p1:Emails xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </d3p1:Emails> <d3p1:Id>1</d3p1:Id> <d3p1:Name>sample string 2</d3p1:Name> <d3p1:Phones xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </d3p1:Phones> <d3p1:PostalCode>sample string 5</d3p1:PostalCode> <d3p1:StreetNo>sample string 6</d3p1:StreetNo> <d3p1:Web>sample string 7</d3p1:Web> </d3p1:SearchCustomer> </Items> <PageIndex>1</PageIndex> <PageSize>2</PageSize> </Customers> </SearchCustomersResult>