GET api/consumer/v1/calendarEvents/user/{userId}/timeoff/{startDate}/{endDate}

Get all user's timeOff filtered by a range date

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userId

Id of the user

 integer

Required
startDate

From date, format: YYYY-MM-DD

 date

Required
endDate

To date, format: YYYY-MM-DD

 date

Required

Body Parameters

None

Response Information

Resource Description

List of Timeoff

Collection of TimeOffDto
NameDescriptionTypeAdditional information
User

Owner of the timeoff

 UserMinDto

None
TimeOffType

Type of the timeoff

 TimeOffTypeMinDto

None
EntryDate

Creation date

 DateDto

None
StartDate

DateDto

None
EndDate

DateDto

None
ApproverResponseDate

Date of the approver response

 DateDto

None
Approver

Approver

 UserMinDto

None
UserNotes

Notes

 string

None
ApproverNotes

Approver notes

 string

None
IsInDays

True if the request is for one or more days

 boolean

None
Status

Status of the request

 TimeOffStatusMinDto

None
Id

Unique ID

 integer

None

Response Formats

application/json, text/json

Sample: 
[
  {
    "User": {
      "Login": "sample string 1",
      "FullName": "sample string 2",
      "Avatar": "sample string 3",
      "Id": 4
    },
    "TimeOffType": {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "Id": 3
    },
    "EntryDate": null,
    "StartDate": null,
    "EndDate": null,
    "ApproverResponseDate": null,
    "Approver": {
      "Login": "sample string 1",
      "FullName": "sample string 2",
      "Avatar": "sample string 3",
      "Id": 4
    },
    "UserNotes": "sample string 1",
    "ApproverNotes": "sample string 2",
    "IsInDays": true,
    "Status": {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "Id": 3
    },
    "Id": 4
  },
  {
    "User": {
      "Login": "sample string 1",
      "FullName": "sample string 2",
      "Avatar": "sample string 3",
      "Id": 4
    },
    "TimeOffType": {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "Id": 3
    },
    "EntryDate": null,
    "StartDate": null,
    "EndDate": null,
    "ApproverResponseDate": null,
    "Approver": {
      "Login": "sample string 1",
      "FullName": "sample string 2",
      "Avatar": "sample string 3",
      "Id": 4
    },
    "UserNotes": "sample string 1",
    "ApproverNotes": "sample string 2",
    "IsInDays": true,
    "Status": {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "Id": 3
    },
    "Id": 4
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.