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

FieldTypeDescription
forceDeleteoptionalLogical

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.

idNumber

The Demands's unique identifier.

revertoptionallogical

If true then revert the plan demand.

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  errorCodeNumber

Error code.

  errorMessageString

Error description.

Error example when a Plan Demand does not exist :

{
"response": {
"errorCode": 1,
"errorMessage": "The selected demand does not exist."
}
}