GET Contacts/RelationshipDetail
Get contactRelationshipDetails from criteria
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| 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. |
| Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
| EntityIDs |
Filter by EntityIDs |
Collection of integer |
None. |
| EntityRelationshipIDs |
Filter by EntityRelationshipIDs |
Collection of integer |
None. |
| ChildEntityID |
Filter by ChildEntityID |
integer |
None. |
| ParentEntityID |
Filter by ParentEntityID |
integer |
None. |
| EntityRelationshipTypeEntryID |
Filter by EntityRelationshipTypeEntryID |
integer |
None. |
| Comments |
Filter by Comments |
string |
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. |
Body Parameters
None.
Response Information
Resource Description
List of ContactRelationshipDetailDTOs
Collection of ContactRelationshipDetailDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ContactID |
Contact ID |
integer |
None. |
| EntityRelationshipID |
Entity Relationship ID |
integer |
None. |
| SortOrder |
Sort Order |
integer |
None. |
| Comments |
Comments |
string |
None. |
| RecordState |
Record State |
RecordState |
None. |
| Created |
Created |
AuditDataDTO |
None. |
| LastUpdated |
Last Updated |
AuditDataDTO |
None. |
| Summary |
Summary |
string |
None. |