GET Clients/Group
Get clientGroups from criteria
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. |
| Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
| EntityIDs |
Filter by EntityIDs |
Collection of integer |
None. |
| BusinessUnits |
Filter by BusinessUnit(s) |
Collection of integer |
None. |
| GroupIDs |
Filter by GroupIDs |
Collection of integer |
None. |
| Status |
Filter by Status |
integer |
None. |
| BusinessUnitStatusTypes |
Filter by multiple status types |
Collection of integer |
None. |
| StatusReason |
Filter by StatusReason |
string |
None. |
| StatusReason2 |
Filter by StatusReason2 |
string |
None. |
| StatusReason3 |
Filter by StatusReason3 |
string |
None. |
| StatusReason3List |
Filter by multiple StatusReason3s |
Collection of string |
None. |
| StatusComments |
Filter by StatusComments |
string |
None. |
| StartDateUtcMin |
Filter by StartDateUtcMin |
date |
None. |
| StartDateUtcMax |
Filter by StartDateUtcMax |
date |
None. |
| StopDateUtcMin |
Filter by StopDateUtcMin |
date |
None. |
| StopDateUtcMax |
Filter by StopDateUtcMax |
date |
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 ClientGroupDTOs
Collection of ClientGroupDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientID |
Client ID |
integer |
None. |
| BUID |
BUID |
integer |
None. |
| GroupID |
Group ID |
integer |
None. |
| BusinessUnitStatusID |
Business Unit Status ID |
integer |
None. |
| StatusReason |
Status Reason |
string |
None. |
| StatusReason2 |
Status Reason2 |
string |
None. |
| StatusReason3 |
Status Reason3 |
string |
None. |
| StatusComments |
Status Comments |
string |
None. |
| StartDateUtc |
Start Date Utc |
date |
None. |
| StopDateUtc |
Stop Date Utc |
date |
None. |
| ReturnDateUtc |
Return Date Utc |
date |
None. |
| RecordState |
Record State |
RecordState |
None. |
| FirstEntryDate |
First Entry Date to the Facility (First Time Admitted) |
date |
None. |
| ReferralSource |
Referral Source |
string |
None. |
| Created |
Created |
AuditDataDTO |
None. |
| LastUpdated |
Last Updated |
AuditDataDTO |
None. |
| StatusName | string |
None. |
|
| StatusType | integer |
None. |
|
| GroupName | string |
None. |
|
| CurrentBedStatus | BedStatusDTO |
None. |
|
| IsCurrent | boolean |
None. |
|
| CurrentFormEntryID | integer |
None. |
|
| GroupType | GroupType |
None. |
|
| IsAbsent | boolean |
None. |
|
| AbsentStatusName | string |
None. |
|
| AbsentStatusDescription | string |
None. |
|
| RefundDueDate | date |
None. |
|
| NoticeDate | date |
None. |
|
| BusinessUnitType | BusinessUnitType |
None. |