Обновить календарь

Print Friendly, PDF & EmailРаспечатать/сохранить в PDF

PUT api/2.0/calendar/{calendarId}

Для этой функции требуется аутентификация.

Описание

Обновляет выбранный календарь с указанными в запросе параметрами (Название, описание, цвет и т.д.)

Параметры

НазваниеОписаниеТипПример
calendarId

sent in url

Идентификатор календарястроковыйтекст
name

sent in body

Название нового календарястроковыйтекст
description

sent in body

Описание нового календарястроковыйтекст
textColor

sent in body

Цвет текста нового событиястроковыйтекст
backgroundColor

sent in body

Новый цвет фона событиястроковыйтекст
timeZone

sent in body

Новый часовой пояс в календарестроковыйтекст
alertType

sent in body

Новый тип оповещения о событии в случае, если тип оповещения установлен по умолчаниюNever, FiveMinutes, FifteenMinutes, HalfHour, Hour, TwoHours, Day, Default
hideEvents

sent in body

Тип отображения: показать или скрыть события в календареЛогическийПравда
sharingOptions

sent in body

Новые возможности совместного использования календаря с другими пользователями.список вариантов совместного использования
iCalUrl

sent in body

Новый URL iCalстроковыйтекст

 

Пример
PUT api/2.0/calendar/some+text
Host: yourportal.r7-office.ru
Content-Type: application/json
Accept: application/json

{
  "name": "some text",
  "description": "some text",
  "textColor": "some text",
  "backgroundColor": "some text",
  "timeZone": "some text",
  "alertType": "never",
  "hideEvents": true,
  "sharingOptions": [
    {}
  ],
  "iCalUrl": "some text"
}

Возвращает

Обновленный календарь

Пример ответа

application/json

{
  "status": 0,
  "response": {
    "canEditTimeZone": false,
    "timeZone": {
      "offset": 0,
      "id": "UTC",
      "name": "UTC"
    },
    "defaultAlert": {
      "type": -1
    },
    "events": [
      {
        "owner": {
          "objectId": "2fdfe577-3c26-4736-9df9-b5a683bb8520",
          "name": "Valery Zykov"
        },
        "permissions": {
          "users": [
            {
              "objectId": "2fdfe577-3c26-4736-9df9-b5a683bb8520",
              "name": "Valery Zykov"
            }
          ]
        },
        "isEditable": false,
        "сanUnsubscribe": true,
        "isShared": true,
        "alert": {
          "type": -1
        },
        "repeatRule": "",
        "start": "2022-10-03T14:03:03.7761353Z",
        "end": "2022-10-03T14:03:03.7761353Z",
        "allDay": false,
        "description": "Event Description",
        "title": "Event Name",
        "objectId": "1",
        "sourceId": "calendarID",
        "status": 0,
        "hasAttachments": false
      }
    ],
    "owner": {
      "objectId": "2fdfe577-3c26-4736-9df9-b5a683bb8520",
      "name": "Valery Zykov"
    },
    "objectId": "1",
    "title": "Calendar Name",
    "description": "Calendar Description",
    "backgroundColor": "#000000",
    "textColor": "#ffffff",
    "isEditable": true,
    "permissions": {
      "data": {
        "actions": [
          {
            "id": "read",
            "name": "Read only",
            "defaultAction": true
          }
        ],
        "items": [
          {
            "selectedAction": {
              "id": "read",
              "name": "Read only",
              "defaultAction": true
            },
            "canEdit": true,
            "isGroup": true,
            "name": "Everyone",
            "id": "2fdfe577-3c26-4736-9df9-b5a683bb8520"
          }
        ]
      }
    },
    "isShared": true,
    "canAlertModify": true,
    "isHidden": false,
    "isiCalStream": false,
    "isSubscription": false
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <canEditTimeZone>false</canEditTimeZone>
    <timeZone>
      <offset>0</offset>
      <id>UTC</id>
      <name>UTC</name>
    </timeZone>
    <defaultAlert>
      <type>-1</type>
    </defaultAlert>
    <events>
      <owner>
        <objectId>2fdfe577-3c26-4736-9df9-b5a683bb8520</objectId>
        <name>Valery Zykov</name>
      </owner>
      <permissions>
        <users>
          <objectId>2fdfe577-3c26-4736-9df9-b5a683bb8520</objectId>
          <name>Valery Zykov</name>
        </users>
      </permissions>
      <isEditable>false</isEditable>
      <сanUnsubscribe>true</сanUnsubscribe>
      <isShared>true</isShared>
      <alert>
        <type>-1</type>
      </alert>
      <repeatRule></repeatRule>
      <start>2022-10-03T14:03:03.7761353Z</start>
      <end>2022-10-03T14:03:03.7761353Z</end>
      <allDay>false</allDay>
      <description>Event Description</description>
      <title>Event Name</title>
      <objectId>1</objectId>
      <sourceId>calendarID</sourceId>
      <status>0</status>
      <hasAttachments>false</hasAttachments>
    </events>
    <owner>
      <objectId>2fdfe577-3c26-4736-9df9-b5a683bb8520</objectId>
      <name>Valery Zykov</name>
    </owner>
    <objectId>1</objectId>
    <title>Calendar Name</title>
    <description>Calendar Description</description>
    <backgroundColor>#000000</backgroundColor>
    <textColor>#ffffff</textColor>
    <isEditable>true</isEditable>
    <permissions>
      <data>
        <actions>
          <id>read</id>
          <name>Read only</name>
          <defaultAction>true</defaultAction>
        </actions>
        <items>
          <selectedAction>
            <id>read</id>
            <name>Read only</name>
            <defaultAction>true</defaultAction>
          </selectedAction>
          <canEdit>true</canEdit>
          <isGroup>true</isGroup>
          <name>Everyone</name>
          <id>2fdfe577-3c26-4736-9df9-b5a683bb8520</id>
        </items>
      </data>
    </permissions>
    <isShared>true</isShared>
    <canAlertModify>true</canAlertModify>
    <isHidden>false</isHidden>
    <isiCalStream>false</isiCalStream>
    <isSubscription>false</isSubscription>
  </response>
</result>