sick-leave-dossiers

Remove sick leave dossier

Removes a sick leave dossier based on the given id.

delete/sick-leave-dossiers/{id}

Request

  • Base URL: https://api.hoorayhr.io
  • URL: https://api.hoorayhr.io/sick-leave-dossiers/{id}
  • Auth: API key in header authorization

Path parameters

idinteger required

The id of the dossier to remove.

Response

The deleted sick leave dossier

idinteger

Unique id of the sick leave dossier

userIdinteger

Unique id of the user that the dossier is about

timezonestring

The time zone of the sick leave dossier. This will automatically be set to the time zone of the provided user through the "userId" field. Use the time-zones endpoint to fetch all supported timezones.

createdAtstring date-time

The creation date of the dossier

updatedAtstring date-time

The date that the dossier or any of the phases was last updated

Example response

{
  "id": 1,
  "userId": 2,
  "timezone": "Europe/Amsterdam",
  "createdAt": "2022-02-15T14:01:17.516Z",
  "updatedAt": "2022-02-23T14:01:17.516Z",
  "phases": [
    {
      "id": 1,
      "sickLeaveDossierId": 1,
      "userIdReported": 5,
      "userIdConfirmed": 5,
      "expectedTotal": 480,
      "calculatedExpectedTotal": 960,
      "actualTotal": 960,
      "startDate": "2025-02-01T15:00:00.000Z",
      "startDateEndTime": "2025-02-01T17:00:00.000Z",
      "expectedReturn": "2025-02-05",
      "calculatedExpectedReturn": "2025-02-20",
      "calculatedEndDate": "2025-02-20T09:00:00.000Z",
      "calculatedEndDateEndTime": "2025-02-20T12:00:00.000Z",
      "status": "REPORTED_SICK",
      "notes": "I've gotten food poisoning while staying at a hotel in Tokyo for the conference. I've sent an email to my direct colleagues to hand over some important work.",
      "createdAt": "2025-02-01T14:57:17.000Z",
      "updatedAt": "2022-02-20T15:01:52.000Z",
      "labels": [
        {
          "id": 5,
          "name": "Long term leave",
          "type": "LEAVE",
          "systemCategoryType": "car",
          "createdAt": "2022-02-23T14:01:17.516Z",
          "updatedAt": "2022-02-23T14:01:17.516Z"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.