GET Workers/Role
Get WorkerBusinessUnitRoles 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. |
| EntityBusinessUnitRoleIDs |
Filter by EntityBusinessUnitRoleIDs |
Collection of integer |
None. |
| RoleID |
Filter by RoleID |
integer |
None. |
| EntityID |
Filter by EntityID |
integer |
None. |
| BusinessUnits |
Filter by BusinessUnit(s) |
Collection of 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. |
| StopDateUtcEventID |
Filter by StopDateUtcEventID |
integer |
None. |
| ReferenceNumber |
Filter by ReferenceNumber |
string |
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. |
Body Parameters
None.
Response Information
Resource Description
List of WorkerBusinessUnitRoleDTOs
Collection of WorkerBusinessUnitRoleDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| WorkerID |
Worker ID |
integer |
None. |
| EntityBusinessUnitRoleID |
Entity Business Unit Role ID |
integer |
None. |
| RoleID |
Role ID |
integer |
None. |
| RoleName |
Role Name |
string |
None. |
| BUID |
BUID |
integer |
None. |
| BusinessUnitName |
Business Unit Name |
string |
None. |
| StartDateUtc |
Start Date Utc |
date |
None. |
| StopDateUtc |
Stop Date Utc |
date |
None. |
| StopDateUtcEventID |
Stop Date Utc Event ID |
integer |
None. |
| ReferenceNumber |
Reference Number |
string |
None. |
| Props |
Props |
Collection of Object |
None. |
| RecordState |
Record State |
RecordState |
None. |
| Created |
Created |
AuditDataDTO |
None. |
| LastUpdated |
Last Updated |
AuditDataDTO |
None. |