Документация

API

Формат запросов, ответов и справочник полей для интеграций.

ФорматОрганизацииПерсоналРесурсыГруппы услугУслугиКлиентыСобытияЗаписиКастомные поляФинансы

Группы услуг

Группы помогают разложить основные услуги по разделам в кабинете и виджете.

URL методов

Для работы с группами услуг используйте значение data=service_groups.

МетодURLОписание
GET/api/?mod=data&data=service_groupsПолучить список групп услуг текущей организации.
GET/api/?mod=data&data=service_groups&id=IDПолучить одну группу услуг по id.
POST/api/?mod=save_data&data=service_groupsСоздать или обновить группу услуг. Для создания id не передается.
POST/api/?mod=delete_data&data=service_groups&id=IDУдалить группу услуг по id. После успешного запроса группа больше не возвращается в ответах API.
ПолеТипОбязательноеDefaultЗначенияСохранениеСписокКарточкаОписание
namestringДаНетЛюбоеНазвание группы услуг.
idnumberНетНетЛюбоеИдентификатор существующей группы услуг. При создании не передается.
sort_ordernumberНетautoЛюбоеПозиция группы услуг в сортировке списка. Заполняется сервером.

Ответы с ошибками

Если запрос не выполнен, API возвращает ok=false и числовой code. Подробности по обязательным полям передаются в required[].

КодКогда возникаетОтвет
16Не передано обязательное поле name.required со списком незаполненных полей.
11-14Нет доступа к группе услуг, созданию, сохранению, удалению или превышен лимит тарифа.message с причиной отказа.