POST shift/cancel
Cancels an existing shift. The shift have to be available or not deployed in order to be cancelled.| shiftId |
The unique Id for the shift that is to be cancelled. Example Values: "8a62d290-688d-41b8-a5a0-db8613835e9d" |
| recipientIds optional |
This parameter is an array of strings.
These recipient id strings are a subset of the recipient ids sent in the original CreateShift method request. Include this parameter
when the recipientNotification parameter is set to Specified (otherwise it will be ignored).
Example Values: ["1","2","3"] |
|
managerIds
optional |
This parameter is an array of strings.
These ManagerId strings are a subset of the ManagerIds sent in the original CreateShift method request.
Include this parameter when the Notify Managers parameter is set to TRUE and you want to notify only a subset of the ManagerIds originally included in the shift.
Example Values: ["1","2","3"] |
|
recipientNotification
optional |
Defines how recipients will be notified or not that the shift has been cancelled.
Accepted values are:
Example Values: All,Claimed,Specified,None |
|
notifyManagers
optional |
Specifies whether or not managers should be notified that the shift has been cancelled.
Example Values: true, false |
The following error codes are returned:
- 204 Missing request body: If the body with the parameters values is not present.
- 400 Shift id not found: If the shift id wasn't found in the system.
- 400 Shift changes not allowed for shifts with status: CURRENT_SHIFT_STATUS: If the shift status is neither Available or NotDeployed.
- 400 shiftId can not be empty: If no shiftId is specified.
- 400 Incorrect Media Type, only application/json is supported: If the request was made with another Content-Type header.
Example Request
POST http://shiftex.vortexconnectstage.com/api/shift/cancel HTTP/1.1
Accept: application/json; version=2.0
Content-Type: application/json
sessionId: wORaLP4wa8MbhK3psvNrEif3Cc8a1wtQvYgwTv52qnQ=
Content-Length: 217
Host: localhost
{
"shiftId": "8a62d290-688d-41b8-a5a0-db8613835e9d",
"recipientIds": [
"gfgg1"
],
"managerIds": [
"1000",
"1001"
],
"recipientNotification": "All",
"notifyManagers": false
}