GET Clients/Group

Request Information

URI Parameters

Name	Type	Additional information
IncludeActive	boolean	None.
IncludeInactive	boolean	None.
IncludeDeleted	boolean	None.
Match	MatchCriteriaStringType	None.
EntityIDs	Collection of integer	None.
BusinessUnits	Collection of integer	None.
GroupIDs	Collection of integer	None.
Status	integer	None.
BusinessUnitStatusTypes	Collection of integer	None.
StatusReason	string	None.
StatusReason2	string	None.
StatusReason3	string	None.
StatusReason3List	Collection of string	None.
StatusComments	string	None.
StartDateUtcMin	date	None.
StartDateUtcMax	date	None.
StopDateUtcMin	date	None.
StopDateUtcMax	date	None.
MaxRows	integer	None.
CreatedDateUtcMin	date	None.
CreatedDateUtcMax	date	None.
LastUpdatedDateUtcMin	date	None.
LastUpdatedDateUtcMax	date	None.

Body Parameters

None.

Response Information

Resource Description

Collection of ClientGroupDTO

Name	Type	Additional 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.

Response 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:58:03.2494597+00:00",
    "stopDateUtc": "2024-12-04T07:58:03.2494597+00:00",
    "returnDateUtc": "2024-12-04T07:58:03.2494597+00:00",
    "recordState": 1,
    "firstEntryDate": "2024-12-04T07:58:03.2494597+00:00",
    "referralSource": "sample string 10",
    "created": {
      "dateUtc": "2024-12-04T07:58:03.2494597+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:58:03 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:58:03.2494597+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:58:03 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:58:03.2494597+00:00",
      "stopDateUtc": "2024-12-04T07:58:03.2494597+00:00",
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:58:03.2494597+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:58:03 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:58:03.2494597+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:58:03 AM"
      }
    },
    "isCurrent": true,
    "currentFormEntryID": 1,
    "groupType": 1,
    "isAbsent": true,
    "absentStatusName": "sample string 15",
    "absentStatusDescription": "sample string 16",
    "refundDueDate": "2024-12-04T07:58:03.2494597+00:00",
    "noticeDate": "2024-12-04T07:58:03.2494597+00:00",
    "businessUnitType": 1
  },
  {
    "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:58:03.2494597+00:00",
    "stopDateUtc": "2024-12-04T07:58:03.2494597+00:00",
    "returnDateUtc": "2024-12-04T07:58:03.2494597+00:00",
    "recordState": 1,
    "firstEntryDate": "2024-12-04T07:58:03.2494597+00:00",
    "referralSource": "sample string 10",
    "created": {
      "dateUtc": "2024-12-04T07:58:03.2494597+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:58:03 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:58:03.2494597+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:58:03 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:58:03.2494597+00:00",
      "stopDateUtc": "2024-12-04T07:58:03.2494597+00:00",
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:58:03.2494597+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:58:03 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:58:03.2494597+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:58:03 AM"
      }
    },
    "isCurrent": true,
    "currentFormEntryID": 1,
    "groupType": 1,
    "isAbsent": true,
    "absentStatusName": "sample string 15",
    "absentStatusDescription": "sample string 16",
    "refundDueDate": "2024-12-04T07:58:03.2494597+00:00",
    "noticeDate": "2024-12-04T07:58:03.2494597+00:00",
    "businessUnitType": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientGroupDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <ClientGroupDTO>
    <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:58:03.2494597+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:58:03.2494597+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <ExtraServiceRoomType>sample string 5</ExtraServiceRoomType>
      <LastUpdated>
        <DateUtc>2024-12-04T07:58:03.2494597+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <RecordState>Active</RecordState>
      <StartDateUtc>2024-12-04T07:58:03.2494597+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:58:03.2494597+00:00</StopDateUtc>
    </CurrentBedStatus>
    <CurrentFormEntryID>1</CurrentFormEntryID>
    <FirstEntryDate>2024-12-04T07:58:03.2494597+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:58:03.2494597+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <NoticeDate>2024-12-04T07:58:03.2494597+00:00</NoticeDate>
    <RecordState>Active</RecordState>
    <ReferralSource>sample string 10</ReferralSource>
    <RefundDueDate>2024-12-04T07:58:03.2494597+00:00</RefundDueDate>
    <ReturnDateUtc>2024-12-04T07:58:03.2494597+00:00</ReturnDateUtc>
    <StartDateUtc>2024-12-04T07:58:03.2494597+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:58:03.2494597+00:00</StopDateUtc>
  </ClientGroupDTO>
  <ClientGroupDTO>
    <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:58:03.2494597+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:58:03.2494597+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <ExtraServiceRoomType>sample string 5</ExtraServiceRoomType>
      <LastUpdated>
        <DateUtc>2024-12-04T07:58:03.2494597+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <RecordState>Active</RecordState>
      <StartDateUtc>2024-12-04T07:58:03.2494597+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:58:03.2494597+00:00</StopDateUtc>
    </CurrentBedStatus>
    <CurrentFormEntryID>1</CurrentFormEntryID>
    <FirstEntryDate>2024-12-04T07:58:03.2494597+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:58:03.2494597+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <NoticeDate>2024-12-04T07:58:03.2494597+00:00</NoticeDate>
    <RecordState>Active</RecordState>
    <ReferralSource>sample string 10</ReferralSource>
    <RefundDueDate>2024-12-04T07:58:03.2494597+00:00</RefundDueDate>
    <ReturnDateUtc>2024-12-04T07:58:03.2494597+00:00</ReturnDateUtc>
    <StartDateUtc>2024-12-04T07:58:03.2494597+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:58:03.2494597+00:00</StopDateUtc>
  </ClientGroupDTO>
</ArrayOfClientGroupDTO>

application/x-compressed-json

Sample:

��U�n�0�C�
sW�q�ַ�ކ�MsvP,�`[%

�~�����$�	�X
�[��f��M�=����ۖ%�Z}�I�d�9#Y����{)y
R.k��*-�!
�lw@��IF$��������bv����=�VT�IS� W�*�
��0�$Jҋ8����h�M��h�6I�����MeQԺ�f���X�)2[3h˻�(��Z�&o��2�i�� ���4��6(C-�Ҫ6�E�UEqӷ���2��O]���y
II�Z6쥤���3���u�i\�ڹ��m
�F4c��#������0�eHtD-wp��m��ϐnL�-C��11��3V�לv����z�3��T?��v�:I�m��L���YTq�����q'H���.�\��՟��V�*Q_�^���H~:&.ocI�PÞ�V�w��~/\ެ�mO�3Jb����,�7ށ�gN�u�r
A-��������p������I?n�q��?%���=��1�.5�