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
| Field | Type | Description |
|---|---|---|
Accept-Languageoptional | String | =en-GB Language use for localization. |
X-Clientoptional | String | =Client type. "Portal""Mobile""Admin" |
X-Roleoptional | Number | ProMark role (1: Employee, 2: User). {12} |
X-WebPart-Idoptional | Number | Unique web-part identifier. |
Path parameters
| Field | Type | Description |
|---|---|---|
| planId | Number | Plan id. |
| templateId | Number | Template id |
Query parameters
| Field | Type | Description |
|---|---|---|
fromoptional | Date | Start date for the minimum manning list |
tooptional | Date | End date for the minimum manning list |
Success 200
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| planMinManning | Object[] | |
| date | Date | The minimum manning date |
| id | Number | Template id |
| minManning | Number[24] | An array with size 24 that contains the number of employess for each hour of the day |
| name | String | Template name |
| planId | Number | Plan id |
messageoptional | Object | Object containing response messages. |
| code | Number | Message code. |
| text | String | Message text. |
| type | String | Type of message. "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
| 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. |