ProRoster - Create snapshot

API Url

Use it to create a snapshot

POST

http://localhost:16010/ProMarkREST/rest/ProRoster/plans/{planId}/snapshots

Permissions: user

Path parameters

Field	Type	Description
planId	Number	The plan's unique identifier.

Parameter

Field	Type	Description
request	Object	Main object containing the request data.
data	Object	Object containg data to be uploaded.
snapshots	Object	Snapshot
from	Date	Starting date of the snapshot.
isPrivate	Boolean	If true then the snapshot is private to the user
name	String	The name of the snapshot.
planId	Number	The id of the plan.
to	Date	Ending date of the snapshot

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
snapshots	Object[]	List of snapshots.
from	Date	Starting date of the snapshot.
isPrivate	Boolean	If true then the snapshots is private to the user.
name	String	The name of the snapshots.
planId	Number	The id of the plan.
to	Date	Ending date of the snapshot.
version	Number	The snapshot version.
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": {
            "snapshots": [
             {
                 "planId": 2164573937,
                 "version": 33,
                 "from": "2020-02-28",
                 "to": "2020-03-05",
                 "name": "test1",
                 "user": "TEST",
                 "isPrivate": true
             }
            ]
        },
        "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.