ProRoster - Get manning for a plan

API Url

Use it to get informations about the manning in a plan

GET

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

Permissions: user

Path parameters

Field	Type	Description
planId	Number	Plan id.

Query parameters

Field	Type	Description
empIds`optional`	String	List with employee ids of the plan
from`optional`	Date	From date, default = TODAY
to`optional`	Date	To date, default = TODAY

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
manning	Object[]
date	Date	The date for manning
values	Object
actualEmployees	Number[24]	An array with size 24 that contains the actual number of employess
minimumEmployees	Number[24]	An array with size 24 that contains the number of employess for each hour of the day based on the min manning setup
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": {
            "manning": [
                {
                    "date": "2020-12-22",
                    "values": {
                        "minimumEmployees": [0,1,2,3,4,8,5,7,9,3,8,13,15,12,14,15,16,17,17,18,19,19,16,10],
                        "actualEmployees": [0,0,0,0,0,0,0,0,5,5,5,5,5,5,5,5,5,0,0,0,0,0,0,0]
                    }
                },
                {
                    "date": "2020-12-23",
                    "values": {
                        "minimumEmployees": [0,1,2,3,4,8,5,7,9,3,8,13,15,12,14,15,16,17,17,18,19,19,16,10],
                        "actualEmployees": [0,0,0,0,0,0,0,0,5,5,5,5,5,5,5,5,5,0,0,0,0,0,0,0]
                    }
                }
            ]
        }
    }
}

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.