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

• Участники — Participants
• Организационно-правовая форма (у участников) — LegalForms

Участники — Participants

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

В методах по работе с участниками доступны:

• Параметр CheckForDuplicates, который позволяет проверять данные участника по правилам определения дубликатов при создании или редактировании участника:
  • Параметр CheckForDuplicates не учитывает наличие флага Запрещать создавать дубликаты
  • Значения параметра:
    • True — при выборе значения участник будет проверяться на дубликаты
    • False — проверка участника на дубликаты выполняться не будет
  • Параметр доступен в методах публичного API, которые позволяют:
    • Создать участника
    • Обновить участника
    • Редактировать участника
• Новые системные поля карточки участника Телефон (PhoneMain, string, необязательный параметр) и Электронная почта (EmailMain, string, необязательный параметр) включены:
  • В ответ и запрос поддерживаемых версий методов:
    • Получение участников (GET /api/v2/participants)
    • Обновление участника
    • Создание участника
  • В ответ поддерживаемых версий методов:
    • Получение участника по идентификатору
    • Обновление участника
  • В V4 (на базе V3) для обработки новых системных полей в запросе (поля включаются в ответ):
    • Создание участника
    • Обновление участника
    • Редактирование участника

API V2 (V1):

• POST /api/v2/participants — метод позволяет создать участника с дополнительными атрибутами:
  • Доступно создать компанию (юридическое лицо) и физическое лицо
  • Создается участник, и сразу можно указать доп. атрибуты по нему
• PATCH /api/v2/participants/{id} — метод позволяет изменить участника с дополнительными атрибутами — доступно изменить поля участника:
  • Включая его обычные атрибуты
  • Через PATCH (по аналогии с делом)
• GET /api/v2/participants/{id} — метод позволяет получить подробной информации об указанном участнике по идентификатору (и по доп. атрибутам)
• GET /api/v2/participants — метод позволяет получить список участников:
  • Данные по контакту и дела, в которых есть контакты
  • Дополнительные атрибуты:
    • Name
    • Type (Individual или Company)
    • Email
    • Phone
    • LastName
    • FirstName
    • INN
    • KPP
  • Если не выбраны условия, то выдается весь список с паджинацией

API V3 — работа с созданными полями выполняется через связку Тег — Значение:

• POST /api/v3/participants — метод позволяет создать участника с дополнительными атрибутами.
• PUT /api/v3/participants/{id} — метод позволяет изменить участника с дополнительными атрибутами.
• GET /api/v3/participants/{id} — метод позволяет получить подробную информацию об указанном участнике с заполненными доп. атрибутами по идентификатору.
• DELETE /api/v3/participants/{id} — метод позволяет удалить участника по идентификатору:
  • Удаление доступно при наличии доступа на изменение секции Участники
  • При удалении проверяются права на изменение дел, в которых этот участник фигурирует — если нет прав на хотя бы одно из дел, то участник не будет удален
• PUT /api/v3/participants/ExcludeParticipantFromProject — метод позволяет исключить участника из дела/объекта:
  • Если Id role in object не указан, участник исключается со всеми ролями
  • Список всех зарегистрированных ролей в системе можно получить с помощью метода GET /api/v2/rolesInCase
  • Исключение доступно при наличии прав на редактирование дела

API V4:

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

Организационно-правовая форма — LegalForms

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

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