POST Clients/Relationship?validateOnly={validateOnly}

Request Information

URI Parameters

Name	Description	Type	Additional information
validateOnly		boolean	Default value is False

Body Parameters

ClientRelationshipDTO

Name	Type	Additional information
ClientRelationshipID	integer	None.
ChildEntityID	integer	None.
ParentEntityID	integer	None.
ParentEntityType	EntityType	None.
ParentEntityTypeEntryID	integer	None.
ParentEntityTypeEntryValue	string	None.
ParentEntityTypeEntryType	integer	None.
ParentEntityName	NameDTO	None.
ParentEntityAddresses	AddressesDTO	None.
ParentEntityCommunicationMethods	CommunicationMethodsDTO	None.
BusinessUnits	Collection of ClientBusinessUnitDTO	None.
EntityRelationshipTypeEntryID	integer	None.
RecordState	RecordState	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
EntityRelationshipTypeValue	string	None.
ClientRelationshipDetails	ClientRelationshipDetailsDTO	None.
Extensions	Collection of FormDataExtensionDto	None.
Comments	string	None.

Request Formats

application/json, text/json

Sample:

{
  "clientRelationshipID": 1,
  "childEntityID": 2,
  "parentEntityID": 3,
  "parentEntityType": 1,
  "parentEntityTypeEntryID": 4,
  "parentEntityTypeEntryValue": "sample string 5",
  "parentEntityTypeEntryType": 6,
  "parentEntityName": {
    "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)"
  },
  "parentEntityAddresses": {
    "list": [],
    "partialData": 1
  },
  "parentEntityCommunicationMethods": {
    "list": [],
    "partialData": 1,
    "phoneNumbers": []
  },
  "businessUnits": [
    {
      "clientID": 1,
      "buid": 2,
      "businessUnitStatusID": 3,
      "startDateUtc": "2024-12-04T07:52:00.6787874+00:00",
      "stopDateUtc": "2024-12-04T07:52:00.6787874+00:00",
      "statusReason": "sample string 5",
      "statusReason2": "sample string 6",
      "statusComments": "sample string 7",
      "referralSource": "sample string 8",
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:52:00.6787874+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:52:00 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:52:00.6787874+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:52:00 AM"
      },
      "businessUnitName": "sample string 9",
      "type": 1,
      "statusName": "sample string 10",
      "statusType": "sample string 11",
      "summary": "sample string 9"
    },
    {
      "clientID": 1,
      "buid": 2,
      "businessUnitStatusID": 3,
      "startDateUtc": "2024-12-04T07:52:00.6787874+00:00",
      "stopDateUtc": "2024-12-04T07:52:00.6787874+00:00",
      "statusReason": "sample string 5",
      "statusReason2": "sample string 6",
      "statusComments": "sample string 7",
      "referralSource": "sample string 8",
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:52:00.6787874+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:52:00 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:52:00.6787874+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:52:00 AM"
      },
      "businessUnitName": "sample string 9",
      "type": 1,
      "statusName": "sample string 10",
      "statusType": "sample string 11",
      "summary": "sample string 9"
    }
  ],
  "entityRelationshipTypeEntryID": 7,
  "recordState": 1,
  "created": {
    "dateUtc": "2024-12-04T07:52:00.6787874+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:52:00 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T07:52:00.6787874+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:52:00 AM"
  },
  "entityRelationshipTypeValue": "sample string 8",
  "clientRelationshipDetails": {
    "list": []
  },
  "extensions": [
    {
      "entityID": 1,
      "entityID2": 2,
      "formFieldLinkID": 3,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:52:00.6787874+00:00",
        "userName": "sample string 2"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:52:00.6787874+00:00",
        "userName": "sample string 2"
      }
    },
    {
      "entityID": 1,
      "entityID2": 2,
      "formFieldLinkID": 3,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:52:00.6787874+00:00",
        "userName": "sample string 2"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:52:00.6787874+00:00",
        "userName": "sample string 2"
      }
    }
  ],
  "comments": "sample string 9"
}

application/xml, text/xml

Sample:

<ClientRelationshipDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <BusinessUnits>
    <ClientBusinessUnitDTO>
      <BUID>2</BUID>
      <BusinessUnitName>sample string 9</BusinessUnitName>
      <BusinessUnitStatusID>3</BusinessUnitStatusID>
      <ClientID>1</ClientID>
      <Created>
        <DateUtc>2024-12-04T07:52:00.6787874+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <LastUpdated>
        <DateUtc>2024-12-04T07:52:00.6787874+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <Props xmlns:d4p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
      <RecordState>Active</RecordState>
      <ReferralSource>sample string 8</ReferralSource>
      <StartDateUtc>2024-12-04T07:52:00.6787874+00:00</StartDateUtc>
      <StatusComments>sample string 7</StatusComments>
      <StatusName>sample string 10</StatusName>
      <StatusReason>sample string 5</StatusReason>
      <StatusReason2>sample string 6</StatusReason2>
      <StatusType>sample string 11</StatusType>
      <StopDateUtc>2024-12-04T07:52:00.6787874+00:00</StopDateUtc>
      <Type>RM</Type>
    </ClientBusinessUnitDTO>
    <ClientBusinessUnitDTO>
      <BUID>2</BUID>
      <BusinessUnitName>sample string 9</BusinessUnitName>
      <BusinessUnitStatusID>3</BusinessUnitStatusID>
      <ClientID>1</ClientID>
      <Created>
        <DateUtc>2024-12-04T07:52:00.6787874+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <LastUpdated>
        <DateUtc>2024-12-04T07:52:00.6787874+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <Props xmlns:d4p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
      <RecordState>Active</RecordState>
      <ReferralSource>sample string 8</ReferralSource>
      <StartDateUtc>2024-12-04T07:52:00.6787874+00:00</StartDateUtc>
      <StatusComments>sample string 7</StatusComments>
      <StatusName>sample string 10</StatusName>
      <StatusReason>sample string 5</StatusReason>
      <StatusReason2>sample string 6</StatusReason2>
      <StatusType>sample string 11</StatusType>
      <StopDateUtc>2024-12-04T07:52:00.6787874+00:00</StopDateUtc>
      <Type>RM</Type>
    </ClientBusinessUnitDTO>
  </BusinessUnits>
  <ChildEntityID>2</ChildEntityID>
  <ClientRelationshipDetails>
    <List />
  </ClientRelationshipDetails>
  <ClientRelationshipID>1</ClientRelationshipID>
  <Comments>sample string 9</Comments>
  <Created>
    <DateUtc>2024-12-04T07:52:00.6787874+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <EntityRelationshipTypeEntryID>7</EntityRelationshipTypeEntryID>
  <EntityRelationshipTypeValue>sample string 8</EntityRelationshipTypeValue>
  <Extensions xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Models.Forms">
    <d2p1:FormDataExtensionDto>
      <d2p1:Created>
        <d2p1:DateUtc>2024-12-04T07:52:00.6787874+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-04T07:52:00.6787874+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-04T07:52:00.6787874+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-04T07:52:00.6787874+00:00</d2p1:DateUtc>
        <d2p1:UserName>sample string 2</d2p1:UserName>
      </d2p1:LastUpdated>
      <d2p1:RecordState>Active</d2p1:RecordState>
    </d2p1:FormDataExtensionDto>
  </Extensions>
  <LastUpdated>
    <DateUtc>2024-12-04T07:52:00.6787874+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <ParentEntityAddresses>
    <List />
    <PartialData>FullData</PartialData>
  </ParentEntityAddresses>
  <ParentEntityCommunicationMethods>
    <List />
    <PartialData>FullData</PartialData>
    <PhoneNumbers />
  </ParentEntityCommunicationMethods>
  <ParentEntityID>3</ParentEntityID>
  <ParentEntityName>
    <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>
  </ParentEntityName>
  <ParentEntityType>Organization</ParentEntityType>
  <ParentEntityTypeEntryID>4</ParentEntityTypeEntryID>
  <ParentEntityTypeEntryType>6</ParentEntityTypeEntryType>
  <ParentEntityTypeEntryValue>sample string 5</ParentEntityTypeEntryValue>
  <RecordState>Active</RecordState>
</ClientRelationshipDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample:

��V�n�0�ç
KW[u�6�bـkm�˰�b1�0Y2$hP��v�'�F�n�8r�6[�L>��H�Ƿ�i�$h��Q�V�~?K��(-WR��%����Қ[�>���E���ξ�V6l(t�jhk�xU+HZ��$���u4��^������u�\N��h�wfa	ւ�"�QI!D�Eg@�D�eL5���v��(�Ř���2����R!��O�%W3��*����TU�ep�2����2.�j�y\4Nj�<���X���C��+�ظ�I�	y�9��
��� gYq�M��l�e�Ǔ��WYF>qh����/�;��e��x���N�v ��4���4��e�I���
���eJ�>��Y'j�AB1�%F'9;,�������{:����o	g�0Q˧d�GO[�x�?� }}�D��ʞ�{J�[����
ؼ��n�ɾ��N<��Ǎ�ݧ��K�u�z�7�yH�X����~XEKc�w�� ��n
�����Z��������Է?��᝹

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.