GET api/groups
Retrieve all available groups.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Name |
Gets or sets the name. |
string |
Invalid Chars: .!@#$%^&*\|`~=+/?<>()[]," Leading or trailing white spaces are not allowed Max length: 30 |
Type |
Gets or sets the type. |
GroupType |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of GroupViewModelName | Description | Type | Additional information |
---|---|---|---|
Id |
Gets or sets the group unique identifier. |
integer |
None. |
Name |
Gets or sets the name. |
string |
Required Invalid Chars: .!@#$%^&*\|`~=+/?<>()[]," Leading or trailing white spaces are not allowed Max length: 30 |
Type |
Gets or sets the type. |
GroupType |
None. |
Links |
Gets the links. |
Collection of LinkModel |
None. |
Response Formats
application/json, text/json
Sample:
[ { "id": 1, "name": "sample string 2", "type": 0 }, { "id": 1, "name": "sample string 2", "type": 0 } ]
application/xml, text/xml
Sample:
<ArrayOfGroupViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TelogWebAPI.Models"> <GroupViewModel> <Id>1</Id> <Name>sample string 2</Name> <Type>Static</Type> </GroupViewModel> <GroupViewModel> <Id>1</Id> <Name>sample string 2</Name> <Type>Static</Type> </GroupViewModel> </ArrayOfGroupViewModel>