Список calendarView

  • Статья

Пространство имен: microsoft.graph

Получение вхождения, исключений и отдельных экземпляров событий в представлении календаря, определяемом диапазоном времени, из календаря пользователя по умолчанию или из другого календаря пользователя.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet
✅ ✅ ✅ ✅

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) Calendars.ReadBasic Calendars.Read, Calendars.ReadWrite
Делегированные (личная учетная запись Майкрософт) Calendars.ReadBasic Calendars.Read, Calendars.ReadWrite
Для приложений Calendars.ReadBasic Calendars.Read, Calendars.ReadWrite

HTTP-запрос

Экземпляр calendar по умолчанию для пользователя.

GET /me/calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}

Экземпляр calendar пользователя в экземпляре по умолчанию calendarGroup.

GET /me/calendars/{id}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendars/{id}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}

Календарь в определенном объекте calendarGroup.

GET /me/calendarGroups/{id}/calendars/{id}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}

Параметры запроса

В URL-адресе запроса укажите перечисленные ниже обязательные параметры запроса и их значения.

Параметр Тип Описание
startDateTime String Дата и время начала диапазона, представленные в формате ISO 8601. Например, "2019-11-08T19:00:00-08:00".
endDateTime String Дата и время окончания диапазона, представленные в формате ISO 8601. Например, "2019-11-08T20:00:00-08:00".

Значения startDateTime и endDateTime интерпретируются с помощью смещения часового пояса, указанного в значении, и не влияют на значение заголовка Prefer: outlook.timezone , если оно присутствует. Если в значении не указано смещение часового пояса, оно интерпретируется в формате UTC.

Этот метод также поддерживает некоторые параметры запросов OData для настройки отклика.

Примечание.

Свойства createdDateTime и lastModifiedDateTimeсобытия не поддерживают $select. Чтобы получить их значения, просто запросите calendarView, не применяя $select.

Заголовки запросов

Имя Тип Описание
Authorization string Bearer {token}. Обязательно.
Prefer: outlook.timezone string С помощью этого заголовка вы можете задать часовой пояс для времени начала и окончания в ответе. Если он не задан, эти значения времени возвращаются в формате UTC. Необязательное свойство.
Prefer: outlook.body-content-type string Формат возвращаемого свойства body. Возможные значения: "text" или "html". Заголовок Preference-Applied возвращается как подтверждение, если заголовок Prefer указан. Если заголовок не указан, свойство body возвращается в формате HTML. Необязательное свойство.

Текст запроса

Не указывайте текст запроса для этого метода.

Отклик

В случае успеха этот метод возвращает код отклика 200 OK и коллекцию объектов event в теле отклика.

Пример

Запрос

Ниже показан пример запроса.

GET https://graph.microsoft.com/v1.0/me/calendarView?startDateTime=2020-01-01T19:00:00-08:00&endDateTime=2020-01-02T19:00:00-08:00

Отклик

Ниже показан пример отклика. Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "originalStartTimeZone": "Pacific Standard Time",
      "originalEndTimeZone": "Pacific Standard Time",
      "responseStatus": {
        "response": "accepted",
        "time": "2016-10-19T10:37:00Z"
      },
      "iCalUId": "040000008200E00074C5B7101A82E00800000000D3D70B8A6A17D70100000000000000001000000074665914A06C3F49BB4B7D7EEE4304DA",
      "reminderMinutesBeforeStart": 15,
      "isReminderOn": true
    }
  ]
}