GET Clients/Group/{clientID}/{bUID}/{groupID}

Get clientGroup

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientID

ClientID of ClientGroup to be searched

integer

Required

bUID

BUID of ClientGroup to be searched

integer

Required

groupID

GroupID of ClientGroup to be searched

integer

Required

Body Parameters

None.

Response Information

Resource Description

ClientGroupDTO

ClientGroupDTO
NameDescriptionTypeAdditional information
ClientID

The unique identifier for the Client record.

integer

None.

BUID

The unique identifier for the business unit record.

integer

None.

GroupID

The unique identifier for the group record.

integer

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

Additional Status Reason (StatusReason2) Input from code table entries where TableName is "Enquiry Statuses", "Absence Leave Reasons" or "Departure Reasons" depending on the StatusType, ().

string

None.

StatusReason3

Additional Status Reason (StatusReason3) Input from code table entries where TableName is "Admission Types", ().

string

None.

StatusComments

Status Comments for the client's group status.

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,

RecordState

None.

FirstEntryDate

First Entry Date to the Facility (First Time Admitted)

date

None.

ReferralSource

The source of the referral for the group. Input from code table entries where TableName is "Referral Sources", ().

string

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 current status of the group.

string

None.

StatusType

The type of the current status of the group.

integer

None.

GroupName

The name of the group.

string

None.

CurrentBedStatus

The current bed status of the client in the group, .

BedStatusDTO

None.

IsCurrent

Indicates if the client is currently active in the group.

boolean

None.

CurrentFormEntryID

The ID of the current form entry associated with the client.

integer

None.

GroupType

The type of the group.

GroupType

None.

IsAbsent

Indicates if the client is currently absent from the group.

boolean

None.

AbsentStatusName

Name of the current absent group status.

string

None.

AbsentStatusDescription

Description of the any type of absent group status.

string

None.

RefundDueDate

Refund due date for separation interest of departing client.

date

None.

NoticeDate

The notice date for the departing client.

date

None.

BusinessUnitType

Business Unit's type associated with the group, .

BusinessUnitType

None.