POST 17.0/app/user/list

Description

Gets a list of Users

URI Parameters

None.

The Filters to filter on

UserListFilters
Name Description Type Additional information
Branches

Collection of integer

None.

application/json, text/json
Sample: 
{
  "branches": [
    1,
    2
  ]
}

application/xml, text/xml
Sample: 
<UserListFilters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Branches>
    <int>1</int>
    <int>2</int>
  </Branches>
</UserListFilters>

application/x-www-form-urlencoded
Sample:

Sample not available.

List(Of UserListItem)

Collection of UserListItem
Name Description Type Additional information
ID

string

None.
Username

string

None.
User

string

None.
LoggedIn

string

None.

application/json, text/json
Sample: 
[
  {
    "id": "sample string 1",
    "username": "sample string 2",
    "user": "sample string 3",
    "loggedIn": "sample string 4"
  },
  {
    "id": "sample string 1",
    "username": "sample string 2",
    "user": "sample string 3",
    "loggedIn": "sample string 4"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfUserListItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UserListItem>
    <ID>sample string 1</ID>
    <Username>sample string 2</Username>
    <User>sample string 3</User>
    <LoggedIn>sample string 4</LoggedIn>
  </UserListItem>
  <UserListItem>
    <ID>sample string 1</ID>
    <Username>sample string 2</Username>
    <User>sample string 3</User>
    <LoggedIn>sample string 4</LoggedIn>
  </UserListItem>
</ArrayOfUserListItem>