GET api/Account/SearchForUser?term={term}&customerId={customerId}&pageIndex={pageIndex}&pageSize={pageSize}

DEPRECATED. Use SearchUsers instead. Gets a list of users where the searched text is found in his/her fullname, email, login, phone numbers or customer name. The role of superoperator or administrator is required. Pagination is supported.

Request Information

URI Parameters

Name	Description	Type	Additional information
term	Search term	string	Required
customerId	If specified the user is searched only within the selected company.	integer	None.
pageIndex	Optional page index (default is 0).	integer	None.
pageSize	Optional page size (default is 200).	integer	None.

Body Parameters

None.

Response Information

Resource Description

SearchForUserResult

Name	Description	Type	Additional information
PagedUsers	A page with User rows.	UserRow	None.

Response Formats

application/json, text/json

Sample:

{
  "PagedUsers": {
    "PageIndex": 1,
    "PageSize": 2,
    "TotalItems": 3,
    "TotalPages": 4,
    "Items": [
      {
        "UserProviderKey": "sample string 1",
        "FullName": "sample string 2",
        "Email": "sample string 3",
        "Customer": "sample string 4",
        "CustomerId": 1,
        "Customers": [
          {
            "Id": 1,
            "Name": "sample string 2"
          },
          {
            "Id": 1,
            "Name": "sample string 2"
          }
        ]
      },
      {
        "UserProviderKey": "sample string 1",
        "FullName": "sample string 2",
        "Email": "sample string 3",
        "Customer": "sample string 4",
        "CustomerId": 1,
        "Customers": [
          {
            "Id": 1,
            "Name": "sample string 2"
          },
          {
            "Id": 1,
            "Name": "sample string 2"
          }
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:

<SearchForUserResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <PagedUsers>
    <Items>
      <SearchForUserResult.UserRow>
        <Customer>sample string 4</Customer>
        <CustomerId>1</CustomerId>
        <Customers xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures">
          <d5p1:UserCustomerData>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Name>sample string 2</d5p1:Name>
          </d5p1:UserCustomerData>
          <d5p1:UserCustomerData>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Name>sample string 2</d5p1:Name>
          </d5p1:UserCustomerData>
        </Customers>
        <Email>sample string 3</Email>
        <FullName>sample string 2</FullName>
        <UserProviderKey>sample string 1</UserProviderKey>
      </SearchForUserResult.UserRow>
      <SearchForUserResult.UserRow>
        <Customer>sample string 4</Customer>
        <CustomerId>1</CustomerId>
        <Customers xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures">
          <d5p1:UserCustomerData>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Name>sample string 2</d5p1:Name>
          </d5p1:UserCustomerData>
          <d5p1:UserCustomerData>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Name>sample string 2</d5p1:Name>
          </d5p1:UserCustomerData>
        </Customers>
        <Email>sample string 3</Email>
        <FullName>sample string 2</FullName>
        <UserProviderKey>sample string 1</UserProviderKey>
      </SearchForUserResult.UserRow>
    </Items>
    <PageIndex>1</PageIndex>
    <PageSize>2</PageSize>
    <TotalItems>3</TotalItems>
    <TotalPages>4</TotalPages>
  </PagedUsers>
</SearchForUserResult>