GET Events/Event/summary

Get event summaries 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.
Groups	Filter by Client's GroupIDs	Collection of integer	None.
BedGroups	Filter by Client's BedGroupIDs	Collection of integer	None.
RoleIDs	Filter by RoleIDs	Collection of integer	None.
BusinessUnits	Filter by BusinessUnit(s)	Collection of integer	None.
Type	Filter by Type	EventType	None.
Types	Filter by Types	Collection of EventType	None.
SubType	Filter by SubType	EventSubType	None.
SubTypes	Filter by SubTypes	Collection of EventSubType	None.
ExcludeSubType	Exclude by SubTypes	EventSubType	None.
EventRecurrenceID	Filter by EventRecurrenceID	integer	None.
ServiceID	Filter by ServiceID	integer	None.
PrimaryServiceProviderEntityID	Filter by PrimaryServiceProviderEntityID	integer	None.
PrimaryServiceProviderEntityRoles		boolean	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.
DateRangeUtcMin	Filter by DateRangeUtcMin	date	None.
DateRangeUtcMax	Filter by DateRangeUtcMax	date	None.
Minutes	Filter by Minutes	integer	None.
Priority	Filter by Priority	EventPriority	None.
DueDateUtcMin	Filter by DueDateUtcMin	date	None.
DueDateUtcMax	Filter by DueDateUtcMax	date	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.
Subject	Filter by Subject	string	None.
Details	Filter by Details	string	None.
Comments	Filter by Comments	string	None.
PercentComplete	Filter by PercentComplete	byte	None.
VerificationStatus	Filter by VerificationStatus	EventVerificationStatus	None.
Notify	Filter by Notify	boolean	None.
NotifyDateUtcMin	Filter by NotifyDateUtcMin	date	None.
NotifyDateUtcMax	Filter by NotifyDateUtcMax	date	None.
NotifyUserID	Filter by NotifyUserID	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.
MaxRows	Limit number of 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.
MinimumPayload	Minimum number of fields retrieved from the call, i.e.: EventID and BUID	boolean	None.
EntityEventTemplateID	Filter by EntityEventTemplateID	integer	None.
EventForms	Filter by Event Forms	FindEventFormsCriteria	None.
IsOverdueOnly	Filter by Is Overdue Only	boolean	None.
IsOverdueOnlyEffectiveDateUtc	Filter by Is Overdue Only	date	None.
IncludeRecurrence	Include Recurrence object on returned events	boolean	None.
AlwaysLoadEventForms	Always load form list from DAL (added for backwards compatibility where this didn't always happen)	boolean	None.
ShiftStartTimeUTC		date	None.
ShiftStopTimeUTC		date	None.
ParentFormName		string	None.
ActivityCategories		Collection of string	None.

Body Parameters

None.

Response Information

Resource Description

List of EventDTOs

Collection of EventDTO

Name	Description	Type	Additional information
EventID	Event ID	integer	None.
BUID	BUID	integer	None.
Type	Type	EventType	None.
SubType	Sub Type	EventSubType	None.
EventRecurrenceID	Event Recurrence ID	integer	None.
EventRecurrenceName	Event Recurrence Name	string	None.
EventRecurrenceSummary	Event Recurrence Summary	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.
PrimaryServiceReceiverName	Primary Service Receiver Name	string	None.
EntityDetails	Entity Details	Collection of EntityDetailDTO	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.
EventShiftCodeID	EventShiftCodeID	integer	None.
EventShiftCode	EventShiftCode	string	None.
Priority	Priority	EventPriority	None.
DueDateUtc	Due Date Utc	date	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.
Subject	Subject	string	None.
Details	Details	string	None.
Comments	Comments	string	None.
PercentComplete	Percent Complete	byte	None.
VerificationStatus	Verification Status	EventVerificationStatus	None.
Notify	Notify	boolean	None.
NotifyDateUtc	Notify Date Utc	date	None.
NotifyUserID	Notify User ID	integer	None.
NotifyUserName	Notify User Name	string	None.
NotifyState	NotifyState	EventNotifyState	None.
OrderDescription	Client Order Description	string	None.
ServiceName	Service Name	string	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.
CurrentLocationGroupID		integer	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.
EntityEventTemplateDetailID	EntityEventTemplateDetailID (used during generation from Entity Event Templates)	integer	None.
IsTimeSpecific	Is Time Specific	boolean	None.
Summary	Summary	string	None.
PrimaryServiceReceiverGroups		Collection of ClientGroupDTO	None.
ActivityCategory	Activity Category	string	None.
ActivityType	Activity Type	string	None.
IntegrationSource	Integration Source	IntegrationSource	None.
SubmissionType	Submission Type, None	SubmissionType	None.