GET Clients/Relationship

Get clientRelationships from criteria

Request Information

URI Parameters

Name	Description	Type	Additional information
EntityRelationshipIDs	Filter by EntityRelationshipIDs	Collection of integer	None.
EntityRelationshipIDsToExclude	Filter by EntityRelationshipIDs	Collection of integer	None.
BusinessUnits	Filter by BusinessUnit(s)	Collection of integer	None.
BusinessUnitNames	Filter by Business Unit Name(s)	Collection of string	None.
EntityID	Entity ID	integer	None.
EntityName	Entity Name for Person entities	NameDTO	None.
EntityStringName	Entity Name for non Person entities	string	None.
Entities	Entities	Collection of integer	None.
ChildEntities	Child Entities	Collection of integer	None.
ChildEntityID	Filter by ChildEntityID	integer	None.
ChildEntityName	Filter by Child Entity Name for Person entities	NameDTO	None.
ChildEntityStringName	Filter by Child Entity Name for non Person entities	string	None.
ChildEntityType	Filter by Child Entity Type, needed when specifying a Name	EntityType	None.
ParentEntityID	Filter by ParentEntityID	integer	None.
ParentEntities	Filter by ParentEntityID	Collection of integer	None.
ParentEntityName		NameDTO	None.
ParentEntityStringName	Filter by Parent Entity Name for non Person entities	string	None.
ParentEntityType	Filter by Parent Entity Type, needed when specifying a Name	EntityType	None.
EntityRelationshipTypeEntryID	Filter by EntityRelationshipTypeEntryID	integer	None.
IncludeActive	Include records where RecordState == RecordState.Active	boolean	None.
IncludeInactive	Include records where RecordState == RecordState.Inactive	boolean	None.
IncludeDeleted	Include records where RecordState == RecordState.Deleted	boolean	None.
IncludeError	Include records where RecordState == RecordState.CreatedInError	boolean	None.
CreatedDateUtcMin	Filter by CreatedDateUtcMin	date	None.
CreatedDateUtcMax	Filter by CreatedDateUtcMax	date	None.
LastUpdatedDateUtcMin	Filter by LastUpdatedDateUtcMin	date	None.
LastUpdatedDateUtcMax	Filter by LastUpdatedDateUtcMax	date	None.
Match	When searching by string, include records based on match type	MatchCriteriaStringType	None.

Body Parameters

None.

Response Information

Resource Description

List of ClientRelationshipDTOs

Collection of ClientRelationshipDTO

Name	Description	Type	Additional information
ClientRelationshipID	Client Relationship ID	integer	None.
ChildEntityID	Child Entity ID	integer	None.
ParentEntityID	Parent Entity ID	integer	None.
ParentEntityType	Parent Entity Type	EntityType	None.
ParentEntityTypeEntryID	Parent Entity Type Entry ID	integer	None.
ParentEntityTypeEntryValue	Parent Entity Type Entry Value	string	None.
ParentEntityTypeEntryType	Parent Entity Type Entry Type	integer	None.
ParentEntityName	Parent Entity Name	NameDTO	None.
ParentEntityAddresses	Parent EntityAddresses	AddressesDTO	None.
ParentEntityCommunicationMethods	Parent Entity Communication methods	CommunicationMethodsDTO	None.
BusinessUnits	Business units	Collection of ClientBusinessUnitDTO	None.
EntityRelationshipTypeEntryID	Entity Relationship Type Entry ID	integer	None.
RecordState	Record State	RecordState	None.
Created	Created	AuditDataDTO	None.
LastUpdated	Last Updated	AuditDataDTO	None.
EntityRelationshipTypeValue		string	None.
ClientRelationshipDetails	Client Relationship Details	ClientRelationshipDetailsDTO	None.
Extensions	Extensions attached to Contact Relationship	Collection of FormDataExtensionDto	None.
Comments	Comments	string	None.