GET api/Admin/ScheduledEvents/{id}

Gets the scheduled event with the specified id and all related scheduled event default properties.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Scheduled event id.

 integer

Required

Body Parameters

None.

Remarks

If the scheduled event is not found 404 Not found are returned.

Example

Gets the scheduled event with id 1 and all
related scheduled event default properties
GET: http://localhost/api/Admin/ScheduledEvent/6

Response Information

Resource Description

Returns 202 OK on success.

AdminGetScheduledEventResponse
NameDescriptionTypeAdditional information
Id

Scheduled event id.

 integer

None.
ScheduleEventDefaultProperties

Scheduled event default properties.

 Collection of AdminScheduleEventDefaultProperty

None.
StartDate

Scheduled event start date.

 date

None.
EndDate

Scheduled event end date.

 date

None.
StartTime

Scheduled event start time.

 time interval

None.
EndTime

Scheduled event end time.

 time interval

None.
Monday

Monday

 boolean

None.
Tuesday

Tuesday

 boolean

None.
Wednesday

Tuesday

 boolean

None.
Thursday

Tuesday

 boolean

None.
Friday

Tuesday

 boolean

None.
Saturday

Tuesday

 boolean

None.
Sunday

Tuesday

 boolean

None.
RecurringEventType

Tuesday

 string

None.
Note

Tuesday

 string

None.
Active

Tuesday

 boolean

None.
Closed

Closed

 boolean

None.
CreatedBy

Created by identifier.

 string

None.
CreatedDateTime

Created date and time.

 date

None.
ChangedBy

Changed by identifier.

 string

None.
ChangedDateTime

Changed date and time.

 date

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "ScheduleEventDefaultProperties": [
    {
      "Id": 1,
      "Key": "sample string 2",
      "Value": "sample string 3",
      "CreatedBy": "sample string 4",
      "CreatedDateTime": "2025-12-20T22:12:10.4070815+00:00",
      "ChangedBy": "sample string 6",
      "ChangedDateTime": "2025-12-20T22:12:10.4070815+00:00"
    },
    {
      "Id": 1,
      "Key": "sample string 2",
      "Value": "sample string 3",
      "CreatedBy": "sample string 4",
      "CreatedDateTime": "2025-12-20T22:12:10.4070815+00:00",
      "ChangedBy": "sample string 6",
      "ChangedDateTime": "2025-12-20T22:12:10.4070815+00:00"
    }
  ],
  "StartDate": "2025-12-20",
  "EndDate": "2025-12-20",
  "StartTime": "00:00",
  "EndTime": "00:00",
  "Monday": true,
  "Tuesday": true,
  "Wednesday": true,
  "Thursday": true,
  "Friday": true,
  "Saturday": true,
  "Sunday": true,
  "RecurringEventType": "sample string 6",
  "Note": "sample string 7",
  "Active": true,
  "Closed": true,
  "CreatedBy": "sample string 10",
  "CreatedDateTime": "2025-12-20T22:12:10.4070815+00:00",
  "ChangedBy": "sample string 12",
  "ChangedDateTime": "2025-12-20T22:12:10.4070815+00:00"
}

application/xml, text/xml

Sample: 
<AdminGetScheduledEventResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.Calendar.Service.DTO">
  <Active>true</Active>
  <ChangedBy>sample string 12</ChangedBy>
  <ChangedDateTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-20T22:12:10.4070815Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </ChangedDateTime>
  <Closed>true</Closed>
  <CreatedBy>sample string 10</CreatedBy>
  <CreatedDateTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-20T22:12:10.4070815Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDateTime>
  <EndDate>2025-12-20T22:12:10.4070815+00:00</EndDate>
  <EndTime>PT0.1234567S</EndTime>
  <Friday>true</Friday>
  <Id>1</Id>
  <Monday>true</Monday>
  <Note>sample string 7</Note>
  <RecurringEventType>sample string 6</RecurringEventType>
  <Saturday>true</Saturday>
  <ScheduleEventDefaultProperties>
    <AdminScheduleEventDefaultProperty>
      <ChangedBy>sample string 6</ChangedBy>
      <ChangedDateTime xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-12-20T22:12:10.4070815Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </ChangedDateTime>
      <CreatedBy>sample string 4</CreatedBy>
      <CreatedDateTime xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-12-20T22:12:10.4070815Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </CreatedDateTime>
      <Id>1</Id>
      <Key>sample string 2</Key>
      <Value>sample string 3</Value>
    </AdminScheduleEventDefaultProperty>
    <AdminScheduleEventDefaultProperty>
      <ChangedBy>sample string 6</ChangedBy>
      <ChangedDateTime xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-12-20T22:12:10.4070815Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </ChangedDateTime>
      <CreatedBy>sample string 4</CreatedBy>
      <CreatedDateTime xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-12-20T22:12:10.4070815Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </CreatedDateTime>
      <Id>1</Id>
      <Key>sample string 2</Key>
      <Value>sample string 3</Value>
    </AdminScheduleEventDefaultProperty>
  </ScheduleEventDefaultProperties>
  <StartDate>2025-12-20T22:12:10.4070815+00:00</StartDate>
  <StartTime>PT0.1234567S</StartTime>
  <Sunday>true</Sunday>
  <Thursday>true</Thursday>
  <Tuesday>true</Tuesday>
  <Wednesday>true</Wednesday>
</AdminGetScheduledEventResponse>