GET api/config/calendars/{id}

Get a calendar by id

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

CalendarConfigDetailsListItem

Name	Type	Additional information
SharingList	Collection of CalendarConfigShareListItem	None.
Id	integer	None.
calendarId	string	None.
calendarName	string	None.
calendarToken	string	None.
calenderRoleId	string	None.
User	CalendarConfigUserItem	None.

Response Formats

application/json, text/json

Sample:

{
  "SharingList": [
    {
      "UserCalendarId": 1,
      "CalendarId": 2,
      "CalendarName": "sample string 3",
      "SharedUser": {
        "Id": 1,
        "Name": "sample string 2",
        "Email": "sample string 3",
        "RoleId": 4,
        "RoleDescription": "sample string 5"
      },
      "SharingType": 4
    },
    {
      "UserCalendarId": 1,
      "CalendarId": 2,
      "CalendarName": "sample string 3",
      "SharedUser": {
        "Id": 1,
        "Name": "sample string 2",
        "Email": "sample string 3",
        "RoleId": 4,
        "RoleDescription": "sample string 5"
      },
      "SharingType": 4
    }
  ],
  "Id": 1,
  "calendarId": "sample string 2",
  "calendarName": "sample string 3",
  "calendarToken": "sample string 4",
  "calenderRoleId": "sample string 5",
  "User": {
    "Id": 1,
    "Name": "sample string 2",
    "Email": "sample string 3",
    "RoleId": 4,
    "RoleDescription": "sample string 5"
  }
}

application/xml, text/xml

Sample:

<CalendarModel.CalendarConfigDetailsListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GabineteDigital.Services.Models">
  <Id>1</Id>
  <User>
    <Email>sample string 3</Email>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <RoleDescription>sample string 5</RoleDescription>
    <RoleId>4</RoleId>
  </User>
  <calendarId>sample string 2</calendarId>
  <calendarName>sample string 3</calendarName>
  <calendarToken>sample string 4</calendarToken>
  <calenderRoleId>sample string 5</calenderRoleId>
  <SharingList>
    <CalendarModel.CalendarConfigShareListItem>
      <CalendarId>2</CalendarId>
      <CalendarName>sample string 3</CalendarName>
      <SharedUser>
        <Email>sample string 3</Email>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <RoleDescription>sample string 5</RoleDescription>
        <RoleId>4</RoleId>
      </SharedUser>
      <SharingType>4</SharingType>
      <UserCalendarId>1</UserCalendarId>
    </CalendarModel.CalendarConfigShareListItem>
    <CalendarModel.CalendarConfigShareListItem>
      <CalendarId>2</CalendarId>
      <CalendarName>sample string 3</CalendarName>
      <SharedUser>
        <Email>sample string 3</Email>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <RoleDescription>sample string 5</RoleDescription>
        <RoleId>4</RoleId>
      </SharedUser>
      <SharingType>4</SharingType>
      <UserCalendarId>1</UserCalendarId>
    </CalendarModel.CalendarConfigShareListItem>
  </SharingList>
</CalendarModel.CalendarConfigDetailsListItem>