ProRoster - Get absence matches employee

API Url

Use it for checking if an absence reason matches an employee.

GET

http://localhost:16010/ProMarkREST/rest/ProRoster/reasons/{id}/matching-employees

Permissions: user

Path parameters

Field	Type	Description
id	Number	The id of the reason to be verified.

Query parameters

Field	Type	Description
empIds`optional`	String	List of empIds separated with comma delimiter.
from`optional`	Date	Start date of the period to be checked. Default is TODAY.
to`optional`	Date	Date of the absence. Default is from + 7 days.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
matchingEmployees	Object[]	Array of employees
absenceScope	String	The scope of the supported absence. 0 = supports only full day absence 1 = supports only partial absence 2 = supports both
date	Date	The date in which the absence matches.
empId	String	Employee id
empName	String	Employee full name
empNo	String	Employee number
messages	Object[]	List of messages(info/warning/errors)
code	String	The code of the message.
level	String	The severity of the message. 0=success,1=info,2=warning,3=error
message	String	The text of the message.
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": {
            "matchingEmployees": [
                {
                    "empId": "833",
                    "empNo": "JDO",
                    "empName": "John Doe",
                    "absenceScope": 2,
                    "messages":[  
                       {  
                          "level": 2,
                          "code": 24,
                          "message": "The absence is overlapping some of the demands."
                       }
                    ]
                }
            ]
        },
        "errorCode": 0,
        "errorMessage": ""
    }
}