ProRoster - Get status of AI Auto assignment for the plan

API Url

Used to get the status of all AI Auto assignment for the plan

GET

http://localhost:16010/ProMarkREST/web/ProRoster/plans/{planId}/automations

Permissions: user

Path parameters

Field	Type	Description
planId	Number	The plan Id.

Query parameters

Field	Type	Description
empIds`optional`	String	Comma seperated list of employee ids. if not sent the employees of the current plans are loaded.
from`optional`	Date	Start of the period
to`optional`	Date	End of the period

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
status	Object[]
from	Date	Start Date of the simulation
id	Number	Id of the simulation
planId	Number	Unique id of the plan
read	Boolean	True if the status was read
snapshotId	Number	The Id of the snapshot where the auto assignment will be saved.
started	DateTime	The date and time of when the simulation was started.
to	Date	End Date of the simulation
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": {
         "status": [
             {
                 "id": 21321354,
                 "from": "2021-11-04",
                 "to": "2021-11-11",
                 "planId": 132130,
                 "read": false,
                 "snapshotId": 1,
                 "started" : 2021-11-04 10:30:00 
             }
         ]   
      },
      "erorCode": 0,
      "errorMessage": ""
   }
}