ProRoster - Get template

API Url

Use it for loading a template

GET

http://localhost:16010/ProMarkREST/rest/ProRoster/templates/{id}

Permissions: user

Path parameters

Field	Type	Description
id	Number	The template's unique identifier.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
planTemplates	Object[]	List of demands.
from	Date	Starting date of the template.
id	Number	The Id of the template.
isPrivate	Boolean	If true then the template is private to the user.
name	String	The name of the template.
planId	Number	The id of the plan.
rolloutFrom	Date	Rollout date start.
rolloutTo	Date	TRollout date end.
to	Date	Ending date of the template
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

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

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.