ProRoster - Simulate attendance time of employees from plan

API Url

Used to simulate the attendance time of employees from a plan

GET

http://localhost:16010/ProMarkREST/web/ProRoster/plans/{planId}/attendance-simulation

Permissions: user

Path parameters

Field	Type	Description
planId	Number	The plan Id.

Query parameters

Field	Type	Description
filteId`optional`	Number	The id of a filter
filterName`optional`	String	The name of a filter
fromDate	Datetime	The start date for the simulation interval
fromTime`optional`	Datetime	The start time for the simulation interval as seconds since midnigth
groupBy`optional`	Number	0 - no grouping, 1 - department, 2 - group
toDate	Datetime	The end date for the simulation interval
toTime`optional`	Datetime	The end time for the simulation interval as seconds since midnigth

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
employeeTime	Object[]
employee	Object	Employee object
deptDescr	String	The description of the department
deptId	String	The id of the department
empId	String	The internal id of the employee
empName	String	The full name of the employee
empNo	String	The employee number
groupDescr	String	The description of the group
groupId	String	The id of the group
simulatedTime	Number	The simulated time of the employee
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 with a single shift:

HTTP/1.1 200 OK
{
 "response": {
     "data": {
         "employeeTime": [
             {
                 "empId": "1313",
                 "empNo": "MGE",
                 "empName": "Monica Geller",
                 "deptId": "WHOUSEAUR",
                 "deptDescr": "AUR warehouse department",
                 "groupId": "WHGRPAUR",
                 "groupDesc": "AUR's Warehouse group",
                 "simulatedTime": 117600
             },
             {
                 "empId": "1314",
                 "empNo": "CBI",
                 "empName": "Chandler Bing",
                 "deptId": "WHOUSEAUR2",
                 "deptDescr": "AUR second warehouse department",
                 "groupId": "WHGRPAUR",
                 "groupDesc": "AUR's Warehouse group",
                 "simulatedTime": 106200
             }            
             ]
              }
          }
      }