GET Events/Visit
Get events 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. |
| EventIDs |
Filter by EventIDs |
Collection of integer |
None. |
| RoleIDs |
Filter by RoleIDs |
Collection of integer |
None. |
| BusinessUnits |
Filter by BusinessUnit(s) |
Collection of integer |
None. |
| SubType |
Filter by SubType |
EventSubType |
None. |
| EventRecurrenceID |
Filter by EventRecurrenceID |
integer |
None. |
| ServiceID |
Filter by ServiceID |
integer |
None. |
| PrimaryServiceProviderEntityID |
Filter by PrimaryServiceProviderEntityID |
integer |
None. |
| PrimaryServiceReceiverEntityID |
Filter by PrimaryServiceReceiverEntityID |
integer |
None. |
| PrimaryGroupEntityID |
Filter by PrimaryGroupEntityID |
integer |
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. |
| Minutes |
Filter by Minutes |
integer |
None. |
| Priority |
Filter by Priority |
EventPriority |
None. |
| Status |
Filter by Status |
EventStatus |
None. |
| StatusReason |
Filter by StatusReason |
string |
None. |
| StatusLastUpdatedOnUtcMin |
Filter by StatusLastUpdatedOnUtcMin |
date |
None. |
| StatusLastUpdatedOnUtcMax |
Filter by StatusLastUpdatedOnUtcMax |
date |
None. |
| StatusLastUpdatedBy |
Filter by StatusLastUpdatedBy |
string |
None. |
| StatusLastUpdatedByUserID |
Filter by StatusLastUpdatedByUserID |
integer |
None. |
| ServiceName |
Filter by Service Name |
string |
None. |
| Comments |
Filter by Comments |
string |
None. |
| PercentComplete |
Filter by PercentComplete |
byte |
None. |
| VerificationStatus |
Filter by VerificationStatus |
EventVerificationStatus |
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. |
| MaxRows |
Max Rows |
integer |
None. |
| ReverseSortOrder |
Reverse Sort Order |
boolean |
None. |
| EventShiftCodeID |
Filter by EventShiftCodeID |
integer |
None. |
| Statuses |
Filter by Statuses |
Collection of EventStatus |
None. |
| IncludeCurrentBedLocation |
Include the information about current location (bed) |
boolean |
None. |
| IncludeCurrentAddressLocation |
Include the information about current location (address) |
boolean |
None. |
| IncludeNextOccurrence |
Include next occurrence |
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
List of VisitDTOs
Collection of VisitDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| EventID |
Event ID |
integer |
None. |
| BUID |
BUID |
integer |
None. |
| SubType |
Sub Type |
EventSubType |
None. |
| EventRecurrenceID |
Event Recurrence ID |
integer |
None. |
| EventRecurrenceName |
Event Recurrence Name |
string |
None. |
| ServiceID |
Service ID |
integer |
None. |
| PrimaryServiceProviderEntityID |
Primary Service Provider Entity ID |
integer |
None. |
| PrimaryServiceProviderEntityName |
Primary Service Provider Entity Name |
NameDTO |
None. |
| PrimaryServiceReceiverEntityID |
Primary Service Receiver Entity ID |
integer |
None. |
| PrimaryServiceReceiverEntityName |
Primary Service Receiver Entity Name |
NameDTO |
None. |
| PrimaryGroupEntityID |
Primary Group Entity ID |
integer |
None. |
| PrimaryGroupEntityName |
Primary Group Entity Name |
string |
None. |
| RoleID |
Role ID |
integer |
None. |
| RoleName |
Role Name |
string |
None. |
| SortDateUtc |
Sort Date Utc |
date |
None. |
| StartDateUtc |
Start Date Utc |
date |
None. |
| StopDateUtc |
Stop Date Utc |
date |
None. |
| Minutes |
Minutes |
integer |
None. |
| Priority |
Priority |
EventPriority |
None. |
| Status |
Status |
EventStatus |
None. |
| StatusReason |
Status Reason |
string |
None. |
| StatusLastUpdatedOnUtc |
Status Last Updated On Utc |
date |
None. |
| StatusLastUpdatedBy |
Status Last Updated By |
string |
None. |
| StatusLastUpdatedByUserID |
Status Last Updated By User ID |
integer |
None. |
| ServiceName |
Subject |
string |
None. |
| Comments |
Comments |
string |
None. |
| PercentComplete |
Percent Complete |
byte |
None. |
| VerificationStatus |
Verification Status |
EventVerificationStatus |
None. |
| Entities |
Entities |
Collection of EntityEventDTO |
None. |
| Extensions |
Entities |
Collection of FormDataExtensionDto |
None. |
| Forms |
Forms |
Collection of EventFormDTO |
None. |
| RecordState |
Record State |
RecordState |
None. |
| Created |
Created |
AuditDataDTO |
None. |
| LastUpdated |
Last Updated |
AuditDataDTO |
None. |
| CurrentLocation |
Current location (bed or address) |
string |
None. |
| BusinessUnitName |
Business Unit Name |
string |
None. |
| Recurrence |
Stores Event Recurrence data |
EventRecurrenceDTO |
None. |
| IsOverdue |
Is Overdue |
boolean |
None. |
| NextOccurrenceDateUtc |
Next Occurrence Date Utc |
date |
None. |
| Summary |
Summary |
string |
None. |