ProRoster - Update multiple shifts

API Url

Use it for editing multiple shifts in ProRoster.

PUT

http://localhost:16010/ProMarkREST/rest/ProRoster/shifts

Permissions: user

Query parameters

Field	Type	Description
forceAssign	Logical	True = Will ignore the warning. False = Return warnings for partial absence overlap and availability.

Parameter

Field	Type	Description
request	Object	Main object containing the request data.
data	Object	Object containg data to be uploaded.
shifts	Object[]	Collection of shifts.
date	Date	The date of the shift.
dayProfile`optional`	Object[]	The day profile object.
id	String	Day profile ID.
department`optional`	Object[]	The department object.
id	String	Id of the department.
empId	String	The Id of the employee.
group`optional`	Object[]	The group object.
id	String	Id of the group.
id	String	The Id of the shift.
normalTime`optional`	Object[]	Normal time interval for variable day profiles.
endTime	Number	End time of the interval in seconds.
startTime	Number	Start time of the interval in seconds.
planId	Number	The Id of the plan.

Request example:

{  
    "request":{  
        "data":{
            "shifts": [
             {
                 "id": "216313325283324587160",
                 "empId": "1000",
                 "date": "2019-06-12",
                 "planId": 2163133252,
                 "dayProfile": [
                     {
                         "id": "FLEX"
                     }
                 ],
                 "attendanceTime": [
                     {
                         "startTime": 39600,
                         "endTime": 50400
                     }
                 ],
                 "department": [
                     {
                         "id": "SUMMERDP"
                     }
                 ],
                 "group": [
                     {
                         "id": "1
                     }
                 ]
             }
         ]
        }
    }
}

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
shifts`optional`	Object[]	Collection of shifts (only when expand=shifts).
attendanceTime`optional`	Object[]	Attendancetime interval of the shift.
endTime`optional`	Number	End time of the interval in seconds.
startTime`optional`	Number	Start time of the interval in seconds.
date	Date	The date of the shift.
dayProfile`optional`	Object[]	The day profile object.
backColor`optional`	String	BackGround color.
description	String	Description of the day profile.
endTime`optional`	Number	Normal time end of day profile.
foreColor`optional`	String	ForeGround color.
id	String	Day profile ID.
isVariable	Boolean	True if day profile is variable.
startTime`optional`	Number	Normal time start of day profile.
department`optional`	Object[]	The department object.
description`optional`	String	Description of the department.
id	String	Id of the department.
empId	String	The Id of the employee.
group`optional`	Object[]	The group object.
description`optional`	String	Description of the group.
id	String	Id of the group.
id	String	The Id of the shift.
isNew	Boolean	True if shift is just created False if not.
isPublished	Boolean	True if shift is published False if not.
normalTime`optional`	Object[]	Normal time interval for variable day profiles.
endTime`optional`	Number	End time of the interval in seconds.
startTime`optional`	Number	Start time of the interval in seconds.
planId	Number	The Id of the plan.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example

HTTP/1.1 200 OK
{
    "response": {
        "data": {
             "shifts": [
             {
                 "id": "216313325283324587160",
                 "empId": "933",
                 "date": "2019-06-12",
                 "planId": 2163133252,
                 "isPublished": false,
                 "isNew": false,
                 "dayProfile": [
                     {
                         "id": "FLEX",
                         "startTime": 28800,
                         "endTime": 57600,
                         "description": "Fixed/flex",
                         "isVariable": false,
                         "foreColor": "FFFFFF",
                         "backColor": "5032F5"
                     }
                 ],
                 "attendanceTime": [
                     {
                         "startTime": 39600,
                         "endTime": 50400
                     }
                 ],
                 "department": [
                     {
                         "id": "SUMMERDP",
                         "description": "Hotel Summer department"
                     }
                 ],
                 "group": [
                     {
                         "id": "1",
                         "description": "BH1"
                     }
                 ]
             }
         ]
        },
        "errorCode": 0,
        "errorMessage": ""
    }
}

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.