GET Groups/Relationship/{groupRelationshipID}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
groupRelationshipID | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
EntityRelationshipDTOName | Description | Type | Additional information |
---|---|---|---|
EntityRelationshipID | integer |
None. |
|
ChildEntityID | integer |
None. |
|
ChildEntityType | EntityType |
None. |
|
ChildEntityStringName | string |
None. |
|
ChildEntityName | NameDTO |
None. |
|
ParentEntityID | integer |
None. |
|
ParentEntityType | EntityType |
None. |
|
ParentEntityTypeEntryID | integer |
None. |
|
ParentEntityTypeEntryValue | string |
None. |
|
ParentEntityName | NameDTO |
None. |
|
ParentEntityStringName | string |
None. |
|
ParentEntityAddresses | AddressesDTO |
None. |
|
ParentEntityCommunicationMethods | CommunicationMethodsDTO |
None. |
|
EntityRelationshipTypeEntryID | integer |
None. |
|
EntityRelationshipTypeValue | string |
None. |
|
RecordState | RecordState |
None. |
|
Created | AuditDataDTO |
None. |
|
LastUpdated | AuditDataDTO |
None. |
|
EntityRelationshipDetails | EntityRelationshipDetailsDTO |
None. |
|
Comments | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "entityRelationshipID": 1, "childEntityID": 2, "childEntityType": 1, "childEntityStringName": "sample string 3", "childEntityName": { "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)" }, "parentEntityID": 4, "parentEntityType": 1, "parentEntityTypeEntryID": 5, "parentEntityTypeEntryValue": "sample string 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)" }, "parentEntityStringName": "sample string 7", "entityRelationshipTypeEntryID": 8, "entityRelationshipTypeValue": "sample string 9", "recordState": 1, "created": { "dateUtc": "2024-12-04T08:04:03.1435133+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:04:03 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:04:03.1435133+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:04:03 AM" }, "entityRelationshipDetails": { "list": [] }, "comments": "sample string 10" }
application/xml, text/xml
Sample:
<EntityRelationshipDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models"> <ChildEntityID>2</ChildEntityID> <ChildEntityName> <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> </ChildEntityName> <ChildEntityStringName>sample string 3</ChildEntityStringName> <ChildEntityType>Organization</ChildEntityType> <Comments>sample string 10</Comments> <Created> <DateUtc>2024-12-04T08:04:03.1435133+00:00</DateUtc> <UserName>sample string 2</UserName> </Created> <EntityRelationshipDetails> <List /> </EntityRelationshipDetails> <EntityRelationshipID>1</EntityRelationshipID> <EntityRelationshipTypeEntryID>8</EntityRelationshipTypeEntryID> <EntityRelationshipTypeValue>sample string 9</EntityRelationshipTypeValue> <LastUpdated> <DateUtc>2024-12-04T08:04:03.1435133+00:00</DateUtc> <UserName>sample string 2</UserName> </LastUpdated> <ParentEntityAddresses> <List /> <PartialData>FullData</PartialData> </ParentEntityAddresses> <ParentEntityCommunicationMethods> <List /> <PartialData>FullData</PartialData> <PhoneNumbers /> </ParentEntityCommunicationMethods> <ParentEntityID>4</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> <ParentEntityStringName>sample string 7</ParentEntityStringName> <ParentEntityType>Organization</ParentEntityType> <ParentEntityTypeEntryID>5</ParentEntityTypeEntryID> <ParentEntityTypeEntryValue>sample string 6</ParentEntityTypeEntryValue> <RecordState>Active</RecordState> </EntityRelationshipDTO>
application/x-compressed-json
Sample:
� �S=O�0�+�'-uJ6�20�@[����j�N"ۑ���2~�K��|����t����������+_=Hͽ�3�W�� ��'{��M����l�B�YkoU�|� �qSh�\�C!�0?9���� ���(��2��J19�(!��Y�@�� W�c�E�m5<C=��'�a*�`�����������6���u9|h-�'���_�F Dg�)�� ����In��s�~+!�&[�@%��:'lC�1a1 �FA��J'��f�,�(�P@lQ�@mot}W�R_¶E��ٕ�\i�\�rǻ'�%�1�u�{ ��"|�