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

FieldTypeDescription
idNumber

The plan unique identifier.

Query parameters

FieldTypeDescription
contextNumber

What to publish: 0=All (default if not sent). 1=Publish assigned demands to employee time queue, 2=Publish un-assigned demands to ESM

filterIdNumber

The filter id.

untilDateDate

The date that the plan is published until.

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

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"
}
}
}