POST api/mobile/mobilegroup
Get groups for a user
Request Information
URI Parameters
None.
Body Parameters
MobileGroupRequest
MobileGroupRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Token |
The token returned after login used for authentication |
string |
None. |
| UserID |
The user id returned after login used for authentication |
unsigned integer |
None. |
| GroupID |
The group id being queried or 0 if you want the groups a user can see directly |
unsigned integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"Token": "sample string 1",
"UserID": 2,
"GroupID": 3
}
application/xml, text/xml
Sample:
<MobileGroupRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Token>sample string 1</Token> <UserID>2</UserID> <GroupID>3</GroupID> </MobileGroupRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
A list of MobileGroupResponse
Collection of MobileGroupResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
The unique id of the group |
unsigned integer |
None. |
| Name |
The name of the group |
string |
None. |
| ParentID |
The parent group id |
unsigned integer |
None. |
| HasGroups |
Indicates if there are child groups |
boolean |
None. |
| NumberOfServices |
The number of services in a group |
integer |
None. |
| NumberOfAssets |
The number of assets in a group |
integer |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ID": 1,
"Name": "sample string 2",
"ParentID": 3,
"HasGroups": true,
"NumberOfServices": 5,
"NumberOfAssets": 6
},
{
"ID": 1,
"Name": "sample string 2",
"ParentID": 3,
"HasGroups": true,
"NumberOfServices": 5,
"NumberOfAssets": 6
}
]
application/xml, text/xml
Sample:
<ArrayOfMobileGroupResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<MobileGroupResponse>
<ID>1</ID>
<Name>sample string 2</Name>
<ParentID>3</ParentID>
<HasGroups>true</HasGroups>
<NumberOfServices>5</NumberOfServices>
<NumberOfAssets>6</NumberOfAssets>
</MobileGroupResponse>
<MobileGroupResponse>
<ID>1</ID>
<Name>sample string 2</Name>
<ParentID>3</ParentID>
<HasGroups>true</HasGroups>
<NumberOfServices>5</NumberOfServices>
<NumberOfAssets>6</NumberOfAssets>
</MobileGroupResponse>
</ArrayOfMobileGroupResponse>