GET Events/Recurrence
Get eventRecurrences 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. |
| EventRecurrenceIDs |
Filter by EventRecurrenceIDs |
Collection of integer |
None. |
| BusinessUnits |
Filter by BusinessUnit(s) |
Collection of integer |
None. |
| Name |
Filter by Name |
string |
None. |
| Status |
Filter by Status |
EventRecurrenceStatus |
None. |
| Props |
Filter by Props |
Collection of Object |
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. |
| AutoGeneratedUntilDateUtc |
Filter by AutoGeneratedUntilDateUtc |
date |
None. |
| AutoGeneratedUntilDateUtcMin |
Filter by AutoGeneratedUntilDateUtcMin |
date |
None. |
| AutoGeneratedUntilDateUtcMax |
Filter by AutoGeneratedUntilDateUtcMax |
date |
None. |
| RecordState |
Filter by RecordState |
RecordState |
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. |
Body Parameters
None.
Response Information
Resource Description
List of EventRecurrenceDTOs
Collection of EventRecurrenceDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| EventRecurrenceID |
Event Recurrence ID |
integer |
None. |
| BUID |
BUID |
integer |
None. |
| Name |
Name |
string |
None. |
| Status |
Status |
EventRecurrenceStatus |
None. |
| Data |
Data |
EventRecurrenceDataDTO |
None. |
| StartDateUtc |
Start Date Utc |
date |
None. |
| StopDateUtc |
Stop Date Utc |
date |
None. |
| AutoGeneratedUntilDateUtc |
Auto Generated Until Date Utc |
date |
None. |
| RecordState |
Record State |
RecordState |
None. |
| Created |
Created |
AuditDataDTO |
None. |
| LastUpdated |
Last Updated |
AuditDataDTO |
None. |
| Summary |
Summary |
string |
None. |