ProRoster - Publish plan
API Url
Use it for publishing a plan
POST
http://localhost:16010/ProMarkREST/rest/ProRoster/plan/{id}/publisher
Permissions: user
Path parameters
| Field | Type | Description |
|---|---|---|
| id | Number | The plan unique identifier. |
Query parameters
| Field | Type | Description |
|---|---|---|
| context | Number | What to publish: 0=All (default if not sent). 1=Publish assigned demands to employee time queue, 2=Publish un-assigned demands to ESM |
| filterId | Number | The filter id. |
| untilDate | Date | The date that the plan is published until. |
Success 200
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
messageoptional | Object | Object containing response messages. |
| code | Number | Message code. |
| text | String | Message text. |
| type | String | Type of message. "warning""info" |
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. |
Error example:
HTTP/1.1 200 OK{"response": {"data": {"publisherErrors": [{"demandId": 2154023310,"date": "2018-07-22","description": "Group must be filled , the attribute is required","demandName": "FaresTest","empName": "fares","empId": "893"},{"demandId": 2154023310,"date": "2018-07-22","description": "Approval Group must be filled , the attribute is required","demandName": "FaresTest","empName": "fares","empId": "893"}]},"errorCode": 65,"errorMessage": "There are errors when publishing this plan"}}}