GET Groups/Group
Get groups
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| IncludeActive |
Include records where RecordState == RecordState.Active |
boolean |
None. |
| IncludeInactive |
Include records where RecordState == RecordState.Inactive |
boolean |
None. |
| IncludeDeleted |
Include records where RecordState == RecordState.Deleted |
boolean |
None. |
| IncludePayload |
Include all data (set to false to return partial data and get a faster result) |
boolean |
None. |
| IncludeRootBU |
Include root group's Business Units |
boolean |
None. |
| IncludeRootGroups | boolean |
None. |
|
| Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
| GroupIDs |
Filter by GroupIDs |
Collection of integer |
None. |
| BusinessUnits |
Filter by BusinessUnits |
Collection of integer |
None. |
| RootGroupID |
Filter by RootGroupID |
integer |
None. |
| RootGroupIDs |
Filter by RootGroupIDs |
Collection of integer |
None. |
| ParentGroupID |
Filter by ParentGroupID |
integer |
None. |
| ParentGroupIDs |
Filter by ParentGroupIDs |
Collection of integer |
None. |
| GroupName |
Filter by GroupName |
string |
None. |
| Type |
Filter by Type |
GroupType |
None. |
| Types |
Filter by Types |
Collection of GroupType |
None. |
| SubType |
Filter by SubType |
GroupSubType |
None. |
| Depth |
Filter by Depth |
byte |
None. |
| TotalDepth |
Filter by TotalDepth |
byte |
None. |
| Comments |
Filter by Comments |
string |
None. |
| ExceptGroupID |
Filter out by GroupID |
integer |
None. |
| MaxRows |
Limit number of rows |
integer |
None. |
| CreatedDateUtcMin |
Filter by CreatedDateUtcMin |
date |
None. |
| CreatedDateUtcMax |
Filter by CreatedDateUtcMax |
date |
None. |
| LastUpdatedDateUtcMin |
Filter by LastUpdatedDateUtcMin |
date |
None. |
| LastUpdatedDateUtcMax |
Filter by LastUpdatedDateUtcMax |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
List of GroupDTOs
Collection of GroupDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| GroupID |
Group ID |
integer |
None. |
| RootGroupID |
Root Group ID |
integer |
None. |
| ParentGroupID |
Parent Group ID |
integer |
None. |
| GroupName |
Group Name |
string |
None. |
| GroupLocation |
Group Location |
string |
None. |
| Addresses |
Addresses |
AddressesDTO |
None. |
| BusinessUnits |
Business units attached to worker |
Collection of GroupBusinessUnitDTO |
None. |
| GLCode |
GL Code |
string |
None. |
| CommunicationMethods |
Communication methods |
CommunicationMethodsDTO |
None. |
| Type |
Type |
GroupType |
None. |
| SubType |
Sub Type |
GroupSubType |
None. |
| Depth |
Depth |
byte |
None. |
| TotalDepth |
Total Depth |
byte |
None. |
| Comments |
Comments |
string |
None. |
| Props |
Props |
Collection of Object |
None. |
| Extensions |
Extensions |
Collection of FormDataExtensionDto |
None. |
| RecordState |
Record State |
RecordState |
None. |
| Created |
Created |
AuditDataDTO |
None. |
| LastUpdated |
Last Updated |
AuditDataDTO |
None. |
| IsPartialData |
Only return partial data to speed up call (results cannot be used for add/update) |
boolean |
None. |
| BuiltDate |
Built Date |
date |
None. |
| LastRefurbishDate |
Last Refurbish Date |
date |
None. |
| AccommodationFunderID |
Accommodation Funder ID |
integer |
None. |
| FeesFunderID |
Resident Fees Funder ID |
integer |
None. |
| FundingFunderID |
Resident Funding Funder ID |
integer |
None. |