ProRoster - Get minimum manning templates list

API Url

Use it to get a list of minimum manning templates

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

Permissions: user

Path parameters

FieldTypeDescription
planIdNumber

Plan id.

Query parameters

FieldTypeDescription
dateoptionalDate

Date of the minimum manning

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

    planMinManningObject[]
      dateoptionalDate

The minimum manning date, when date is given

      idNumber

Template id

      minManningoptionalNumber[24]

An array with size 24 that contains the number of employess for each hour of the day, when date is given

      nameString

Template name

      planIdNumber

Plan id

  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": {
"planMinManning": [
{
"id": 2254285028,
"planId": 2164886755,
"date": "2020-11-18,
"minManning": [null, null, null, null, null, null, null, null, null, 8, 5, 2, 7, 1, 4, 5, 7, null, null, null, null, null, null, null],
"name": "Template test"
}
]
}
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.