POST Clients/Group?validateOnly={validateOnly}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
validateOnly

boolean

Default value is False

Body Parameters

ClientGroupDTO
NameDescriptionTypeAdditional information
ClientID

integer

None.

BUID

integer

None.

GroupID

integer

None.

BusinessUnitStatusID

integer

None.

StatusReason

string

None.

StatusReason2

string

None.

StatusReason3

string

None.

StatusComments

string

None.

StartDateUtc

date

None.

StopDateUtc

date

None.

ReturnDateUtc

date

None.

RecordState

RecordState

None.

FirstEntryDate

date

None.

ReferralSource

string

None.

Created

AuditDataDTO

None.

LastUpdated

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.

Request Formats

application/json, text/json

Sample:
{
  "clientID": 1,
  "buid": 2,
  "groupID": 3,
  "businessUnitStatusID": 4,
  "statusReason": "sample string 5",
  "statusReason2": "sample string 6",
  "statusReason3": "sample string 7",
  "statusComments": "sample string 8",
  "startDateUtc": "2024-12-04T07:47:43.5084115+00:00",
  "stopDateUtc": "2024-12-04T07:47:43.5084115+00:00",
  "returnDateUtc": "2024-12-04T07:47:43.5084115+00:00",
  "recordState": 1,
  "firstEntryDate": "2024-12-04T07:47:43.5084115+00:00",
  "referralSource": "sample string 10",
  "created": {
    "dateUtc": "2024-12-04T07:47:43.5084115+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:47:43 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T07:47:43.5084115+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:47:43 AM"
  },
  "statusName": "sample string 11",
  "statusType": 1,
  "groupName": "sample string 12",
  "currentBedStatus": {
    "bedStatusID": 1,
    "bedID": 2,
    "clientID": 1,
    "clientName": {
      "lastName": "sample string 1",
      "firstName": "sample string 2",
      "preferredName": "sample string 3",
      "middleName": "sample string 4",
      "prefix": "sample string 5",
      "suffix": "sample string 6",
      "summary": "sample string 1, sample string 2 (sample string 3)"
    },
    "bedName": "sample string 3",
    "bedLocation": "sample string 4",
    "bedGroupID": 1,
    "extraServiceRoomType": "sample string 5",
    "status": 1,
    "statusReason": "sample string 6",
    "statusReason2": "sample string 7",
    "statusComments": "sample string 8",
    "startDateUtc": "2024-12-04T07:47:43.5084115+00:00",
    "stopDateUtc": "2024-12-04T07:47:43.5084115+00:00",
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T07:47:43.5084115+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:47:43 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:47:43.5084115+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:47:43 AM"
    }
  },
  "isCurrent": true,
  "currentFormEntryID": 1,
  "groupType": 1,
  "isAbsent": true,
  "absentStatusName": "sample string 15",
  "absentStatusDescription": "sample string 16",
  "refundDueDate": "2024-12-04T07:47:43.5084115+00:00",
  "noticeDate": "2024-12-04T07:47:43.5084115+00:00",
  "businessUnitType": 1
}

application/xml, text/xml

Sample:
<ClientGroupDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <AbsentStatusDescription>sample string 16</AbsentStatusDescription>
  <AbsentStatusName>sample string 15</AbsentStatusName>
  <BUID>2</BUID>
  <BusinessUnitStatusID>4</BusinessUnitStatusID>
  <BusinessUnitType>RM</BusinessUnitType>
  <ClientID>1</ClientID>
  <Created>
    <DateUtc>2024-12-04T07:47:43.5084115+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <CurrentBedStatus>
    <BedGroupID>1</BedGroupID>
    <BedID>2</BedID>
    <BedLocation>sample string 4</BedLocation>
    <BedName>sample string 3</BedName>
    <BedStatusID>1</BedStatusID>
    <ClientID>1</ClientID>
    <ClientName>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 1</LastName>
      <MiddleName>sample string 4</MiddleName>
      <PreferredName>sample string 3</PreferredName>
      <Prefix>sample string 5</Prefix>
      <Suffix>sample string 6</Suffix>
    </ClientName>
    <Created>
      <DateUtc>2024-12-04T07:47:43.5084115+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <ExtraServiceRoomType>sample string 5</ExtraServiceRoomType>
    <LastUpdated>
      <DateUtc>2024-12-04T07:47:43.5084115+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <RecordState>Active</RecordState>
    <StartDateUtc>2024-12-04T07:47:43.5084115+00:00</StartDateUtc>
    <Status>Vacant</Status>
    <StatusComments>sample string 8</StatusComments>
    <StatusReason>sample string 6</StatusReason>
    <StatusReason2>sample string 7</StatusReason2>
    <StopDateUtc>2024-12-04T07:47:43.5084115+00:00</StopDateUtc>
  </CurrentBedStatus>
  <CurrentFormEntryID>1</CurrentFormEntryID>
  <FirstEntryDate>2024-12-04T07:47:43.5084115+00:00</FirstEntryDate>
  <GroupID>3</GroupID>
  <GroupName>sample string 12</GroupName>
  <GroupType>List</GroupType>
  <IsAbsent>true</IsAbsent>
  <IsCurrent>true</IsCurrent>
  <LastUpdated>
    <DateUtc>2024-12-04T07:47:43.5084115+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <NoticeDate>2024-12-04T07:47:43.5084115+00:00</NoticeDate>
  <RecordState>Active</RecordState>
  <ReferralSource>sample string 10</ReferralSource>
  <RefundDueDate>2024-12-04T07:47:43.5084115+00:00</RefundDueDate>
  <ReturnDateUtc>2024-12-04T07:47:43.5084115+00:00</ReturnDateUtc>
  <StartDateUtc>2024-12-04T07:47:43.5084115+00:00</StartDateUtc>
  <StatusComments>sample string 8</StatusComments>
  <StatusName>sample string 11</StatusName>
  <StatusReason>sample string 5</StatusReason>
  <StatusReason2>sample string 6</StatusReason2>
  <StatusReason3>sample string 7</StatusReason3>
  <StatusType>1</StatusType>
  <StopDateUtc>2024-12-04T07:47:43.5084115+00:00</StopDateUtc>
</ClientGroupDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample:
��UKn�0���U�*�(�N�]�E���8>-�)�"���u�#�
�G6lK1�]�09oF��������!u#@��)iJ�VpR�)yFe;9�ZH�z!��f���"%:�i%II4k�mP��dJ�1;BL���A��kS ���b�v�<ˋK�_f�SvS�7��f��ӏYVfYHQ�yƢ<7�V��� �w%P�O��
W�Xd���+�5@=�Fp��6��աՀ?X;,��!ٶe��%�_��I_;��N^S�0m/�D��֤tG��u7x?��-����x������p�ω�@Z�Ko”�Cz��9�.�(b��༁�p�/サ������i����QK~�
��7U3#F|���/[Cr���l�S��T�������^u�DC�z_Nt�*��?ގ�G臨XR���g�m��QA�;�n���X8�O8�'�>�]��F	Mg�ԭ䕅3>RG�3�?��˽���*��

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.