ProRoster - Get comparisons for planning figures

API Url

Use it to get the published budgets

GET

http://localhost:16010/ProMarkREST/web/ProRoster/plans/{id}/planning-figures

Permissions: user

Request headers

Field	Type	Description
Accept-Language`optional`	String	=en-GB Language use for localization.
X-Client`optional`	String	=Client type. Allowed values:`"Portal""Mobile""Admin"`
X-Role`optional`	Number	ProMark role (1: Employee, 2: User). Allowed values:`{12}`
X-WebPart-Id`optional`	Number	Unique web-part identifier.

Success 200

Field	Type	Description
id	Number	Plan id.

Success example:

{
    "response": {
        "data": {
            "planningFigures": [
                {
                    "date": "2020-07-21",
                    "values": [
                        {
                            "sequenceNo": 0,
                            "type": 0,
                            "value": -689.285714285,
                            "warning": 0,
                            "comparison": true
                        }
                    ]
                }
            ],
            "totals": [
                {
                    "sequenceNo": 0,
                    "type": 0,
                    "value": -689.285714285,
                    "warning": 0,
                    "comparison": true
                }
            ]
        }
    }
}

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.