GET Clients/GroupStatus
Get clientGroupStatuses 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. |
IncludeError |
Include records where RecordState == RecordState.Error |
boolean |
None. |
Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
StatusIDs |
Filter by StatusIDs |
Collection of integer |
None. |
EntityID |
Filter by EntityID |
integer |
None. |
BusinessUnitStatusID |
Filter by BusinessUnitStatusID |
integer |
None. |
EntityTypes |
Filter by EntityTypes |
Collection of EntityType |
None. |
BusinessUnits |
Filter by BusinessUnit(s) |
Collection of integer |
None. |
GroupID |
Filter by GroupID |
integer |
None. |
GroupIDs |
Filter by GroupIDs |
Collection of integer |
None. |
BedID |
Filter by BedID |
integer |
None. |
Status |
Filter by Status |
integer |
None. |
StatusType |
Filter by StatusType |
string |
None. |
StatusReason |
Filter by StatusReason |
string |
None. |
StatusReason2 |
Filter by StatusReason2 |
string |
None. |
StatusReason3 | 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. |
DateRangeUtcMin |
Filter by DateRangeUtcMin |
date |
None. |
DateRangeUtcMax |
Filter by DateRangeUtcMax |
date |
None. |
FormEntryID |
Filter by FormEntryID |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
List of ClientGroupStatusDTOs
Collection of ClientGroupStatusDTOName | Description | Type | Additional information |
---|---|---|---|
StatusID |
The unique identifier for the client's group status record. |
integer |
None. |
ClientID |
The unique identifier for the client record. |
integer |
None. |
ClientName |
The name of the client, . |
NameDTO |
None. |
BUID |
The unique identifier for the Business Unit. |
integer |
None. |
BusinessUnitName |
The name of the Business Unit. |
string |
None. |
BusinessUnitType |
The type of the Business Unit (RM or RV), . |
BusinessUnitType |
None. |
GroupID |
The unique identifier for the Group record. |
integer |
None. |
GroupType |
The type of the Group, . |
GroupType |
None. |
GroupName |
The name of the Group. |
string |
None. |
BedID |
The unique identifier for the current bed record. |
integer |
None. |
OldBedID |
The unique identifier for the old Bed record. |
integer |
None. |
BedName |
The name of the current bed. |
string |
None. |
BedLocation |
The location of the current bed. |
string |
None. |
BusinessUnitStatusID |
The unique identifier for the Business Unit Status record. |
integer |
None. |
StatusReason |
Status Reason Input from code table entries where TableName is "Resident Types" depending on the StatusType, (). |
string |
None. |
StatusReason2 |
Status Reason2 Input from code table entries where TableName is "Enquiry Statuses", "Absence Leave Reasons" or "Departure Reasons" depending on the StatusType, (). |
string |
None. |
StatusReason3 |
StatusReason3 Input from code table entries where TableName is "Admission Types", (). |
string |
None. |
StatusComments |
Status Comments for the client's group status. |
string |
None. |
ReferralSource |
Referral Source Input from code table entries where TableName is "Referral Sources",(). |
string |
None. |
StartDateUtc |
Start Date in UTC |
date |
None. |
StopDateUtc |
Stop Date in UTC |
date |
None. |
ReturnDateUtc |
Return Date in UTC |
date |
None. |
RecordState |
Record State, |
ClinicalRecordState |
None. |
Created |
The audit information for the creation of the record, including the creation date in UTC and the user who created it, . This field is readonly. |
AuditDataDTO |
None. |
LastUpdated |
The audit information for the last update to the record, including the update date in UTC and the user who made the update, . This field is readonly. |
AuditDataDTO |
None. |
StatusName |
The name of the group status. |
string |
None. |
StatusToAdjust |
The status to adjust. |
string |
None. |
FormEntryID |
The unique identifier for the Form Entry record. |
integer |
None. |
BedLocationID |
The unique identifier for the Bed Location record. |
integer |
None. |
RefundDueDate |
The refund due date for separation interest of departing client. |
date |
None. |
NoticeDate |
The notice date for the departing client. |
date |
None. |
BedStatus |
The status of the bed, . |
BedStatusDTO |
None. |
SimilarNameFlag |
If the client should be flagged with a similar name to another client in the facility. This field is read-only. |
boolean |
None. |