POST api/v1/users/page/{pageStart}/{pageSize}
Gets the user overviews.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| pageStart | integer |
Default value is 1 |
|
| pageSize | integer |
Default value is 100 |
Body Parameters
PageableSearchFilterOfUserOverviewSearchFilter| Name | Description | Type | Additional information |
|---|---|---|---|
| Sorting | Dictionary of string [key] and string [value] |
None. |
|
| SearchFilter | UserOverviewSearchFilter |
None. |
Request Formats
application/json, text/json
Sample:
{
"Sorting": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"SearchFilter": {
"FriendlyName": "sample string 1",
"NotificationEmail": "sample string 2",
"PersonName": "sample string 3",
"UserName": "sample string 4",
"UserRoles": "sample string 5",
"ClubName": "sample string 6",
"AccountState": "sample string 7"
}
}
text/html
Sample:
{"Sorting":{"sample string 1":"sample string 2","sample string 3":"sample string 4"},"SearchFilter":{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonName":"sample string 3","UserName":"sample string 4","UserRoles":"sample string 5","ClubName":"sample string 6","AccountState":"sample string 7"}}
application/xml, text/xml
Sample:
<PageableSearchFilterOfUserOverviewSearchFilter9XpmGMPb xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">
<SearchFilter xmlns:d2p1="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi.User">
<d2p1:AccountState>sample string 7</d2p1:AccountState>
<d2p1:ClubName>sample string 6</d2p1:ClubName>
<d2p1:FriendlyName>sample string 1</d2p1:FriendlyName>
<d2p1:NotificationEmail>sample string 2</d2p1:NotificationEmail>
<d2p1:PersonName>sample string 3</d2p1:PersonName>
<d2p1:UserName>sample string 4</d2p1:UserName>
<d2p1:UserRoles>sample string 5</d2p1:UserRoles>
</SearchFilter>
<Sorting xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Sorting>
</PageableSearchFilterOfUserOverviewSearchFilter9XpmGMPb>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
PagedListOfUserOverview| Name | Description | Type | Additional information |
|---|---|---|---|
| Items | Collection of UserOverview |
None. |
|
| PageStart | integer |
None. |
|
| PageSize | integer |
None. |
|
| TotalRows | integer |
None. |
Response Formats
application/json, text/json, text/html
Sample:
Sample not available.