POST api/user/search
Request Information
URI Parameters
None.
Body Parameters
UserSearch| Name | Description | Type | Additional information |
|---|---|---|---|
| UserPermissionEntityId | globally unique identifier |
None. |
|
| UserPermissionEntityIds | Collection of globally unique identifier |
None. |
|
| Detail | ContactDetail |
None. |
|
| ExcludeAdmins | boolean |
None. |
|
| RoleNames | Collection of string |
None. |
|
| SortColumn | string |
None. |
|
| SortDirection | string |
None. |
|
| Page | integer |
None. |
|
| PageSize | integer |
None. |
Request Formats
application/json, text/json, text/html
Sample:
{
"userPermissionEntityId": "1c3bbd0a-fc80-41fc-bbeb-8e664afead9f",
"userPermissionEntityIds": [
"9223a8ba-1638-48fb-bb3f-29148b510ee9",
"a051e7d5-d25b-4154-b9cd-ddc7e97671c5"
],
"detail": {
"firstName": "sample string 1",
"lastName": "sample string 2",
"fullName": "sample string 1 sample string 2",
"title": "sample string 3",
"phone1": "sample string 4",
"phone2": "sample string 5",
"officeAddress": {
"addressLine1": "sample string 1",
"addressLine2": "sample string 2",
"city": "sample string 3",
"zip": "sample string 4",
"state": "sample string 5",
"country": "sample string 6",
"addressString": "sample string 1, sample string 2, sample string 3, sample string 5, sample string 6"
}
},
"excludeAdmins": true,
"roleNames": [
"sample string 1",
"sample string 2"
],
"sortColumn": "sample string 2",
"sortDirection": "sample string 3",
"page": 4,
"pageSize": 5
}
application/xml, text/xml
Sample:
<UserSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TAM.Data.Contract.Models">
<Page>4</Page>
<PageSize>5</PageSize>
<SortColumn>sample string 2</SortColumn>
<SortDirection>sample string 3</SortDirection>
<Detail xmlns:d2p1="http://schemas.datacontract.org/2004/07/TAM.Data.Model.Shared">
<d2p1:FirstName>sample string 1</d2p1:FirstName>
<d2p1:LastName>sample string 2</d2p1:LastName>
<d2p1:OfficeAddress>
<d2p1:AddressLine1>sample string 1</d2p1:AddressLine1>
<d2p1:AddressLine2>sample string 2</d2p1:AddressLine2>
<d2p1:City>sample string 3</d2p1:City>
<d2p1:Country>sample string 6</d2p1:Country>
<d2p1:State>sample string 5</d2p1:State>
<d2p1:Zip>sample string 4</d2p1:Zip>
</d2p1:OfficeAddress>
<d2p1:Phone1>sample string 4</d2p1:Phone1>
<d2p1:Phone2>sample string 5</d2p1:Phone2>
<d2p1:Title>sample string 3</d2p1:Title>
</Detail>
<ExcludeAdmins>true</ExcludeAdmins>
<RoleNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</RoleNames>
<UserPermissionEntityId>1c3bbd0a-fc80-41fc-bbeb-8e664afead9f</UserPermissionEntityId>
<UserPermissionEntityIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>9223a8ba-1638-48fb-bb3f-29148b510ee9</d2p1:guid>
<d2p1:guid>a051e7d5-d25b-4154-b9cd-ddc7e97671c5</d2p1:guid>
</UserPermissionEntityIds>
</UserSearch>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, text/html, application/xml, text/xml
Sample:
Sample not available.