PUT Clients/GroupStatus/{statusID}?validateOnly={validateOnly}

Update clientGroupStatus

Request Information

URI Parameters

NameDescriptionTypeAdditional information
statusID

StatusID of ClientGroupStatus to be updated

integer

Required

validateOnly

Validate data, but don't post it

boolean

Default value is False

Body Parameters

EntityGroupStatus data

ClientGroupStatusDTO
NameDescriptionTypeAdditional 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.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.