v1/absences/{id}

put https://shyftplan.com/api/v1/absences/{id}

Update an absence.

Path Params

int32

required

≥ 1

ID of the absence to be updated.

Body Params

user_email

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

authentication_token

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

company_id

int32

≥ 1

ID of the shyftplan account.

absence_reason_id

int32

≥ 1

ID of the absence reason.

days

float

≥ 0

Duration of the absence in working days.

ends_at

date-time

Date-time (ISO 8601) for the end of the object's span.

force_collision

boolean

Defaults to false

Should the absence be created in spite of conflicts with shifts or absences of the employee?

More info

This parameter has no effect when two settings in shyftplan are both disabled - these are:

Company profile > Shift schedules > Absence Conflicts
Company profile > Absences > Maximum number of absence days

Otherwise, this parameter has the following effect:

For a conflict with pre-existing absences:

If both force_collision and force_collision_and_remove are set to false, the new absence will not be created. Instead, an error will be saved.
If at least one of the force* parameters is set to true, the absence will be created.

For a conflict with shift assignments:

If both force_collision and force_collision_and_remove are set to false, the new absence will not be created. Instead, an error will be saved. The employee stays assigned to conflicting shifts.
If force_collision_and_remove is true then the absence will be created and the employee unassigned from conflicting shifts.
If force_collision_and_remove is false and "force_collision" is true then the absence is created, but the employee stays assigned to conflicting shifts.

force_collision_and_remove

boolean

Defaults to false

Should the absence be created in spite of conflicts with shifts or absences of the employee, and should the employee be unassigned from conflicting shifts?

More info

This parameter has no effect when two settings in shyftplan are both disabled - these are:

Company profile > Shift schedules > Absence Conflicts
Company profile > Absences > Maximum number of absence days

Otherwise, this parameter has the following effect:

For a conflict with pre-existing absences:

If both force_collision and force_collision_and_remove are set to false, the new absence will not be created. Instead, an error will be saved.
If at least one of the force* parameters is set to true, the absence will be created.

For a conflict with shift assignments:

If both force_collision and force_collision_and_remove are set to false, the new absence will not be created. Instead, an error will be saved. The employee stays assigned to conflicting shifts.
If force_collision_and_remove is true then the absence will be created and the employee unassigned from conflicting shifts.
If force_collision_and_remove is false and "force_collision" is true then the absence is created, but the employee stays assigned to conflicting shifts.

is_full_day

boolean

Is the absence spanning full days only?

notes

string

Note to be saved with the object.

paid

boolean

Determines whether the absence duration is counted as working time.

true: Only retrieve absences that are marked as 'paid' (absence counts as working time).
false: Only retrieve unpaid absences.

refuse_message

string

Note for the refusal of the absence.

starts_at

date-time

Date-time (ISO 8601) for the begin of the object's span.

state

string

State of the absence.

new: Absence application (by manager or employee) on which no decision has been made.
accepted: Approved absence (by manager).
refused: Application refused by a manager.
withdrawn: Application withdrawn by the employee.

absence_days_breakdown

array of objects

List of absence minutes per calendar day.

absence_days_breakdown

Responses

Response body

object

absence_reason_id

int32

required

≥ 1

ID of the absence reason.

absence_reason_type

string

Type of an absence reason.

time_account: External (managed outside shyftplan) time account absence reason type.
with_entitlement: Reason type for absences with a yearly entitlement per employee. Deductions from this entitlement are performed inside shyftplan.
without_entitlement: Reason type for absences with no fixed maximum entitlement per employee. Typical example of an absence reason with this type: Sickness.

time_account with_entitlement without_entitlement

can_manage

boolean

Can the API user manage this absence?

created_at

date-time

Date-time (ISO 8601) when the object was created.

days

float

≥ 0

Duration of the absence in working days.

deleted_at

date-time

Date-time (ISO 8601) when the object was deleted.

employment_id

int32

required

≥ 1

ID of an employment.

ends_at

date-time

Date-time (ISO 8601) for the end of the object's span.

file

Attachment file (<= 5MB)

file_name

string

Name of the attachment file.

file_uid

string

File ID for the attachment to the absence.

file_uploaded_at

date-time

Date-time (ISO 8601) value.

int32

required

≥ 1

ID of the absence.

is_full_day

boolean

Is the absence spanning full days only?

notes

string

Note to be saved with the object.

paid

boolean

Determines whether the absence duration is counted as working time.

true: Only retrieve absences that are marked as 'paid' (absence counts as working time).
false: Only retrieve unpaid absences.

refuse_message

string

Note for the refusal of the absence.

starts_at

date-time

Date-time (ISO 8601) for the begin of the object's span.

state

string

State of the absence.

new: Absence application (by manager or employee) on which no decision has been made.
accepted: Approved absence (by manager).
refused: Application refused by a manager.
withdrawn: Application withdrawn by the employee.

accepted new refused withdrawn

state_updated_at

date-time

Date-time (ISO 8601) when the object was created.

updated_at

date-time

Date-time (ISO 8601) when the object was created.

vacation_minutes

int32

≥ 0

Working minutes equivalent of an absence.

Language


xxxxxxxxxx
10
1
curl --request PUT \
2
     --url https://shyftplan.com/api/v1/absences/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "force_collision": false,
8
  "force_collision_and_remove": false
9
}
10
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully updated

404Couldn't find absence

422Carryover days are disabled for this Absence Reason