POST api/Customer/FullTextSearchUsers

Full-Text search for Customer users by posted parameters .

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
SimpleSearch	The field is used for searching by one field	SimpleSearchUsers	None.

Request Formats

application/json, text/json

Sample:

{
  "SimpleSearch": {
    "PageIndex": 1,
    "PageSize": 2,
    "Value": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<FullTextSearchUsersPost 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>
</FullTextSearchUsersPost>

Response Information

Resource Description

FullTextSearchUsersResult

Name	Description	Type	Additional information
Users	A scroll with Users.	ExtendedRequestorUser	None.

Response Formats

application/json, text/json

Sample:

{
  "Users": {
    "PageIndex": 1,
    "PageSize": 2,
    "IsNextPage": true,
    "Items": [
      {
        "SecondaryEmails": [
          "sample string 1",
          "sample string 2"
        ],
        "CustomUserFieldsHash": 1,
        "FieldData": [
          {
            "CustomFieldId": 1,
            "DateValue": "2024-04-28T11:42:56.2926604+02:00",
            "DoubleValue": 1.1,
            "LongValue": 1,
            "TextBoxValue": "sample string 2",
            "CheckBoxValue": true,
            "FieldItem": {
              "Id": 1,
              "Title": "sample string 2"
            }
          },
          {
            "CustomFieldId": 1,
            "DateValue": "2024-04-28T11:42:56.2926604+02:00",
            "DoubleValue": 1.1,
            "LongValue": 1,
            "TextBoxValue": "sample string 2",
            "CheckBoxValue": true,
            "FieldItem": {
              "Id": 1,
              "Title": "sample string 2"
            }
          }
        ],
        "UserProviderKey": "sample string 2",
        "UserName": "sample string 3",
        "Email": "sample string 4",
        "FirstName": "sample string 5",
        "LastName": "sample string 6",
        "MiddleName": "sample string 7",
        "DisplayName": "sample string 8",
        "NoteBesideName": "sample string 9",
        "FullName": "sample string 10",
        "IsApproved": true,
        "IsEndUser": true,
        "IsSmartUser": true,
        "IsOperator": true,
        "IsSuperOperator": true,
        "IsAdministrator": true,
        "TimeZoneId": null,
        "ExternalAccount": true,
        "EmailAccount": true,
        "Customer": "sample string 20",
        "CustomerId": 1,
        "Customers": [
          {
            "Id": 1,
            "Name": "sample string 2"
          },
          {
            "Id": 1,
            "Name": "sample string 2"
          }
        ],
        "Phones": [
          "sample string 1",
          "sample string 2"
        ],
        "AdminNote": "sample string 21",
        "OperatorNote": "sample string 22",
        "AdditionalInformation": "sample string 23",
        "SkypeName": "sample string 24",
        "OperatorGroupIds": [
          1,
          2
        ],
        "InternalGroupIds": [
          1,
          2
        ],
        "Color": "sample string 25",
        "Initials": "sample string 26",
        "PhotoLastUpdatedUtc": "2024-04-28T11:42:56.2926604+02:00",
        "LastUpdatedUtc": "2024-04-28T11:42:56.2926604+02:00",
        "Language": 0,
        "Anonymized": true,
        "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
          }
        ],
        "ExternalId": "sample string 28",
        "ManagerKey": "sample string 29",
        "Company": "sample string 30",
        "Department": "sample string 31",
        "Division": "sample string 32",
        "EmployeeId": "sample string 33"
      },
      {
        "SecondaryEmails": [
          "sample string 1",
          "sample string 2"
        ],
        "CustomUserFieldsHash": 1,
        "FieldData": [
          {
            "CustomFieldId": 1,
            "DateValue": "2024-04-28T11:42:56.2926604+02:00",
            "DoubleValue": 1.1,
            "LongValue": 1,
            "TextBoxValue": "sample string 2",
            "CheckBoxValue": true,
            "FieldItem": {
              "Id": 1,
              "Title": "sample string 2"
            }
          },
          {
            "CustomFieldId": 1,
            "DateValue": "2024-04-28T11:42:56.2926604+02:00",
            "DoubleValue": 1.1,
            "LongValue": 1,
            "TextBoxValue": "sample string 2",
            "CheckBoxValue": true,
            "FieldItem": {
              "Id": 1,
              "Title": "sample string 2"
            }
          }
        ],
        "UserProviderKey": "sample string 2",
        "UserName": "sample string 3",
        "Email": "sample string 4",
        "FirstName": "sample string 5",
        "LastName": "sample string 6",
        "MiddleName": "sample string 7",
        "DisplayName": "sample string 8",
        "NoteBesideName": "sample string 9",
        "FullName": "sample string 10",
        "IsApproved": true,
        "IsEndUser": true,
        "IsSmartUser": true,
        "IsOperator": true,
        "IsSuperOperator": true,
        "IsAdministrator": true,
        "TimeZoneId": null,
        "ExternalAccount": true,
        "EmailAccount": true,
        "Customer": "sample string 20",
        "CustomerId": 1,
        "Customers": [
          {
            "Id": 1,
            "Name": "sample string 2"
          },
          {
            "Id": 1,
            "Name": "sample string 2"
          }
        ],
        "Phones": [
          "sample string 1",
          "sample string 2"
        ],
        "AdminNote": "sample string 21",
        "OperatorNote": "sample string 22",
        "AdditionalInformation": "sample string 23",
        "SkypeName": "sample string 24",
        "OperatorGroupIds": [
          1,
          2
        ],
        "InternalGroupIds": [
          1,
          2
        ],
        "Color": "sample string 25",
        "Initials": "sample string 26",
        "PhotoLastUpdatedUtc": "2024-04-28T11:42:56.2926604+02:00",
        "LastUpdatedUtc": "2024-04-28T11:42:56.2926604+02:00",
        "Language": 0,
        "Anonymized": true,
        "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
          }
        ],
        "ExternalId": "sample string 28",
        "ManagerKey": "sample string 29",
        "Company": "sample string 30",
        "Department": "sample string 31",
        "Division": "sample string 32",
        "EmployeeId": "sample string 33"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<FullTextSearchUsersResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results.Customer">
  <Users 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:ExtendedRequestorUser>
        <d3p1:AdditionalInformation>sample string 23</d3p1:AdditionalInformation>
        <d3p1:AdminNote>sample string 21</d3p1:AdminNote>
        <d3p1:Anonymized>true</d3p1:Anonymized>
        <d3p1:Color>sample string 25</d3p1:Color>
        <d3p1:Company>sample string 30</d3p1:Company>
        <d3p1:CustomUserFieldsHash>0</d3p1:CustomUserFieldsHash>
        <d3p1:Customer>sample string 20</d3p1:Customer>
        <d3p1:CustomerId>1</d3p1:CustomerId>
        <d3p1:Customers>
          <d3p1:UserCustomerData>
            <d3p1:Id>1</d3p1:Id>
            <d3p1:Name>sample string 2</d3p1:Name>
          </d3p1:UserCustomerData>
          <d3p1:UserCustomerData>
            <d3p1:Id>1</d3p1:Id>
            <d3p1:Name>sample string 2</d3p1:Name>
          </d3p1:UserCustomerData>
        </d3p1:Customers>
        <d3p1:Department>sample string 31</d3p1:Department>
        <d3p1:DisplayName>sample string 8</d3p1:DisplayName>
        <d3p1:Division>sample string 32</d3p1:Division>
        <d3p1:Email>sample string 4</d3p1:Email>
        <d3p1:EmailAccount>true</d3p1:EmailAccount>
        <d3p1:EmployeeId>sample string 33</d3p1:EmployeeId>
        <d3p1:ExternalAccount>true</d3p1:ExternalAccount>
        <d3p1:ExternalId>sample string 28</d3p1:ExternalId>
        <d3p1:FieldData i:nil="true" />
        <d3p1:FirstName>sample string 5</d3p1:FirstName>
        <d3p1:FullName>sample string 10</d3p1:FullName>
        <d3p1:Initials>sample string 26</d3p1:Initials>
        <d3p1:InternalGroupIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </d3p1:InternalGroupIds>
        <d3p1:IsAdministrator>true</d3p1:IsAdministrator>
        <d3p1:IsApproved>true</d3p1:IsApproved>
        <d3p1:IsEndUser>true</d3p1:IsEndUser>
        <d3p1:IsOperator>true</d3p1:IsOperator>
        <d3p1:IsSmartUser>true</d3p1:IsSmartUser>
        <d3p1:IsSuperOperator>true</d3p1:IsSuperOperator>
        <d3p1:Language>en</d3p1:Language>
        <d3p1:LastName>sample string 6</d3p1:LastName>
        <d3p1:LastUpdatedUtc>2024-04-28T11:42:56.2926604+02:00</d3p1:LastUpdatedUtc>
        <d3p1:ManagerKey>sample string 29</d3p1:ManagerKey>
        <d3p1:MiddleName>sample string 7</d3p1:MiddleName>
        <d3p1:NoteBesideName>sample string 9</d3p1:NoteBesideName>
        <d3p1:OperatorGroupIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </d3p1:OperatorGroupIds>
        <d3p1:OperatorNote>sample string 22</d3p1:OperatorNote>
        <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-04-28T11:42:56.2926604+02:00</d3p1:PhotoLastUpdatedUtc>
        <d3p1:SkypeName>sample string 24</d3p1:SkypeName>
        <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:UserName>sample string 3</d3p1:UserName>
        <d3p1:UserProviderKey>sample string 2</d3p1:UserProviderKey>
        <d3p1:CustomUserFieldsHash>1</d3p1:CustomUserFieldsHash>
        <d3p1:FieldData>
          <d3p1:UserCustomFieldData>
            <d3p1:CheckBoxValue>true</d3p1:CheckBoxValue>
            <d3p1:CustomFieldId>1</d3p1:CustomFieldId>
            <d3p1:DateValue>2024-04-28T11:42:56.2926604+02: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:UserCustomFieldData>
          <d3p1:UserCustomFieldData>
            <d3p1:CheckBoxValue>true</d3p1:CheckBoxValue>
            <d3p1:CustomFieldId>1</d3p1:CustomFieldId>
            <d3p1:DateValue>2024-04-28T11:42:56.2926604+02: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:UserCustomFieldData>
        </d3p1:FieldData>
        <d3p1:SecondaryEmails 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:SecondaryEmails>
      </d3p1:ExtendedRequestorUser>
      <d3p1:ExtendedRequestorUser>
        <d3p1:AdditionalInformation>sample string 23</d3p1:AdditionalInformation>
        <d3p1:AdminNote>sample string 21</d3p1:AdminNote>
        <d3p1:Anonymized>true</d3p1:Anonymized>
        <d3p1:Color>sample string 25</d3p1:Color>
        <d3p1:Company>sample string 30</d3p1:Company>
        <d3p1:CustomUserFieldsHash>0</d3p1:CustomUserFieldsHash>
        <d3p1:Customer>sample string 20</d3p1:Customer>
        <d3p1:CustomerId>1</d3p1:CustomerId>
        <d3p1:Customers>
          <d3p1:UserCustomerData>
            <d3p1:Id>1</d3p1:Id>
            <d3p1:Name>sample string 2</d3p1:Name>
          </d3p1:UserCustomerData>
          <d3p1:UserCustomerData>
            <d3p1:Id>1</d3p1:Id>
            <d3p1:Name>sample string 2</d3p1:Name>
          </d3p1:UserCustomerData>
        </d3p1:Customers>
        <d3p1:Department>sample string 31</d3p1:Department>
        <d3p1:DisplayName>sample string 8</d3p1:DisplayName>
        <d3p1:Division>sample string 32</d3p1:Division>
        <d3p1:Email>sample string 4</d3p1:Email>
        <d3p1:EmailAccount>true</d3p1:EmailAccount>
        <d3p1:EmployeeId>sample string 33</d3p1:EmployeeId>
        <d3p1:ExternalAccount>true</d3p1:ExternalAccount>
        <d3p1:ExternalId>sample string 28</d3p1:ExternalId>
        <d3p1:FieldData i:nil="true" />
        <d3p1:FirstName>sample string 5</d3p1:FirstName>
        <d3p1:FullName>sample string 10</d3p1:FullName>
        <d3p1:Initials>sample string 26</d3p1:Initials>
        <d3p1:InternalGroupIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </d3p1:InternalGroupIds>
        <d3p1:IsAdministrator>true</d3p1:IsAdministrator>
        <d3p1:IsApproved>true</d3p1:IsApproved>
        <d3p1:IsEndUser>true</d3p1:IsEndUser>
        <d3p1:IsOperator>true</d3p1:IsOperator>
        <d3p1:IsSmartUser>true</d3p1:IsSmartUser>
        <d3p1:IsSuperOperator>true</d3p1:IsSuperOperator>
        <d3p1:Language>en</d3p1:Language>
        <d3p1:LastName>sample string 6</d3p1:LastName>
        <d3p1:LastUpdatedUtc>2024-04-28T11:42:56.2926604+02:00</d3p1:LastUpdatedUtc>
        <d3p1:ManagerKey>sample string 29</d3p1:ManagerKey>
        <d3p1:MiddleName>sample string 7</d3p1:MiddleName>
        <d3p1:NoteBesideName>sample string 9</d3p1:NoteBesideName>
        <d3p1:OperatorGroupIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </d3p1:OperatorGroupIds>
        <d3p1:OperatorNote>sample string 22</d3p1:OperatorNote>
        <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-04-28T11:42:56.2926604+02:00</d3p1:PhotoLastUpdatedUtc>
        <d3p1:SkypeName>sample string 24</d3p1:SkypeName>
        <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:UserName>sample string 3</d3p1:UserName>
        <d3p1:UserProviderKey>sample string 2</d3p1:UserProviderKey>
        <d3p1:CustomUserFieldsHash>1</d3p1:CustomUserFieldsHash>
        <d3p1:FieldData>
          <d3p1:UserCustomFieldData>
            <d3p1:CheckBoxValue>true</d3p1:CheckBoxValue>
            <d3p1:CustomFieldId>1</d3p1:CustomFieldId>
            <d3p1:DateValue>2024-04-28T11:42:56.2926604+02: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:UserCustomFieldData>
          <d3p1:UserCustomFieldData>
            <d3p1:CheckBoxValue>true</d3p1:CheckBoxValue>
            <d3p1:CustomFieldId>1</d3p1:CustomFieldId>
            <d3p1:DateValue>2024-04-28T11:42:56.2926604+02: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:UserCustomFieldData>
        </d3p1:FieldData>
        <d3p1:SecondaryEmails 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:SecondaryEmails>
      </d3p1:ExtendedRequestorUser>
    </d2p1:Items>
    <d2p1:PageIndex>1</d2p1:PageIndex>
    <d2p1:PageSize>2</d2p1:PageSize>
  </Users>
</FullTextSearchUsersResult>