GET api/v3/Calendar/GetDepartmentCalendarItems

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of CalendarItem
NameDescriptionTypeAdditional information
CalendarItemId

integer

None.

Title

string

None.

Start

date

None.

End

date

None.

StartTimezone

string

None.

EndTimezone

string

None.

Description

string

None.

RecurrenceId

string

None.

RecurrenceRule

string

None.

RecurrenceException

string

None.

ItemType

integer

None.

IsAllDay

boolean

None.

Location

string

None.

SignupType

integer

None.

Reminder

integer

None.

LockEditing

boolean

None.

Entities

string

None.

RequiredAttendes

string

None.

OptionalAttendes

string

None.

IsAdminOrCreator

boolean

None.

CreatorUserId

string

None.

Attending

boolean

None.

Attendees

Collection of CalendarItemAttendee

None.

Response Formats

application/json

Sample:
[
  {
    "CalendarItemId": 1,
    "Title": "sample string 2",
    "Start": "2017-10-16T04:25:22.1439162+00:00",
    "End": "2017-10-16T04:25:22.1439162+00:00",
    "StartTimezone": "sample string 5",
    "EndTimezone": "sample string 6",
    "Description": "sample string 7",
    "RecurrenceId": "sample string 8",
    "RecurrenceRule": "sample string 9",
    "RecurrenceException": "sample string 10",
    "ItemType": 1,
    "IsAllDay": true,
    "Location": "sample string 12",
    "SignupType": 13,
    "Reminder": 14,
    "LockEditing": true,
    "Entities": "sample string 16",
    "RequiredAttendes": "sample string 17",
    "OptionalAttendes": "sample string 18",
    "IsAdminOrCreator": true,
    "CreatorUserId": "sample string 20",
    "Attending": true,
    "Attendees": [
      {
        "CalendarItemId": 1,
        "UserId": "sample string 2",
        "AttendeeType": 3,
        "Timestamp": "2017-10-16T04:25:22.1595367+00:00",
        "Note": "sample string 5"
      },
      {
        "CalendarItemId": 1,
        "UserId": "sample string 2",
        "AttendeeType": 3,
        "Timestamp": "2017-10-16T04:25:22.1595367+00:00",
        "Note": "sample string 5"
      }
    ]
  },
  {
    "CalendarItemId": 1,
    "Title": "sample string 2",
    "Start": "2017-10-16T04:25:22.1439162+00:00",
    "End": "2017-10-16T04:25:22.1439162+00:00",
    "StartTimezone": "sample string 5",
    "EndTimezone": "sample string 6",
    "Description": "sample string 7",
    "RecurrenceId": "sample string 8",
    "RecurrenceRule": "sample string 9",
    "RecurrenceException": "sample string 10",
    "ItemType": 1,
    "IsAllDay": true,
    "Location": "sample string 12",
    "SignupType": 13,
    "Reminder": 14,
    "LockEditing": true,
    "Entities": "sample string 16",
    "RequiredAttendes": "sample string 17",
    "OptionalAttendes": "sample string 18",
    "IsAdminOrCreator": true,
    "CreatorUserId": "sample string 20",
    "Attending": true,
    "Attendees": [
      {
        "CalendarItemId": 1,
        "UserId": "sample string 2",
        "AttendeeType": 3,
        "Timestamp": "2017-10-16T04:25:22.1595367+00:00",
        "Note": "sample string 5"
      },
      {
        "CalendarItemId": 1,
        "UserId": "sample string 2",
        "AttendeeType": 3,
        "Timestamp": "2017-10-16T04:25:22.1595367+00:00",
        "Note": "sample string 5"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfCalendarItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Calendar">
  <CalendarItem>
    <Attendees>
      <CalendarItemAttendee>
        <AttendeeType>3</AttendeeType>
        <CalendarItemId>1</CalendarItemId>
        <Note>sample string 5</Note>
        <Timestamp>2017-10-16T04:25:22.1595367+00:00</Timestamp>
        <UserId>sample string 2</UserId>
      </CalendarItemAttendee>
      <CalendarItemAttendee>
        <AttendeeType>3</AttendeeType>
        <CalendarItemId>1</CalendarItemId>
        <Note>sample string 5</Note>
        <Timestamp>2017-10-16T04:25:22.1595367+00:00</Timestamp>
        <UserId>sample string 2</UserId>
      </CalendarItemAttendee>
    </Attendees>
    <Attending>true</Attending>
    <CalendarItemId>1</CalendarItemId>
    <CreatorUserId>sample string 20</CreatorUserId>
    <Description>sample string 7</Description>
    <End>2017-10-16T04:25:22.1439162+00:00</End>
    <EndTimezone>sample string 6</EndTimezone>
    <Entities>sample string 16</Entities>
    <IsAdminOrCreator>true</IsAdminOrCreator>
    <IsAllDay>true</IsAllDay>
    <ItemType>1</ItemType>
    <Location>sample string 12</Location>
    <LockEditing>true</LockEditing>
    <OptionalAttendes>sample string 18</OptionalAttendes>
    <RecurrenceException>sample string 10</RecurrenceException>
    <RecurrenceId>sample string 8</RecurrenceId>
    <RecurrenceRule>sample string 9</RecurrenceRule>
    <Reminder>14</Reminder>
    <RequiredAttendes>sample string 17</RequiredAttendes>
    <SignupType>13</SignupType>
    <Start>2017-10-16T04:25:22.1439162+00:00</Start>
    <StartTimezone>sample string 5</StartTimezone>
    <Title>sample string 2</Title>
  </CalendarItem>
  <CalendarItem>
    <Attendees>
      <CalendarItemAttendee>
        <AttendeeType>3</AttendeeType>
        <CalendarItemId>1</CalendarItemId>
        <Note>sample string 5</Note>
        <Timestamp>2017-10-16T04:25:22.1595367+00:00</Timestamp>
        <UserId>sample string 2</UserId>
      </CalendarItemAttendee>
      <CalendarItemAttendee>
        <AttendeeType>3</AttendeeType>
        <CalendarItemId>1</CalendarItemId>
        <Note>sample string 5</Note>
        <Timestamp>2017-10-16T04:25:22.1595367+00:00</Timestamp>
        <UserId>sample string 2</UserId>
      </CalendarItemAttendee>
    </Attendees>
    <Attending>true</Attending>
    <CalendarItemId>1</CalendarItemId>
    <CreatorUserId>sample string 20</CreatorUserId>
    <Description>sample string 7</Description>
    <End>2017-10-16T04:25:22.1439162+00:00</End>
    <EndTimezone>sample string 6</EndTimezone>
    <Entities>sample string 16</Entities>
    <IsAdminOrCreator>true</IsAdminOrCreator>
    <IsAllDay>true</IsAllDay>
    <ItemType>1</ItemType>
    <Location>sample string 12</Location>
    <LockEditing>true</LockEditing>
    <OptionalAttendes>sample string 18</OptionalAttendes>
    <RecurrenceException>sample string 10</RecurrenceException>
    <RecurrenceId>sample string 8</RecurrenceId>
    <RecurrenceRule>sample string 9</RecurrenceRule>
    <Reminder>14</Reminder>
    <RequiredAttendes>sample string 17</RequiredAttendes>
    <SignupType>13</SignupType>
    <Start>2017-10-16T04:25:22.1439162+00:00</Start>
    <StartTimezone>sample string 5</StartTimezone>
    <Title>sample string 2</Title>
  </CalendarItem>
</ArrayOfCalendarItem>