POST api/Account/SearchUsers

Searches users by posted parameters.

Request Information

URI Parameters

None.

Body Parameters

SearchUsersPost
NameDescriptionTypeAdditional information
SimpleSearch

The field is used for searching by one field

SimpleSearchUsers

None.

Request Formats

application/json, text/json

Sample:
{
  "SimpleSearch": {
    "PageIndex": 0,
    "PageSize": 10,
    "Type": 6,
    "Value": "john.doe",
    "Equality": true
  }
}

application/xml, text/xml

Sample:
<SearchUsersPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts">
  <SimpleSearch>
    <Equality>true</Equality>
    <PageIndex>0</PageIndex>
    <PageSize>10</PageSize>
    <Type>Email</Type>
    <Value>john.doe</Value>
  </SimpleSearch>
</SearchUsersPost>

Response Information

Resource Description

SearchUsersResult
NameDescriptionTypeAdditional information
Users

A scroll with Users.

SearchUser

None.

Response Formats

application/json, text/json

Sample:
{
  "Users": {
    "PageIndex": 0,
    "PageSize": 10,
    "IsNextPage": false,
    "Items": [
      {
        "UserProviderKey": "9a2fb176-9d1a-4982-a39a-da04cad8df22",
        "UserName": "john.doe",
        "Domain": null,
        "Emails": [
          "john.doe@domain.com"
        ],
        "FirstName": "John",
        "LastName": "Doe",
        "DisplayName": "John Doe",
        "NoteBesideName": "Note",
        "Phones": [
          "+420 732 389 583"
        ],
        "AdditionalInformation": "Everything else",
        "ManagerKey": null,
        "Company": null,
        "Department": null,
        "Division": null,
        "EmployeeId": null
      }
    ]
  }
}

application/xml, text/xml

Sample:
<SearchUsersResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <Users>
    <IsNextPage>false</IsNextPage>
    <Items xmlns:d3p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures">
      <d3p1:SearchUser>
        <d3p1:AdditionalInformation>Everything else</d3p1:AdditionalInformation>
        <d3p1:Company i:nil="true" />
        <d3p1:Department i:nil="true" />
        <d3p1:DisplayName>John Doe</d3p1:DisplayName>
        <d3p1:Division i:nil="true" />
        <d3p1:Domain i:nil="true" />
        <d3p1:Emails xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>john.doe@domain.com</d5p1:string>
        </d3p1:Emails>
        <d3p1:EmployeeId i:nil="true" />
        <d3p1:FirstName>John</d3p1:FirstName>
        <d3p1:LastName>Doe</d3p1:LastName>
        <d3p1:ManagerKey i:nil="true" />
        <d3p1:NoteBesideName>Note</d3p1:NoteBesideName>
        <d3p1:Phones xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>+420 732 389 583</d5p1:string>
        </d3p1:Phones>
        <d3p1:UserName>john.doe</d3p1:UserName>
        <d3p1:UserProviderKey>9a2fb176-9d1a-4982-a39a-da04cad8df22</d3p1:UserProviderKey>
      </d3p1:SearchUser>
    </Items>
    <PageIndex>0</PageIndex>
    <PageSize>10</PageSize>
  </Users>
</SearchUsersResult>