Группы методов для работы с событиями

Методы для работы с событиями распределены по следующим группам:

  • События — Events
  • Типы событий — EventTypes

События — Events

Доступные версии: V1, V2, V3.

API V2 (V1):

  • POST /api/v2/events — метод позволяет создать событие:
    • Событие создается одним запросом, даже если по типу события указаны дополнительные атрибуты
    • Можно не передавать:
      • Календарь (всегда создавать в Firm)
      • Location
      • Reminder
  • PUT /api/v2/events/{id} — метод позволяет обновить событие.
  • GET /api/v2/events/{id} — метод позволяет получить событие по идентификатору.
  • GET /api/v2/events — метод позволяет получить список событий (возможна фильтрации по: делу, дате начала события).
  • DELETE /api/v2/events/{id} — метод позволяет удалить событие по идентификатору.

API V3:

  • POST /api/v3/events — метод позволяет создать событие с заполненными доп. атрибутами:
    • Работа с созданными полями выполняется через связку Тег — Значение
    • Если у поля нет тега, то в качестве тега используется Id поля
  • PUT /api/v3/events/{id} — метод позволяет обновить событие с заполненными доп. атрибутами:
    • Работа с созданными полями выполняется через связку Тег — Значение
    • Если у поля нет тега, то в качестве тега используется Id поля
  • GET /api/v3/events/{id} — метод позволяет получить событие с заполненными доп. атрибутами по идентификатору:
    • Работа с созданными полями выполняется через связку Тег — Значение
    • Если у поля нет тега, то в качестве тега используется Id поля
    • В результате будут получены основные данные по событию и доп. атрибуты в виде Тег — Значение

Типы событий — EventTypes

Доступные версии: V1, V2:

  • GET /api/v2/eventTypes/{id} — метод позволяет получить подробную информацию по указанному типу события по идентификатору.
  • GET /api/v2/eventTypes — метод позволяет получить список всех типов событий.