POST api/Customer/FullTextSearchCustomers
Full-Text search for Customers by posted parameters .
Request Information
URI Parameters
None.
Body Parameters
FullTextSearchCustomersPost| Name | 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": 1,
"PageSize": 2,
"Value": "sample string 3"
}
}
application/xml, text/xml
Sample:
<FullTextSearchCustomersPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts.Customer">
<SimpleSearch>
<PageIndex>1</PageIndex>
<PageSize>2</PageSize>
<Value>sample string 3</Value>
</SimpleSearch>
</FullTextSearchCustomersPost>
Response Information
Resource Description
FullTextSearchCustomersResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Customers |
A scroll with Customers. |
ExtendedRequestorCustomer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Customers": {
"PageIndex": 1,
"PageSize": 2,
"IsNextPage": true,
"Items": [
{
"IdCustomer": 1,
"Name": "sample string 1",
"Phones": [
"sample string 1",
"sample string 2"
],
"Emails": [
"sample string 1",
"sample string 2"
],
"EmailDomains": [
"sample string 1",
"sample string 2"
],
"TimeZoneId": null,
"Web": "sample string 3",
"StreetNumber": "sample string 4",
"City": "sample string 5",
"PostalCode": "sample string 6",
"CountryCode": "sample string 7",
"Descrtiption": "sample string 8",
"Location": "sample string 9",
"CustomerGroups": [
{
"Id": 1,
"Name": "sample string 2",
"Color": "sample string 3",
"Description": "sample string 4"
},
{
"Id": 1,
"Name": "sample string 2",
"Color": "sample string 3",
"Description": "sample string 4"
}
],
"Tags": [
{
"Id": 1,
"Name": "sample string 2",
"Static": true,
"Color": "sample string 4",
"Type": 1
},
{
"Id": 1,
"Name": "sample string 2",
"Static": true,
"Color": "sample string 4",
"Type": 1
}
],
"FieldData": [
{
"CustomFieldId": 1,
"DateValue": "2024-12-23T00:06:34.3688859+01:00",
"DoubleValue": 1.1,
"LongValue": 1,
"TextBoxValue": "sample string 2",
"CheckBoxValue": true,
"FieldItem": {
"Id": 1,
"Title": "sample string 2"
}
},
{
"CustomFieldId": 1,
"DateValue": "2024-12-23T00:06:34.3688859+01:00",
"DoubleValue": 1.1,
"LongValue": 1,
"TextBoxValue": "sample string 2",
"CheckBoxValue": true,
"FieldItem": {
"Id": 1,
"Title": "sample string 2"
}
}
],
"HavePhoto": true,
"PhotoLastUpdatedUtc": "2024-12-23T00:06:34.3688859+01:00",
"CustomCustomerFieldsHash": 11,
"Disabled": true,
"ExternalId": "sample string 13"
},
{
"IdCustomer": 1,
"Name": "sample string 1",
"Phones": [
"sample string 1",
"sample string 2"
],
"Emails": [
"sample string 1",
"sample string 2"
],
"EmailDomains": [
"sample string 1",
"sample string 2"
],
"TimeZoneId": null,
"Web": "sample string 3",
"StreetNumber": "sample string 4",
"City": "sample string 5",
"PostalCode": "sample string 6",
"CountryCode": "sample string 7",
"Descrtiption": "sample string 8",
"Location": "sample string 9",
"CustomerGroups": [
{
"Id": 1,
"Name": "sample string 2",
"Color": "sample string 3",
"Description": "sample string 4"
},
{
"Id": 1,
"Name": "sample string 2",
"Color": "sample string 3",
"Description": "sample string 4"
}
],
"Tags": [
{
"Id": 1,
"Name": "sample string 2",
"Static": true,
"Color": "sample string 4",
"Type": 1
},
{
"Id": 1,
"Name": "sample string 2",
"Static": true,
"Color": "sample string 4",
"Type": 1
}
],
"FieldData": [
{
"CustomFieldId": 1,
"DateValue": "2024-12-23T00:06:34.3688859+01:00",
"DoubleValue": 1.1,
"LongValue": 1,
"TextBoxValue": "sample string 2",
"CheckBoxValue": true,
"FieldItem": {
"Id": 1,
"Title": "sample string 2"
}
},
{
"CustomFieldId": 1,
"DateValue": "2024-12-23T00:06:34.3688859+01:00",
"DoubleValue": 1.1,
"LongValue": 1,
"TextBoxValue": "sample string 2",
"CheckBoxValue": true,
"FieldItem": {
"Id": 1,
"Title": "sample string 2"
}
}
],
"HavePhoto": true,
"PhotoLastUpdatedUtc": "2024-12-23T00:06:34.3688859+01:00",
"CustomCustomerFieldsHash": 11,
"Disabled": true,
"ExternalId": "sample string 13"
}
]
}
}
application/xml, text/xml
Sample:
<FullTextSearchCustomersResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results.Customer">
<Customers xmlns:d2p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
<d2p1:IsNextPage>true</d2p1:IsNextPage>
<d2p1:Items xmlns:d3p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures">
<d3p1:ExtendedRequestorCustomer>
<d3p1:City>sample string 5</d3p1:City>
<d3p1:CountryCode>sample string 7</d3p1:CountryCode>
<d3p1:CustomCustomerFieldsHash>11</d3p1:CustomCustomerFieldsHash>
<d3p1:CustomerGroups>
<d3p1:CustomerGroupData>
<d3p1:Color>sample string 3</d3p1:Color>
<d3p1:Description>sample string 4</d3p1:Description>
<d3p1:Id>1</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
</d3p1:CustomerGroupData>
<d3p1:CustomerGroupData>
<d3p1:Color>sample string 3</d3p1:Color>
<d3p1:Description>sample string 4</d3p1:Description>
<d3p1:Id>1</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
</d3p1:CustomerGroupData>
</d3p1:CustomerGroups>
<d3p1:Descrtiption>sample string 8</d3p1:Descrtiption>
<d3p1:Disabled>true</d3p1:Disabled>
<d3p1:EmailDomains 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:EmailDomains>
<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:ExternalId>sample string 13</d3p1:ExternalId>
<d3p1:FieldData>
<d3p1:CustomerCustomFieldData>
<d3p1:CheckBoxValue>true</d3p1:CheckBoxValue>
<d3p1:CustomFieldId>1</d3p1:CustomFieldId>
<d3p1:DateValue>2024-12-23T00:06:34.3688859+01:00</d3p1:DateValue>
<d3p1:DoubleValue>1.1</d3p1:DoubleValue>
<d3p1:FieldItem>
<d3p1:Id>1</d3p1:Id>
<d3p1:Title>sample string 2</d3p1:Title>
</d3p1:FieldItem>
<d3p1:LongValue>1</d3p1:LongValue>
<d3p1:TextBoxValue>sample string 2</d3p1:TextBoxValue>
</d3p1:CustomerCustomFieldData>
<d3p1:CustomerCustomFieldData>
<d3p1:CheckBoxValue>true</d3p1:CheckBoxValue>
<d3p1:CustomFieldId>1</d3p1:CustomFieldId>
<d3p1:DateValue>2024-12-23T00:06:34.3688859+01:00</d3p1:DateValue>
<d3p1:DoubleValue>1.1</d3p1:DoubleValue>
<d3p1:FieldItem>
<d3p1:Id>1</d3p1:Id>
<d3p1:Title>sample string 2</d3p1:Title>
</d3p1:FieldItem>
<d3p1:LongValue>1</d3p1:LongValue>
<d3p1:TextBoxValue>sample string 2</d3p1:TextBoxValue>
</d3p1:CustomerCustomFieldData>
</d3p1:FieldData>
<d3p1:HavePhoto>true</d3p1:HavePhoto>
<d3p1:IdCustomer>1</d3p1:IdCustomer>
<d3p1:Location>sample string 9</d3p1:Location>
<d3p1:Name>sample string 1</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:PhotoLastUpdatedUtc>2024-12-23T00:06:34.3688859+01:00</d3p1:PhotoLastUpdatedUtc>
<d3p1:PostalCode>sample string 6</d3p1:PostalCode>
<d3p1:StreetNumber>sample string 4</d3p1:StreetNumber>
<d3p1:Tags>
<d3p1:TagData>
<d3p1:Color>sample string 4</d3p1:Color>
<d3p1:Id>1</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
<d3p1:Static>true</d3p1:Static>
<d3p1:Type>Ticket</d3p1:Type>
</d3p1:TagData>
<d3p1:TagData>
<d3p1:Color>sample string 4</d3p1:Color>
<d3p1:Id>1</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
<d3p1:Static>true</d3p1:Static>
<d3p1:Type>Ticket</d3p1:Type>
</d3p1:TagData>
</d3p1:Tags>
<d3p1:TimeZoneId i:nil="true" />
<d3p1:Web>sample string 3</d3p1:Web>
</d3p1:ExtendedRequestorCustomer>
<d3p1:ExtendedRequestorCustomer>
<d3p1:City>sample string 5</d3p1:City>
<d3p1:CountryCode>sample string 7</d3p1:CountryCode>
<d3p1:CustomCustomerFieldsHash>11</d3p1:CustomCustomerFieldsHash>
<d3p1:CustomerGroups>
<d3p1:CustomerGroupData>
<d3p1:Color>sample string 3</d3p1:Color>
<d3p1:Description>sample string 4</d3p1:Description>
<d3p1:Id>1</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
</d3p1:CustomerGroupData>
<d3p1:CustomerGroupData>
<d3p1:Color>sample string 3</d3p1:Color>
<d3p1:Description>sample string 4</d3p1:Description>
<d3p1:Id>1</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
</d3p1:CustomerGroupData>
</d3p1:CustomerGroups>
<d3p1:Descrtiption>sample string 8</d3p1:Descrtiption>
<d3p1:Disabled>true</d3p1:Disabled>
<d3p1:EmailDomains 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:EmailDomains>
<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:ExternalId>sample string 13</d3p1:ExternalId>
<d3p1:FieldData>
<d3p1:CustomerCustomFieldData>
<d3p1:CheckBoxValue>true</d3p1:CheckBoxValue>
<d3p1:CustomFieldId>1</d3p1:CustomFieldId>
<d3p1:DateValue>2024-12-23T00:06:34.3688859+01:00</d3p1:DateValue>
<d3p1:DoubleValue>1.1</d3p1:DoubleValue>
<d3p1:FieldItem>
<d3p1:Id>1</d3p1:Id>
<d3p1:Title>sample string 2</d3p1:Title>
</d3p1:FieldItem>
<d3p1:LongValue>1</d3p1:LongValue>
<d3p1:TextBoxValue>sample string 2</d3p1:TextBoxValue>
</d3p1:CustomerCustomFieldData>
<d3p1:CustomerCustomFieldData>
<d3p1:CheckBoxValue>true</d3p1:CheckBoxValue>
<d3p1:CustomFieldId>1</d3p1:CustomFieldId>
<d3p1:DateValue>2024-12-23T00:06:34.3688859+01:00</d3p1:DateValue>
<d3p1:DoubleValue>1.1</d3p1:DoubleValue>
<d3p1:FieldItem>
<d3p1:Id>1</d3p1:Id>
<d3p1:Title>sample string 2</d3p1:Title>
</d3p1:FieldItem>
<d3p1:LongValue>1</d3p1:LongValue>
<d3p1:TextBoxValue>sample string 2</d3p1:TextBoxValue>
</d3p1:CustomerCustomFieldData>
</d3p1:FieldData>
<d3p1:HavePhoto>true</d3p1:HavePhoto>
<d3p1:IdCustomer>1</d3p1:IdCustomer>
<d3p1:Location>sample string 9</d3p1:Location>
<d3p1:Name>sample string 1</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:PhotoLastUpdatedUtc>2024-12-23T00:06:34.3688859+01:00</d3p1:PhotoLastUpdatedUtc>
<d3p1:PostalCode>sample string 6</d3p1:PostalCode>
<d3p1:StreetNumber>sample string 4</d3p1:StreetNumber>
<d3p1:Tags>
<d3p1:TagData>
<d3p1:Color>sample string 4</d3p1:Color>
<d3p1:Id>1</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
<d3p1:Static>true</d3p1:Static>
<d3p1:Type>Ticket</d3p1:Type>
</d3p1:TagData>
<d3p1:TagData>
<d3p1:Color>sample string 4</d3p1:Color>
<d3p1:Id>1</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
<d3p1:Static>true</d3p1:Static>
<d3p1:Type>Ticket</d3p1:Type>
</d3p1:TagData>
</d3p1:Tags>
<d3p1:TimeZoneId i:nil="true" />
<d3p1:Web>sample string 3</d3p1:Web>
</d3p1:ExtendedRequestorCustomer>
</d2p1:Items>
<d2p1:PageIndex>1</d2p1:PageIndex>
<d2p1:PageSize>2</d2p1:PageSize>
</Customers>
</FullTextSearchCustomersResult>