ProRoster - Delete a shift

API Url

Use it for deleting a shift.

DELETE
http://localhost:16010/ProMarkREST/rest/ProRoster/employees/{empId}/shifts/{id}

Permissions: user

Path parameters

FieldTypeDescription
empIdString

The unique identifier of the employee.

idString

The unique identifier of the shift.

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 there is only one shift in a day:

{
"response": {
"errorCode": 98,
"errorMessage": "You cannot have less than one shift in a day"
}
}