GET api/v1/users/manage-users
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
ManageUsersViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| UsedLicenses | integer |
None. |
|
| TotalLicenses | integer |
None. |
|
| AvailableLicenses | integer |
None. |
|
| Users | Collection of UserManageDto |
None. |
Response Formats
application/json, text/json
Sample:
{
"usedLicenses": 1,
"totalLicenses": 2,
"availableLicenses": 3,
"users": [
{
"active": true,
"userId": 2,
"wpCustomerId": 3,
"name": "sample string 4",
"userName": "sample string 5",
"email": "sample string 6",
"phoneNumber": "sample string 7",
"externalNumber": "sample string 8",
"loginGuid": "sample string 9"
},
{
"active": true,
"userId": 2,
"wpCustomerId": 3,
"name": "sample string 4",
"userName": "sample string 5",
"email": "sample string 6",
"phoneNumber": "sample string 7",
"externalNumber": "sample string 8",
"loginGuid": "sample string 9"
}
]
}
application/xml, text/xml
Sample:
<ManageUsersViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Workpilot.ServiceLayer.ViewModels">
<AvailableLicenses>3</AvailableLicenses>
<TotalLicenses>2</TotalLicenses>
<UsedLicenses>1</UsedLicenses>
<Users xmlns:d2p1="http://schemas.datacontract.org/2004/07/Workpilot.ServiceLayer.Models">
<d2p1:UserManageDto>
<d2p1:Active>true</d2p1:Active>
<d2p1:Email>sample string 6</d2p1:Email>
<d2p1:ExternalNumber>sample string 8</d2p1:ExternalNumber>
<d2p1:LoginGuid>sample string 9</d2p1:LoginGuid>
<d2p1:Name>sample string 4</d2p1:Name>
<d2p1:PhoneNumber>sample string 7</d2p1:PhoneNumber>
<d2p1:UserId>2</d2p1:UserId>
<d2p1:UserName>sample string 5</d2p1:UserName>
<d2p1:WpCustomerId>3</d2p1:WpCustomerId>
</d2p1:UserManageDto>
<d2p1:UserManageDto>
<d2p1:Active>true</d2p1:Active>
<d2p1:Email>sample string 6</d2p1:Email>
<d2p1:ExternalNumber>sample string 8</d2p1:ExternalNumber>
<d2p1:LoginGuid>sample string 9</d2p1:LoginGuid>
<d2p1:Name>sample string 4</d2p1:Name>
<d2p1:PhoneNumber>sample string 7</d2p1:PhoneNumber>
<d2p1:UserId>2</d2p1:UserId>
<d2p1:UserName>sample string 5</d2p1:UserName>
<d2p1:WpCustomerId>3</d2p1:WpCustomerId>
</d2p1:UserManageDto>
</Users>
</ManageUsersViewModel>