GET api/Group/Get?groupId={groupId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
groupId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
LiteGroupName | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
|
GroupCategoryId | integer |
None. |
|
GroupCategoryName | string |
None. |
|
GroupSubcategoryId | integer |
None. |
|
GroupSubcategoryName | string |
None. |
|
YearLevel | byte |
None. |
|
Name | string |
None. |
|
Description | string |
None. |
|
IsOwner | boolean |
None. |
|
MemberCount | integer |
None. |
|
IsPending | boolean |
None. |
|
IsJoined | boolean |
None. |
|
CreatedDate | date |
None. |
|
GroupMembers | Collection of LiteGroupMember |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": 1, "GroupCategoryId": 2, "GroupCategoryName": "sample string 3", "GroupSubcategoryId": 1, "GroupSubcategoryName": "sample string 4", "YearLevel": 64, "Name": "sample string 5", "Description": "sample string 6", "IsOwner": true, "MemberCount": 8, "IsPending": true, "IsJoined": true, "CreatedDate": "2020-12-06T07:08:54.0008565+00:00", "GroupMembers": [ { "Id": 1, "GroupId": 2, "UserId": "sample string 3", "UserFullName": "sample string 4", "UserEmailAddress": "sample string 5", "UserSuburb": "sample string 6", "UserPhoneNumber": "sample string 7", "UserProfileImageThumbnail": "QEA=" }, { "Id": 1, "GroupId": 2, "UserId": "sample string 3", "UserFullName": "sample string 4", "UserEmailAddress": "sample string 5", "UserSuburb": "sample string 6", "UserPhoneNumber": "sample string 7", "UserProfileImageThumbnail": "QEA=" } ] }
application/xml, text/xml
Sample:
<LiteGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HubApi.Models.Hub.Api"> <CreatedDate>2020-12-06T07:08:54.0008565+00:00</CreatedDate> <Description>sample string 6</Description> <GroupCategoryId>2</GroupCategoryId> <GroupCategoryName>sample string 3</GroupCategoryName> <GroupMembers> <LiteGroupMember> <GroupId>2</GroupId> <Id>1</Id> <UserEmailAddress>sample string 5</UserEmailAddress> <UserFullName>sample string 4</UserFullName> <UserId>sample string 3</UserId> <UserPhoneNumber>sample string 7</UserPhoneNumber> <UserProfileImageThumbnail>QEA=</UserProfileImageThumbnail> <UserSuburb>sample string 6</UserSuburb> </LiteGroupMember> <LiteGroupMember> <GroupId>2</GroupId> <Id>1</Id> <UserEmailAddress>sample string 5</UserEmailAddress> <UserFullName>sample string 4</UserFullName> <UserId>sample string 3</UserId> <UserPhoneNumber>sample string 7</UserPhoneNumber> <UserProfileImageThumbnail>QEA=</UserProfileImageThumbnail> <UserSuburb>sample string 6</UserSuburb> </LiteGroupMember> </GroupMembers> <GroupSubcategoryId>1</GroupSubcategoryId> <GroupSubcategoryName>sample string 4</GroupSubcategoryName> <Id>1</Id> <IsJoined>true</IsJoined> <IsOwner>true</IsOwner> <IsPending>true</IsPending> <MemberCount>8</MemberCount> <Name>sample string 5</Name> <YearLevel>64</YearLevel> </LiteGroup>