ProRoster - Create template

API Url

Use it for creating a template with all the demands in the specified from and to dates.

POST
http://localhost:16010/ProMarkREST/rest/ProRoster/templates

Permissions: user

Parameter

FieldTypeDescription
requestObject

Main object containing the request data.

  dataObject

Object containg data to be uploaded.

    planTemplatesObject[]

List of demands.

      fromDate

Starting date of the template.

      idNumber

The Id of the template.

      isPrivateBoolean

If true then the template is private to the user.

      nameString

The name of the template.

      planIdNumber

The id of the plan.

      rolloutFromDate

Rollout date start.

      rolloutToDate

TRollout date end.

      toDate

Ending date of the template

Success example:

HTTP/1.1 200 OK
{
"response": {
"data": {
"demands": [
{
"planId": 2153908066,
"id": -2153908066,
"from": "2021-08-24",
"to": "2021-08-24",
"name": "Template 1",
"rolloutFrom": "2021-08-24",
"rolloutFrom": "2021-08-24",
"isPrivate": false
}
]
},
"errorCode": 0,
"errorMessage": ""
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.