ProRoster - create and update events in the information calendar.

API Url

Use it to get list of events in a selected period

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

Permissions: user

Request headers

FieldTypeDescription
Accept-LanguageoptionalString

=en-GB Language use for localization.

X-ClientoptionalString

=Client type.

Allowed values:"Portal""Mobile""Admin"
X-RoleoptionalNumber

ProMark role (1: Employee, 2: User).

Allowed values:{12}
X-WebPart-IdoptionalNumber

Unique web-part identifier.

Success 200

FieldTypeDescription
idNumber

Plan id.

Success example:

{
"response": {
"data": {
"events": [
{
"PlanId":1234,
"id":2,
"name": 0,
"date": "2020-07-21",
"from": 0,
"to": -86400,
"isAllDay": true,
"isGlobal" : false
}
]
}
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.