ProRoster - Get events for information calendar

API Url

Use it to get list of events in a selected period

GET

http://localhost:16010/ProMarkREST/web/ProRoster/plans/{id}/events

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": {
        "events": [
            {

                  "planId":"123,
                  "id": 1,
                  "name": "black friday",
                  "date": "2020-07-21",
                  "from": 0,
                  "to": -86400,
                  "isGlobal": false,
                  "isAllDay": 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.