GET api/consumer/v1/calendarEvents/{calendarEventId}

Details of the Calendar Event

Request Information

URI Parameters

NameDescriptionTypeAdditional information
calendarEventId

ID of the Calendar Event

 integer

Required

Body Parameters

None

Response Information

Resource Description

Calendar Event details

CalendarEventDto
NameDescriptionTypeAdditional information
Entity

Entity

 integer

None
EntityFullName

Typology of entity

 string

None
Category

Category of element

 EventCategoryMinDto

None
Timesheet

Timesheet of element

 TimesheetMinDto

None
OwnerUser

Owner of element

 UserMinDto

None
StartDate

Start date of element

 DateDto

None
EndDate

End date of element

 DateDto

None
Progress

progress of element (range of values between 1-100)

 integer

None
State

State of element

 EventStateMinDto

None
Priority

Priority of element (range of values 1-3)

 ItemValueIntDto

None
Recurrence

Recurrence of element

 string

None
Reminder

Reminder of element

 string

None
Location

Location of element

 string

None
TimeZone

Time zone of element

 TimeZoneMinDto

None
Typology

Typology of the element (required)

 ItemValueIntDto

None
IsDay

Yes if Calendar Event is in day

 boolean

None
EventShareType

Event Share Type

 EventShareTypeMinDto

None
IsArchived

Yes if Calendar Event is archived

 boolean

None
Complexity

Card complexity (optional)

 integer

None
Params

Extra params (for internal use)

 string

None
Code

The short code of the element

 string

None
Description

The description of the element

 string

None
IsActive

True if the element is active, false otherwise

 boolean

None
Permissions

Permissions

 PermissionDto

None
CreationDate

Creation

 date

None
CreatedBy

The user who has made the insert

 UserMinDto

None
LastUpdateDate

Date of the last update

 date

None
LastUpdatedBy

The user who has made the last update

 UserMinDto

None
Id

Unique ID

 integer

None

Response Formats

application/json, text/json

Sample: 
{
  "Entity": 1,
  "EntityFullName": "sample string 1",
  "Category": {
    "Icon": "sample string 1",
    "Color": "sample string 2",
    "Code": "sample string 3",
    "Description": "sample string 4",
    "Id": 5
  },
  "Timesheet": {
    "StartDate": "2024-11-01T16:56:12.8742553+01:00",
    "EndDate": "2024-11-01T16:56:12.8742553+01:00",
    "Code": "sample string 3",
    "Description": "sample string 4",
    "Id": 5
  },
  "OwnerUser": {
    "Login": "sample string 1",
    "FullName": "sample string 2",
    "Avatar": "sample string 3",
    "Id": 4
  },
  "StartDate": null,
  "EndDate": null,
  "Progress": 2,
  "State": {
    "Code": "sample string 1",
    "Description": "sample string 2",
    "Id": 3
  },
  "Priority": {
    "Value": 1,
    "Description": "sample string 2"
  },
  "Recurrence": "sample string 3",
  "Reminder": "sample string 4",
  "Location": "sample string 5",
  "TimeZone": {
    "Description": "sample string 1",
    "Id": 2
  },
  "Typology": {
    "Value": 1,
    "Description": "sample string 2"
  },
  "IsDay": true,
  "EventShareType": {
    "Code": "sample string 1",
    "Description": "sample string 2",
    "Id": 3
  },
  "IsArchived": true,
  "Complexity": 1,
  "Params": "sample string 8",
  "Code": "sample string 9",
  "Description": "sample string 10",
  "IsActive": true,
  "Permissions": {
    "CanModify": true,
    "CanDelete": true
  },
  "CreationDate": "2024-11-01T16:56:12.8742553+01:00",
  "CreatedBy": {
    "Login": "sample string 1",
    "FullName": "sample string 2",
    "Avatar": "sample string 3",
    "Id": 4
  },
  "LastUpdateDate": "2024-11-01T16:56:12.8742553+01:00",
  "LastUpdatedBy": {
    "Login": "sample string 1",
    "FullName": "sample string 2",
    "Avatar": "sample string 3",
    "Id": 4
  },
  "Id": 12
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.