ProRoster - Get minimum manning template

API Url

Use it to get informations for a minimum manning template

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

Request headers

FieldTypeDescription
Accept-LanguageoptionalString

=en-GB Language use for localization.

X-ClientoptionalString

=Client type.

Allowed values:"Portal""Mobile""Admin"
X-RoleoptionalNumber

ProMark role (1: Employee, 2: User).

Allowed values:{12}
X-WebPart-IdoptionalNumber

Unique web-part identifier.

Path parameters

FieldTypeDescription
planIdNumber

Plan id.

templateIdNumber

Template id

Query parameters

FieldTypeDescription
fromoptionalDate

Start date for the minimum manning list

tooptionalDate

End date for the minimum manning list

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

    planMinManningObject[]
      dateDate

The minimum manning date

      idNumber

Template id

      minManningNumber[24]

An array with size 24 that contains the number of employess for each hour of the day

      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.