Leave

Edit the details of a leave

Activity name : <a href="https://developer.loket.nl/Activities/PutLeaveByLeaveId" target="_blank">PutLeaveByLeaveId</a>

Edit the details of a leave

put/v2/providers/employers/employees/employments/leave/{leaveId}

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/employments/leave/{leaveId}
  • Auth
    none required

Path parameters

leaveIdstring uuid required

The unique identifier of the leave

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Request body

idstring uuid

The unique identifier of an object (GUID/UUID)

numberOfUnitsnumber double

The number of leave units requested

isAccrualboolean

Indicates whether the request is for accrual of leave.

  • false will result in a reduction of the employee's leave entitlement
  • true will result in an increase of the employee's leave entitlement
startDatestring date

The start date of the leave requested

endDatestring date

The end date of the leave requested (last day of the leave)

commentstring nullable

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "numberOfUnits": 8,
  "unitType": {
    "key": 1,
    "value": "Uren"
  },
  "startDate": "2017-11-01",
  "endDate": "2017-11-01",
  "leaveType": {
    "key": 1,
    "value": "Verlof (bovenwettelijk)",
    "balanceExceedsYear": true
  },
  "origin": {
    "leavePolicy": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "value": "Default leave Regulations",
      "leaveUnitType": {
        "key": 1,
        "value": "Uren"
      },
      "accrualType": {
        "key": 1,
        "value": "Jaar"
      }
    },
    "meansOfCreation": {
      "key": 1,
      "value": "individual"
    }
  },
  "comment": "some comment",
  "relatedLeaveRequest": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
  },
  "relatedLeave": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
  }
}

Response

OK

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "numberOfUnits": 8,
    "unitType": {
      "key": 1,
      "value": "Uren"
    },
    "startDate": "2017-11-01",
    "endDate": "2017-11-01",
    "leaveType": {
      "key": 1,
      "value": "Verlof (bovenwettelijk)",
      "balanceExceedsYear": true
    },
    "origin": {
      "leavePolicy": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "value": "Default leave Regulations",
        "leaveUnitType": {
          "key": 1,
          "value": "Uren"
        },
        "accrualType": {
          "key": 1,
          "value": "Jaar"
        }
      },
      "meansOfCreation": {
        "key": 1,
        "value": "individual"
      }
    },
    "comment": "some comment",
    "relatedLeaveRequest": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
    },
    "relatedLeave": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
    }
  }
}

Changes

No recorded changes to this operation across all 6 revisions of this API.