PUT Groups/Group/{groupID}?validateOnly={validateOnly}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupID

integer

Required

validateOnly

boolean

Default value is False

Body Parameters

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

Request 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:04:17.3557893+00:00",
      "stopDateUtc": "2024-12-04T08:04:17.3557893+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:04:17.3557893+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:04:17 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:04:17.3557893+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:04:17 AM"
      },
      "businessUnitName": "sample string 10",
      "statusName": "sample string 11"
    },
    {
      "groupID": 1,
      "buid": 2,
      "businessUnitStatusID": 3,
      "startDateUtc": "2024-12-04T08:04:17.3557893+00:00",
      "stopDateUtc": "2024-12-04T08:04:17.3557893+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:04:17.3557893+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:04:17 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:04:17.3557893+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:04:17 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:04:17.3557893+00:00",
        "userName": "sample string 2"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:04:17.3557893+00:00",
        "userName": "sample string 2"
      }
    },
    {
      "entityID": 1,
      "entityID2": 2,
      "formFieldLinkID": 3,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T08:04:17.3557893+00:00",
        "userName": "sample string 2"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:04:17.3557893+00:00",
        "userName": "sample string 2"
      }
    }
  ],
  "recordState": 1,
  "created": {
    "dateUtc": "2024-12-04T08:04:17.3557893+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:04:17 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T08:04:17.3557893+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:04:17 AM"
  },
  "isPartialData": true,
  "builtDate": "2024-12-04T08:04:17.3557893+00:00",
  "lastRefurbishDate": "2024-12-04T08:04:17.3557893+00:00",
  "accommodationFunderID": 1,
  "feesFunderID": 1,
  "fundingFunderID": 1
}

application/xml, text/xml

Sample:
<GroupDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <AccommodationFunderID>1</AccommodationFunderID>
  <Addresses>
    <List />
    <PartialData>FullData</PartialData>
  </Addresses>
  <BuiltDate>2024-12-04T08:04:17.3557893+00:00</BuiltDate>
  <BusinessUnits>
    <GroupBusinessUnitDTO>
      <BUID>2</BUID>
      <BusinessUnitName>sample string 10</BusinessUnitName>
      <BusinessUnitStatusID>3</BusinessUnitStatusID>
      <Created>
        <DateUtc>2024-12-04T08:04:17.3557893+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <GroupID>1</GroupID>
      <LastUpdated>
        <DateUtc>2024-12-04T08:04:17.3557893+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:04:17.3557893+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:04:17.3557893+00:00</StopDateUtc>
    </GroupBusinessUnitDTO>
    <GroupBusinessUnitDTO>
      <BUID>2</BUID>
      <BusinessUnitName>sample string 10</BusinessUnitName>
      <BusinessUnitStatusID>3</BusinessUnitStatusID>
      <Created>
        <DateUtc>2024-12-04T08:04:17.3557893+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <GroupID>1</GroupID>
      <LastUpdated>
        <DateUtc>2024-12-04T08:04:17.3557893+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:04:17.3557893+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:04:17.3557893+00:00</StopDateUtc>
    </GroupBusinessUnitDTO>
  </BusinessUnits>
  <Comments>sample string 7</Comments>
  <CommunicationMethods>
    <List />
    <PartialData>FullData</PartialData>
    <PhoneNumbers />
  </CommunicationMethods>
  <Created>
    <DateUtc>2024-12-04T08:04:17.3557893+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <Depth>64</Depth>
  <Extensions xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Models.Forms">
    <d2p1:FormDataExtensionDto>
      <d2p1:Created>
        <d2p1:DateUtc>2024-12-04T08:04:17.3557893+00:00</d2p1:DateUtc>
        <d2p1:UserName>sample string 2</d2p1:UserName>
      </d2p1:Created>
      <d2p1:EntityID>1</d2p1:EntityID>
      <d2p1:EntityID2>2</d2p1:EntityID2>
      <d2p1:Field i:nil="true" />
      <d2p1:FieldValue>sample string 4</d2p1:FieldValue>
      <d2p1:FormFieldLinkID>3</d2p1:FormFieldLinkID>
      <d2p1:LastUpdated>
        <d2p1:DateUtc>2024-12-04T08:04:17.3557893+00:00</d2p1:DateUtc>
        <d2p1:UserName>sample string 2</d2p1:UserName>
      </d2p1:LastUpdated>
      <d2p1:RecordState>Active</d2p1:RecordState>
    </d2p1:FormDataExtensionDto>
    <d2p1:FormDataExtensionDto>
      <d2p1:Created>
        <d2p1:DateUtc>2024-12-04T08:04:17.3557893+00:00</d2p1:DateUtc>
        <d2p1:UserName>sample string 2</d2p1:UserName>
      </d2p1:Created>
      <d2p1:EntityID>1</d2p1:EntityID>
      <d2p1:EntityID2>2</d2p1:EntityID2>
      <d2p1:Field i:nil="true" />
      <d2p1:FieldValue>sample string 4</d2p1:FieldValue>
      <d2p1:FormFieldLinkID>3</d2p1:FormFieldLinkID>
      <d2p1:LastUpdated>
        <d2p1:DateUtc>2024-12-04T08:04:17.3557893+00:00</d2p1:DateUtc>
        <d2p1:UserName>sample string 2</d2p1:UserName>
      </d2p1:LastUpdated>
      <d2p1:RecordState>Active</d2p1:RecordState>
    </d2p1: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:04:17.3557893+00:00</LastRefurbishDate>
  <LastUpdated>
    <DateUtc>2024-12-04T08:04:17.3557893+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <ParentGroupID>1</ParentGroupID>
  <Props xmlns:d2p1="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>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample:
��V�n�0�Cץ��8M��РÀn��T��L+̖����I��I��&s
4�
��(>�"�H�Ƿ���w�Bf����
�)��Ӣ?���WCB���%���T���!�1��
͌f�f����J�|vŊ=E�p ��T1̸�4/���(-�ӉL���G���t�&Me��hbݾ��%(���@�C��C먧?ٞ٦	��C&��DU_Y�e?ӧ-��X��@��!,C�D�W��_�'��Q���k�,?.����;;y�Q��V�3W�-�٤�Γ����g�O<�xzfp}f���Ƽt�*��_?�+p|/�I�U=}�˗��_�9���y��ǣ��M��؜k��m�t��'x�k������ί�����С�+!=��Fݾ
��V������Sel][���so*�����Bfco�^Ci@

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.