GET Groups/Relationship

Request Information

URI Parameters

Name	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 EntityRelationshipDTO

Name	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-04T07:55:16.0281663+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:55:16 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:55:16.0281663+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:55:16 AM"
    },
    "entityRelationshipDetails": {
      "list": []
    },
    "comments": "sample string 10"
  },
  {
    "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-04T07:55:16.0281663+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:55:16 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:55:16.0281663+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:55:16 AM"
    },
    "entityRelationshipDetails": {
      "list": []
    },
    "comments": "sample string 10"
  }
]

application/xml, text/xml

Sample:

<ArrayOfEntityRelationshipDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <EntityRelationshipDTO>
    <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-04T07:55:16.0281663+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-04T07:55:16.0281663+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>
  <EntityRelationshipDTO>
    <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-04T07:55:16.0281663+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-04T07:55:16.0281663+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>
</ArrayOfEntityRelationshipDTO>

application/x-compressed-json

Sample:

��T�N�0~���:n��lHe`���,U+v�%;�lW"�x2�W��B�Ċ ���~����_�6G,']� s2M�^f�y#��7%Zxhͳ�3�d-����=Ӏ`�t���Mq���9bŬ��{��IӃR@3#v��{�iɹ��_%��-(�v]PXBZ3���F����9~��̀�_��u�I֦,S=�#S��C�����X��j����}��\AF#���c��4F�ɋIp0�.�0J�?���+2�� ��KB�^N/��D+L�d�$�(M�G'��(������Х؄u�K;me�1�l���:m���S��k��@ �pՆ�����߾j�e���