NameDescriptionTypeAdditional information
PersonId

Unique identification of the person in the system. The scheduled action record is uniquely identified by "PersonId", "SalaryElementExtCode", "DateTo" and "DateFrom".

string

Required

String length: inclusive between 0 and 100

SalaryElementExtCode

The code of the salary elements in the external system. The same external code of the salary element has to be defined in the system as well. The scheduled action record is uniquely identified by "PersonId", "SalaryElementExtCode", "DateTo" and "DateFrom".

string

Required

String length: inclusive between 0 and 15

DateFrom

The begin (Date) of the scheduled action. The scheduled action record is uniquely identified by "PersonId", "SalaryElementExtCode", "DateTo" and "DateFrom". Only date is valid, time is ignored.

date

Required

Data type: Date

DateTo

The end (Date) of the scheduled action. The scheduled action record is uniquely identified by "PersonId", "SalaryElementExtCode", "DateTo" and "DateFrom". Only date is valid, time is ignored.

date

Required

Data type: Date

TimeFrom

The interval begin (Time) of the scheduled action. It is required parameter when parameter "ActionType" is set to "Interval" (value 3)

date

Data type: Time

TimeTo

The interval end (Time) of the scheduled action. It is required parameter when parameter "ActionType" is set to "Interval" (value 3)

date

Data type: Time

ApproverId

The unique identification of the approver in the system (The approver personal ID).

string

String length: inclusive between 0 and 100

ApprovalDate

The date of the approval

date

None.

Status

The status of the scheduled action. The meaning is : 0 - new; 1 - approved; 2 - waiting for cancel; 3 - reject; 4 - cancelled; 5 - deleted. Only status "approved" is supported in the request

integer

Required

Matching regular expression pattern: [1]

ActionType

The type of the scheduled action. The meaning is : 0 - day; 1 - half a day[begin]; 2 - half a day[end]; 3 - value; 5 - interval; 6 - maximal value; 7 - interval value; 8 - interval maximal value. Only "day", "half day[begin]", "half day[end]", value and interval types are supported. The action type can internally acquire values "maximal value", "interval value" and "interval maximal value" as well, but usage of them as WebAPI input parameters is not allowed.

integer

Required

Matching regular expression pattern: [0,1,2,3,5]

Text

The text of the request

string

String length: inclusive between 0 and 4000

Description

The description.

string

String length: inclusive between 0 and 4000

ValueDays

Value - Days

decimal number

None.

ValueTime

Value - Duration in minutes

integer

None.

IntervalBegin

Value - IntervalBegin (time in minutes since day begin. For example: time 08:00 is 480 minutes)

integer

None.

IntervalEnd

Value - IntervalEnd (time in minutes since day begin. For example: time 15:00 is 900 minutes)

integer

None.

InsertForEachDay

The scheduled action should by inserted for each day within requested time range. The meaning is : 0 - no; 1 - yes

integer

Matching regular expression pattern: [0,1]