ProRoster - Delete a demand
API Url
Use it for deleting a Demand.
DELETE
http://localhost:16010/ProMarkREST/rest/ProRoster/demands/{id}
Permissions: user
Path parameters
| Field | Type | Description |
|---|---|---|
forceDeleteoptional | Logical | True = If employees have been assigned to the Demand, the employees are un-assigned from the Demand before the Demand is deleted. False = If employees have been assigned to the Demand, the routine ends with an error message. |
| id | Number | The Demands's unique identifier. |
revertoptional | logical | If true then revert the plan demand. |
Success 200
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
messageoptional | Object | Object containing response messages. |
| code | Number | Message code. |
| text | String | Message text. |
| type | String | Type of message. "warning""info" |
Error 4xx
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| errorCode | Number | Error code. |
| errorMessage | String | Error description. |
Error example when a Plan Demand does not exist :
{"response": {"errorCode": 1,"errorMessage": "The selected demand does not exist."}}