GET api/group?userID={userID}&token={token}&groupID={groupID}
Get a list of GroupResponse by groupID
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| userID |
The ID returned from a successful login |
unsigned integer |
Required |
| token |
The authentication token returned from a successful login |
string |
Required |
| groupID |
The group id being queried |
unsigned integer |
Default value is 0 |
Body Parameters
None.
Response Information
Resource Description
A list of GroupResponses
Collection of GroupResponse| 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. |
| HasVehicles |
Indicates if there are vehicles in the group |
boolean |
None. |
| HasGroups |
Indicates if there are child groups |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ID": 1,
"Name": "sample string 2",
"ParentID": 3,
"HasVehicles": true,
"HasGroups": true
},
{
"ID": 1,
"Name": "sample string 2",
"ParentID": 3,
"HasVehicles": true,
"HasGroups": true
}
]
application/xml, text/xml
Sample:
<ArrayOfGroupResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<GroupResponse>
<ID>1</ID>
<Name>sample string 2</Name>
<ParentID>3</ParentID>
<HasVehicles>true</HasVehicles>
<HasGroups>true</HasGroups>
</GroupResponse>
<GroupResponse>
<ID>1</ID>
<Name>sample string 2</Name>
<ParentID>3</ParentID>
<HasVehicles>true</HasVehicles>
<HasGroups>true</HasGroups>
</GroupResponse>
</ArrayOfGroupResponse>