GET Events/Event/summary/list

Get event summaries from criteria

Request Information

URI Parameters

NameDescriptionTypeAdditional information
IncludeActive

Include records where RecordState == RecordState.Active

boolean

None.

IncludeInactive

Include records where RecordState == RecordState.Inactive

boolean

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.

FormNames

Filter by Form Names(s)

Collection of string

None.

ExcludeFormNames

Excluded by Form Names(s)

Collection of string

None.

DateRangeUtcMin

Filter by DateRangeUtcMin

date

None.

DateRangeUtcMax

Filter by DateRangeUtcMax

date

None.

EventShiftCodeID

Filter by EventShiftCodeID

integer

None.

PrimaryServiceProviderEntityID

Filter by PrimaryServiceProviderEntityID

integer

None.

Types

Filter by SubTypes

Collection of EventType

None.

SubTypes

Filter by SubTypes

Collection of EventSubType

None.

Statuses

Filter by Statuses

Collection of EventStatus

None.

ShiftStartTimeUTC

date

None.

ShiftStopTimeUTC

date

None.

ShiftStartTimeOnly

time interval

None.

ShiftStopTimeOnly

time interval

None.

Sort

Collection of FindSortByCriteria

None.

Skip

integer

None.

Limit

integer

None.

Match

When searching by string, include records based on match type

MatchCriteriaStringType

None.

Body Parameters

None.

Response Information

Resource Description

List of EventDTOs

PagedDataResponseOfEventDTO
NameDescriptionTypeAdditional information
RecordsTotal

integer

None.

Data

Collection of EventDTO

None.

LastId

integer

None.