GET Contacts/GroupStatus
Get contactGroupStatuses 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. |
| IncludeError |
Include records where RecordState == RecordState.Error |
boolean |
None. |
| Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
| StatusIDs |
Filter by StatusIDs |
Collection of integer |
None. |
| EntityID |
Filter by EntityID |
integer |
None. |
| BusinessUnitStatusID |
Filter by BusinessUnitStatusID |
integer |
None. |
| EntityTypes |
Filter by EntityTypes |
Collection of EntityType |
None. |
| BusinessUnits |
Filter by BusinessUnit(s) |
Collection of integer |
None. |
| GroupID |
Filter by GroupID |
integer |
None. |
| GroupIDs |
Filter by GroupIDs |
Collection of integer |
None. |
| BedID |
Filter by BedID |
integer |
None. |
| Status |
Filter by Status |
integer |
None. |
| StatusType |
Filter by StatusType |
string |
None. |
| StatusReason |
Filter by StatusReason |
string |
None. |
| StatusReason2 |
Filter by StatusReason2 |
string |
None. |
| StatusComments |
Filter by StatusComments |
string |
None. |
| StartDateUtcMin |
Filter by StartDateUtcMin |
date |
None. |
| StartDateUtcMax |
Filter by StartDateUtcMax |
date |
None. |
| StopDateUtcMin |
Filter by StopDateUtcMin |
date |
None. |
| StopDateUtcMax |
Filter by StopDateUtcMax |
date |
None. |
| MaxRows |
Limit number of rows |
integer |
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. |
| DateRangeUtcMin |
Filter by DateRangeUtcMin |
date |
None. |
| DateRangeUtcMax |
Filter by DateRangeUtcMax |
date |
None. |
| FormEntryID |
Filter by FormEntryID |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
List of ContactGroupStatusDTOs
Collection of ContactGroupStatusDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| StatusID |
Status ID |
integer |
None. |
| ContactID |
Contact ID |
integer |
None. |
| BUID |
BUID |
integer |
None. |
| GroupID |
Group ID |
integer |
None. |
| BusinessUnitStatusID |
Business Unit Status ID |
integer |
None. |
| StatusReason |
Status Reason |
string |
None. |
| StatusReason2 |
Status Reason2 |
string |
None. |
| StatusComments |
Status Comments |
string |
None. |
| ReferralSource |
Referral Source |
string |
None. |
| StartDateUtc |
Start Date Utc |
date |
None. |
| StopDateUtc |
Stop Date Utc |
date |
None. |
| RecordState |
Record State |
RecordState |
None. |
| Created |
Created |
AuditDataDTO |
None. |
| LastUpdated |
Last Updated |
AuditDataDTO |
None. |
| StatusName | string |
None. |
|
| FormEntryID | integer |
None. |
|
| Summary |
Summary |
string |
None. |