ProRoster - Delete a base demand.

API Url

DELETE

http://localhost:16010/ProMarkREST/rest/ProRoster/base-demands/{id}

Permissions: user

Path parameters

Field	Type	Description
id	Number	The Demand's unique identifier.

Query parameters

Field	Type	Description
forceDelete`optional`	Boolean	true = Ignore warnings (if demand is already in use) and delete the demand.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"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 Base Demand is used in active Plan Demands:

{
   "response": {
      "errorCode": 6,
      "errorMessage": "You are about to delete the selected Base Demand. This Base Demand is in use in active plans. If you delete it, it will no longer be available in the pallette of Base Demands."
   }
}