POST attendance/cleanScheduledAction?Token={Token}

Remove scheduled action data of the person from the system. Application privilege "Edit" for licensed agenda "Requests" required. Functionality may also be restricted by record permission "Edit" of agenda "Person"

Request Information

Authorization

Authorization by token required

Availability

Method can be used

URI Parameters

Name	Description	Type	Additional information
Token	The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds	globally unique identifier	Required

Body Parameters

AttendanceCleanScheduledActionReq

Name	Description	Type	Additional information
PersonId	Unique identification of the person in the system. The scheduled action record uniquely identified by "PersonId", "SalaryElementExtCode", "DateTo" and "DateFrom" will be removed from the system.	string	Required String length: inclusive between 0 and 100
SalaryElementExtCode	The code of the salary elements in the external system. The scheduled action record uniquely identified by "PersonId", "SalaryElementExtCode", "DateTo" and "DateFrom" will be removed from the system.	string	Required String length: inclusive between 0 and 15
DateFrom	The begin (Date) of the scheduled action. The scheduled action record uniquely identified by "PersonId", "SalaryElementExtCode", "DateTo" and "DateFrom" will be removed from the system. Only date is valid, time is ignored. "DateTo" and "DateFrom has to match to scheduled action record dates in the system. Do not use those dates as time range values!	date	Required Data type: Date
DateTo	The end (Date) of the scheduled action. The scheduled action record uniquely identified by "PersonId", "SalaryElementExtCode", "DateTo" and "DateFrom" will be removed from the system. Only date is valid, time is ignored. "DateTo" and "DateFrom has to match to scheduled action record dates in the system. Do not use those dates as time range values!	date	Required Data type: Date
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. When mandatory parameters are not enough to identify scheduled action record for cleaning then optional parameter "ActionType" can be used for that	integer	Matching regular expression pattern: [0,1,2,3,5]
ValueDays	Value - Days. When mandatory parameters are not enough to identify scheduled action record for cleaning then optional parameter "ValueDays" can be used for that	decimal number	None.
ValueTime	Value - Duration in minutes. When mandatory parameters are not enough to identify scheduled action record for cleaning then optional parameter "ValueTime" can be used for that	integer	None.
IntervalBegin	Value - IntervalBegin (time in minutes since day begin. For example: time 08:00 is 480 minutes). When mandatory parameters are not enough to identify scheduled action record for cleaning then optional parameter "IntervalBegin" can be used for that	integer	None.
IntervalEnd	Value - IntervalEnd (time in minutes since day begin. For example: time 15:00 is 900 minutes). When mandatory parameters are not enough to identify scheduled action record for cleaning then optional parameter "IntervalEnd" can be used for that	integer	None.
Description	The description	string	String length: inclusive between 0 and 4000

Request Formats

application/json

Sample:

{"PersonId":"100200300","SalaryElementExtCode":"Holiday","DateFrom":"\/Date(1732147200000)\/","DateTo":"\/Date(1732320000000)\/","ActionType":null,"ValueDays":null,"ValueTime":null,"IntervalBegin":null,"IntervalEnd":null,"Description":"Cancelled by approver"}

application/xml

Sample:


<Request>
  <PersonId>100200300</PersonId>
  <SalaryElementExtCode>Holiday</SalaryElementExtCode>
  <DateFrom>2024-11-21T00:00:00Z</DateFrom>
  <DateTo>2024-11-23T00:00:00Z</DateTo>
  <ActionType d2p1:nil="true" xmlns:d2p1="http://www.w3.org/2001/XMLSchema-instance" />
  <ValueDays d2p1:nil="true" xmlns:d2p1="http://www.w3.org/2001/XMLSchema-instance" />
  <ValueTime d2p1:nil="true" xmlns:d2p1="http://www.w3.org/2001/XMLSchema-instance" />
  <IntervalBegin d2p1:nil="true" xmlns:d2p1="http://www.w3.org/2001/XMLSchema-instance" />
  <IntervalEnd d2p1:nil="true" xmlns:d2p1="http://www.w3.org/2001/XMLSchema-instance" />
  <Description>Cancelled by approver</Description>
</Request>

text/json

Sample:

{
  "PersonId": "sample string 1",
  "SalaryElementExtCode": "sample string 2",
  "DateFrom": "2024-11-21T13:12:35.4853572+01:00",
  "DateTo": "2024-11-21T13:12:35.4853572+01:00",
  "ActionType": 1,
  "ValueDays": 1.1,
  "ValueTime": 1,
  "IntervalBegin": 1,
  "IntervalEnd": 1,
  "Description": "sample string 5"
}

text/xml

Sample:

<Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PersonId>sample string 1</PersonId>
  <SalaryElementExtCode>sample string 2</SalaryElementExtCode>
  <DateFrom>2024-11-21T13:12:35.4853572+01:00</DateFrom>
  <DateTo>2024-11-21T13:12:35.4853572+01:00</DateTo>
  <ActionType>1</ActionType>
  <ValueDays>1.1</ValueDays>
  <ValueTime>1</ValueTime>
  <IntervalBegin>1</IntervalBegin>
  <IntervalEnd>1</IntervalEnd>
  <Description>sample string 5</Description>
</Request>

Response Information

Response Codes

Http Code	Error Number	Description
200 request succesfully done	0	Scheduled events of Person [{0}] cleaned successfully
400 bad request	1002	Entry parameter missing or parameter bindigs failed
401 unauthorized	1000	Token {0} not found
401 unauthorized	1001	Token {0} already expired
401 unauthorized	1006	Ip filter violated for ip client address [{0}]
401 unauthorized	1007	Ip filter [{0}] parsing failed
401 unauthorized	1008	Request rate policy violated for [{0}]
403 bad request	1128	Attendance Closing already done
403 server refuses fo fulfill the request	1	Db operation failed, agenda missing priviliges
403 server refuses fo fulfill the request	2	Db operation failed, record missing priviliges
403 server refuses fo fulfill the request	3	Db operation failed, Record duplicity
403 server refuses fo fulfill the request	4	Db operation failed, already changed by another user
403 server refuses fo fulfill the request	5	Db operation failed, already deleted by another user
403 server refuses fo fulfill the request	6	Db operation failed, database data consistence violation
403 server refuses fo fulfill the request	7	Db operation failed, operation can not be executed because another problems occured
403 server refuses fo fulfill the request	8	Db operation failed, licence violation
403 server refuses fo fulfill the request	1139	Privilege Edit of agenda Requests violated for [{0}]
404 required resource does not exist on the server	1100	PersonId [{0}] not found
404 required resource does not exist on the server	1127	Request for [Person {0}, TimeFrom {1}, TimeTo {2}] not found
404 required resource does not exist on the server	1129	Working time model or salary element not found
404 required resource does not exist on the server	1130	Working days not found
415 unsupported Media Type		The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported

Resource Description

BaseRespOfAttendanceCleanScheduledActionReq

Name	Description	Type	Additional information
Result		RequestResult	None.
Request		AttendanceCleanScheduledActionReq	None.

Response Formats

application/json

Sample:

{"Result":{"Message":"Processed with result: ExecOK","Code":0,"ModelStateErr":null},"Request":{"PersonId":"100200300","SalaryElementExtCode":"Holiday","DateFrom":"\/Date(1732147200000)\/","DateTo":"\/Date(1732320000000)\/","ActionType":null,"ValueDays":null,"ValueTime":null,"IntervalBegin":null,"IntervalEnd":null,"Description":"Cancelled by approver"}}

application/xml

Sample:


<Response>
  <Result>
    <Message>Processed with result: ExecOK</Message>
    <Code>0</Code>
  </Result>
  <Request>
    <PersonId>100200300</PersonId>
    <SalaryElementExtCode>Holiday</SalaryElementExtCode>
    <DateFrom>2024-11-21T00:00:00Z</DateFrom>
    <DateTo>2024-11-23T00:00:00Z</DateTo>
    <ActionType d3p1:nil="true" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance" />
    <ValueDays d3p1:nil="true" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance" />
    <ValueTime d3p1:nil="true" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance" />
    <IntervalBegin d3p1:nil="true" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance" />
    <IntervalEnd d3p1:nil="true" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance" />
    <Description>Cancelled by approver</Description>
  </Request>
</Response>

text/json

Sample:

{
  "Result": {
    "Message": "sample string 1",
    "Code": 2,
    "ModelStateErr": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Request": {
    "PersonId": "sample string 1",
    "SalaryElementExtCode": "sample string 2",
    "DateFrom": "2024-11-21T13:12:35.5009731+01:00",
    "DateTo": "2024-11-21T13:12:35.5009731+01:00",
    "ActionType": 1,
    "ValueDays": 1.1,
    "ValueTime": 1,
    "IntervalBegin": 1,
    "IntervalEnd": 1,
    "Description": "sample string 5"
  }
}

text/xml

Sample:

<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Result>
    <Message>sample string 1</Message>
    <Code>2</Code>
    <ModelStateErr>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </ModelStateErr>
  </Result>
  <Request>
    <PersonId>sample string 1</PersonId>
    <SalaryElementExtCode>sample string 2</SalaryElementExtCode>
    <DateFrom>2024-11-21T13:12:35.5009731+01:00</DateFrom>
    <DateTo>2024-11-21T13:12:35.5009731+01:00</DateTo>
    <ActionType>1</ActionType>
    <ValueDays>1.1</ValueDays>
    <ValueTime>1</ValueTime>
    <IntervalBegin>1</IntervalBegin>
    <IntervalEnd>1</IntervalEnd>
    <Description>sample string 5</Description>
  </Request>
</Response>