GET ClinicalUpdates/Overview/Contacts/Relationships
Get a list of Client Relationships that match the criteria.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| DateTimeUtcMin | date |
None. |
|
| DateTimeUtcMax | date |
None. |
|
| GroupID | integer |
None. |
|
| SubGroupIDs | Collection of integer |
None. |
|
| Data | Collection of ClinicalUpdateData |
None. |
|
| BUID | integer |
None. |
|
| NoteTypes | Collection of integer |
None. |
|
| DocumentFormNames | Collection of string |
None. |
|
| IncidentTypes | Collection of integer |
None. |
|
| IncidentSeverities | Collection of integer |
None. |
|
| InfectionTypes | Collection of integer |
None. |
|
| ClientIDs | Collection of integer |
None. |
|
| CarePlanNames | Collection of string |
None. |
|
| ChartFormNames | Collection of string |
None. |
|
| HazardTypes | Collection of integer |
None. |
|
| OutOfRangeFormEntriesOnly | boolean |
None. |
|
| IncludeMarkedInError | boolean |
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. |