GET Clients/Relationship
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
EntityRelationshipIDs | Collection of integer |
None. |
|
EntityRelationshipIDsToExclude | Collection of integer |
None. |
|
BusinessUnits | Collection of integer |
None. |
|
BusinessUnitNames | Collection of string |
None. |
|
EntityID | integer |
None. |
|
EntityName | NameDTO |
None. |
|
EntityStringName | string |
None. |
|
Entities | Collection of integer |
None. |
|
ChildEntities | Collection of integer |
None. |
|
ChildEntityID | integer |
None. |
|
ChildEntityName | NameDTO |
None. |
|
ChildEntityStringName | string |
None. |
|
ChildEntityType | EntityType |
None. |
|
ParentEntityID | integer |
None. |
|
ParentEntities | Collection of integer |
None. |
|
ParentEntityName | NameDTO |
None. |
|
ParentEntityStringName | string |
None. |
|
ParentEntityType | EntityType |
None. |
|
EntityRelationshipTypeEntryID | integer |
None. |
|
IncludeActive | boolean |
None. |
|
IncludeInactive | boolean |
None. |
|
IncludeDeleted | boolean |
None. |
|
IncludeError | boolean |
None. |
|
CreatedDateUtcMin | date |
None. |
|
CreatedDateUtcMax | date |
None. |
|
LastUpdatedDateUtcMin | date |
None. |
|
LastUpdatedDateUtcMax | date |
None. |
|
Match | MatchCriteriaStringType |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of ClientRelationshipDTOName | Description | 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. |
Response 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:54:52.6172643+00:00", "stopDateUtc": "2024-12-04T07:54:52.6172643+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:54:52.6172643+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:54:52 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T07:54:52.6172643+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:54:52 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:54:52.6172643+00:00", "stopDateUtc": "2024-12-04T07:54:52.6172643+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:54:52.6172643+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:54:52 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T07:54:52.6172643+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:54:52 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:54:52.6172643+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:54:52 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T07:54:52.6172643+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:54:52 AM" }, "entityRelationshipTypeValue": "sample string 8", "clientRelationshipDetails": { "list": [] }, "extensions": [ { "entityID": 1, "entityID2": 2, "formFieldLinkID": 3, "recordState": 1, "created": { "dateUtc": "2024-12-04T07:54:52.6172643+00:00", "userName": "sample string 2" }, "lastUpdated": { "dateUtc": "2024-12-04T07:54:52.6172643+00:00", "userName": "sample string 2" } }, { "entityID": 1, "entityID2": 2, "formFieldLinkID": 3, "recordState": 1, "created": { "dateUtc": "2024-12-04T07:54:52.6172643+00:00", "userName": "sample string 2" }, "lastUpdated": { "dateUtc": "2024-12-04T07:54:52.6172643+00:00", "userName": "sample string 2" } } ], "comments": "sample string 9" }, { "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:54:52.6172643+00:00", "stopDateUtc": "2024-12-04T07:54:52.6172643+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:54:52.6172643+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:54:52 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T07:54:52.6172643+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:54:52 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:54:52.6172643+00:00", "stopDateUtc": "2024-12-04T07:54:52.6172643+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:54:52.6172643+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:54:52 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T07:54:52.6172643+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:54:52 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:54:52.6172643+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:54:52 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T07:54:52.6172643+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 7:54:52 AM" }, "entityRelationshipTypeValue": "sample string 8", "clientRelationshipDetails": { "list": [] }, "extensions": [ { "entityID": 1, "entityID2": 2, "formFieldLinkID": 3, "recordState": 1, "created": { "dateUtc": "2024-12-04T07:54:52.6172643+00:00", "userName": "sample string 2" }, "lastUpdated": { "dateUtc": "2024-12-04T07:54:52.6172643+00:00", "userName": "sample string 2" } }, { "entityID": 1, "entityID2": 2, "formFieldLinkID": 3, "recordState": 1, "created": { "dateUtc": "2024-12-04T07:54:52.6172643+00:00", "userName": "sample string 2" }, "lastUpdated": { "dateUtc": "2024-12-04T07:54:52.6172643+00:00", "userName": "sample string 2" } } ], "comments": "sample string 9" } ]
application/xml, text/xml
Sample:
<ArrayOfClientRelationshipDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models"> <ClientRelationshipDTO> <BusinessUnits> <ClientBusinessUnitDTO> <BUID>2</BUID> <BusinessUnitName>sample string 9</BusinessUnitName> <BusinessUnitStatusID>3</BusinessUnitStatusID> <ClientID>1</ClientID> <Created> <DateUtc>2024-12-04T07:54:52.6172643+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <LastUpdated> <DateUtc>2024-12-04T07:54:52.6172643+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" /> <RecordState>Active</RecordState> <ReferralSource>sample string 8</ReferralSource> <StartDateUtc>2024-12-04T07:54:52.6172643+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:54:52.6172643+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:54:52.6172643+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <LastUpdated> <DateUtc>2024-12-04T07:54:52.6172643+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" /> <RecordState>Active</RecordState> <ReferralSource>sample string 8</ReferralSource> <StartDateUtc>2024-12-04T07:54:52.6172643+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:54:52.6172643+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:54:52.6172643+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <EntityRelationshipTypeEntryID>7</EntityRelationshipTypeEntryID> <EntityRelationshipTypeValue>sample string 8</EntityRelationshipTypeValue> <Extensions xmlns:d3p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Models.Forms"> <d3p1:FormDataExtensionDto> <d3p1:Created> <d3p1:DateUtc>2024-12-04T07:54:52.6172643+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-04T07:54:52.6172643+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-04T07:54:52.6172643+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-04T07:54:52.6172643+00:00</d3p1:DateUtc> <d3p1:UserName>sample string 2</d3p1:UserName> </d3p1:LastUpdated> <d3p1:RecordState>Active</d3p1:RecordState> </d3p1:FormDataExtensionDto> </Extensions> <LastUpdated> <DateUtc>2024-12-04T07:54:52.6172643+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> <ClientRelationshipDTO> <BusinessUnits> <ClientBusinessUnitDTO> <BUID>2</BUID> <BusinessUnitName>sample string 9</BusinessUnitName> <BusinessUnitStatusID>3</BusinessUnitStatusID> <ClientID>1</ClientID> <Created> <DateUtc>2024-12-04T07:54:52.6172643+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <LastUpdated> <DateUtc>2024-12-04T07:54:52.6172643+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" /> <RecordState>Active</RecordState> <ReferralSource>sample string 8</ReferralSource> <StartDateUtc>2024-12-04T07:54:52.6172643+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:54:52.6172643+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:54:52.6172643+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <LastUpdated> <DateUtc>2024-12-04T07:54:52.6172643+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" /> <RecordState>Active</RecordState> <ReferralSource>sample string 8</ReferralSource> <StartDateUtc>2024-12-04T07:54:52.6172643+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:54:52.6172643+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:54:52.6172643+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <EntityRelationshipTypeEntryID>7</EntityRelationshipTypeEntryID> <EntityRelationshipTypeValue>sample string 8</EntityRelationshipTypeValue> <Extensions xmlns:d3p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Models.Forms"> <d3p1:FormDataExtensionDto> <d3p1:Created> <d3p1:DateUtc>2024-12-04T07:54:52.6172643+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-04T07:54:52.6172643+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-04T07:54:52.6172643+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-04T07:54:52.6172643+00:00</d3p1:DateUtc> <d3p1:UserName>sample string 2</d3p1:UserName> </d3p1:LastUpdated> <d3p1:RecordState>Active</d3p1:RecordState> </d3p1:FormDataExtensionDto> </Extensions> <LastUpdated> <DateUtc>2024-12-04T07:54:52.6172643+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> </ArrayOfClientRelationshipDTO>
application/x-compressed-json
Sample:
� �V�n�0~�('[�x��4�� ���v�T��,k�ؑ�H]U}2<����&q*z ��o���3�g�_?~^�����0���jK�O�8O'q���|��=A���Ҩ>M�GW� �e��|Ig��Ⱦ`V�X�b)-)����&м+=ǥ9��V���K�� �#Rd�I�@�S�QRBx�Y��x/��O4w���r7Lx�r�^�Rz�u�pJ��@�RP�����S��%��t�g�^�e�i� pz+ȓ��+8�������V���+N�=�V�uM��оޥƺV-��6ALX�%(;J�Q�]%�|��3�v�.�<��I�<Ilᴨ�ka#^ V��۴����r�f�vj��0* �0��,�Hy�T !�-@�d �ز�gݨV G=�, ��8;�!��wtzf�dЪ"���>`��O�g}?z�����# �җ�O�xbR ��~Y�6�� �_����}��t����b��k S�پ�����[��@����r�h#d��#�)��N�ѿ�؋;;x��+��Y����Uh{�큶�sx��`8N���/ҁ��~�6����� ��_r