POST api/v1/assignments/{assignmentId}/cancel
Cancel an assignment.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| assignmentId |
Assignment Id |
globally unique identifier |
Required |
Body Parameters
AssignmentCancelModel
AssignmentCancelModel| Name | Description | Type | Additional information |
|---|---|---|---|
| CancelReasonId | integer |
Required |
|
| UnscheduledAbsence | boolean |
None. |
|
| UnscheduledAbsenceOption | integer |
None. |
|
| Comment | string |
None. |
|
| IsCancelInitiatedFromWorkforce | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"CancelReasonId": 1,
"UnscheduledAbsence": true,
"UnscheduledAbsenceOption": 1,
"Comment": "sample string 2",
"IsCancelInitiatedFromWorkforce": true
}
Response Information
Resource Description
ApiResponseModelOfAssignmentModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | ApiResponseDataModelOfAssignmentModel |
None. |
|
| Errors | Collection of string |
None. |
|
| Warnings | Collection of string |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.