GET Events/ShiftCode
Get eventShiftCodes 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. |
| EventShiftCodeIDs |
Filter by EventShiftCodeIDs |
Collection of integer |
None. |
| BusinessUnits |
Filter by BusinessUnits |
Collection of integer |
None. |
| Code |
Filter by Code |
string |
None. |
| Description |
Filter by Description |
string |
None. |
| DefaultTimes |
Filter by DefaultTimes |
boolean |
None. |
| DefaultStartTimeUtcMin |
Filter by DefaultStartTimeUtcMin |
date |
None. |
| DefaultStartTimeUtcMax |
Filter by DefaultStartTimeUtcMax |
date |
None. |
| DefaultStopTimeUtcMin |
Filter by DefaultStopTimeUtcMin |
date |
None. |
| DefaultStopTimeUtcMax |
Filter by DefaultStopTimeUtcMax |
date |
None. |
| StartTimeMin |
Filter by StartTimeMin |
time interval |
None. |
| StartTimeMax |
Filter by StartTimeMax |
time interval |
None. |
| StopTimeMin |
Filter by StopTimeMin |
time interval |
None. |
| StopTimeMax |
Filter by StopTimeMax |
time interval |
None. |
| Props |
Filter by Props |
Collection of Object |
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. |
Body Parameters
None.
Response Information
Resource Description
List of EventShiftCodeDTOs
Collection of EventShiftCodeDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| EventShiftCodeID |
Event Shift Code ID |
integer |
None. |
| Code |
Code |
string |
None. |
| Description |
Description |
string |
None. |
| DefaultTimes |
Default Times |
boolean |
None. |
| DefaultStartTimeUtc |
Default Start Time Utc |
date |
None. |
| DefaultStopTimeUtc |
Default Stop Time Utc |
date |
None. |
| BusinessUnits |
Business Units |
Collection of EventShiftCodeBusinessUnitDTO |
None. |
| StartTime |
Start Time |
time interval |
None. |
| StopTime |
Stop Time |
time interval |
None. |
| SortOrder |
Sort Order |
integer |
None. |
| Props |
Props |
Collection of Object |
None. |
| RecordState |
Record State |
RecordState |
None. |
| Created |
Created |
AuditDataDTO |
None. |
| LastUpdated |
Last Updated |
AuditDataDTO |
None. |