GET Groups/Group

Request Information

URI Parameters

Name	Type	Additional information
IncludeActive	boolean	None.
IncludeInactive	boolean	None.
IncludeDeleted	boolean	None.
IncludePayload	boolean	None.
IncludeRootBU	boolean	None.
IncludeRootGroups	boolean	None.
Match	MatchCriteriaStringType	None.
GroupIDs	Collection of integer	None.
BusinessUnits	Collection of integer	None.
RootGroupID	integer	None.
RootGroupIDs	Collection of integer	None.
ParentGroupID	integer	None.
ParentGroupIDs	Collection of integer	None.
GroupName	string	None.
Type	GroupType	None.
Types	Collection of GroupType	None.
SubType	GroupSubType	None.
Depth	byte	None.
TotalDepth	byte	None.
Comments	string	None.
ExceptGroupID	integer	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 GroupDTO

Name	Type	Additional information
GroupID	integer	None.
RootGroupID	integer	None.
ParentGroupID	integer	None.
GroupName	string	None.
GroupLocation	string	None.
Addresses	AddressesDTO	None.
BusinessUnits	Collection of GroupBusinessUnitDTO	None.
GLCode	string	None.
CommunicationMethods	CommunicationMethodsDTO	None.
Type	GroupType	None.
SubType	GroupSubType	None.
Depth	byte	None.
TotalDepth	byte	None.
Comments	string	None.
Props	Collection of Object	None.
Extensions	Collection of FormDataExtensionDto	None.
RecordState	RecordState	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
IsPartialData	boolean	None.
BuiltDate	date	None.
LastRefurbishDate	date	None.
AccommodationFunderID	integer	None.
FeesFunderID	integer	None.
FundingFunderID	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "groupID": 1,
    "rootGroupID": 1,
    "parentGroupID": 1,
    "groupName": "sample string 2",
    "groupLocation": "sample string 3",
    "businessUnits": [
      {
        "groupID": 1,
        "buid": 2,
        "businessUnitStatusID": 3,
        "startDateUtc": "2024-12-04T08:17:36.7940826+00:00",
        "stopDateUtc": "2024-12-04T08:17:36.7940826+00:00",
        "statusReason": "sample string 5",
        "statusReason2": "sample string 6",
        "props": "sample string 7",
        "statusComments": "sample string 8",
        "referralSource": "sample string 9",
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:17:36 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:17:36 AM"
        },
        "businessUnitName": "sample string 10",
        "statusName": "sample string 11"
      },
      {
        "groupID": 1,
        "buid": 2,
        "businessUnitStatusID": 3,
        "startDateUtc": "2024-12-04T08:17:36.7940826+00:00",
        "stopDateUtc": "2024-12-04T08:17:36.7940826+00:00",
        "statusReason": "sample string 5",
        "statusReason2": "sample string 6",
        "props": "sample string 7",
        "statusComments": "sample string 8",
        "referralSource": "sample string 9",
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:17:36 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:17:36 AM"
        },
        "businessUnitName": "sample string 10",
        "statusName": "sample string 11"
      }
    ],
    "glCode": "sample string 4",
    "type": 1,
    "subType": 1,
    "depth": 64,
    "totalDepth": 64,
    "comments": "sample string 7",
    "extensions": [
      {
        "entityID": 1,
        "entityID2": 2,
        "formFieldLinkID": 3,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
          "userName": "sample string 2"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
          "userName": "sample string 2"
        }
      },
      {
        "entityID": 1,
        "entityID2": 2,
        "formFieldLinkID": 3,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
          "userName": "sample string 2"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
          "userName": "sample string 2"
        }
      }
    ],
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:17:36 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:17:36 AM"
    },
    "isPartialData": true,
    "builtDate": "2024-12-04T08:17:36.7940826+00:00",
    "lastRefurbishDate": "2024-12-04T08:17:36.7940826+00:00",
    "accommodationFunderID": 1,
    "feesFunderID": 1,
    "fundingFunderID": 1
  },
  {
    "groupID": 1,
    "rootGroupID": 1,
    "parentGroupID": 1,
    "groupName": "sample string 2",
    "groupLocation": "sample string 3",
    "businessUnits": [
      {
        "groupID": 1,
        "buid": 2,
        "businessUnitStatusID": 3,
        "startDateUtc": "2024-12-04T08:17:36.7940826+00:00",
        "stopDateUtc": "2024-12-04T08:17:36.7940826+00:00",
        "statusReason": "sample string 5",
        "statusReason2": "sample string 6",
        "props": "sample string 7",
        "statusComments": "sample string 8",
        "referralSource": "sample string 9",
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:17:36 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:17:36 AM"
        },
        "businessUnitName": "sample string 10",
        "statusName": "sample string 11"
      },
      {
        "groupID": 1,
        "buid": 2,
        "businessUnitStatusID": 3,
        "startDateUtc": "2024-12-04T08:17:36.7940826+00:00",
        "stopDateUtc": "2024-12-04T08:17:36.7940826+00:00",
        "statusReason": "sample string 5",
        "statusReason2": "sample string 6",
        "props": "sample string 7",
        "statusComments": "sample string 8",
        "referralSource": "sample string 9",
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:17:36 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:17:36 AM"
        },
        "businessUnitName": "sample string 10",
        "statusName": "sample string 11"
      }
    ],
    "glCode": "sample string 4",
    "type": 1,
    "subType": 1,
    "depth": 64,
    "totalDepth": 64,
    "comments": "sample string 7",
    "extensions": [
      {
        "entityID": 1,
        "entityID2": 2,
        "formFieldLinkID": 3,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
          "userName": "sample string 2"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
          "userName": "sample string 2"
        }
      },
      {
        "entityID": 1,
        "entityID2": 2,
        "formFieldLinkID": 3,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
          "userName": "sample string 2"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
          "userName": "sample string 2"
        }
      }
    ],
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:17:36 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:17:36.7940826+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:17:36 AM"
    },
    "isPartialData": true,
    "builtDate": "2024-12-04T08:17:36.7940826+00:00",
    "lastRefurbishDate": "2024-12-04T08:17:36.7940826+00:00",
    "accommodationFunderID": 1,
    "feesFunderID": 1,
    "fundingFunderID": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfGroupDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <GroupDTO>
    <AccommodationFunderID>1</AccommodationFunderID>
    <Addresses>
      <List />
      <PartialData>FullData</PartialData>
    </Addresses>
    <BuiltDate>2024-12-04T08:17:36.7940826+00:00</BuiltDate>
    <BusinessUnits>
      <GroupBusinessUnitDTO>
        <BUID>2</BUID>
        <BusinessUnitName>sample string 10</BusinessUnitName>
        <BusinessUnitStatusID>3</BusinessUnitStatusID>
        <Created>
          <DateUtc>2024-12-04T08:17:36.7940826+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <GroupID>1</GroupID>
        <LastUpdated>
          <DateUtc>2024-12-04T08:17:36.7940826+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <Props>sample string 7</Props>
        <RecordState>Active</RecordState>
        <ReferralSource>sample string 9</ReferralSource>
        <StartDateUtc>2024-12-04T08:17:36.7940826+00:00</StartDateUtc>
        <StatusComments>sample string 8</StatusComments>
        <StatusName>sample string 11</StatusName>
        <StatusReason>sample string 5</StatusReason>
        <StatusReason2>sample string 6</StatusReason2>
        <StopDateUtc>2024-12-04T08:17:36.7940826+00:00</StopDateUtc>
      </GroupBusinessUnitDTO>
      <GroupBusinessUnitDTO>
        <BUID>2</BUID>
        <BusinessUnitName>sample string 10</BusinessUnitName>
        <BusinessUnitStatusID>3</BusinessUnitStatusID>
        <Created>
          <DateUtc>2024-12-04T08:17:36.7940826+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <GroupID>1</GroupID>
        <LastUpdated>
          <DateUtc>2024-12-04T08:17:36.7940826+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <Props>sample string 7</Props>
        <RecordState>Active</RecordState>
        <ReferralSource>sample string 9</ReferralSource>
        <StartDateUtc>2024-12-04T08:17:36.7940826+00:00</StartDateUtc>
        <StatusComments>sample string 8</StatusComments>
        <StatusName>sample string 11</StatusName>
        <StatusReason>sample string 5</StatusReason>
        <StatusReason2>sample string 6</StatusReason2>
        <StopDateUtc>2024-12-04T08:17:36.7940826+00:00</StopDateUtc>
      </GroupBusinessUnitDTO>
    </BusinessUnits>
    <Comments>sample string 7</Comments>
    <CommunicationMethods>
      <List />
      <PartialData>FullData</PartialData>
      <PhoneNumbers />
    </CommunicationMethods>
    <Created>
      <DateUtc>2024-12-04T08:17:36.7940826+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <Depth>64</Depth>
    <Extensions xmlns:d3p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Models.Forms">
      <d3p1:FormDataExtensionDto>
        <d3p1:Created>
          <d3p1:DateUtc>2024-12-04T08:17:36.7940826+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:Created>
        <d3p1:EntityID>1</d3p1:EntityID>
        <d3p1:EntityID2>2</d3p1:EntityID2>
        <d3p1:Field i:nil="true" />
        <d3p1:FieldValue>sample string 4</d3p1:FieldValue>
        <d3p1:FormFieldLinkID>3</d3p1:FormFieldLinkID>
        <d3p1:LastUpdated>
          <d3p1:DateUtc>2024-12-04T08:17:36.7940826+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:LastUpdated>
        <d3p1:RecordState>Active</d3p1:RecordState>
      </d3p1:FormDataExtensionDto>
      <d3p1:FormDataExtensionDto>
        <d3p1:Created>
          <d3p1:DateUtc>2024-12-04T08:17:36.7940826+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:Created>
        <d3p1:EntityID>1</d3p1:EntityID>
        <d3p1:EntityID2>2</d3p1:EntityID2>
        <d3p1:Field i:nil="true" />
        <d3p1:FieldValue>sample string 4</d3p1:FieldValue>
        <d3p1:FormFieldLinkID>3</d3p1:FormFieldLinkID>
        <d3p1:LastUpdated>
          <d3p1:DateUtc>2024-12-04T08:17:36.7940826+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:LastUpdated>
        <d3p1:RecordState>Active</d3p1:RecordState>
      </d3p1:FormDataExtensionDto>
    </Extensions>
    <FeesFunderID>1</FeesFunderID>
    <FundingFunderID>1</FundingFunderID>
    <GLCode>sample string 4</GLCode>
    <GroupID>1</GroupID>
    <GroupLocation>sample string 3</GroupLocation>
    <GroupName>sample string 2</GroupName>
    <IsPartialData>true</IsPartialData>
    <LastRefurbishDate>2024-12-04T08:17:36.7940826+00:00</LastRefurbishDate>
    <LastUpdated>
      <DateUtc>2024-12-04T08:17:36.7940826+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <ParentGroupID>1</ParentGroupID>
    <Props xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
    <RecordState>Active</RecordState>
    <RootGroupID>1</RootGroupID>
    <SubType>Group</SubType>
    <TotalDepth>64</TotalDepth>
    <Type>List</Type>
  </GroupDTO>
  <GroupDTO>
    <AccommodationFunderID>1</AccommodationFunderID>
    <Addresses>
      <List />
      <PartialData>FullData</PartialData>
    </Addresses>
    <BuiltDate>2024-12-04T08:17:36.7940826+00:00</BuiltDate>
    <BusinessUnits>
      <GroupBusinessUnitDTO>
        <BUID>2</BUID>
        <BusinessUnitName>sample string 10</BusinessUnitName>
        <BusinessUnitStatusID>3</BusinessUnitStatusID>
        <Created>
          <DateUtc>2024-12-04T08:17:36.7940826+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <GroupID>1</GroupID>
        <LastUpdated>
          <DateUtc>2024-12-04T08:17:36.7940826+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <Props>sample string 7</Props>
        <RecordState>Active</RecordState>
        <ReferralSource>sample string 9</ReferralSource>
        <StartDateUtc>2024-12-04T08:17:36.7940826+00:00</StartDateUtc>
        <StatusComments>sample string 8</StatusComments>
        <StatusName>sample string 11</StatusName>
        <StatusReason>sample string 5</StatusReason>
        <StatusReason2>sample string 6</StatusReason2>
        <StopDateUtc>2024-12-04T08:17:36.7940826+00:00</StopDateUtc>
      </GroupBusinessUnitDTO>
      <GroupBusinessUnitDTO>
        <BUID>2</BUID>
        <BusinessUnitName>sample string 10</BusinessUnitName>
        <BusinessUnitStatusID>3</BusinessUnitStatusID>
        <Created>
          <DateUtc>2024-12-04T08:17:36.7940826+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <GroupID>1</GroupID>
        <LastUpdated>
          <DateUtc>2024-12-04T08:17:36.7940826+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <Props>sample string 7</Props>
        <RecordState>Active</RecordState>
        <ReferralSource>sample string 9</ReferralSource>
        <StartDateUtc>2024-12-04T08:17:36.7940826+00:00</StartDateUtc>
        <StatusComments>sample string 8</StatusComments>
        <StatusName>sample string 11</StatusName>
        <StatusReason>sample string 5</StatusReason>
        <StatusReason2>sample string 6</StatusReason2>
        <StopDateUtc>2024-12-04T08:17:36.7940826+00:00</StopDateUtc>
      </GroupBusinessUnitDTO>
    </BusinessUnits>
    <Comments>sample string 7</Comments>
    <CommunicationMethods>
      <List />
      <PartialData>FullData</PartialData>
      <PhoneNumbers />
    </CommunicationMethods>
    <Created>
      <DateUtc>2024-12-04T08:17:36.7940826+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <Depth>64</Depth>
    <Extensions xmlns:d3p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Models.Forms">
      <d3p1:FormDataExtensionDto>
        <d3p1:Created>
          <d3p1:DateUtc>2024-12-04T08:17:36.7940826+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:Created>
        <d3p1:EntityID>1</d3p1:EntityID>
        <d3p1:EntityID2>2</d3p1:EntityID2>
        <d3p1:Field i:nil="true" />
        <d3p1:FieldValue>sample string 4</d3p1:FieldValue>
        <d3p1:FormFieldLinkID>3</d3p1:FormFieldLinkID>
        <d3p1:LastUpdated>
          <d3p1:DateUtc>2024-12-04T08:17:36.7940826+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:LastUpdated>
        <d3p1:RecordState>Active</d3p1:RecordState>
      </d3p1:FormDataExtensionDto>
      <d3p1:FormDataExtensionDto>
        <d3p1:Created>
          <d3p1:DateUtc>2024-12-04T08:17:36.7940826+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:Created>
        <d3p1:EntityID>1</d3p1:EntityID>
        <d3p1:EntityID2>2</d3p1:EntityID2>
        <d3p1:Field i:nil="true" />
        <d3p1:FieldValue>sample string 4</d3p1:FieldValue>
        <d3p1:FormFieldLinkID>3</d3p1:FormFieldLinkID>
        <d3p1:LastUpdated>
          <d3p1:DateUtc>2024-12-04T08:17:36.7940826+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:LastUpdated>
        <d3p1:RecordState>Active</d3p1:RecordState>
      </d3p1:FormDataExtensionDto>
    </Extensions>
    <FeesFunderID>1</FeesFunderID>
    <FundingFunderID>1</FundingFunderID>
    <GLCode>sample string 4</GLCode>
    <GroupID>1</GroupID>
    <GroupLocation>sample string 3</GroupLocation>
    <GroupName>sample string 2</GroupName>
    <IsPartialData>true</IsPartialData>
    <LastRefurbishDate>2024-12-04T08:17:36.7940826+00:00</LastRefurbishDate>
    <LastUpdated>
      <DateUtc>2024-12-04T08:17:36.7940826+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <ParentGroupID>1</ParentGroupID>
    <Props xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
    <RecordState>Active</RecordState>
    <RootGroupID>1</RootGroupID>
    <SubType>Group</SubType>
    <TotalDepth>64</TotalDepth>
    <Type>List</Type>
  </GroupDTO>
</ArrayOfGroupDTO>

application/x-compressed-json

Sample:

��V�n�0~Cץ��xI�[ѠÀn��4�XL+̖Q}��H{�I��&q
4�
��M?�"�Q��ݐ+���4%������7܂�8i�_x�䍩!Cg���(�g��Nj�Cb�Q*@�)鐰-�/atv���Aǭ�r3W4��AA��2��b̆���2��ѻ<gyN��6�jD���q�������`O2��{��&�����%X���mՏ�Q��14�F���!x7D��G���}�p���2������D�ݝ&�Rst3#��s֩����!��E�&�4���t���D����ne~qy�`�5a�2ȵ���a_=�����@a����n������E�Զ9�P�3��w��?x�s|����<��ӟ#�k�2�w�0g=�}�n���}:�����{��*���v���t	��a�Y;�nvi(L���Ug
O�O�P���4>���p��e.