ProRoster - Get the remaining rotation hours
API Url
Use it to get the number of hours remained in a rotation
GET
http://localhost:16010/ProMarkREST/web/ProRoster/plans/{id}/rotation-hours
Permissions: user
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 | String | Plan id. |
Query parameters
| Field | Type | Description |
|---|---|---|
dateoptional | Date | The date relativ to which the rotation is calculated. If empty, the default will be TODAY |
empIdsoptional | String | List of employee ids separated by comma. Used to return the data only for certain employees. If list contains employees that are not in the plan, they are ignored. |
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. |