ProRoster - Get employees that match with an assigned task

API Url

Use it to return a list of all employees of a plan that match a task on a date.

GET
http://localhost:16010/ProMarkREST/web/ProRoster/assigned-tasks/{taskId}/matching-employees

Permissions: user

Path parameters

FieldTypeDescription
taskIdNumber

Task id.

Query parameters

FieldTypeDescription
dateoptionalDate

Date of the task

empIdsoptionalString

List of employees.

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

    matchingEmployeesObject[]
      dateDate

Date whenthe task can be assigned

      emNameString

Employee name

      empIdString

Employee id

      empNoString

Employee number

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Success example:

HTTP/1.1 200 OK
{
"response": {
"data": {
"matchingEmployees": [
{
"empId": "1313",
"empNo": "MGE",
"empName": "Monica Geller",
"date": "2021-06-11"
},
{
"empId": "1314",
"empNo": "CBI",
"empName": "Chandler Bing",
"date": "2021-06-11"
},
{
"empId": "1316",
"empNo": "PBU",
"empName": "Phoebe Buffay 3",
"date": "2021-06-11"
}
]
}
}
}