GET api/CommunitySync/GetMembersByGroup?APIKey={APIKey}&ClientId={ClientId}&GroupType={GroupType}&GroupId={GroupId}&PageNumber={PageNumber}&PageCount={PageCount}&PagingCookie={PagingCookie}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
APIKey | string |
Required |
|
ClientId | string |
Required |
|
GroupType | string |
Required |
|
GroupId | globally unique identifier |
Required |
|
PageNumber | integer |
Default value is 1 |
|
PageCount | integer |
Default value is 250 |
|
PagingCookie | string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
MembersByGroupName | Description | Type | Additional information |
---|---|---|---|
Status | Status |
None. |
|
Description | string |
None. |
|
MoreRecords | boolean |
None. |
|
PagingCookie | string |
None. |
|
RecordsCount | integer |
None. |
|
Members | Collection of GroupMember |
None. |
Response Formats
application/json, text/json
Sample:
{ "Status": 0, "Description": "sample string 1", "MoreRecords": true, "PagingCookie": "sample string 3", "RecordsCount": 4, "Members": [ { "Id": "5db07611-3b60-4806-8704-2587bfe35555", "Name": "sample string 2", "TitleId": "a6dd5d72-3974-4e3f-9251-cd674eeee1f8", "TitleName": "sample string 4" }, { "Id": "5db07611-3b60-4806-8704-2587bfe35555", "Name": "sample string 2", "TitleId": "a6dd5d72-3974-4e3f-9251-cd674eeee1f8", "TitleName": "sample string 4" } ] }
application/xml, text/xml
Sample:
<MembersByGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Protech.UX.API.Core"> <Description>sample string 1</Description> <Members> <GroupMember> <Id>5db07611-3b60-4806-8704-2587bfe35555</Id> <Name>sample string 2</Name> <TitleId>a6dd5d72-3974-4e3f-9251-cd674eeee1f8</TitleId> <TitleName>sample string 4</TitleName> </GroupMember> <GroupMember> <Id>5db07611-3b60-4806-8704-2587bfe35555</Id> <Name>sample string 2</Name> <TitleId>a6dd5d72-3974-4e3f-9251-cd674eeee1f8</TitleId> <TitleName>sample string 4</TitleName> </GroupMember> </Members> <MoreRecords>true</MoreRecords> <PagingCookie>sample string 3</PagingCookie> <RecordsCount>4</RecordsCount> <Status>Success</Status> </MembersByGroup>