POST Workers/Group?validateOnly={validateOnly}
Add workerGroup
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| validateOnly |
Validate data, but don't post it |
boolean |
Default value is False |
Body Parameters
EntityGroup data
WorkerGroupDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| WorkerID |
The unique identifier for the Worker record. |
integer |
None. |
| BUID |
The unique identifier for the Business Unit record. |
integer |
None. |
| GroupID |
The unique identifier for the Group record. |
integer |
None. |
| BusinessUnitStatusID |
The unique identifier for the Business Unit Status record. |
integer |
None. |
| StatusReason |
Status Reason Input from code table entries where TableName is "Worker Group Statuses", (). |
string |
None. |
| StatusReason2 |
Additional Status Reason (StatusReason2) Input from code table entries where TableName is "Worker Group Statuses 2", (). |
string |
None. |
| StatusComments |
Status Comments for the worker's group. |
string |
None. |
| StartDateUtc |
Start Date in UTC |
date |
None. |
| StopDateUtc |
Stop Date in UTC |
date |
None. |
| RecordState |
Record State, |
RecordState |
None. |
| ReferralSource |
The source of the referral for the business unit. Input from code table entries where TableName is "Referral Sources", (). |
string |
None. |
| Created |
The audit information for the creation of the record, including the creation date in UTC and the user who created it, . This field is readonly. |
AuditDataDTO |
None. |
| LastUpdated |
The audit information for the last update to the record, including the update date in UTC and the user who made the update, . This field is readonly. |
AuditDataDTO |
None. |
| StatusName |
The name of the current status of the group. |
string |
None. |
| GroupName |
Name of the group. |
string |
None. |
| BusinessUnitName |
Name of the business unit. |
string |
None. |
| IsSchedulable |
Indicates if the worker's group is schedulable. |
boolean |
None. |
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |