GET Setup/Role

Get roles 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.
IncludeError	Include records where RecordState == RecordState.CreatedInError	boolean	None.
Match	When searching by string, include records based on match type	MatchCriteriaStringType	None.
RoleIDs	Filter by RoleIDs	Collection of integer	None.
BusinessUnits	Filter by BusinessUnits	Collection of integer	None.
CategoryID	Filter by CategoryID	integer	None.
RoleName	Filter by RoleName	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.
WorkerID		integer	None.
ClientOrderID		integer	None.

Body Parameters

None.

Response Information

Resource Description

List of RoleDTOs

Collection of RoleDTO

Name	Description	Type	Additional information
RoleID	Role ID	integer	None.
BusinessUnits	Business Units	Collection of RoleBusinessUnitDTO	None.
CategoryID	Category ID	integer	None.
CategoryName	Category Name	string	None.
RoleName	Role Name	string	None.
Props	Props	Collection of Object	None.
RecordState	Record State	RecordState	None.
Created	Created	AuditDataDTO	None.
LastUpdated	Last Updated	AuditDataDTO	None.