ProRoster - Get changes.

API Url

This api is used to load changes in a plan in a period of time.

GET

http://localhost:16010/ProMarkREST/rest/ProRoster/plans/{id}/changes

Permissions: user

Path parameters

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

Query parameters

Field	Type	Description
empIds`optional`	Number	List of employee ids to get changes for , If not provided changes will load for all employees in the plan.
filter`optional`	String	Smart Filter's Josn.
filterId`optional`	Number	The Filter ID.
from	Date	Start of the period.
to	Date	End of the period.

Success 200

Field	Type	Description
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	Number	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.

Success example:

HTTP/1.1 200 OK
{
 "response": {
     "data": {
        "shifts": [
                {
                    "id": 802925200,
                    "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.