GET api/CommunitySync/GetGroups?APIKey={APIKey}&ClientId={ClientId}&LastUpdateTimestamp={LastUpdateTimestamp}&PageNumber={PageNumber}&PageCount={PageCount}&PagingCookie={PagingCookie}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| APIKey | string |
Required |
|
| ClientId | string |
Required |
|
| LastUpdateTimestamp | date |
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
CommunityGroups| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | Status |
None. |
|
| Description | string |
None. |
|
| MoreRecords | boolean |
None. |
|
| PagingCookie | string |
None. |
|
| RecordsCount | integer |
None. |
|
| Groups | Collection of Groups |
None. |
Response Formats
application/json, text/json
Sample:
{
"Status": 0,
"Description": "sample string 1",
"MoreRecords": true,
"PagingCookie": "sample string 3",
"RecordsCount": 4,
"Groups": [
{
"Id": "e805d908-190f-4413-8db1-13c108fc37ec",
"Name": "sample string 2",
"Type": "sample string 3"
},
{
"Id": "e805d908-190f-4413-8db1-13c108fc37ec",
"Name": "sample string 2",
"Type": "sample string 3"
}
]
}
application/xml, text/xml
Sample:
<CommunityGroups 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>
<Groups>
<Groups>
<Id>e805d908-190f-4413-8db1-13c108fc37ec</Id>
<Name>sample string 2</Name>
<Type>sample string 3</Type>
</Groups>
<Groups>
<Id>e805d908-190f-4413-8db1-13c108fc37ec</Id>
<Name>sample string 2</Name>
<Type>sample string 3</Type>
</Groups>
</Groups>
<MoreRecords>true</MoreRecords>
<PagingCookie>sample string 3</PagingCookie>
<RecordsCount>4</RecordsCount>
<Status>Success</Status>
</CommunityGroups>