ProRoster - Get approval registrations for a plan

API Url

Use it to get the published budgets

GET

http://localhost:16010/ProMarkREST/web/ProRoster/plans/{id}/approval-registrations

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.

Path parameters

Field	Type	Description
id	Number	Plan id.

Query parameters

Field	Type	Description
empIds`optional`	Number	List of employee ids separated by comma. Used to return the data only for certain employees. If list contains employees that are not in the plan, they are ignored.
from`optional`	String	The start date of the period inside a plan ( If not provided default is start of the current week).
to`optional`	String	The end date of the period inside a plan ( If not provided default is end of the current week).

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
approvedBy`optional`	String	The approval user if the transaction is approved
approvedDate`optional`	Date	The date when the transaction was approved
rejectedText`optional`	String	Rejection Text if transaction is rejected
rejectionCode`optional`	String	Rejection code if transaction is rejected
registrations`optional`	Object[]
approvalRegistrations`optional`	Object[]
approvalStatus	Number	The approval status of the planning figure
planFigureDescription	Date	Description of the planning figure.
planFigureId	String	Id of the planning figure.
planObjectId	Number	The plan Object Id.
date	Date	Date of the registrations
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": {
            "registrations": [
                {
                    "date": "2020-07-21",
                    "approvalRegistrations": [
                        {
                            "planObjectId": 2163995151,
                            "planFigureId": 1,
                            "planFigureDescription": "AUR budget 2 vs AUR budget Approval",
                            "approvalStatus": 3,
                            "rejectionTime" : "2020-09-09T17:07:15.000",
                            "rejectedBy"    : "OGG",
                            "rejectedText"  : "Not good to be over budget",
                            "rejectionCode" : "HVBA1"
                        }
                    ]
                }

                {
                    "date": "2020-09-23",
                    "approvalRegistrations": [
                        {
                            "planObjectId": 2163995151,
                            "planFigureId": 1,
                            "planFigureDescription": "AUR budget 2 vs AUR budget Approval",
                            "approvedBy": "OGG",
                            "approvalTime": "2020-09-09T17:09:45.000",
                            "approvalStatus": 2
                        },
                        {
                            "planObjectId": 2163995151,
                            "planFigureId": 3,
                            "planFigureDescription": "Ovidiu Approval",
                            "approvedBy": "OGG",
                            "approvalTime": "2020-09-09T17:09:45.000",
                            "approvalStatus": 2
                        }
                    ]
                }

            ]
        }
    }
}

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.