Service |  |
Returns a GetUserGroupsOut response with a result model List<GetUserGroupsModel>
Namespace: AppOne.Services.V2
Assembly: AppOne.Web.Service (in AppOne.Web.Service.dll) Version: 1.0.141
Syntaxpublic GetUserGroupsOut GetUserGroups( GetUserGroupsIn input )
Parameters
- input GetUserGroupsIn
- A new GetUserGroupsIn object
Return Value
GetUserGroupsOutA GetUserGroupsOut object
Remarks
Use this method to get a results list of GetUserGroupsModel
 Note |
|---|
| For a higher level overview of the business rules for user groups see the class WSUserGroups of this web method. |
 Caution |
|---|
|
The Group Number is ONLY present when the group is created by the system as part of a group hierarchy. When part of the hierarchy, the value will
equal the Employee Identifier of the user who the group was created for. This is why if using group hierarchy it is important not to change
the name of a group created by the system - since it will potentially cause problems down the line. If using Group Hierarchy, the naming of the
groups can be controlled under General Configuration.
The important detail to hold onto from this method call is the ID since that is what will be used when calling the UserInfoInsert, UserInfoAdd or UserInfoUpdate methods. |
DataAction Names
| Name | Description | Values Example |
|---|---|---|
| SELECT-ALL | Returns all user groups in system regardless of any state. | [ignored] |
ExampleJSON Request
{
"AuthToken":${#Project#Project_Token},
"DataAction":{
"Name":"SELECT-ALL",
"Values":[""]
}
}JSON Response
{
"Report": {
"APIVersion": "2.0",
"ProcessTime": "0.0909502",
"RequestTime": "/Date(1542136039501-0700)/",
"ResponseTime": "/Date(1542136039592-0700)/",
"Results": 11
},
"Results": [
{
"ID": 127,
"ModifiedBy": 0,
"ModifiedOn": "/Date(1312594368000-0700)/",
"Name": "Group 1000",
"Number": "1000"
},
{
"ID": 128,
"ModifiedBy": 0,
"ModifiedOn": "/Date(1312586112000-0700)/",
"Name": "Group 1234",
"Number": "1234"
},
{
"ID": 134,
"ModifiedBy": 2,
"ModifiedOn": "/Date(1325888267010-0700)/",
"Name": "Group 1337",
"Number": "1337"
},
{
"ID": 129,
"ModifiedBy": 2,
"ModifiedOn": "/Date(1315590319000-0700)/",
"Name": "Group 2222",
"Number": "2222"
},
{
"ID": 136,
"ModifiedBy": 0,
"ModifiedOn": "/Date(1330380710030-0700)/",
"Name": "Group 3000",
"Number": "3000"
}
]
}See Also