Антиспам
Антиспам, список стран
Получить "Антиспам, список стран"
GET /api/v1.1/antispam_countries/
Фильтрация "Антиспам, список стран" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/antispam_countries/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| code |
string |
Код страны |
|
| allow |
int |
Активность |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Антиспам, список стран"
POST /api/v1.1/antispam_countries/
Обновить "Антиспам, список стран" с идентификатором {id}
PUT /api/v1.1/antispam_countries/{id}/
{"code": "...", "allow": 1, ...}
Удалить "Антиспам, список стран" с переданным {id}
DELETE /api/v1.1/antispam_countries/{id}/
Связанные элементы
Получить "Список стран, языковые значения" у "Антиспам, список стран" с идентификатором {id}
GET /api/v1.1/antispam_countries/{id}/antispam_country_languages/
Список стран, языковые значения
Получить "Список стран, языковые значения"
GET /api/v1.1/antispam_country_languages/
Фильтрация "Список стран, языковые значения" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/antispam_country_languages/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| antispam_country_id |
int |
|
|
| admin_language_id |
int |
|
|
| name |
string |
|
|
Создать "Список стран, языковые значения"
POST /api/v1.1/antispam_country_languages/
Обновить "Список стран, языковые значения" с идентификатором {id}
PUT /api/v1.1/antispam_country_languages/{id}/
{"antispam_country_id": 1, "admin_language_id": 1, ...}
Удалить "Список стран, языковые значения" с переданным {id}
DELETE /api/v1.1/antispam_country_languages/{id}/
Антиспам, домены
Получить "Антиспам, домены"
GET /api/v1.1/antispam_domains/
Фильтрация "Антиспам, домены" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/antispam_domains/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| domain |
string |
Домен или список доменов |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Антиспам, домены"
POST /api/v1.1/antispam_domains/
Обновить "Антиспам, домены" с идентификатором {id}
PUT /api/v1.1/antispam_domains/{id}/
{"domain": "...", "user_id": 1, ...}
Удалить "Антиспам, домены" с переданным {id}
DELETE /api/v1.1/antispam_domains/{id}/
Антиспам, запись журнала
Получить "Антиспам, запись журнала"
GET /api/v1.1/antispam_logs/
Фильтрация "Антиспам, запись журнала" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/antispam_logs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| datetime |
string |
|
|
| antispam_country_id |
int |
|
|
| ip |
string |
|
|
| user_agent |
string |
|
|
| result |
int |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Антиспам, запись журнала"
POST /api/v1.1/antispam_logs/
Обновить "Антиспам, запись журнала" с идентификатором {id}
PUT /api/v1.1/antispam_logs/{id}/
{"datetime": "...", "antispam_country_id": 1, ...}
Удалить "Антиспам, запись журнала" с переданным {id}
DELETE /api/v1.1/antispam_logs/{id}/
Антиспам, стоп-слова
Получить "Антиспам, стоп-слова"
GET /api/v1.1/antispam_stopwords/
Фильтрация "Антиспам, стоп-слова" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/antispam_stopwords/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| value |
string |
Стоп-слово |
|
| type |
int |
Тип |
|
| case_sensitive |
int |
С учетом регистра |
|
| active |
int |
Активность |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Антиспам, стоп-слова"
POST /api/v1.1/antispam_stopwords/
Обновить "Антиспам, стоп-слова" с идентификатором {id}
PUT /api/v1.1/antispam_stopwords/{id}/
{"value": "...", "type": 1, ...}
Удалить "Антиспам, стоп-слова" с переданным {id}
DELETE /api/v1.1/antispam_stopwords/{id}/
Получить "Форматы"
GET /api/v1.1/media_formats/
Фильтрация "Форматы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/media_formats/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Название |
|
| width |
int |
Ширина |
|
| height |
int |
Высота |
|
| watermark_file |
string |
Изображение для водяного знака |
|
| watermark_default_position_x |
string |
Позиция по оси X (по умолчанию) |
|
| watermark_default_position_y |
string |
Позиция по оси Y (по умолчанию) |
|
| preserve_aspect_ratio |
int |
Сохранять пропорции изображения |
|
| change_format |
string |
Изменить формат |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Форматы"
POST /api/v1.1/media_formats/
Обновить "Форматы" с идентификатором {id}
PUT /api/v1.1/media_formats/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Форматы" с переданным {id}
DELETE /api/v1.1/media_formats/{id}/
Связанные элементы
Получить "Библиотека файлов, форматы элементов" у "Форматы" с идентификатором {id}
GET /api/v1.1/media_formats/{id}/media_item_formats/
Получить "Библиотека файлов, группы"
GET /api/v1.1/media_groups/
Фильтрация "Библиотека файлов, группы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/media_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| parent_id |
int |
Родительская группа |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Библиотека файлов, группы"
POST /api/v1.1/media_groups/
Обновить "Библиотека файлов, группы" с идентификатором {id}
PUT /api/v1.1/media_groups/{id}/
{"site_id": 1, "parent_id": 1, ...}
Удалить "Библиотека файлов, группы" с переданным {id}
DELETE /api/v1.1/media_groups/{id}/
Связанные элементы
Получить "Библиотека файлов, файлы" у "Библиотека файлов, группы" с идентификатором {id}
GET /api/v1.1/media_groups/{id}/media_items/
Получить "Библиотека файлов, группы" у "Библиотека файлов, группы" с идентификатором {id}
GET /api/v1.1/media_groups/{id}/media_groups/
Получить "Библиотека файлов, группы информационных элементов"
GET /api/v1.1/media_informationsystem_groups/
Фильтрация "Библиотека файлов, группы информационных элементов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/media_informationsystem_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| media_item_id |
int |
|
|
| informationsystem_group_id |
int |
|
|
| sorting |
int |
|
|
Создать "Библиотека файлов, группы информационных элементов"
POST /api/v1.1/media_informationsystem_groups/
Обновить "Библиотека файлов, группы информационных элементов" с идентификатором {id}
PUT /api/v1.1/media_informationsystem_groups/{id}/
{"media_item_id": 1, "informationsystem_group_id": 1, ...}
Удалить "Библиотека файлов, группы информационных элементов" с переданным {id}
DELETE /api/v1.1/media_informationsystem_groups/{id}/
Получить "Библиотека файлов, информационные элементы"
GET /api/v1.1/media_informationsystem_items/
Фильтрация "Библиотека файлов, информационные элементы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/media_informationsystem_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| media_item_id |
int |
|
|
| informationsystem_item_id |
int |
|
|
| sorting |
int |
|
|
Создать "Библиотека файлов, информационные элементы"
POST /api/v1.1/media_informationsystem_items/
Обновить "Библиотека файлов, информационные элементы" с идентификатором {id}
PUT /api/v1.1/media_informationsystem_items/{id}/
{"media_item_id": 1, "informationsystem_item_id": 1, ...}
Удалить "Библиотека файлов, информационные элементы" с переданным {id}
DELETE /api/v1.1/media_informationsystem_items/{id}/
Получить "Библиотека файлов, форматы элементов"
GET /api/v1.1/media_item_formats/
Фильтрация "Библиотека файлов, форматы элементов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/media_item_formats/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| media_item_id |
int |
|
|
| media_format_id |
int |
|
|
| file |
string |
|
|
| width |
int |
|
|
| height |
int |
|
|
| size |
int |
|
|
Создать "Библиотека файлов, форматы элементов"
POST /api/v1.1/media_item_formats/
Обновить "Библиотека файлов, форматы элементов" с идентификатором {id}
PUT /api/v1.1/media_item_formats/{id}/
{"media_item_id": 1, "media_format_id": 1, ...}
Удалить "Библиотека файлов, форматы элементов" с переданным {id}
DELETE /api/v1.1/media_item_formats/{id}/
Получить "Библиотека файлов, файлы"
GET /api/v1.1/media_items/
Фильтрация "Библиотека файлов, файлы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/media_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| media_group_id |
int |
Родительская группа |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| caption |
string |
Заголовок |
|
| alt |
string |
Alt |
|
| width |
int |
|
|
| height |
int |
|
|
| size |
int |
|
|
| file |
string |
Файл |
|
| type |
int |
|
|
| datetime |
string |
Дата |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Библиотека файлов, файлы"
POST /api/v1.1/media_items/
Обновить "Библиотека файлов, файлы" с идентификатором {id}
PUT /api/v1.1/media_items/{id}/
{"site_id": 1, "media_group_id": 1, ...}
Удалить "Библиотека файлов, файлы" с переданным {id}
DELETE /api/v1.1/media_items/{id}/
Связанные элементы
Получить "Библиотека файлов, форматы элементов" у "Библиотека файлов, файлы" с идентификатором {id}
GET /api/v1.1/media_items/{id}/media_item_formats/
Получить "Библиотека файлов, группы информационных элементов" у "Библиотека файлов, файлы" с идентификатором {id}
GET /api/v1.1/media_items/{id}/media_informationsystem_groups/
Получить "Библиотека файлов, информационные элементы" у "Библиотека файлов, файлы" с идентификатором {id}
GET /api/v1.1/media_items/{id}/media_informationsystem_items/
Получить "Библиотека файлов, группы товаров магазина" у "Библиотека файлов, файлы" с идентификатором {id}
GET /api/v1.1/media_items/{id}/media_shop_groups/
Получить "Библиотека файлов, товары магазина" у "Библиотека файлов, файлы" с идентификатором {id}
GET /api/v1.1/media_items/{id}/media_shop_items/
Получить "Библиотека файлов, узлы структуры" у "Библиотека файлов, файлы" с идентификатором {id}
GET /api/v1.1/media_items/{id}/media_structures/
Получить "Библиотека файлов, группы товаров магазина"
GET /api/v1.1/media_shop_groups/
Фильтрация "Библиотека файлов, группы товаров магазина" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/media_shop_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| media_item_id |
int |
|
|
| shop_group_id |
int |
|
|
| sorting |
int |
|
|
Создать "Библиотека файлов, группы товаров магазина"
POST /api/v1.1/media_shop_groups/
Обновить "Библиотека файлов, группы товаров магазина" с идентификатором {id}
PUT /api/v1.1/media_shop_groups/{id}/
{"media_item_id": 1, "shop_group_id": 1, ...}
Удалить "Библиотека файлов, группы товаров магазина" с переданным {id}
DELETE /api/v1.1/media_shop_groups/{id}/
Получить "Библиотека файлов, товары магазина"
GET /api/v1.1/media_shop_items/
Фильтрация "Библиотека файлов, товары магазина" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/media_shop_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| media_item_id |
int |
|
|
| shop_item_id |
int |
|
|
| sorting |
int |
|
|
Создать "Библиотека файлов, товары магазина"
POST /api/v1.1/media_shop_items/
Обновить "Библиотека файлов, товары магазина" с идентификатором {id}
PUT /api/v1.1/media_shop_items/{id}/
{"media_item_id": 1, "shop_item_id": 1, ...}
Удалить "Библиотека файлов, товары магазина" с переданным {id}
DELETE /api/v1.1/media_shop_items/{id}/
Получить "Библиотека файлов, узлы структуры"
GET /api/v1.1/media_structures/
Фильтрация "Библиотека файлов, узлы структуры" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/media_structures/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| media_item_id |
int |
|
|
| structure_id |
int |
|
|
| sorting |
int |
|
|
Создать "Библиотека файлов, узлы структуры"
POST /api/v1.1/media_structures/
Обновить "Библиотека файлов, узлы структуры" с идентификатором {id}
PUT /api/v1.1/media_structures/{id}/
{"media_item_id": 1, "structure_id": 1, ...}
Удалить "Библиотека файлов, узлы структуры" с переданным {id}
DELETE /api/v1.1/media_structures/{id}/
Боты
Разделы ботов
Получить "Разделы ботов"
GET /api/v1.1/bot_dirs/
Фильтрация "Разделы ботов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/bot_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Родительский раздел |
|
| name |
string |
Название |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Разделы ботов"
POST /api/v1.1/bot_dirs/
Обновить "Разделы ботов" с идентификатором {id}
PUT /api/v1.1/bot_dirs/{id}/
{"parent_id": 1, "name": "...", ...}
Удалить "Разделы ботов" с переданным {id}
DELETE /api/v1.1/bot_dirs/{id}/
Связанные элементы
Получить "Боты" у "Разделы ботов" с идентификатором {id}
GET /api/v1.1/bot_dirs/{id}/bots/
Получить "Разделы ботов" у "Разделы ботов" с идентификатором {id}
GET /api/v1.1/bot_dirs/{id}/bot_dirs/
Боты, сущности
Получить "Боты, сущности"
GET /api/v1.1/bot_entities/
Фильтрация "Боты, сущности" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/bot_entities/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| bot_module_id |
int |
|
|
| object_id |
int |
|
|
| model |
string |
|
|
| datetime |
string |
|
|
| executed |
int |
|
|
Создать "Боты, сущности"
POST /api/v1.1/bot_entities/
Обновить "Боты, сущности" с идентификатором {id}
PUT /api/v1.1/bot_entities/{id}/
{"bot_module_id": 1, "object_id": 1, ...}
Удалить "Боты, сущности" с переданным {id}
DELETE /api/v1.1/bot_entities/{id}/
Боты, модули
Получить "Боты, модули"
GET /api/v1.1/bot_modules/
Фильтрация "Боты, модули" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/bot_modules/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| bot_id |
int |
|
|
| module_id |
int |
|
|
| type |
int |
|
|
| entity_id |
int |
|
|
| minutes |
int |
минут |
|
| delay_type |
int |
|
|
| json |
string |
|
|
| sorting |
int |
|
|
Создать "Боты, модули"
POST /api/v1.1/bot_modules/
Обновить "Боты, модули" с идентификатором {id}
PUT /api/v1.1/bot_modules/{id}/
{"bot_id": 1, "module_id": 1, ...}
Удалить "Боты, модули" с переданным {id}
DELETE /api/v1.1/bot_modules/{id}/
Связанные элементы
Получить "Боты, сущности" у "Боты, модули" с идентификатором {id}
GET /api/v1.1/bot_modules/{id}/bot_entities/
Боты
Получить "Боты"
GET /api/v1.1/bots/
Фильтрация "Боты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/bots/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| bot_dir_id |
int |
Родительский раздел |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| class |
string |
Класс |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Боты"
POST /api/v1.1/bots/
Обновить "Боты" с идентификатором {id}
PUT /api/v1.1/bots/{id}/
{"bot_dir_id": 1, "name": "...", ...}
Удалить "Боты" с переданным {id}
DELETE /api/v1.1/bots/{id}/
Связанные элементы
Получить "Боты, модули" у "Боты" с идентификатором {id}
GET /api/v1.1/bots/{id}/bot_modules/
Вебхуки
Вебхуки, события
Получить "Вебхуки, события"
GET /api/v1.1/webhook_events/
Фильтрация "Вебхуки, события" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/webhook_events/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| webhook_id |
int |
|
|
| event |
string |
|
|
Создать "Вебхуки, события"
POST /api/v1.1/webhook_events/
Обновить "Вебхуки, события" с идентификатором {id}
PUT /api/v1.1/webhook_events/{id}/
{"webhook_id": 1, "event": "...", ...}
Удалить "Вебхуки, события" с переданным {id}
DELETE /api/v1.1/webhook_events/{id}/
Вебхуки Журнал событий
Получить "Вебхуки Журнал событий"
GET /api/v1.1/webhook_logs/
Фильтрация "Вебхуки Журнал событий" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/webhook_logs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| webhook_id |
int |
Идентификатор вебхука |
|
| event |
string |
Событие |
|
| json |
string |
JSON |
|
| set |
string |
Установлен |
|
| completed |
int |
Завершено |
|
| tries |
int |
Попыток |
|
| last_try |
string |
Последняя попытка |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Вебхуки Журнал событий"
POST /api/v1.1/webhook_logs/
Обновить "Вебхуки Журнал событий" с идентификатором {id}
PUT /api/v1.1/webhook_logs/{id}/
{"webhook_id": 1, "event": "...", ...}
Удалить "Вебхуки Журнал событий" с переданным {id}
DELETE /api/v1.1/webhook_logs/{id}/
Вебхуки
Получить "Вебхуки"
GET /api/v1.1/webhooks/
Фильтрация "Вебхуки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/webhooks/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Сайт |
|
| name |
string |
Название |
|
| url |
string |
Путь |
|
| token |
string |
Токен |
|
| auth_header |
string |
Заголовок авторизации |
|
| auth_header_mask |
string |
Шаблон значения заголовка авторизации |
|
| function_name |
string |
Функция |
|
| active |
int |
Активность |
|
| timeout |
int |
Таймаут, с. |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Вебхуки"
POST /api/v1.1/webhooks/
Обновить "Вебхуки" с идентификатором {id}
PUT /api/v1.1/webhooks/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Вебхуки" с переданным {id}
DELETE /api/v1.1/webhooks/{id}/
Связанные элементы
Получить "Вебхуки Журнал событий" у "Вебхуки" с идентификатором {id}
GET /api/v1.1/webhooks/{id}/webhook_logs/
Получить "Вебхуки, события" у "Вебхуки" с идентификатором {id}
GET /api/v1.1/webhooks/{id}/webhook_events/
Дела
Дела, файлы
Получить "Дела, файлы"
GET /api/v1.1/event_attachments/
Фильтрация "Дела, файлы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/event_attachments/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| event_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| file_name |
string |
|
|
| file_path |
string |
|
|
Создать "Дела, файлы"
POST /api/v1.1/event_attachments/
Обновить "Дела, файлы" с идентификатором {id}
PUT /api/v1.1/event_attachments/{id}/
{"event_id": 1, "user_id": 1, ...}
Удалить "Дела, файлы" с переданным {id}
DELETE /api/v1.1/event_attachments/{id}/
Дела, календари
Получить "Дела, календари"
GET /api/v1.1/event_calendar_caldavs/
Фильтрация "Дела, календари" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/event_calendar_caldavs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| event_id |
int |
|
|
| calendar_caldav_id |
int |
|
|
Создать "Дела, календари"
POST /api/v1.1/event_calendar_caldavs/
Обновить "Дела, календари" с идентификатором {id}
PUT /api/v1.1/event_calendar_caldavs/{id}/
{"event_id": 1, "calendar_caldav_id": 1, ...}
Удалить "Дела, календари" с переданным {id}
DELETE /api/v1.1/event_calendar_caldavs/{id}/
Чек-листы, пункты
Получить "Чек-листы, пункты"
GET /api/v1.1/event_checklist_items/
Фильтрация "Чек-листы, пункты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/event_checklist_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| event_checklist_id |
int |
|
|
| name |
string |
|
|
| important |
int |
|
|
| completed |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Чек-листы, пункты"
POST /api/v1.1/event_checklist_items/
Обновить "Чек-листы, пункты" с идентификатором {id}
PUT /api/v1.1/event_checklist_items/{id}/
{"event_checklist_id": 1, "name": "...", ...}
Удалить "Чек-листы, пункты" с переданным {id}
DELETE /api/v1.1/event_checklist_items/{id}/
Чек-листы
Получить "Чек-листы"
GET /api/v1.1/event_checklists/
Фильтрация "Чек-листы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/event_checklists/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| event_id |
int |
|
|
| name |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Чек-листы"
POST /api/v1.1/event_checklists/
Обновить "Чек-листы" с идентификатором {id}
PUT /api/v1.1/event_checklists/{id}/
{"event_id": 1, "name": "...", ...}
Удалить "Чек-листы" с переданным {id}
DELETE /api/v1.1/event_checklists/{id}/
Связанные элементы
Получить "Чек-листы, пункты" у "Чек-листы" с идентификатором {id}
GET /api/v1.1/event_checklists/{id}/event_checklist_items/
Дела, заметки
Получить "Дела, заметки"
GET /api/v1.1/event_crm_notes/
Фильтрация "Дела, заметки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/event_crm_notes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| crm_note_id |
int |
|
|
| event_id |
int |
|
|
Создать "Дела, заметки"
POST /api/v1.1/event_crm_notes/
Обновить "Дела, заметки" с идентификатором {id}
PUT /api/v1.1/event_crm_notes/{id}/
{"crm_note_id": 1, "event_id": 1, ...}
Удалить "Дела, заметки" с переданным {id}
DELETE /api/v1.1/event_crm_notes/{id}/
Дела, проекты
Получить "Дела, проекты"
GET /api/v1.1/event_crm_projects/
Фильтрация "Дела, проекты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/event_crm_projects/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| event_id |
int |
|
|
| crm_project_id |
int |
|
|
Создать "Дела, проекты"
POST /api/v1.1/event_crm_projects/
Обновить "Дела, проекты" с идентификатором {id}
PUT /api/v1.1/event_crm_projects/{id}/
{"event_id": 1, "crm_project_id": 1, ...}
Удалить "Дела, проекты" с переданным {id}
DELETE /api/v1.1/event_crm_projects/{id}/
Дела, документы
Получить "Дела, документы"
GET /api/v1.1/event_dms_documents/
Фильтрация "Дела, документы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/event_dms_documents/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| event_id |
int |
|
|
| dms_document_id |
int |
|
|
Создать "Дела, документы"
POST /api/v1.1/event_dms_documents/
Обновить "Дела, документы" с идентификатором {id}
PUT /api/v1.1/event_dms_documents/{id}/
{"event_id": 1, "dms_document_id": 1, ...}
Удалить "Дела, документы" с переданным {id}
DELETE /api/v1.1/event_dms_documents/{id}/
Группы дел
Получить "Группы дел"
GET /api/v1.1/event_groups/
Фильтрация "Группы дел" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/event_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Группы дел"
POST /api/v1.1/event_groups/
Обновить "Группы дел" с идентификатором {id}
PUT /api/v1.1/event_groups/{id}/
{"name": "...", "description": "...", ...}
Удалить "Группы дел" с переданным {id}
DELETE /api/v1.1/event_groups/{id}/
Связанные элементы
Получить "Дела" у "Группы дел" с идентификатором {id}
GET /api/v1.1/event_groups/{id}/events/
Дела, история
Получить "Дела, история"
GET /api/v1.1/event_histories/
Фильтрация "Дела, история" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/event_histories/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| event_id |
int |
|
|
| datetime |
string |
|
|
| text |
string |
|
|
| ip |
string |
|
|
| color |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Дела, история"
POST /api/v1.1/event_histories/
Обновить "Дела, история" с идентификатором {id}
PUT /api/v1.1/event_histories/{id}/
{"event_id": 1, "datetime": "...", ...}
Удалить "Дела, история" с переданным {id}
DELETE /api/v1.1/event_histories/{id}/
Дела, клиенты
Получить "Дела, клиенты"
GET /api/v1.1/event_siteusers/
Фильтрация "Дела, клиенты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/event_siteusers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| event_id |
int |
|
|
| siteuser_company_id |
int |
|
|
| siteuser_person_id |
int |
|
|
Создать "Дела, клиенты"
POST /api/v1.1/event_siteusers/
Обновить "Дела, клиенты" с идентификатором {id}
PUT /api/v1.1/event_siteusers/{id}/
{"event_id": 1, "siteuser_company_id": 1, ...}
Удалить "Дела, клиенты" с переданным {id}
DELETE /api/v1.1/event_siteusers/{id}/
Статусы дел
Получить "Статусы дел"
GET /api/v1.1/event_statuses/
Фильтрация "Статусы дел" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/event_statuses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| final |
int |
Финальный |
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Статусы дел"
POST /api/v1.1/event_statuses/
Обновить "Статусы дел" с идентификатором {id}
PUT /api/v1.1/event_statuses/{id}/
{"name": "...", "description": "...", ...}
Удалить "Статусы дел" с переданным {id}
DELETE /api/v1.1/event_statuses/{id}/
Связанные элементы
Получить "Дела" у "Статусы дел" с идентификатором {id}
GET /api/v1.1/event_statuses/{id}/events/
Типы дел
Получить "Типы дел"
GET /api/v1.1/event_types/
Фильтрация "Типы дел" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/event_types/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| successfully |
string |
Название успешного завершения |
|
| failed |
string |
Название проваленного результата |
|
| color |
string |
Цвет |
|
| icon |
string |
Иконка |
|
| default |
int |
По умолчанию |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Типы дел"
POST /api/v1.1/event_types/
Обновить "Типы дел" с идентификатором {id}
PUT /api/v1.1/event_types/{id}/
{"name": "...", "description": "...", ...}
Удалить "Типы дел" с переданным {id}
DELETE /api/v1.1/event_types/{id}/
Связанные элементы
Получить "Дела" у "Типы дел" с идентификатором {id}
GET /api/v1.1/event_types/{id}/events/
Дела, сотрудники
Получить "Дела, сотрудники"
GET /api/v1.1/event_users/
Фильтрация "Дела, сотрудники" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/event_users/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| event_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| creator |
int |
|
|
Создать "Дела, сотрудники"
POST /api/v1.1/event_users/
Обновить "Дела, сотрудники" с идентификатором {id}
PUT /api/v1.1/event_users/{id}/
{"event_id": 1, "user_id": 1, ...}
Удалить "Дела, сотрудники" с переданным {id}
DELETE /api/v1.1/event_users/{id}/
Дела
Получить "Дела"
GET /api/v1.1/events/
Фильтрация "Дела" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/events/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
|
|
| event_group_id |
int |
Группа |
|
| event_status_id |
int |
Статус |
|
| crm_project_id |
int |
Проект |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| event_type_id |
int |
Тип |
|
| completed |
int |
Завершено |
|
| datetime |
string |
|
|
| start |
string |
Начало |
|
| deadline |
string |
Срок |
|
| finish |
string |
Завершено |
|
| all_day |
int |
Весь день |
|
| duration |
int |
Продолжительность |
|
| duration_type |
int |
|
|
| important |
int |
Важное |
|
| place |
string |
Где |
|
| reminder_start |
string |
|
|
| reminder_value |
int |
Напомнить за |
|
| reminder_type |
int |
|
|
| result |
string |
Результат |
|
| busy |
int |
Занят |
|
| guid |
string |
GUID |
|
| last_modified |
string |
Последнее изменение |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Дела"
POST /api/v1.1/events/
Обновить "Дела" с идентификатором {id}
PUT /api/v1.1/events/{id}/
{"parent_id": 1, "event_group_id": 1, ...}
Удалить "Дела" с переданным {id}
DELETE /api/v1.1/events/{id}/
Связанные элементы
Получить "Дела, файлы" у "Дела" с идентификатором {id}
GET /api/v1.1/events/{id}/event_attachments/
Получить "Дела, клиенты" у "Дела" с идентификатором {id}
GET /api/v1.1/events/{id}/event_siteusers/
Получить "Дела, сотрудники" у "Дела" с идентификатором {id}
GET /api/v1.1/events/{id}/event_users/
Получить "Сотрудники" у "Дела" с идентификатором {id}
GET /api/v1.1/events/{id}/users/
Получить "Дела в сделках" у "Дела" с идентификатором {id}
GET /api/v1.1/events/{id}/deal_events/
Получить "Дела в лидах" у "Дела" с идентификатором {id}
GET /api/v1.1/events/{id}/lead_events/
Получить "Дела, сотрудники запущенных бизнес-процессов" у "Дела" с идентификатором {id}
GET /api/v1.1/events/{id}/dms_workflow_execution_users/
Получить "Дела" у "Дела" с идентификатором {id}
GET /api/v1.1/events/{id}/events/
Получить "Дела, история" у "Дела" с идентификатором {id}
GET /api/v1.1/events/{id}/event_histories/
Получить "Дела, заметки" у "Дела" с идентификатором {id}
GET /api/v1.1/events/{id}/event_crm_notes/
Получить "CRM: Заметки" у "Дела" с идентификатором {id}
GET /api/v1.1/events/{id}/crm_notes/
Получить "Документооборот" у "Дела" с идентификатором {id}
GET /api/v1.1/events/{id}/dms_documents/
Получить "Дела, документы" у "Дела" с идентификатором {id}
GET /api/v1.1/events/{id}/event_dms_documents/
Получить "Дела, календари" у "Дела" с идентификатором {id}
GET /api/v1.1/events/{id}/event_calendar_caldavs/
Получить "Дела, проекты" у "Дела" с идентификатором {id}
GET /api/v1.1/events/{id}/event_crm_projects/
Получить "Метки" у "Дела" с идентификатором {id}
GET /api/v1.1/events/{id}/tags/
Получить "Key 'model_name' in 'ru' language does not exist for model 'tag_event'." у "Дела" с идентификатором {id}
GET /api/v1.1/events/{id}/tag_events/
Получить "Чек-листы" у "Дела" с идентификатором {id}
GET /api/v1.1/events/{id}/event_checklists/
Документооборот
Архив дел
Получить "Архив дел"
GET /api/v1.1/dms_case_archives/
Фильтрация "Архив дел" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_case_archives/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| company_id |
int |
Компания |
|
| site_id |
int |
Идентификатор сайта |
|
| responsible_user_id |
int |
Ответственный |
|
| number |
string |
Номер |
|
| datetime |
string |
Дата |
|
| description |
string |
Описание |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Архив дел"
POST /api/v1.1/dms_case_archives/
Обновить "Архив дел" с идентификатором {id}
PUT /api/v1.1/dms_case_archives/{id}/
{"company_id": 1, "site_id": 1, ...}
Удалить "Архив дел" с переданным {id}
DELETE /api/v1.1/dms_case_archives/{id}/
Связанные элементы
Получить "Дела в документообороте" у "Архив дел" с идентификатором {id}
GET /api/v1.1/dms_case_archives/{id}/dms_cases/
Уничтожение дел
Получить "Уничтожение дел"
GET /api/v1.1/dms_case_destructions/
Фильтрация "Уничтожение дел" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_case_destructions/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| company_id |
int |
Компания |
|
| site_id |
int |
Идентификатор сайта |
|
| responsible_user_id |
int |
Ответственный |
|
| number |
string |
Номер |
|
| datetime |
string |
Дата |
|
| description |
string |
Описание |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Уничтожение дел"
POST /api/v1.1/dms_case_destructions/
Обновить "Уничтожение дел" с идентификатором {id}
PUT /api/v1.1/dms_case_destructions/{id}/
{"company_id": 1, "site_id": 1, ...}
Удалить "Уничтожение дел" с переданным {id}
DELETE /api/v1.1/dms_case_destructions/{id}/
Связанные элементы
Получить "Дела в документообороте" у "Уничтожение дел" с идентификатором {id}
GET /api/v1.1/dms_case_destructions/{id}/dms_cases/
Дела в документообороте
Получить "Дела в документообороте"
GET /api/v1.1/dms_cases/
Фильтрация "Дела в документообороте" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_cases/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| dms_nomenclature_id |
int |
Номенклатура дел |
|
| company_location_id |
int |
|
|
| dms_case_archive_id |
int |
|
|
| dms_case_destruction_id |
int |
|
|
| volume |
string |
Том |
|
| sheets |
int |
Листов |
|
| status |
int |
Статус |
|
| begin |
string |
Начато |
|
| end |
string |
Окончено |
|
| precious |
int |
Ценность |
|
| note |
string |
Примечание |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Дела в документообороте"
POST /api/v1.1/dms_cases/
Обновить "Дела в документообороте" с идентификатором {id}
PUT /api/v1.1/dms_cases/{id}/
{"dms_nomenclature_id": 1, "company_location_id": 1, ...}
Удалить "Дела в документообороте" с переданным {id}
DELETE /api/v1.1/dms_cases/{id}/
Связанные элементы
Получить "Документооборот" у "Дела в документообороте" с идентификатором {id}
GET /api/v1.1/dms_cases/{id}/dms_documents/
Классы документов
Получить "Классы документов"
GET /api/v1.1/dms_classes/
Фильтрация "Классы документов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_classes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| crm_icon_id |
int |
|
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| ~icon |
string |
|
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Классы документов"
POST /api/v1.1/dms_classes/
Обновить "Классы документов" с идентификатором {id}
PUT /api/v1.1/dms_classes/{id}/
{"site_id": 1, "crm_icon_id": 1, ...}
Удалить "Классы документов" с переданным {id}
DELETE /api/v1.1/dms_classes/{id}/
Связанные элементы
Получить "Типы документов" у "Классы документов" с идентификатором {id}
GET /api/v1.1/dms_classes/{id}/dms_document_types/
Способы связи
Получить "Способы связи"
GET /api/v1.1/dms_communications/
Фильтрация "Способы связи" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_communications/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Способы связи"
POST /api/v1.1/dms_communications/
Обновить "Способы связи" с идентификатором {id}
PUT /api/v1.1/dms_communications/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Способы связи" с переданным {id}
DELETE /api/v1.1/dms_communications/{id}/
Связанные элементы
Получить "Документооборот" у "Способы связи" с идентификатором {id}
GET /api/v1.1/dms_communications/{id}/dms_documents/
Документооборот, права доступа сотрудников
Получить "Документооборот, права доступа сотрудников"
GET /api/v1.1/dms_document_access_users/
Фильтрация "Документооборот, права доступа сотрудников" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_document_access_users/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_document_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| access |
int |
|
|
Создать "Документооборот, права доступа сотрудников"
POST /api/v1.1/dms_document_access_users/
Обновить "Документооборот, права доступа сотрудников" с идентификатором {id}
PUT /api/v1.1/dms_document_access_users/{id}/
{"dms_document_id": 1, "user_id": 1, ...}
Удалить "Документооборот, права доступа сотрудников" с переданным {id}
DELETE /api/v1.1/dms_document_access_users/{id}/
Визы
Получить "Визы"
GET /api/v1.1/dms_document_approves/
Фильтрация "Визы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_document_approves/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| dms_document_id |
int |
Идентификатор документа |
|
| approved |
int |
Согласовано |
|
| text |
string |
Комментарий |
|
| datetime |
string |
Дата |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Визы"
POST /api/v1.1/dms_document_approves/
Обновить "Визы" с идентификатором {id}
PUT /api/v1.1/dms_document_approves/{id}/
{"dms_document_id": 1, "approved": 1, ...}
Удалить "Визы" с переданным {id}
DELETE /api/v1.1/dms_document_approves/{id}/
Контрольные точки, вложения
Получить "Контрольные точки, вложения"
GET /api/v1.1/dms_document_checkpoint_attachments/
Фильтрация "Контрольные точки, вложения" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_document_checkpoint_attachments/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_document_checkpoint_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| datetime |
string |
|
|
| file_name |
string |
|
|
| file_path |
string |
|
|
| description |
string |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Контрольные точки, вложения"
POST /api/v1.1/dms_document_checkpoint_attachments/
Обновить "Контрольные точки, вложения" с идентификатором {id}
PUT /api/v1.1/dms_document_checkpoint_attachments/{id}/
{"dms_document_checkpoint_id": 1, "user_id": 1, ...}
Удалить "Контрольные точки, вложения" с переданным {id}
DELETE /api/v1.1/dms_document_checkpoint_attachments/{id}/
Контрольные точки
Получить "Контрольные точки"
GET /api/v1.1/dms_document_checkpoints/
Фильтрация "Контрольные точки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_document_checkpoints/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| dms_document_id |
int |
Идентификатор документа |
|
| event_id |
int |
Дело |
|
| name |
string |
Название |
|
| description |
string |
Комментарий |
|
| datetime |
string |
Дата создания |
|
| remind |
int |
Напомнить за, в днях |
|
| days |
int |
Дней на исполнение |
|
| deadline |
string |
Срок |
|
| responsible_user_id |
int |
Ответственный |
|
| completed |
int |
Завершено |
|
| important |
int |
Важное |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Контрольные точки"
POST /api/v1.1/dms_document_checkpoints/
Обновить "Контрольные точки" с идентификатором {id}
PUT /api/v1.1/dms_document_checkpoints/{id}/
{"site_id": 1, "dms_document_id": 1, ...}
Удалить "Контрольные точки" с переданным {id}
DELETE /api/v1.1/dms_document_checkpoints/{id}/
Связанные элементы
Получить "Контрольные точки, вложения" у "Контрольные точки" с идентификатором {id}
GET /api/v1.1/dms_document_checkpoints/{id}/dms_document_checkpoint_attachments/
Резолюции
Получить "Резолюции"
GET /api/v1.1/dms_document_instructions/
Фильтрация "Резолюции" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_document_instructions/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| dms_document_id |
int |
Идентификатор документа |
|
| text |
string |
Резолюция |
|
| datetime |
string |
Дата |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Резолюции"
POST /api/v1.1/dms_document_instructions/
Обновить "Резолюции" с идентификатором {id}
PUT /api/v1.1/dms_document_instructions/{id}/
{"dms_document_id": 1, "text": "...", ...}
Удалить "Резолюции" с переданным {id}
DELETE /api/v1.1/dms_document_instructions/{id}/
Документооборот, тип связи связанного документа
Получить "Документооборот, тип связи связанного документа"
GET /api/v1.1/dms_document_relation_type_document_types/
Фильтрация "Документооборот, тип связи связанного документа" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_document_relation_type_document_types/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_document_relation_type_id |
int |
|
|
| dms_document_type_id |
int |
|
|
Создать "Документооборот, тип связи связанного документа"
POST /api/v1.1/dms_document_relation_type_document_types/
Обновить "Документооборот, тип связи связанного документа" с идентификатором {id}
PUT /api/v1.1/dms_document_relation_type_document_types/{id}/
{"dms_document_relation_type_id": 1, "dms_document_type_id": 1, ...}
Удалить "Документооборот, тип связи связанного документа" с переданным {id}
DELETE /api/v1.1/dms_document_relation_type_document_types/{id}/
Типы связей
Получить "Типы связей"
GET /api/v1.1/dms_document_relation_types/
Фильтрация "Типы связей" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_document_relation_types/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Типы связей"
POST /api/v1.1/dms_document_relation_types/
Обновить "Типы связей" с идентификатором {id}
PUT /api/v1.1/dms_document_relation_types/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Типы связей" с переданным {id}
DELETE /api/v1.1/dms_document_relation_types/{id}/
Связанные элементы
Получить "Документооборот, тип связи связанного документа" у "Типы связей" с идентификатором {id}
GET /api/v1.1/dms_document_relation_types/{id}/dms_document_relation_type_document_types/
Получить "Типы документов" у "Типы связей" с идентификатором {id}
GET /api/v1.1/dms_document_relation_types/{id}/dms_document_types/
Документооборот, связанные документы
Получить "Документооборот, связанные документы"
GET /api/v1.1/dms_document_relations/
Фильтрация "Документооборот, связанные документы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_document_relations/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_document_id |
int |
|
|
| dms_document_relation_id |
int |
|
|
| dms_document_relation_type_id |
int |
|
|
Создать "Документооборот, связанные документы"
POST /api/v1.1/dms_document_relations/
Обновить "Документооборот, связанные документы" с идентификатором {id}
PUT /api/v1.1/dms_document_relations/{id}/
{"dms_document_id": 1, "dms_document_relation_id": 1, ...}
Удалить "Документооборот, связанные документы" с переданным {id}
DELETE /api/v1.1/dms_document_relations/{id}/
Документооборот, состояние
Получить "Документооборот, состояние"
GET /api/v1.1/dms_document_states/
Фильтрация "Документооборот, состояние" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_document_states/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_document_id |
int |
|
|
| dms_state_id |
int |
|
|
| dms_state_value_id |
int |
|
|
| datetime |
string |
|
|
| ip |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Документооборот, состояние"
POST /api/v1.1/dms_document_states/
Обновить "Документооборот, состояние" с идентификатором {id}
PUT /api/v1.1/dms_document_states/{id}/
{"dms_document_id": 1, "dms_state_id": 1, ...}
Удалить "Документооборот, состояние" с переданным {id}
DELETE /api/v1.1/dms_document_states/{id}/
Действия
Получить "Действия"
GET /api/v1.1/dms_document_transfer_actions/
Фильтрация "Действия" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_document_transfer_actions/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Действия"
POST /api/v1.1/dms_document_transfer_actions/
Обновить "Действия" с идентификатором {id}
PUT /api/v1.1/dms_document_transfer_actions/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Действия" с переданным {id}
DELETE /api/v1.1/dms_document_transfer_actions/{id}/
Связанные элементы
Получить "Журнал передачи" у "Действия" с идентификатором {id}
GET /api/v1.1/dms_document_transfer_actions/{id}/dms_document_transfers/
Результаты
Получить "Результаты"
GET /api/v1.1/dms_document_transfer_results/
Фильтрация "Результаты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_document_transfer_results/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| icon |
string |
Иконка |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Результаты"
POST /api/v1.1/dms_document_transfer_results/
Обновить "Результаты" с идентификатором {id}
PUT /api/v1.1/dms_document_transfer_results/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Результаты" с переданным {id}
DELETE /api/v1.1/dms_document_transfer_results/{id}/
Связанные элементы
Получить "Журнал передачи" у "Результаты" с идентификатором {id}
GET /api/v1.1/dms_document_transfer_results/{id}/dms_document_transfers/
Журнал передачи
Получить "Журнал передачи"
GET /api/v1.1/dms_document_transfers/
Фильтрация "Журнал передачи" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_document_transfers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| dms_document_id |
int |
Идентификатор документа |
|
| dms_document_transfer_action_id |
int |
Действие |
|
| dms_document_transfer_result_id |
int |
Результат |
|
| recipient_user_id |
int |
Кому передано |
|
| original |
int |
Оригинал |
|
| description |
string |
Комментарий |
|
| issued |
string |
Дата выдачи |
|
| deadline |
string |
Срок возврата |
|
| recieved |
string |
Дата возврата |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Журнал передачи"
POST /api/v1.1/dms_document_transfers/
Обновить "Журнал передачи" с идентификатором {id}
PUT /api/v1.1/dms_document_transfers/{id}/
{"site_id": 1, "dms_document_id": 1, ...}
Удалить "Журнал передачи" с переданным {id}
DELETE /api/v1.1/dms_document_transfers/{id}/
Документооборот, права доступа отдела к типам документов
Получить "Документооборот, права доступа отдела к типам документов"
GET /api/v1.1/dms_document_type_department_accesses/
Фильтрация "Документооборот, права доступа отдела к типам документов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_document_type_department_accesses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_document_type_id |
int |
|
|
| company_department_id |
int |
|
|
| department_access |
int |
|
|
| head_access |
int |
|
|
Создать "Документооборот, права доступа отдела к типам документов"
POST /api/v1.1/dms_document_type_department_accesses/
Обновить "Документооборот, права доступа отдела к типам документов" с идентификатором {id}
PUT /api/v1.1/dms_document_type_department_accesses/{id}/
{"dms_document_type_id": 1, "company_department_id": 1, ...}
Удалить "Документооборот, права доступа отдела к типам документов" с переданным {id}
DELETE /api/v1.1/dms_document_type_department_accesses/{id}/
Документооборот, поля типов документов
Получить "Документооборот, поля типов документов"
GET /api/v1.1/dms_document_type_fields/
Фильтрация "Документооборот, поля типов документов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_document_type_fields/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_document_type_id |
int |
|
|
| dms_field_id |
int |
|
|
Создать "Документооборот, поля типов документов"
POST /api/v1.1/dms_document_type_fields/
Обновить "Документооборот, поля типов документов" с идентификатором {id}
PUT /api/v1.1/dms_document_type_fields/{id}/
{"dms_document_type_id": 1, "dms_field_id": 1, ...}
Удалить "Документооборот, поля типов документов" с переданным {id}
DELETE /api/v1.1/dms_document_type_fields/{id}/
Документооборот, права доступа сотрудников к типам документов
Получить "Документооборот, права доступа сотрудников к типам документов"
GET /api/v1.1/dms_document_type_user_accesses/
Фильтрация "Документооборот, права доступа сотрудников к типам документов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_document_type_user_accesses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_document_type_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| access |
int |
|
|
Создать "Документооборот, права доступа сотрудников к типам документов"
POST /api/v1.1/dms_document_type_user_accesses/
Обновить "Документооборот, права доступа сотрудников к типам документов" с идентификатором {id}
PUT /api/v1.1/dms_document_type_user_accesses/{id}/
{"dms_document_type_id": 1, "user_id": 1, ...}
Удалить "Документооборот, права доступа сотрудников к типам документов" с переданным {id}
DELETE /api/v1.1/dms_document_type_user_accesses/{id}/
Типы документов
Получить "Типы документов"
GET /api/v1.1/dms_document_types/
Фильтрация "Типы документов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_document_types/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Родительский тип |
|
| dms_class_id |
int |
Класс документа |
|
| crm_icon_id |
int |
|
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| number_template |
string |
Шаблон номера |
|
| periodicity |
int |
Периодичность |
|
| color |
string |
Цвет |
|
| ~icon |
string |
|
|
| sorting |
int |
Порядок сортировки |
|
| number |
int |
|
|
| date |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Типы документов"
POST /api/v1.1/dms_document_types/
Обновить "Типы документов" с идентификатором {id}
PUT /api/v1.1/dms_document_types/{id}/
{"parent_id": 1, "dms_class_id": 1, ...}
Удалить "Типы документов" с переданным {id}
DELETE /api/v1.1/dms_document_types/{id}/
Связанные элементы
Получить "Документооборот" у "Типы документов" с идентификатором {id}
GET /api/v1.1/dms_document_types/{id}/dms_documents/
Получить "Типы документов" у "Типы документов" с идентификатором {id}
GET /api/v1.1/dms_document_types/{id}/dms_document_types/
Получить "Номенклатура" у "Типы документов" с идентификатором {id}
GET /api/v1.1/dms_document_types/{id}/dms_nomenclatures/
Получить "Документооборот, типы документов номенклатуры" у "Типы документов" с идентификатором {id}
GET /api/v1.1/dms_document_types/{id}/dms_nomenclature_document_types/
Получить "Документооборот, поля типов документов" у "Типы документов" с идентификатором {id}
GET /api/v1.1/dms_document_types/{id}/dms_document_type_fields/
Получить "Поля групп полей" у "Типы документов" с идентификатором {id}
GET /api/v1.1/dms_document_types/{id}/dms_fields/
Получить "Документооборот, типы документов, состояния" у "Типы документов" с идентификатором {id}
GET /api/v1.1/dms_document_types/{id}/dms_state_document_types/
Получить "Состояния" у "Типы документов" с идентификатором {id}
GET /api/v1.1/dms_document_types/{id}/dms_states/
Получить "Документооборот, права доступа сотрудников к типам документов" у "Типы документов" с идентификатором {id}
GET /api/v1.1/dms_document_types/{id}/dms_document_type_user_accesses/
Получить "Документооборот, права доступа отдела к типам документов" у "Типы документов" с идентификатором {id}
GET /api/v1.1/dms_document_types/{id}/dms_document_type_department_accesses/
Получить "Документооборот, тип связи связанного документа" у "Типы документов" с идентификатором {id}
GET /api/v1.1/dms_document_types/{id}/dms_document_relation_type_document_types/
Вложения версий документов
Получить "Вложения версий документов"
GET /api/v1.1/dms_document_version_attachments/
Фильтрация "Вложения версий документов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_document_version_attachments/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_document_version_id |
int |
|
|
| name |
string |
|
|
| filename |
string |
|
|
| number |
int |
|
|
| datetime |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Вложения версий документов"
POST /api/v1.1/dms_document_version_attachments/
Обновить "Вложения версий документов" с идентификатором {id}
PUT /api/v1.1/dms_document_version_attachments/{id}/
{"dms_document_version_id": 1, "name": "...", ...}
Удалить "Вложения версий документов" с переданным {id}
DELETE /api/v1.1/dms_document_version_attachments/{id}/
Версии документов
Получить "Версии документов"
GET /api/v1.1/dms_document_versions/
Фильтрация "Версии документов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_document_versions/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_document_id |
int |
|
|
| datetime |
string |
|
|
| guid |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Версии документов"
POST /api/v1.1/dms_document_versions/
Обновить "Версии документов" с идентификатором {id}
PUT /api/v1.1/dms_document_versions/{id}/
{"dms_document_id": 1, "datetime": "...", ...}
Удалить "Версии документов" с переданным {id}
DELETE /api/v1.1/dms_document_versions/{id}/
Связанные элементы
Получить "Вложения версий документов" у "Версии документов" с идентификатором {id}
GET /api/v1.1/dms_document_versions/{id}/dms_document_version_attachments/
Документооборот
Получить "Документооборот"
GET /api/v1.1/dms_documents/
Фильтрация "Документооборот" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_documents/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| dms_document_type_id |
int |
Тип документа |
|
| dms_communication_id |
int |
Способ связи |
|
| company_id |
int |
Компания |
|
| crm_project_id |
int |
Проект |
|
| company_activity_id |
int |
Направление деятельности |
|
| dms_case_id |
int |
Дело |
|
| number |
string |
Номер документа |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| datetime |
string |
от |
|
| created |
string |
Создано |
|
| classify |
int |
Гриф |
|
| dms_case_date |
string |
Дата |
|
| dms_case_copy |
int |
Экземпляров |
|
| dms_case_sheets |
int |
Листов в экз. |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Документооборот"
POST /api/v1.1/dms_documents/
Обновить "Документооборот" с идентификатором {id}
PUT /api/v1.1/dms_documents/{id}/
{"site_id": 1, "dms_document_type_id": 1, ...}
Удалить "Документооборот" с переданным {id}
DELETE /api/v1.1/dms_documents/{id}/
Связанные элементы
Получить "Версии документов" у "Документооборот" с идентификатором {id}
GET /api/v1.1/dms_documents/{id}/dms_document_versions/
Получить "Визы" у "Документооборот" с идентификатором {id}
GET /api/v1.1/dms_documents/{id}/dms_document_approves/
Получить "Резолюции" у "Документооборот" с идентификатором {id}
GET /api/v1.1/dms_documents/{id}/dms_document_instructions/
Получить "Документооборот, состояние" у "Документооборот" с идентификатором {id}
GET /api/v1.1/dms_documents/{id}/dms_document_states/
Получить "Запущенные бизнес-процессы" у "Документооборот" с идентификатором {id}
GET /api/v1.1/dms_documents/{id}/dms_workflow_executions/
Получить "Документооборот, права доступа сотрудников" у "Документооборот" с идентификатором {id}
GET /api/v1.1/dms_documents/{id}/dms_document_access_users/
Получить "Документооборот, связанные документы" у "Документооборот" с идентификатором {id}
GET /api/v1.1/dms_documents/{id}/dms_document_relations/
Получить "Журнал передачи" у "Документооборот" с идентификатором {id}
GET /api/v1.1/dms_documents/{id}/dms_document_transfers/
Получить "Контрольные точки" у "Документооборот" с идентификатором {id}
GET /api/v1.1/dms_documents/{id}/dms_document_checkpoints/
Получить "Лиды, документы" у "Документооборот" с идентификатором {id}
GET /api/v1.1/dms_documents/{id}/lead_dms_documents/
Получить "Сделки, документы" у "Документооборот" с идентификатором {id}
GET /api/v1.1/dms_documents/{id}/deal_dms_documents/
Получить "Дела, документы" у "Документооборот" с идентификатором {id}
GET /api/v1.1/dms_documents/{id}/event_dms_documents/
Группы полей
Получить "Группы полей"
GET /api/v1.1/dms_field_dirs/
Фильтрация "Группы полей" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_field_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Название |
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Группы полей"
POST /api/v1.1/dms_field_dirs/
Обновить "Группы полей" с идентификатором {id}
PUT /api/v1.1/dms_field_dirs/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Группы полей" с переданным {id}
DELETE /api/v1.1/dms_field_dirs/{id}/
Связанные элементы
Получить "Поля групп полей" у "Группы полей" с идентификатором {id}
GET /api/v1.1/dms_field_dirs/{id}/dms_fields/
Документооборот, значение полей дата-время
Получить "Документооборот, значение полей дата-время"
GET /api/v1.1/dms_field_value_datetimes/
Фильтрация "Документооборот, значение полей дата-время" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_field_value_datetimes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_field_id |
int |
|
|
| entity_id |
int |
|
|
| value |
string |
|
|
| number |
string |
|
|
Создать "Документооборот, значение полей дата-время"
POST /api/v1.1/dms_field_value_datetimes/
Обновить "Документооборот, значение полей дата-время" с идентификатором {id}
PUT /api/v1.1/dms_field_value_datetimes/{id}/
{"dms_field_id": 1, "entity_id": 1, ...}
Удалить "Документооборот, значение полей дата-время" с переданным {id}
DELETE /api/v1.1/dms_field_value_datetimes/{id}/
Документооборот, значение полей число с плавающей запятой
Получить "Документооборот, значение полей число с плавающей запятой"
GET /api/v1.1/dms_field_value_decimals/
Фильтрация "Документооборот, значение полей число с плавающей запятой" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_field_value_decimals/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_field_id |
int |
|
|
| entity_id |
int |
|
|
| value |
decimal |
|
|
| shop_currency_id |
int |
|
|
Создать "Документооборот, значение полей число с плавающей запятой"
POST /api/v1.1/dms_field_value_decimals/
Обновить "Документооборот, значение полей число с плавающей запятой" с идентификатором {id}
PUT /api/v1.1/dms_field_value_decimals/{id}/
{"dms_field_id": 1, "entity_id": 1, ...}
Удалить "Документооборот, значение полей число с плавающей запятой" с переданным {id}
DELETE /api/v1.1/dms_field_value_decimals/{id}/
Документооборот, значение полей целое число
Получить "Документооборот, значение полей целое число"
GET /api/v1.1/dms_field_value_ints/
Фильтрация "Документооборот, значение полей целое число" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_field_value_ints/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_field_id |
int |
|
|
| entity_id |
int |
|
|
| value |
int |
|
|
Создать "Документооборот, значение полей целое число"
POST /api/v1.1/dms_field_value_ints/
Обновить "Документооборот, значение полей целое число" с идентификатором {id}
PUT /api/v1.1/dms_field_value_ints/{id}/
{"dms_field_id": 1, "entity_id": 1, ...}
Удалить "Документооборот, значение полей целое число" с переданным {id}
DELETE /api/v1.1/dms_field_value_ints/{id}/
Документооборот, значение полей строки
Получить "Документооборот, значение полей строки"
GET /api/v1.1/dms_field_value_strings/
Фильтрация "Документооборот, значение полей строки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_field_value_strings/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_field_id |
int |
|
|
| entity_id |
int |
|
|
| value |
string |
|
|
Создать "Документооборот, значение полей строки"
POST /api/v1.1/dms_field_value_strings/
Обновить "Документооборот, значение полей строки" с идентификатором {id}
PUT /api/v1.1/dms_field_value_strings/{id}/
{"dms_field_id": 1, "entity_id": 1, ...}
Удалить "Документооборот, значение полей строки" с переданным {id}
DELETE /api/v1.1/dms_field_value_strings/{id}/
Документооборот, значение полей текст
Получить "Документооборот, значение полей текст"
GET /api/v1.1/dms_field_value_texts/
Фильтрация "Документооборот, значение полей текст" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_field_value_texts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_field_id |
int |
|
|
| entity_id |
int |
|
|
| value |
string |
|
|
Создать "Документооборот, значение полей текст"
POST /api/v1.1/dms_field_value_texts/
Обновить "Документооборот, значение полей текст" с идентификатором {id}
PUT /api/v1.1/dms_field_value_texts/{id}/
{"dms_field_id": 1, "entity_id": 1, ...}
Удалить "Документооборот, значение полей текст" с переданным {id}
DELETE /api/v1.1/dms_field_value_texts/{id}/
Поля групп полей
Получить "Поля групп полей"
GET /api/v1.1/dms_fields/
Фильтрация "Поля групп полей" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_fields/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| dms_field_dir_id |
int |
Группа полей |
|
| list_id |
int |
Список |
|
| name |
string |
Название |
|
| active |
int |
Активность |
|
| type |
int |
Тип поля |
|
| obligatory |
int |
Обязательное для заполнения |
|
| show |
int |
Отображать в списке документов |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Поля групп полей"
POST /api/v1.1/dms_fields/
Обновить "Поля групп полей" с идентификатором {id}
PUT /api/v1.1/dms_fields/{id}/
{"dms_field_dir_id": 1, "list_id": 1, ...}
Удалить "Поля групп полей" с переданным {id}
DELETE /api/v1.1/dms_fields/{id}/
Связанные элементы
Получить "Документооборот, поля типов документов" у "Поля групп полей" с идентификатором {id}
GET /api/v1.1/dms_fields/{id}/dms_document_type_fields/
Получить "Документооборот, значение полей целое число" у "Поля групп полей" с идентификатором {id}
GET /api/v1.1/dms_fields/{id}/dms_field_value_ints/
Получить "Документооборот, значение полей число с плавающей запятой" у "Поля групп полей" с идентификатором {id}
GET /api/v1.1/dms_fields/{id}/dms_field_value_decimals/
Получить "Документооборот, значение полей строки" у "Поля групп полей" с идентификатором {id}
GET /api/v1.1/dms_fields/{id}/dms_field_value_strings/
Получить "Документооборот, значение полей текст" у "Поля групп полей" с идентификатором {id}
GET /api/v1.1/dms_fields/{id}/dms_field_value_texts/
Получить "Документооборот, значение полей дата-время" у "Поля групп полей" с идентификатором {id}
GET /api/v1.1/dms_fields/{id}/dms_field_value_datetimes/
Раздел номенклатуры
Получить "Раздел номенклатуры"
GET /api/v1.1/dms_nomenclature_dirs/
Фильтрация "Раздел номенклатуры" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_nomenclature_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Родительский раздел |
|
| company_id |
int |
Компания |
|
| company_department_id |
int |
Отдел |
|
| index |
string |
Индекс |
|
| name |
string |
Название |
|
| year |
int |
Год |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Раздел номенклатуры"
POST /api/v1.1/dms_nomenclature_dirs/
Обновить "Раздел номенклатуры" с идентификатором {id}
PUT /api/v1.1/dms_nomenclature_dirs/{id}/
{"parent_id": 1, "company_id": 1, ...}
Удалить "Раздел номенклатуры" с переданным {id}
DELETE /api/v1.1/dms_nomenclature_dirs/{id}/
Связанные элементы
Получить "Номенклатура" у "Раздел номенклатуры" с идентификатором {id}
GET /api/v1.1/dms_nomenclature_dirs/{id}/dms_nomenclatures/
Получить "Раздел номенклатуры" у "Раздел номенклатуры" с идентификатором {id}
GET /api/v1.1/dms_nomenclature_dirs/{id}/dms_nomenclature_dirs/
Документооборот, типы документов номенклатуры
Получить "Документооборот, типы документов номенклатуры"
GET /api/v1.1/dms_nomenclature_document_types/
Фильтрация "Документооборот, типы документов номенклатуры" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_nomenclature_document_types/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_nomenclature_id |
int |
|
|
| dms_document_type_id |
int |
|
|
Создать "Документооборот, типы документов номенклатуры"
POST /api/v1.1/dms_nomenclature_document_types/
Обновить "Документооборот, типы документов номенклатуры" с идентификатором {id}
PUT /api/v1.1/dms_nomenclature_document_types/{id}/
{"dms_nomenclature_id": 1, "dms_document_type_id": 1, ...}
Удалить "Документооборот, типы документов номенклатуры" с переданным {id}
DELETE /api/v1.1/dms_nomenclature_document_types/{id}/
Номенклатура
Получить "Номенклатура"
GET /api/v1.1/dms_nomenclatures/
Фильтрация "Номенклатура" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_nomenclatures/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| dms_nomenclature_dir_id |
int |
Раздел |
|
| company_id |
int |
Компания |
|
| company_department_id |
int |
Отдел |
|
| index |
string |
Индекс |
|
| name |
string |
Название |
|
| year |
int |
Год |
|
| retention_period |
int |
Период хранения (лет) |
|
| paragraphs |
string |
Статьи |
|
| note |
string |
Примечание |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Номенклатура"
POST /api/v1.1/dms_nomenclatures/
Обновить "Номенклатура" с идентификатором {id}
PUT /api/v1.1/dms_nomenclatures/{id}/
{"dms_nomenclature_dir_id": 1, "company_id": 1, ...}
Удалить "Номенклатура" с переданным {id}
DELETE /api/v1.1/dms_nomenclatures/{id}/
Связанные элементы
Получить "Типы документов" у "Номенклатура" с идентификатором {id}
GET /api/v1.1/dms_nomenclatures/{id}/dms_document_types/
Получить "Документооборот, типы документов номенклатуры" у "Номенклатура" с идентификатором {id}
GET /api/v1.1/dms_nomenclatures/{id}/dms_nomenclature_document_types/
Получить "Дела в документообороте" у "Номенклатура" с идентификатором {id}
GET /api/v1.1/dms_nomenclatures/{id}/dms_cases/
Шаблоны участников
Получить "Шаблоны участников"
GET /api/v1.1/dms_participants/
Фильтрация "Шаблоны участников" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_participants/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| function |
string |
Функция |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Шаблоны участников"
POST /api/v1.1/dms_participants/
Обновить "Шаблоны участников" с идентификатором {id}
PUT /api/v1.1/dms_participants/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Шаблоны участников" с переданным {id}
DELETE /api/v1.1/dms_participants/{id}/
Связанные элементы
Получить "Шаблоны участников, сотрудники" у "Шаблоны участников" с идентификатором {id}
GET /api/v1.1/dms_participants/{id}/dms_workflow_template_users/
Документооборот, типы документов, состояния
Получить "Документооборот, типы документов, состояния"
GET /api/v1.1/dms_state_document_types/
Фильтрация "Документооборот, типы документов, состояния" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_state_document_types/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_state_id |
int |
|
|
| dms_document_type_id |
int |
|
|
Создать "Документооборот, типы документов, состояния"
POST /api/v1.1/dms_state_document_types/
Обновить "Документооборот, типы документов, состояния" с идентификатором {id}
PUT /api/v1.1/dms_state_document_types/{id}/
{"dms_state_id": 1, "dms_document_type_id": 1, ...}
Удалить "Документооборот, типы документов, состояния" с переданным {id}
DELETE /api/v1.1/dms_state_document_types/{id}/
Статусы
Получить "Статусы"
GET /api/v1.1/dms_state_values/
Фильтрация "Статусы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_state_values/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| dms_state_id |
int |
Состояние |
|
| name |
string |
Название |
|
| status |
int |
Статус |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Статусы"
POST /api/v1.1/dms_state_values/
Обновить "Статусы" с идентификатором {id}
PUT /api/v1.1/dms_state_values/{id}/
{"dms_state_id": 1, "name": "...", ...}
Удалить "Статусы" с переданным {id}
DELETE /api/v1.1/dms_state_values/{id}/
Связанные элементы
Получить "Документооборот, состояние" у "Статусы" с идентификатором {id}
GET /api/v1.1/dms_state_values/{id}/dms_document_states/
Состояния
Получить "Состояния"
GET /api/v1.1/dms_states/
Фильтрация "Состояния" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_states/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| sorting |
int |
Порядок сортировки |
|
| color |
string |
Цвет |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Состояния"
POST /api/v1.1/dms_states/
Обновить "Состояния" с идентификатором {id}
PUT /api/v1.1/dms_states/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Состояния" с переданным {id}
DELETE /api/v1.1/dms_states/{id}/
Связанные элементы
Получить "Документооборот, типы документов, состояния" у "Состояния" с идентификатором {id}
GET /api/v1.1/dms_states/{id}/dms_state_document_types/
Получить "Документооборот, состояние" у "Состояния" с идентификатором {id}
GET /api/v1.1/dms_states/{id}/dms_document_states/
Получить "Статусы" у "Состояния" с идентификатором {id}
GET /api/v1.1/dms_states/{id}/dms_state_values/
Получить "Типы документов" у "Состояния" с идентификатором {id}
GET /api/v1.1/dms_states/{id}/dms_document_types/
Группа шаблонов резолюций
Получить "Группа шаблонов резолюций"
GET /api/v1.1/dms_template_instruction_dirs/
Фильтрация "Группа шаблонов резолюций" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_template_instruction_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Родительская группа |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Группа шаблонов резолюций"
POST /api/v1.1/dms_template_instruction_dirs/
Обновить "Группа шаблонов резолюций" с идентификатором {id}
PUT /api/v1.1/dms_template_instruction_dirs/{id}/
{"parent_id": 1, "site_id": 1, ...}
Удалить "Группа шаблонов резолюций" с переданным {id}
DELETE /api/v1.1/dms_template_instruction_dirs/{id}/
Связанные элементы
Получить "Шаблоны резолюций" у "Группа шаблонов резолюций" с идентификатором {id}
GET /api/v1.1/dms_template_instruction_dirs/{id}/dms_template_instructions/
Получить "Группа шаблонов резолюций" у "Группа шаблонов резолюций" с идентификатором {id}
GET /api/v1.1/dms_template_instruction_dirs/{id}/dms_template_instruction_dirs/
Шаблоны резолюций
Получить "Шаблоны резолюций"
GET /api/v1.1/dms_template_instructions/
Фильтрация "Шаблоны резолюций" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_template_instructions/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| dms_template_instruction_dir_id |
int |
Группа шаблонов резолюций |
|
| name |
string |
Название |
|
| text |
string |
Текст |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Шаблоны резолюций"
POST /api/v1.1/dms_template_instructions/
Обновить "Шаблоны резолюций" с идентификатором {id}
PUT /api/v1.1/dms_template_instructions/{id}/
{"site_id": 1, "dms_template_instruction_dir_id": 1, ...}
Удалить "Шаблоны резолюций" с переданным {id}
DELETE /api/v1.1/dms_template_instructions/{id}/
Запущенные бизнес-процессы, переход по этапам
Получить "Запущенные бизнес-процессы, переход по этапам"
GET /api/v1.1/dms_workflow_execution_step_routes/
Фильтрация "Запущенные бизнес-процессы, переход по этапам" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_workflow_execution_step_routes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| expected_step_id |
int |
|
|
| dms_state_value_id |
int |
|
|
| dms_workflow_execution_step_id |
int |
|
|
Создать "Запущенные бизнес-процессы, переход по этапам"
POST /api/v1.1/dms_workflow_execution_step_routes/
Обновить "Запущенные бизнес-процессы, переход по этапам" с идентификатором {id}
PUT /api/v1.1/dms_workflow_execution_step_routes/{id}/
{"expected_step_id": 1, "dms_state_value_id": 1, ...}
Удалить "Запущенные бизнес-процессы, переход по этапам" с переданным {id}
DELETE /api/v1.1/dms_workflow_execution_step_routes/{id}/
Запущенные бизнес-процессы, этапы
Получить "Запущенные бизнес-процессы, этапы"
GET /api/v1.1/dms_workflow_execution_steps/
Фильтрация "Запущенные бизнес-процессы, этапы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_workflow_execution_steps/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_workflow_id |
int |
|
|
| dms_workflow_execution_id |
int |
|
|
| dms_workflow_template_step_id |
int |
|
|
| duration |
int |
|
|
| route_type |
int |
|
|
| final |
int |
|
|
| sorting |
int |
|
|
| started |
int |
|
|
| completed |
int |
|
|
Создать "Запущенные бизнес-процессы, этапы"
POST /api/v1.1/dms_workflow_execution_steps/
Обновить "Запущенные бизнес-процессы, этапы" с идентификатором {id}
PUT /api/v1.1/dms_workflow_execution_steps/{id}/
{"dms_workflow_id": 1, "dms_workflow_execution_id": 1, ...}
Удалить "Запущенные бизнес-процессы, этапы" с переданным {id}
DELETE /api/v1.1/dms_workflow_execution_steps/{id}/
Связанные элементы
Получить "Запущенные бизнес-процессы, переход по этапам" у "Запущенные бизнес-процессы, этапы" с идентификатором {id}
GET /api/v1.1/dms_workflow_execution_steps/{id}/dms_workflow_execution_step_routes/
Получить "Дела, сотрудники запущенных бизнес-процессов" у "Запущенные бизнес-процессы, этапы" с идентификатором {id}
GET /api/v1.1/dms_workflow_execution_steps/{id}/dms_workflow_execution_users/
Дела, сотрудники запущенных бизнес-процессов
Получить "Дела, сотрудники запущенных бизнес-процессов"
GET /api/v1.1/dms_workflow_execution_users/
Фильтрация "Дела, сотрудники запущенных бизнес-процессов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_workflow_execution_users/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_workflow_execution_id |
int |
|
|
| dms_workflow_execution_step_id |
int |
|
|
| dms_participant_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| event_id |
int |
|
|
| sorting |
int |
|
|
| responsible |
int |
|
|
Создать "Дела, сотрудники запущенных бизнес-процессов"
POST /api/v1.1/dms_workflow_execution_users/
Обновить "Дела, сотрудники запущенных бизнес-процессов" с идентификатором {id}
PUT /api/v1.1/dms_workflow_execution_users/{id}/
{"dms_workflow_execution_id": 1, "dms_workflow_execution_step_id": 1, ...}
Удалить "Дела, сотрудники запущенных бизнес-процессов" с переданным {id}
DELETE /api/v1.1/dms_workflow_execution_users/{id}/
Запущенные бизнес-процессы
Получить "Запущенные бизнес-процессы"
GET /api/v1.1/dms_workflow_executions/
Фильтрация "Запущенные бизнес-процессы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_workflow_executions/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_document_id |
int |
|
|
| dms_workflow_template_id |
int |
|
|
| dms_workflow_execution_step_id |
int |
|
|
| datetime |
string |
Запущен |
|
| deadline |
string |
Срок |
|
| responsible |
int |
Ответственный |
|
| completed |
int |
|
|
| user_id |
int |
Запустил |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Запущенные бизнес-процессы"
POST /api/v1.1/dms_workflow_executions/
Обновить "Запущенные бизнес-процессы" с идентификатором {id}
PUT /api/v1.1/dms_workflow_executions/{id}/
{"dms_document_id": 1, "dms_workflow_template_id": 1, ...}
Удалить "Запущенные бизнес-процессы" с переданным {id}
DELETE /api/v1.1/dms_workflow_executions/{id}/
Связанные элементы
Получить "Дела, сотрудники запущенных бизнес-процессов" у "Запущенные бизнес-процессы" с идентификатором {id}
GET /api/v1.1/dms_workflow_executions/{id}/dms_workflow_execution_users/
Получить "Запущенные бизнес-процессы, этапы" у "Запущенные бизнес-процессы" с идентификатором {id}
GET /api/v1.1/dms_workflow_executions/{id}/dms_workflow_execution_steps/
Раздел шаблонов бизнес-процессов
Получить "Раздел шаблонов бизнес-процессов"
GET /api/v1.1/dms_workflow_template_dirs/
Фильтрация "Раздел шаблонов бизнес-процессов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_workflow_template_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| parent_id |
int |
|
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Раздел шаблонов бизнес-процессов"
POST /api/v1.1/dms_workflow_template_dirs/
Обновить "Раздел шаблонов бизнес-процессов" с идентификатором {id}
PUT /api/v1.1/dms_workflow_template_dirs/{id}/
{"site_id": 1, "parent_id": 1, ...}
Удалить "Раздел шаблонов бизнес-процессов" с переданным {id}
DELETE /api/v1.1/dms_workflow_template_dirs/{id}/
Связанные элементы
Получить "Шаблоны бизнес-процессов" у "Раздел шаблонов бизнес-процессов" с идентификатором {id}
GET /api/v1.1/dms_workflow_template_dirs/{id}/dms_workflow_templates/
Получить "Раздел шаблонов бизнес-процессов" у "Раздел шаблонов бизнес-процессов" с идентификатором {id}
GET /api/v1.1/dms_workflow_template_dirs/{id}/dms_workflow_template_dirs/
Шаблоны бизнес-процессов, переход по этапам
Получить "Шаблоны бизнес-процессов, переход по этапам"
GET /api/v1.1/dms_workflow_template_step_routes/
Фильтрация "Шаблоны бизнес-процессов, переход по этапам" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_workflow_template_step_routes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| expected_step_id |
int |
|
|
| dms_state_value_id |
int |
|
|
| dms_workflow_template_step_id |
int |
|
|
Создать "Шаблоны бизнес-процессов, переход по этапам"
POST /api/v1.1/dms_workflow_template_step_routes/
Обновить "Шаблоны бизнес-процессов, переход по этапам" с идентификатором {id}
PUT /api/v1.1/dms_workflow_template_step_routes/{id}/
{"expected_step_id": 1, "dms_state_value_id": 1, ...}
Удалить "Шаблоны бизнес-процессов, переход по этапам" с переданным {id}
DELETE /api/v1.1/dms_workflow_template_step_routes/{id}/
Шаблоны бизнес-процессов, этапы
Получить "Шаблоны бизнес-процессов, этапы"
GET /api/v1.1/dms_workflow_template_steps/
Фильтрация "Шаблоны бизнес-процессов, этапы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_workflow_template_steps/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_workflow_id |
int |
|
|
| dms_workflow_template_id |
int |
|
|
| description |
string |
|
|
| inspector |
int |
|
|
| duration |
int |
|
|
| route_type |
int |
|
|
| final |
int |
Финальный этап |
|
| sorting |
int |
|
|
Создать "Шаблоны бизнес-процессов, этапы"
POST /api/v1.1/dms_workflow_template_steps/
Обновить "Шаблоны бизнес-процессов, этапы" с идентификатором {id}
PUT /api/v1.1/dms_workflow_template_steps/{id}/
{"dms_workflow_id": 1, "dms_workflow_template_id": 1, ...}
Удалить "Шаблоны бизнес-процессов, этапы" с переданным {id}
DELETE /api/v1.1/dms_workflow_template_steps/{id}/
Связанные элементы
Получить "Шаблоны участников, сотрудники" у "Шаблоны бизнес-процессов, этапы" с идентификатором {id}
GET /api/v1.1/dms_workflow_template_steps/{id}/dms_workflow_template_users/
Получить "Шаблоны бизнес-процессов, переход по этапам" у "Шаблоны бизнес-процессов, этапы" с идентификатором {id}
GET /api/v1.1/dms_workflow_template_steps/{id}/dms_workflow_template_step_routes/
Шаблоны участников, сотрудники
Получить "Шаблоны участников, сотрудники"
GET /api/v1.1/dms_workflow_template_users/
Фильтрация "Шаблоны участников, сотрудники" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_workflow_template_users/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| dms_workflow_template_step_id |
int |
|
|
| dms_participant_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| sorting |
int |
|
|
| responsible |
int |
|
|
Создать "Шаблоны участников, сотрудники"
POST /api/v1.1/dms_workflow_template_users/
Обновить "Шаблоны участников, сотрудники" с идентификатором {id}
PUT /api/v1.1/dms_workflow_template_users/{id}/
{"dms_workflow_template_step_id": 1, "dms_participant_id": 1, ...}
Удалить "Шаблоны участников, сотрудники" с переданным {id}
DELETE /api/v1.1/dms_workflow_template_users/{id}/
Шаблоны бизнес-процессов
Получить "Шаблоны бизнес-процессов"
GET /api/v1.1/dms_workflow_templates/
Фильтрация "Шаблоны бизнес-процессов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_workflow_templates/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| dms_workflow_template_dir_id |
int |
Раздел |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| responsible |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Шаблоны бизнес-процессов"
POST /api/v1.1/dms_workflow_templates/
Обновить "Шаблоны бизнес-процессов" с идентификатором {id}
PUT /api/v1.1/dms_workflow_templates/{id}/
{"site_id": 1, "dms_workflow_template_dir_id": 1, ...}
Удалить "Шаблоны бизнес-процессов" с переданным {id}
DELETE /api/v1.1/dms_workflow_templates/{id}/
Связанные элементы
Получить "Шаблоны бизнес-процессов, этапы" у "Шаблоны бизнес-процессов" с идентификатором {id}
GET /api/v1.1/dms_workflow_templates/{id}/dms_workflow_template_steps/
Получить "Запущенные бизнес-процессы" у "Шаблоны бизнес-процессов" с идентификатором {id}
GET /api/v1.1/dms_workflow_templates/{id}/dms_workflow_executions/
Бизнес-процессы
Получить "Бизнес-процессы"
GET /api/v1.1/dms_workflows/
Фильтрация "Бизнес-процессы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/dms_workflows/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| event_type_id |
int |
Тип дела |
|
| dms_state_id |
int |
Состояние |
|
| progress_dms_state_value_id |
int |
Запуск |
|
| success_dms_state_value_id |
int |
Успешно |
|
| failed_dms_state_value_id |
int |
Провалено |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| important |
int |
Важное |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Бизнес-процессы"
POST /api/v1.1/dms_workflows/
Обновить "Бизнес-процессы" с идентификатором {id}
PUT /api/v1.1/dms_workflows/{id}/
{"site_id": 1, "event_type_id": 1, ...}
Удалить "Бизнес-процессы" с переданным {id}
DELETE /api/v1.1/dms_workflows/{id}/
Связанные элементы
Получить "Шаблоны бизнес-процессов, этапы" у "Бизнес-процессы" с идентификатором {id}
GET /api/v1.1/dms_workflows/{id}/dms_workflow_template_steps/
Получить "Запущенные бизнес-процессы, этапы" у "Бизнес-процессы" с идентификатором {id}
GET /api/v1.1/dms_workflows/{id}/dms_workflow_execution_steps/
Дополнительные свойства
Дополнительные свойства
Получить "Дополнительные свойства"
GET /api/v1.1/properties/
Фильтрация "Дополнительные свойства" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/properties/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| property_dir_id |
int |
|
|
| list_id |
int |
Список |
|
| informationsystem_id |
int |
Информационная система |
|
| shop_id |
int |
Интернет-магазин |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| type |
int |
Тип |
|
| default_value |
string |
Значение по умолчанию |
|
| tag_name |
string |
Название XML-тега |
|
| sorting |
int |
Порядок сортировки |
|
| prefix_small_file |
string |
Префикс имени малого файла |
|
| prefix_large_file |
string |
Префикс имени большого файла |
|
| image_large_max_width |
int |
Максимальная ширина большого изображения |
|
| image_large_max_height |
int |
Максимальная высота большого изображения |
|
| image_small_max_width |
int |
Максимальная ширина малого изображения |
|
| image_small_max_height |
int |
Максимальная высота малого изображения |
|
| hide_small_image |
int |
Скрыть поле малого изображения |
|
| preserve_aspect_ratio |
int |
Сохранять пропорции изображения |
|
| preserve_aspect_ratio_small |
int |
Сохранять пропорции малого изображения |
|
| watermark_default_use_large_image |
int |
Использовать водяной знак |
|
| watermark_default_use_small_image |
int |
Использовать водяной знак для малых изображений |
|
| typograph |
int |
|
|
| trailing_punctuation |
int |
|
|
| guid |
string |
GUID |
|
| multiple |
int |
Разрешить множественные значения для свойства |
|
| indexing |
int |
Индексировать |
|
| obligatory |
int |
Обязательное для заполнения |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Дополнительные свойства"
POST /api/v1.1/properties/
Обновить "Дополнительные свойства" с идентификатором {id}
PUT /api/v1.1/properties/{id}/
{"property_dir_id": 1, "list_id": 1, ...}
Удалить "Дополнительные свойства" с переданным {id}
DELETE /api/v1.1/properties/{id}/
Связанные элементы
Получить "Дополнительные свойства, значения большие целые числа" у "Дополнительные свойства" с идентификатором {id}
GET /api/v1.1/properties/{id}/property_value_bigints/
Получить "Дополнительные свойства, значения целые числа" у "Дополнительные свойства" с идентификатором {id}
GET /api/v1.1/properties/{id}/property_value_ints/
Получить "Дополнительные свойства, значения числа с плавающей запятой" у "Дополнительные свойства" с идентификатором {id}
GET /api/v1.1/properties/{id}/property_value_floats/
Получить "Дополнительные свойства, значения строки" у "Дополнительные свойства" с идентификатором {id}
GET /api/v1.1/properties/{id}/property_value_strings/
Получить "Дополнительные свойства, значения текст" у "Дополнительные свойства" с идентификатором {id}
GET /api/v1.1/properties/{id}/property_value_texts/
Получить "Дополнительные свойства, значения дата-время" у "Дополнительные свойства" с идентификатором {id}
GET /api/v1.1/properties/{id}/property_value_datetimes/
Получить "Дополнительные свойства, значения файлов" у "Дополнительные свойства" с идентификатором {id}
GET /api/v1.1/properties/{id}/property_value_files/
Разделы свойств
Получить "Разделы свойств"
GET /api/v1.1/property_dirs/
Фильтрация "Разделы свойств" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/property_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Родительская директория |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| sorting |
int |
Сортировка |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Разделы свойств"
POST /api/v1.1/property_dirs/
Обновить "Разделы свойств" с идентификатором {id}
PUT /api/v1.1/property_dirs/{id}/
{"parent_id": 1, "name": "...", ...}
Удалить "Разделы свойств" с переданным {id}
DELETE /api/v1.1/property_dirs/{id}/
Связанные элементы
Получить "Дополнительные свойства" у "Разделы свойств" с идентификатором {id}
GET /api/v1.1/property_dirs/{id}/properties/
Получить "Разделы свойств" у "Разделы свойств" с идентификатором {id}
GET /api/v1.1/property_dirs/{id}/property_dirs/
Дополнительные свойства, значения большие целые числа
Получить "Дополнительные свойства, значения большие целые числа"
GET /api/v1.1/property_value_bigints/
Фильтрация "Дополнительные свойства, значения большие целые числа" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/property_value_bigints/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| property_id |
int |
|
|
| entity_id |
int |
|
|
| value |
int |
|
|
| sorting |
int |
|
|
Создать "Дополнительные свойства, значения большие целые числа"
POST /api/v1.1/property_value_bigints/
Обновить "Дополнительные свойства, значения большие целые числа" с идентификатором {id}
PUT /api/v1.1/property_value_bigints/{id}/
{"property_id": 1, "entity_id": 1, ...}
Удалить "Дополнительные свойства, значения большие целые числа" с переданным {id}
DELETE /api/v1.1/property_value_bigints/{id}/
Дополнительные свойства, значения дата-время
Получить "Дополнительные свойства, значения дата-время"
GET /api/v1.1/property_value_datetimes/
Фильтрация "Дополнительные свойства, значения дата-время" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/property_value_datetimes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| property_id |
int |
|
|
| entity_id |
int |
|
|
| value |
string |
|
|
| sorting |
int |
|
|
Создать "Дополнительные свойства, значения дата-время"
POST /api/v1.1/property_value_datetimes/
Обновить "Дополнительные свойства, значения дата-время" с идентификатором {id}
PUT /api/v1.1/property_value_datetimes/{id}/
{"property_id": 1, "entity_id": 1, ...}
Удалить "Дополнительные свойства, значения дата-время" с переданным {id}
DELETE /api/v1.1/property_value_datetimes/{id}/
Дополнительные свойства, значения файлов
Получить "Дополнительные свойства, значения файлов"
GET /api/v1.1/property_value_files/
Фильтрация "Дополнительные свойства, значения файлов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/property_value_files/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| property_id |
int |
|
|
| entity_id |
int |
|
|
| file |
string |
|
|
| file_name |
string |
|
|
| file_description |
string |
|
|
| file_small |
string |
|
|
| file_small_name |
string |
|
|
| file_small_description |
string |
|
|
| sorting |
int |
|
|
Создать "Дополнительные свойства, значения файлов"
POST /api/v1.1/property_value_files/
Обновить "Дополнительные свойства, значения файлов" с идентификатором {id}
PUT /api/v1.1/property_value_files/{id}/
{"property_id": 1, "entity_id": 1, ...}
Удалить "Дополнительные свойства, значения файлов" с переданным {id}
DELETE /api/v1.1/property_value_files/{id}/
Дополнительные свойства, значения числа с плавающей запятой
Получить "Дополнительные свойства, значения числа с плавающей запятой"
GET /api/v1.1/property_value_floats/
Фильтрация "Дополнительные свойства, значения числа с плавающей запятой" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/property_value_floats/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| property_id |
int |
|
|
| entity_id |
int |
|
|
| value |
float |
|
|
| sorting |
int |
|
|
Создать "Дополнительные свойства, значения числа с плавающей запятой"
POST /api/v1.1/property_value_floats/
Обновить "Дополнительные свойства, значения числа с плавающей запятой" с идентификатором {id}
PUT /api/v1.1/property_value_floats/{id}/
{"property_id": 1, "entity_id": 1, ...}
Удалить "Дополнительные свойства, значения числа с плавающей запятой" с переданным {id}
DELETE /api/v1.1/property_value_floats/{id}/
Дополнительные свойства, значения целые числа
Получить "Дополнительные свойства, значения целые числа"
GET /api/v1.1/property_value_ints/
Фильтрация "Дополнительные свойства, значения целые числа" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/property_value_ints/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| property_id |
int |
|
|
| entity_id |
int |
|
|
| value |
int |
|
|
| sorting |
int |
|
|
Создать "Дополнительные свойства, значения целые числа"
POST /api/v1.1/property_value_ints/
Обновить "Дополнительные свойства, значения целые числа" с идентификатором {id}
PUT /api/v1.1/property_value_ints/{id}/
{"property_id": 1, "entity_id": 1, ...}
Удалить "Дополнительные свойства, значения целые числа" с переданным {id}
DELETE /api/v1.1/property_value_ints/{id}/
Дополнительные свойства, значения строки
Получить "Дополнительные свойства, значения строки"
GET /api/v1.1/property_value_strings/
Фильтрация "Дополнительные свойства, значения строки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/property_value_strings/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| property_id |
int |
|
|
| entity_id |
int |
|
|
| value |
string |
|
|
| sorting |
int |
|
|
Создать "Дополнительные свойства, значения строки"
POST /api/v1.1/property_value_strings/
Обновить "Дополнительные свойства, значения строки" с идентификатором {id}
PUT /api/v1.1/property_value_strings/{id}/
{"property_id": 1, "entity_id": 1, ...}
Удалить "Дополнительные свойства, значения строки" с переданным {id}
DELETE /api/v1.1/property_value_strings/{id}/
Дополнительные свойства, значения текст
Получить "Дополнительные свойства, значения текст"
GET /api/v1.1/property_value_texts/
Фильтрация "Дополнительные свойства, значения текст" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/property_value_texts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| property_id |
int |
|
|
| entity_id |
int |
|
|
| value |
string |
|
|
| sorting |
int |
|
|
Создать "Дополнительные свойства, значения текст"
POST /api/v1.1/property_value_texts/
Обновить "Дополнительные свойства, значения текст" с идентификатором {id}
PUT /api/v1.1/property_value_texts/{id}/
{"property_id": 1, "entity_id": 1, ...}
Удалить "Дополнительные свойства, значения текст" с переданным {id}
DELETE /api/v1.1/property_value_texts/{id}/
Интернет-магазин
Уровни партнерской программы
Получить "Уровни партнерской программы"
GET /api/v1.1/shop_affiliate_plans/
Фильтрация "Уровни партнерской программы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_affiliate_plans/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| affiliate_plan_id |
int |
|
|
| shop_id |
int |
|
|
Создать "Уровни партнерской программы"
POST /api/v1.1/shop_affiliate_plans/
Обновить "Уровни партнерской программы" с идентификатором {id}
PUT /api/v1.1/shop_affiliate_plans/{id}/
{"affiliate_plan_id": 1, "shop_id": 1, ...}
Удалить "Уровни партнерской программы" с переданным {id}
DELETE /api/v1.1/shop_affiliate_plans/{id}/
Разделы бонусов
Получить "Разделы бонусов"
GET /api/v1.1/shop_bonus_dirs/
Фильтрация "Разделы бонусов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_bonus_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Раздел |
|
| shop_id |
int |
Идентификатор магазина |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Разделы бонусов"
POST /api/v1.1/shop_bonus_dirs/
Обновить "Разделы бонусов" с идентификатором {id}
PUT /api/v1.1/shop_bonus_dirs/{id}/
{"parent_id": 1, "shop_id": 1, ...}
Удалить "Разделы бонусов" с переданным {id}
DELETE /api/v1.1/shop_bonus_dirs/{id}/
Связанные элементы
Получить "Бонусы" у "Разделы бонусов" с идентификатором {id}
GET /api/v1.1/shop_bonus_dirs/{id}/shop_bonuses/
Получить "Разделы бонусов" у "Разделы бонусов" с идентификатором {id}
GET /api/v1.1/shop_bonus_dirs/{id}/shop_bonus_dirs/
Бонусы
Получить "Бонусы"
GET /api/v1.1/shop_bonuses/
Фильтрация "Бонусы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_bonuses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_bonus_dir_id |
int |
Раздел |
|
| shop_id |
int |
Идентификатор магазина |
|
| name |
string |
Название |
|
| description |
string |
Описание бонуса |
|
| start_datetime |
string |
Действует от |
|
| end_datetime |
string |
Действует до |
|
| active |
int |
Активность |
|
| value |
decimal |
Величина бонуса |
|
| type |
int |
Тип бонуса |
|
| min_amount |
decimal |
Минимальная сумма |
|
| accrual_date |
string |
Дата начисления |
|
| accrual_days |
int |
Через (дней) |
|
| expire_days |
int |
На (дней) |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Бонусы"
POST /api/v1.1/shop_bonuses/
Обновить "Бонусы" с идентификатором {id}
PUT /api/v1.1/shop_bonuses/{id}/
{"shop_bonus_dir_id": 1, "shop_id": 1, ...}
Удалить "Бонусы" с переданным {id}
DELETE /api/v1.1/shop_bonuses/{id}/
Связанные элементы
Получить "Товары, бонусы" у "Бонусы" с идентификатором {id}
GET /api/v1.1/shop_bonuses/{id}/shop_item_bonuses/
Интернет-магазин, корзина
Получить "Интернет-магазин, корзина"
GET /api/v1.1/shop_carts/
Фильтрация "Интернет-магазин, корзина" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_carts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| postpone |
int |
|
|
| quantity |
decimal |
|
|
| id |
int |
|
|
| shop_item_id |
int |
|
|
| marking |
string |
|
|
| shop_id |
int |
|
|
| shop_warehouse_id |
int |
|
|
| siteuser_id |
int |
|
|
Создать "Интернет-магазин, корзина"
POST /api/v1.1/shop_carts/
Обновить "Интернет-магазин, корзина" с идентификатором {id}
PUT /api/v1.1/shop_carts/{id}/
{"quantity": "...", "id": 1, ...}
Удалить "Интернет-магазин, корзина" с переданным {id}
DELETE /api/v1.1/shop_carts/{id}/
Маркировка
Получить "Маркировка"
GET /api/v1.1/shop_codetypes/
Фильтрация "Маркировка" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_codetypes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| code |
string |
Код |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Маркировка"
POST /api/v1.1/shop_codetypes/
Обновить "Маркировка" с идентификатором {id}
PUT /api/v1.1/shop_codetypes/{id}/
{"name": "...", "description": "...", ...}
Удалить "Маркировка" с переданным {id}
DELETE /api/v1.1/shop_codetypes/{id}/
Связанные элементы
Получить "Товары заказа, маркировка" у "Маркировка" с идентификатором {id}
GET /api/v1.1/shop_codetypes/{id}/shop_order_item_codes/
Получить "Комментарии, дополнительные свойства"
GET /api/v1.1/shop_comment_properties/
Фильтрация "Комментарии, дополнительные свойства" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_comment_properties/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_id |
int |
|
|
| property_id |
int |
|
|
Создать "Комментарии, дополнительные свойства"
POST /api/v1.1/shop_comment_properties/
Обновить "Комментарии, дополнительные свойства" с идентификатором {id}
PUT /api/v1.1/shop_comment_properties/{id}/
{"shop_id": 1, "property_id": 1, ...}
Удалить "Комментарии, дополнительные свойства" с переданным {id}
DELETE /api/v1.1/shop_comment_properties/{id}/
Получить "Комментарии, группы дополнительных свойств"
GET /api/v1.1/shop_comment_property_dirs/
Фильтрация "Комментарии, группы дополнительных свойств" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_comment_property_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_id |
int |
|
|
| property_dir_id |
int |
|
|
Создать "Комментарии, группы дополнительных свойств"
POST /api/v1.1/shop_comment_property_dirs/
Обновить "Комментарии, группы дополнительных свойств" с идентификатором {id}
PUT /api/v1.1/shop_comment_property_dirs/{id}/
{"shop_id": 1, "property_dir_id": 1, ...}
Удалить "Комментарии, группы дополнительных свойств" с переданным {id}
DELETE /api/v1.1/shop_comment_property_dirs/{id}/
Интернет-магазин, сравнение
Получить "Интернет-магазин, сравнение"
GET /api/v1.1/shop_compares/
Фильтрация "Интернет-магазин, сравнение" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_compares/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_item_id |
int |
|
|
| siteuser_id |
int |
|
|
| shop_id |
int |
|
|
Создать "Интернет-магазин, сравнение"
POST /api/v1.1/shop_compares/
Обновить "Интернет-магазин, сравнение" с идентификатором {id}
PUT /api/v1.1/shop_compares/{id}/
{"shop_item_id": 1, "siteuser_id": 1, ...}
Удалить "Интернет-магазин, сравнение" с переданным {id}
DELETE /api/v1.1/shop_compares/{id}/
Страны
Получить "Страны"
GET /api/v1.1/shop_countries/
Фильтрация "Страны" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_countries/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название страны |
|
| alpha2 |
string |
Код государства |
|
| name_en |
string |
На английском |
|
| name_ru |
string |
На русском |
|
| name_de |
string |
На немецком |
|
| name_fr |
string |
На французском |
|
| name_it |
string |
На итальянском |
|
| name_es |
string |
На испанском |
|
| name_pt |
string |
На португальском |
|
| name_ua |
string |
На украинском |
|
| name_be |
string |
На белорусском |
|
| name_pl |
string |
На польском |
|
| name_lt |
string |
На литовском |
|
| name_lv |
string |
На латышском |
|
| name_cz |
string |
На чешском |
|
| name_ja |
string |
На японском |
|
| user_id |
int |
Идентификатор сотрудника |
|
| sorting |
int |
Порядок сортировки |
|
| active |
int |
Активность |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Страны"
POST /api/v1.1/shop_countries/
Обновить "Страны" с идентификатором {id}
PUT /api/v1.1/shop_countries/{id}/
{"name": "...", "alpha2": "...", ...}
Удалить "Страны" с переданным {id}
DELETE /api/v1.1/shop_countries/{id}/
Связанные элементы
Получить "Интернет-магазины" у "Страны" с идентификатором {id}
GET /api/v1.1/shop_countries/{id}/shops/
Получить "Регионы страны" у "Страны" с идентификатором {id}
GET /api/v1.1/shop_countries/{id}/shop_country_locations/
Населенные пункты и районы
Получить "Населенные пункты и районы"
GET /api/v1.1/shop_country_location_cities/
Фильтрация "Населенные пункты и районы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_country_location_cities/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_country_location_id |
int |
Идентификатор региона |
|
| name |
string |
Название |
|
| name_en |
string |
На английском |
|
| name_ru |
string |
На русском |
|
| name_de |
string |
На немецком |
|
| name_fr |
string |
На французском |
|
| name_it |
string |
На итальянском |
|
| name_es |
string |
На испанском |
|
| name_pt |
string |
На португальском |
|
| name_ua |
string |
На украинском |
|
| name_be |
string |
На белорусском |
|
| name_pl |
string |
На польском |
|
| name_lt |
string |
На литовском |
|
| name_lv |
string |
На латышском |
|
| name_cz |
string |
На чешском |
|
| name_ja |
string |
На японском |
|
| user_id |
int |
Идентификатор сотрудника |
|
| sorting |
int |
Порядок сортировки |
|
| active |
int |
Активность |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Населенные пункты и районы"
POST /api/v1.1/shop_country_location_cities/
Обновить "Населенные пункты и районы" с идентификатором {id}
PUT /api/v1.1/shop_country_location_cities/{id}/
{"shop_country_location_id": 1, "name": "...", ...}
Удалить "Населенные пункты и районы" с переданным {id}
DELETE /api/v1.1/shop_country_location_cities/{id}/
Связанные элементы
Получить "Населенные пункты или районы города" у "Населенные пункты и районы" с идентификатором {id}
GET /api/v1.1/shop_country_location_cities/{id}/shop_country_location_city_areas/
Населенные пункты или районы города
Получить "Населенные пункты или районы города"
GET /api/v1.1/shop_country_location_city_areas/
Фильтрация "Населенные пункты или районы города" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_country_location_city_areas/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| name_en |
string |
На английском |
|
| name_ru |
string |
На русском |
|
| name_de |
string |
На немецком |
|
| name_fr |
string |
На французском |
|
| name_it |
string |
На итальянском |
|
| name_es |
string |
На испанском |
|
| name_pt |
string |
На португальском |
|
| name_ua |
string |
На украинском |
|
| name_be |
string |
На белорусском |
|
| name_pl |
string |
На польском |
|
| name_lt |
string |
На литовском |
|
| name_lv |
string |
На латышском |
|
| name_cz |
string |
На чешском |
|
| name_ja |
string |
На японском |
|
| shop_country_location_city_id |
int |
Идентификатор города |
|
| user_id |
int |
Идентификатор сотрудника |
|
| sorting |
int |
Порядок сортировки |
|
| active |
int |
Активность |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Населенные пункты или районы города"
POST /api/v1.1/shop_country_location_city_areas/
Обновить "Населенные пункты или районы города" с идентификатором {id}
PUT /api/v1.1/shop_country_location_city_areas/{id}/
{"name": "...", "name_en": "...", ...}
Удалить "Населенные пункты или районы города" с переданным {id}
DELETE /api/v1.1/shop_country_location_city_areas/{id}/
Регионы страны
Получить "Регионы страны"
GET /api/v1.1/shop_country_locations/
Фильтрация "Регионы страны" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_country_locations/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| shop_country_id |
int |
Идентификатор страны |
|
| name_en |
string |
На английском |
|
| name_ru |
string |
На русском |
|
| name_de |
string |
На немецком |
|
| name_fr |
string |
На французском |
|
| name_it |
string |
На итальянском |
|
| name_es |
string |
На испанском |
|
| name_pt |
string |
На португальском |
|
| name_ua |
string |
На украинском |
|
| name_be |
string |
На белорусском |
|
| name_pl |
string |
На польском |
|
| name_lt |
string |
На литовском |
|
| name_lv |
string |
На латышском |
|
| name_cz |
string |
На чешском |
|
| name_ja |
string |
На японском |
|
| user_id |
int |
Идентификатор сотрудника |
|
| sorting |
int |
Порядок сортировки |
|
| active |
int |
Активность |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Регионы страны"
POST /api/v1.1/shop_country_locations/
Обновить "Регионы страны" с идентификатором {id}
PUT /api/v1.1/shop_country_locations/{id}/
{"name": "...", "shop_country_id": 1, ...}
Удалить "Регионы страны" с переданным {id}
DELETE /api/v1.1/shop_country_locations/{id}/
Связанные элементы
Получить "Населенные пункты и районы" у "Регионы страны" с идентификатором {id}
GET /api/v1.1/shop_country_locations/{id}/shop_country_location_cities/
Валюты
Получить "Валюты"
GET /api/v1.1/shop_currencies/
Фильтрация "Валюты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_currencies/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| code |
string |
Трехбуквенный код (ISO 4217) |
|
| exchange_rate |
decimal |
Курс |
|
| sign |
string |
Знак валюты |
|
| sign_position |
int |
Позиция знака |
|
| decimal_separator |
string |
Десятичный разделитель |
|
| thousands_separator |
string |
Разделитель тысяч |
|
| hide_zeros |
int |
Не показывать незначащие нули |
|
| date |
string |
Дата курса |
|
| default |
int |
Базовая |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Валюты"
POST /api/v1.1/shop_currencies/
Обновить "Валюты" с идентификатором {id}
PUT /api/v1.1/shop_currencies/{id}/
{"name": "...", "code": "...", ...}
Удалить "Валюты" с переданным {id}
DELETE /api/v1.1/shop_currencies/{id}/
Связанные элементы
Получить "Интернет-магазины" у "Валюты" с идентификатором {id}
GET /api/v1.1/shop_currencies/{id}/shops/
Получить "Товары магазина" у "Валюты" с идентификатором {id}
GET /api/v1.1/shop_currencies/{id}/shop_items/
Типы доставки
Получить "Типы доставки"
GET /api/v1.1/shop_deliveries/
Фильтрация "Типы доставки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_deliveries/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| image |
string |
Изображение |
|
| image_height |
int |
|
|
| image_width |
int |
|
|
| shop_id |
int |
Идентификатор магазина |
|
| user_id |
int |
Идентификатор сотрудника |
|
| sorting |
int |
Порядок сортировки |
|
| type |
int |
|
|
| method |
int |
Способ доставки |
|
| days_from |
int |
Дней доставки от |
|
| days_to |
int |
до |
|
| guid |
string |
GUID |
|
| active |
int |
Активность |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Типы доставки"
POST /api/v1.1/shop_deliveries/
Обновить "Типы доставки" с идентификатором {id}
PUT /api/v1.1/shop_deliveries/{id}/
{"name": "...", "description": "...", ...}
Удалить "Типы доставки" с переданным {id}
DELETE /api/v1.1/shop_deliveries/{id}/
Связанные элементы
Получить "Условия доставки" у "Типы доставки" с идентификатором {id}
GET /api/v1.1/shop_deliveries/{id}/shop_delivery_conditions/
Получить "Группа условий доставки" у "Типы доставки" с идентификатором {id}
GET /api/v1.1/shop_deliveries/{id}/shop_delivery_condition_dirs/
Получить "Типы доставки, платежные системы" у "Типы доставки" с идентификатором {id}
GET /api/v1.1/shop_deliveries/{id}/shop_delivery_payment_systems/
Получить "Платежные системы" у "Типы доставки" с идентификатором {id}
GET /api/v1.1/shop_deliveries/{id}/shop_payment_systems/
Получить "Типы доставки, интервалы" у "Типы доставки" с идентификатором {id}
GET /api/v1.1/shop_deliveries/{id}/shop_delivery_intervals/
Получить "Типы доставки, группы клиентов" у "Типы доставки" с идентификатором {id}
GET /api/v1.1/shop_deliveries/{id}/shop_delivery_siteuser_groups/
Группа условий доставки
Получить "Группа условий доставки"
GET /api/v1.1/shop_delivery_condition_dirs/
Фильтрация "Группа условий доставки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_delivery_condition_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Группа условий доставки |
|
| shop_delivery_id |
int |
Тип доставки, к которому относится группа |
|
| name |
string |
Название группы |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Группа условий доставки"
POST /api/v1.1/shop_delivery_condition_dirs/
Обновить "Группа условий доставки" с идентификатором {id}
PUT /api/v1.1/shop_delivery_condition_dirs/{id}/
{"parent_id": 1, "shop_delivery_id": 1, ...}
Удалить "Группа условий доставки" с переданным {id}
DELETE /api/v1.1/shop_delivery_condition_dirs/{id}/
Связанные элементы
Получить "Группа условий доставки" у "Группа условий доставки" с идентификатором {id}
GET /api/v1.1/shop_delivery_condition_dirs/{id}/shop_delivery_condition_dirs/
Получить "Условия доставки" у "Группа условий доставки" с идентификатором {id}
GET /api/v1.1/shop_delivery_condition_dirs/{id}/shop_delivery_conditions/
Условия доставки
Получить "Условия доставки"
GET /api/v1.1/shop_delivery_conditions/
Фильтрация "Условия доставки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_delivery_conditions/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_delivery_condition_dir_id |
int |
|
|
| shop_delivery_id |
int |
Тип доставки, к которому относится условие доставки |
|
| shop_country_id |
int |
Страна |
|
| shop_country_id_inverted |
int |
|
|
| shop_country_location_id |
int |
Местоположение |
|
| shop_country_location_id_inverted |
int |
|
|
| shop_country_location_city_id |
int |
Город |
|
| shop_country_location_city_id_inverted |
int |
|
|
| shop_country_location_city_area_id |
int |
Район |
|
| shop_country_location_city_area_id_inverted |
int |
|
|
| name |
string |
Название |
|
| delivery_time |
string |
Сроки доставки |
|
| max_weight |
decimal |
Вес заказа до (%s), при указании 0 — максимальный вес заказа не ограничен |
|
| min_weight |
decimal |
Вес заказа от (%s), при указании 0 — минимальный вес заказа не ограничен |
|
| max_price |
decimal |
Цена заказа до, при указании 0 — максимальная цена заказа не ограничена |
|
| min_price |
decimal |
Цена заказа от, при указании 0 — минимальная цена заказа не ограничена |
|
| time_from |
string |
Время заказа с, при указании 00:00:00 — время не ограничено |
|
| time_to |
string |
Время заказа до, при указании 00:00:00 — время не ограничено |
|
| description |
string |
Описание |
|
| price |
decimal |
Цена доставки |
|
| marking |
string |
Артикул доставки |
|
| shop_currency_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| shop_tax_id |
int |
Налог |
|
| sorting |
int |
Порядок сортировки |
|
| active |
int |
Активно |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Условия доставки"
POST /api/v1.1/shop_delivery_conditions/
Обновить "Условия доставки" с идентификатором {id}
PUT /api/v1.1/shop_delivery_conditions/{id}/
{"shop_delivery_condition_dir_id": 1, "shop_delivery_id": 1, ...}
Удалить "Условия доставки" с переданным {id}
DELETE /api/v1.1/shop_delivery_conditions/{id}/
Типы доставки, интервалы
Получить "Типы доставки, интервалы"
GET /api/v1.1/shop_delivery_intervals/
Фильтрация "Типы доставки, интервалы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_delivery_intervals/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_delivery_id |
int |
|
|
| from_time |
string |
Начало интервала |
|
| to_time |
string |
Конец интервала |
|
Создать "Типы доставки, интервалы"
POST /api/v1.1/shop_delivery_intervals/
Обновить "Типы доставки, интервалы" с идентификатором {id}
PUT /api/v1.1/shop_delivery_intervals/{id}/
{"shop_delivery_id": 1, "from_time": "...", ...}
Удалить "Типы доставки, интервалы" с переданным {id}
DELETE /api/v1.1/shop_delivery_intervals/{id}/
Типы доставки, платежные системы
Получить "Типы доставки, платежные системы"
GET /api/v1.1/shop_delivery_payment_systems/
Фильтрация "Типы доставки, платежные системы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_delivery_payment_systems/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_delivery_id |
int |
|
|
| shop_payment_system_id |
int |
|
|
Создать "Типы доставки, платежные системы"
POST /api/v1.1/shop_delivery_payment_systems/
Обновить "Типы доставки, платежные системы" с идентификатором {id}
PUT /api/v1.1/shop_delivery_payment_systems/{id}/
{"shop_delivery_id": 1, "shop_payment_system_id": 1, ...}
Удалить "Типы доставки, платежные системы" с переданным {id}
DELETE /api/v1.1/shop_delivery_payment_systems/{id}/
Типы доставки, группы клиентов
Получить "Типы доставки, группы клиентов"
GET /api/v1.1/shop_delivery_siteuser_groups/
Фильтрация "Типы доставки, группы клиентов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_delivery_siteuser_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_delivery_id |
int |
|
|
| siteuser_group_id |
int |
|
|
Создать "Типы доставки, группы клиентов"
POST /api/v1.1/shop_delivery_siteuser_groups/
Обновить "Типы доставки, группы клиентов" с идентификатором {id}
PUT /api/v1.1/shop_delivery_siteuser_groups/{id}/
{"shop_delivery_id": 1, "siteuser_group_id": 1, ...}
Удалить "Типы доставки, группы клиентов" с переданным {id}
DELETE /api/v1.1/shop_delivery_siteuser_groups/{id}/
Разделы интернет-магазинов
Получить "Разделы интернет-магазинов"
GET /api/v1.1/shop_dirs/
Фильтрация "Разделы интернет-магазинов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Раздел |
|
| name |
string |
Название раздела интеренет-магазинов |
|
| description |
string |
Описание раздела интернет-магазинов |
|
| site_id |
int |
Идентификатор сайта |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Разделы интернет-магазинов"
POST /api/v1.1/shop_dirs/
Обновить "Разделы интернет-магазинов" с идентификатором {id}
PUT /api/v1.1/shop_dirs/{id}/
{"parent_id": 1, "name": "...", ...}
Удалить "Разделы интернет-магазинов" с переданным {id}
DELETE /api/v1.1/shop_dirs/{id}/
Связанные элементы
Получить "Интернет-магазины" у "Разделы интернет-магазинов" с идентификатором {id}
GET /api/v1.1/shop_dirs/{id}/shops/
Получить "Разделы интернет-магазинов" у "Разделы интернет-магазинов" с идентификатором {id}
GET /api/v1.1/shop_dirs/{id}/shop_dirs/
Разделы скидок
Получить "Разделы скидок"
GET /api/v1.1/shop_discount_dirs/
Фильтрация "Разделы скидок" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_discount_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Раздел |
|
| shop_id |
int |
Идентификатор магазина |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Разделы скидок"
POST /api/v1.1/shop_discount_dirs/
Обновить "Разделы скидок" с идентификатором {id}
PUT /api/v1.1/shop_discount_dirs/{id}/
{"parent_id": 1, "shop_id": 1, ...}
Удалить "Разделы скидок" с переданным {id}
DELETE /api/v1.1/shop_discount_dirs/{id}/
Связанные элементы
Получить "Скидки" у "Разделы скидок" с идентификатором {id}
GET /api/v1.1/shop_discount_dirs/{id}/shop_discounts/
Получить "Разделы скидок" у "Разделы скидок" с идентификатором {id}
GET /api/v1.1/shop_discount_dirs/{id}/shop_discount_dirs/
Группы персональной скидки
Получить "Группы персональной скидки"
GET /api/v1.1/shop_discount_siteuser_groups/
Фильтрация "Группы персональной скидки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_discount_siteuser_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_discount_id |
int |
|
|
| siteuser_group_id |
int |
|
|
Создать "Группы персональной скидки"
POST /api/v1.1/shop_discount_siteuser_groups/
Обновить "Группы персональной скидки" с идентификатором {id}
PUT /api/v1.1/shop_discount_siteuser_groups/{id}/
{"shop_discount_id": 1, "siteuser_group_id": 1, ...}
Удалить "Группы персональной скидки" с переданным {id}
DELETE /api/v1.1/shop_discount_siteuser_groups/{id}/
Бонусы дисконтной карты, транзакции
Получить "Бонусы дисконтной карты, транзакции"
GET /api/v1.1/shop_discountcard_bonus_transactions/
Фильтрация "Бонусы дисконтной карты, транзакции" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_discountcard_bonus_transactions/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_order_id |
int |
|
|
| shop_discountcard_bonus_id |
int |
|
|
| amount |
decimal |
|
|
Создать "Бонусы дисконтной карты, транзакции"
POST /api/v1.1/shop_discountcard_bonus_transactions/
Обновить "Бонусы дисконтной карты, транзакции" с идентификатором {id}
PUT /api/v1.1/shop_discountcard_bonus_transactions/{id}/
{"shop_order_id": 1, "shop_discountcard_bonus_id": 1, ...}
Удалить "Бонусы дисконтной карты, транзакции" с переданным {id}
DELETE /api/v1.1/shop_discountcard_bonus_transactions/{id}/
Типы зачислений
Получить "Типы зачислений"
GET /api/v1.1/shop_discountcard_bonus_types/
Фильтрация "Типы зачислений" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_discountcard_bonus_types/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_id |
int |
Идентификатор магазина |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок сортировки |
|
| default |
int |
Тип зачисления "по умолчанию" |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Типы зачислений"
POST /api/v1.1/shop_discountcard_bonus_types/
Обновить "Типы зачислений" с идентификатором {id}
PUT /api/v1.1/shop_discountcard_bonus_types/{id}/
{"shop_id": 1, "name": "...", ...}
Удалить "Типы зачислений" с переданным {id}
DELETE /api/v1.1/shop_discountcard_bonus_types/{id}/
Связанные элементы
Получить "Бонусы дисконтной карты" у "Типы зачислений" с идентификатором {id}
GET /api/v1.1/shop_discountcard_bonus_types/{id}/shop_discountcard_bonuses/
Бонусы дисконтной карты
Получить "Бонусы дисконтной карты"
GET /api/v1.1/shop_discountcard_bonuses/
Фильтрация "Бонусы дисконтной карты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_discountcard_bonuses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_order_id |
int |
Идентификатор заказа |
|
| shop_discountcard_id |
int |
Идентификатор дисконтной карты |
|
| shop_discountcard_bonus_type_id |
int |
Тип зачисления |
|
| datetime |
string |
Дата начисления |
|
| expired |
string |
Дата сгорания |
|
| amount |
decimal |
Сумма |
|
| written_off |
decimal |
Потрачено |
|
| description |
string |
Комментарий |
|
| active |
int |
Активность |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Бонусы дисконтной карты"
POST /api/v1.1/shop_discountcard_bonuses/
Обновить "Бонусы дисконтной карты" с идентификатором {id}
PUT /api/v1.1/shop_discountcard_bonuses/{id}/
{"shop_order_id": 1, "shop_discountcard_id": 1, ...}
Удалить "Бонусы дисконтной карты" с переданным {id}
DELETE /api/v1.1/shop_discountcard_bonuses/{id}/
Связанные элементы
Получить "Бонусы дисконтной карты, транзакции" у "Бонусы дисконтной карты" с идентификатором {id}
GET /api/v1.1/shop_discountcard_bonuses/{id}/shop_discountcard_bonus_transactions/
Уровни дисконтных карт
Получить "Уровни дисконтных карт"
GET /api/v1.1/shop_discountcard_levels/
Фильтрация "Уровни дисконтных карт" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_discountcard_levels/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_id |
int |
Идентификатор магазина |
|
| level |
int |
Уровень (1,2,...) |
|
| discount |
decimal |
Скидка, % |
|
| name |
string |
Название |
|
| color |
string |
Цвет |
|
| amount |
decimal |
Сумма, %s |
|
| apply_max_discount |
int |
Применять максимальную скидку |
|
| round |
int |
Округлять |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Уровни дисконтных карт"
POST /api/v1.1/shop_discountcard_levels/
Обновить "Уровни дисконтных карт" с идентификатором {id}
PUT /api/v1.1/shop_discountcard_levels/{id}/
{"shop_id": 1, "level": 1, ...}
Удалить "Уровни дисконтных карт" с переданным {id}
DELETE /api/v1.1/shop_discountcard_levels/{id}/
Связанные элементы
Получить "Дисконтные карты" у "Уровни дисконтных карт" с идентификатором {id}
GET /api/v1.1/shop_discountcard_levels/{id}/shop_discountcards/
Дисконтные карты
Получить "Дисконтные карты"
GET /api/v1.1/shop_discountcards/
Фильтрация "Дисконтные карты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_discountcards/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_id |
int |
Идентификатор магазина |
|
| siteuser_id |
int |
Клиент |
|
| shop_discountcard_level_id |
int |
Уровень |
|
| number |
string |
Номер |
|
| datetime |
string |
Выдан |
|
| amount |
decimal |
Накоплено, %s |
|
| active |
int |
Активность |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Дисконтные карты"
POST /api/v1.1/shop_discountcards/
Обновить "Дисконтные карты" с идентификатором {id}
PUT /api/v1.1/shop_discountcards/{id}/
{"shop_id": 1, "siteuser_id": 1, ...}
Удалить "Дисконтные карты" с переданным {id}
DELETE /api/v1.1/shop_discountcards/{id}/
Связанные элементы
Получить "Бонусы дисконтной карты" у "Дисконтные карты" с идентификатором {id}
GET /api/v1.1/shop_discountcards/{id}/shop_discountcard_bonuses/
Скидки
Получить "Скидки"
GET /api/v1.1/shop_discounts/
Фильтрация "Скидки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_discounts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_discount_dir_id |
int |
Раздел |
|
| shop_id |
int |
Идентификатор магазина |
|
| name |
string |
Название |
|
| description |
string |
Описание скидки |
|
| start_datetime |
string |
Действует от |
|
| end_datetime |
string |
Действует до |
|
| start_time |
string |
Время от |
|
| end_time |
string |
Время до |
|
| day1 |
int |
Понедельник |
|
| day2 |
int |
Вторник |
|
| day3 |
int |
Среда |
|
| day4 |
int |
Четверг |
|
| day5 |
int |
Пятница |
|
| day6 |
int |
Суббота |
|
| day7 |
int |
Воскресенье |
|
| active |
int |
Активность |
|
| value |
decimal |
Величина скидки |
|
| type |
int |
Тип скидки |
|
| coupon |
int |
Применять с купоном |
|
| coupon_text |
string |
Купон |
|
| max_discount |
decimal |
Максимальная скидка |
|
| url |
string |
Ссылка на описание скидки |
|
| not_apply_purchase_discount |
int |
Не применять скидки от суммы заказа |
|
| public |
int |
Выгружать в Маркет |
|
| guid |
string |
Идентификатор товара CommerceML |
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Скидки"
POST /api/v1.1/shop_discounts/
Обновить "Скидки" с идентификатором {id}
PUT /api/v1.1/shop_discounts/{id}/
{"shop_discount_dir_id": 1, "shop_id": 1, ...}
Удалить "Скидки" с переданным {id}
DELETE /api/v1.1/shop_discounts/{id}/
Связанные элементы
Получить "Товары со скидками" у "Скидки" с идентификатором {id}
GET /api/v1.1/shop_discounts/{id}/shop_item_discounts/
Получить "Группы товаров со скидками" у "Скидки" с идентификатором {id}
GET /api/v1.1/shop_discounts/{id}/shop_group_discounts/
Получить "Группы персональной скидки" у "Скидки" с идентификатором {id}
GET /api/v1.1/shop_discounts/{id}/shop_discount_siteuser_groups/
Связанные документы
Получить "Связанные документы"
GET /api/v1.1/shop_document_relations/
Фильтрация "Связанные документы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_document_relations/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| document_id |
int |
|
|
| related_document_id |
int |
|
|
| paid |
decimal |
|
|
Создать "Связанные документы"
POST /api/v1.1/shop_document_relations/
Обновить "Связанные документы" с идентификатором {id}
PUT /api/v1.1/shop_document_relations/{id}/
{"document_id": 1, "related_document_id": 1, ...}
Удалить "Связанные документы" с переданным {id}
DELETE /api/v1.1/shop_document_relations/{id}/
Списки избранного
Получить "Списки избранного"
GET /api/v1.1/shop_favorite_lists/
Фильтрация "Списки избранного" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_favorite_lists/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_id |
int |
Интернет-магазин |
|
| siteuser_id |
int |
Идентификатор клиента |
|
| name |
string |
Название |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Списки избранного"
POST /api/v1.1/shop_favorite_lists/
Обновить "Списки избранного" с идентификатором {id}
PUT /api/v1.1/shop_favorite_lists/{id}/
{"shop_id": 1, "siteuser_id": 1, ...}
Удалить "Списки избранного" с переданным {id}
DELETE /api/v1.1/shop_favorite_lists/{id}/
Связанные элементы
Получить "Избранное" у "Списки избранного" с идентификатором {id}
GET /api/v1.1/shop_favorite_lists/{id}/shop_favorites/
Избранное
Получить "Избранное"
GET /api/v1.1/shop_favorites/
Фильтрация "Избранное" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_favorites/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_favorite_list_id |
int |
Список избранного |
|
| shop_item_id |
int |
Идентификатор товара |
|
| siteuser_id |
int |
Идентификатор клиента |
|
| shop_id |
int |
Интернет-магазин |
|
Создать "Избранное"
POST /api/v1.1/shop_favorites/
Обновить "Избранное" с идентификатором {id}
PUT /api/v1.1/shop_favorites/{id}/
{"shop_favorite_list_id": 1, "shop_item_id": 1, ...}
Удалить "Избранное" с переданным {id}
DELETE /api/v1.1/shop_favorites/{id}/
Группа SEO-фильтров
Получить "Группа SEO-фильтров"
GET /api/v1.1/shop_filter_seo_dirs/
Фильтрация "Группа SEO-фильтров" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_filter_seo_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Группа SEO-фильтров |
|
| shop_id |
int |
Идентификатор магазина |
|
| name |
string |
Название группы |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Группа SEO-фильтров"
POST /api/v1.1/shop_filter_seo_dirs/
Обновить "Группа SEO-фильтров" с идентификатором {id}
PUT /api/v1.1/shop_filter_seo_dirs/{id}/
{"parent_id": 1, "shop_id": 1, ...}
Удалить "Группа SEO-фильтров" с переданным {id}
DELETE /api/v1.1/shop_filter_seo_dirs/{id}/
Связанные элементы
Получить "SEO-фильтр" у "Группа SEO-фильтров" с идентификатором {id}
GET /api/v1.1/shop_filter_seo_dirs/{id}/shop_filter_seos/
Получить "Группа SEO-фильтров" у "Группа SEO-фильтров" с идентификатором {id}
GET /api/v1.1/shop_filter_seo_dirs/{id}/shop_filter_seo_dirs/
SEO-фильтры, свойства
Получить "SEO-фильтры, свойства"
GET /api/v1.1/shop_filter_seo_properties/
Фильтрация "SEO-фильтры, свойства" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_filter_seo_properties/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_filter_seo_id |
int |
|
|
| property_id |
int |
|
|
| value |
string |
|
|
| value_to |
string |
|
|
| sorting |
int |
|
|
Создать "SEO-фильтры, свойства"
POST /api/v1.1/shop_filter_seo_properties/
Обновить "SEO-фильтры, свойства" с идентификатором {id}
PUT /api/v1.1/shop_filter_seo_properties/{id}/
{"shop_filter_seo_id": 1, "property_id": 1, ...}
Удалить "SEO-фильтры, свойства" с переданным {id}
DELETE /api/v1.1/shop_filter_seo_properties/{id}/
SEO-фильтр
Получить "SEO-фильтр"
GET /api/v1.1/shop_filter_seos/
Фильтрация "SEO-фильтр" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_filter_seos/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_id |
int |
Магазин |
|
| shop_group_id |
int |
Группа магазина |
|
| shop_producer_id |
int |
Производитель |
|
| shop_filter_seo_dir_id |
int |
|
|
| name |
string |
Название |
|
| price_from |
decimal |
Цена от |
|
| price_to |
decimal |
Цена до |
|
| seo_title |
string |
Заголовок (title) |
|
| seo_description |
string |
Описание (description) |
|
| seo_keywords |
string |
Ключевые слова (keywords) |
|
| h1 |
string |
Заголовок H1 |
|
| text |
string |
Текст |
|
| active |
int |
Активность |
|
| indexing |
int |
Индексировать |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "SEO-фильтр"
POST /api/v1.1/shop_filter_seos/
Обновить "SEO-фильтр" с идентификатором {id}
PUT /api/v1.1/shop_filter_seos/{id}/
{"shop_id": 1, "shop_group_id": 1, ...}
Удалить "SEO-фильтр" с переданным {id}
DELETE /api/v1.1/shop_filter_seos/{id}/
Связанные элементы
Получить "SEO-фильтры, свойства" у "SEO-фильтр" с идентификатором {id}
GET /api/v1.1/shop_filter_seos/{id}/shop_filter_seo_properties/
Разделы подарков
Получить "Разделы подарков"
GET /api/v1.1/shop_gift_dirs/
Фильтрация "Разделы подарков" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_gift_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Раздел |
|
| shop_id |
int |
Идентификатор магазина |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Разделы подарков"
POST /api/v1.1/shop_gift_dirs/
Обновить "Разделы подарков" с идентификатором {id}
PUT /api/v1.1/shop_gift_dirs/{id}/
{"parent_id": 1, "shop_id": 1, ...}
Удалить "Разделы подарков" с переданным {id}
DELETE /api/v1.1/shop_gift_dirs/{id}/
Связанные элементы
Получить "Подарки" у "Разделы подарков" с идентификатором {id}
GET /api/v1.1/shop_gift_dirs/{id}/shop_gifts/
Получить "Разделы подарков" у "Разделы подарков" с идентификатором {id}
GET /api/v1.1/shop_gift_dirs/{id}/shop_gift_dirs/
Key 'model_name' in 'ru' language does not exist for model 'shop_gift_entity'.
Получить "Key 'model_name' in 'ru' language does not exist for model 'shop_gift_entity'."
GET /api/v1.1/shop_gift_entities/
Фильтрация "Key 'model_name' in 'ru' language does not exist for model 'shop_gift_entity'." — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_gift_entities/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_gift_id |
int |
|
|
| type |
int |
|
|
| entity_id |
int |
|
|
Создать "Key 'model_name' in 'ru' language does not exist for model 'shop_gift_entity'."
POST /api/v1.1/shop_gift_entities/
Обновить "Key 'model_name' in 'ru' language does not exist for model 'shop_gift_entity'." с идентификатором {id}
PUT /api/v1.1/shop_gift_entities/{id}/
{"shop_gift_id": 1, "type": 1, ...}
Удалить "Key 'model_name' in 'ru' language does not exist for model 'shop_gift_entity'." с переданным {id}
DELETE /api/v1.1/shop_gift_entities/{id}/
Key 'model_name' in 'ru' language does not exist for model 'shop_gift_siteuser_group'.
Получить "Key 'model_name' in 'ru' language does not exist for model 'shop_gift_siteuser_group'."
GET /api/v1.1/shop_gift_siteuser_groups/
Фильтрация "Key 'model_name' in 'ru' language does not exist for model 'shop_gift_siteuser_group'." — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_gift_siteuser_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_gift_id |
int |
|
|
| siteuser_group_id |
int |
|
|
Создать "Key 'model_name' in 'ru' language does not exist for model 'shop_gift_siteuser_group'."
POST /api/v1.1/shop_gift_siteuser_groups/
Обновить "Key 'model_name' in 'ru' language does not exist for model 'shop_gift_siteuser_group'." с идентификатором {id}
PUT /api/v1.1/shop_gift_siteuser_groups/{id}/
{"shop_gift_id": 1, "siteuser_group_id": 1, ...}
Удалить "Key 'model_name' in 'ru' language does not exist for model 'shop_gift_siteuser_group'." с переданным {id}
DELETE /api/v1.1/shop_gift_siteuser_groups/{id}/
Подарки
Получить "Подарки"
GET /api/v1.1/shop_gifts/
Фильтрация "Подарки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_gifts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_gift_dir_id |
int |
Раздел |
|
| shop_id |
int |
Идентификатор магазина |
|
| shop_currency_id |
int |
Валюта |
|
| name |
string |
Название |
|
| active |
int |
Активность |
|
| coupon |
int |
Применять только с купоном |
|
| coupon_text |
string |
Купон |
|
| value |
decimal |
Величина скидки |
|
| type |
int |
Тип скидки |
|
| max_discount |
decimal |
Максимальная скидка |
|
| start_datetime |
string |
Подарок активен с |
|
| end_datetime |
string |
Подарок активен до |
|
| min_amount |
decimal |
Сумма ⩾ |
|
| max_amount |
decimal |
Сумма < |
|
| min_weight |
decimal |
Вес ⩾, %s |
|
| max_weight |
decimal |
Вес <, %s |
|
| mode |
int |
|
|
| min_count |
int |
Кол-во ⩾ |
|
| max_count |
int |
Кол-во < |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Подарки"
POST /api/v1.1/shop_gifts/
Обновить "Подарки" с идентификатором {id}
PUT /api/v1.1/shop_gifts/{id}/
{"shop_gift_dir_id": 1, "shop_id": 1, ...}
Удалить "Подарки" с переданным {id}
DELETE /api/v1.1/shop_gifts/{id}/
Связанные элементы
Получить "Купоны" у "Подарки" с идентификатором {id}
GET /api/v1.1/shop_gifts/{id}/shop_purchase_discount_coupons/
Получить "Key 'model_name' in 'ru' language does not exist for model 'shop_gift_siteuser_group'." у "Подарки" с идентификатором {id}
GET /api/v1.1/shop_gifts/{id}/shop_gift_siteuser_groups/
Получить "Key 'model_name' in 'ru' language does not exist for model 'shop_gift_entity'." у "Подарки" с идентификатором {id}
GET /api/v1.1/shop_gifts/{id}/shop_gift_entities/
Получить "Товары, подарки" у "Подарки" с идентификатором {id}
GET /api/v1.1/shop_gifts/{id}/shop_item_gifts/
Получить "Группы интернет-магазина, подарки" у "Подарки" с идентификатором {id}
GET /api/v1.1/shop_gifts/{id}/shop_group_gifts/
Получить "Товары магазина" у "Подарки" с идентификатором {id}
GET /api/v1.1/shop_gifts/{id}/shop_items/
Получить "Группы товаров" у "Подарки" с идентификатором {id}
GET /api/v1.1/shop_gifts/{id}/shop_groups/
Группы интернет-магазина, бонусы
Получить "Группы интернет-магазина, бонусы"
GET /api/v1.1/shop_group_bonuses/
Фильтрация "Группы интернет-магазина, бонусы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_group_bonuses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_group_id |
int |
|
|
| shop_bonus_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Группы интернет-магазина, бонусы"
POST /api/v1.1/shop_group_bonuses/
Обновить "Группы интернет-магазина, бонусы" с идентификатором {id}
PUT /api/v1.1/shop_group_bonuses/{id}/
{"shop_group_id": 1, "shop_bonus_id": 1, ...}
Удалить "Группы интернет-магазина, бонусы" с переданным {id}
DELETE /api/v1.1/shop_group_bonuses/{id}/
Группы товаров со скидками
Получить "Группы товаров со скидками"
GET /api/v1.1/shop_group_discounts/
Фильтрация "Группы товаров со скидками" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_group_discounts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_group_id |
int |
|
|
| shop_discount_id |
int |
|
|
| siteuser_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Группы товаров со скидками"
POST /api/v1.1/shop_group_discounts/
Обновить "Группы товаров со скидками" с идентификатором {id}
PUT /api/v1.1/shop_group_discounts/{id}/
{"shop_group_id": 1, "shop_discount_id": 1, ...}
Удалить "Группы товаров со скидками" с переданным {id}
DELETE /api/v1.1/shop_group_discounts/{id}/
Группы интернет-магазина, подарки
Получить "Группы интернет-магазина, подарки"
GET /api/v1.1/shop_group_gifts/
Фильтрация "Группы интернет-магазина, подарки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_group_gifts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_group_id |
int |
|
|
| shop_gift_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Группы интернет-магазина, подарки"
POST /api/v1.1/shop_group_gifts/
Обновить "Группы интернет-магазина, подарки" с идентификатором {id}
PUT /api/v1.1/shop_group_gifts/{id}/
{"shop_group_id": 1, "shop_gift_id": 1, ...}
Удалить "Группы интернет-магазина, подарки" с переданным {id}
DELETE /api/v1.1/shop_group_gifts/{id}/
Группы интернет-магазина, дополнительные свойства
Получить "Группы интернет-магазина, дополнительные свойства"
GET /api/v1.1/shop_group_properties/
Фильтрация "Группы интернет-магазина, дополнительные свойства" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_group_properties/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_id |
int |
|
|
| property_id |
int |
|
|
Создать "Группы интернет-магазина, дополнительные свойства"
POST /api/v1.1/shop_group_properties/
Обновить "Группы интернет-магазина, дополнительные свойства" с идентификатором {id}
PUT /api/v1.1/shop_group_properties/{id}/
{"shop_id": 1, "property_id": 1, ...}
Удалить "Группы интернет-магазина, дополнительные свойства" с переданным {id}
DELETE /api/v1.1/shop_group_properties/{id}/
Группы интернет-магазина, группы дополнительных свойств
Получить "Группы интернет-магазина, группы дополнительных свойств"
GET /api/v1.1/shop_group_property_dirs/
Фильтрация "Группы интернет-магазина, группы дополнительных свойств" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_group_property_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_id |
int |
|
|
| property_dir_id |
int |
|
|
Создать "Группы интернет-магазина, группы дополнительных свойств"
POST /api/v1.1/shop_group_property_dirs/
Обновить "Группы интернет-магазина, группы дополнительных свойств" с идентификатором {id}
PUT /api/v1.1/shop_group_property_dirs/{id}/
{"shop_id": 1, "property_dir_id": 1, ...}
Удалить "Группы интернет-магазина, группы дополнительных свойств" с переданным {id}
DELETE /api/v1.1/shop_group_property_dirs/{id}/
Группы товаров
Получить "Группы товаров"
GET /api/v1.1/shop_groups/
Фильтрация "Группы товаров" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_id |
int |
Идентификатор магазина |
|
| siteuser_id |
int |
Клиент |
|
| parent_id |
int |
Группа |
|
| shortcut_id |
int |
|
|
| name |
string |
Название группы |
|
| description |
string |
Описание группы |
|
| image_large |
string |
Изображение группы |
|
| image_small |
string |
Малое изображение |
|
| sorting |
int |
Порядок сортировки |
|
| indexing |
int |
Индексировать группу |
|
| subgroups_count |
int |
|
|
| subgroups_total_count |
int |
|
|
| items_count |
int |
|
|
| items_total_count |
int |
Количество активных товаров |
|
| active |
int |
Активность |
|
| siteuser_group_id |
int |
|
|
| path |
string |
Путь |
|
| seo_title |
string |
Заголовок (title) |
|
| seo_description |
string |
Описание (description) |
|
| seo_keywords |
string |
Ключевые слова (keywords) |
|
| seo_group_title_template |
string |
Шаблон title |
|
| seo_group_keywords_template |
string |
Шаблон keywords |
|
| seo_group_description_template |
string |
Шаблон description |
|
| seo_group_h1_template |
string |
Шаблон H1 |
|
| seo_item_title_template |
string |
Шаблон title |
|
| seo_item_keywords_template |
string |
Шаблон keywords |
|
| seo_item_description_template |
string |
Шаблон description |
|
| seo_item_h1_template |
string |
Шаблон H1 |
|
| user_id |
int |
Идентификатор сотрудника |
|
| image_large_width |
int |
|
|
| image_large_height |
int |
|
|
| image_small_width |
int |
|
|
| image_small_height |
int |
|
|
| guid |
string |
Идентификатор группы товаров CommerceML |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Группы товаров"
POST /api/v1.1/shop_groups/
Обновить "Группы товаров" с идентификатором {id}
PUT /api/v1.1/shop_groups/{id}/
{"shop_id": 1, "siteuser_id": 1, ...}
Удалить "Группы товаров" с переданным {id}
DELETE /api/v1.1/shop_groups/{id}/
Связанные элементы
Получить "Группы товаров" у "Группы товаров" с идентификатором {id}
GET /api/v1.1/shop_groups/{id}/shop_groups/
Получить "Товары магазина" у "Группы товаров" с идентификатором {id}
GET /api/v1.1/shop_groups/{id}/shop_items/
Получить "Дополнительные свойства товара разрешенные для группы" у "Группы товаров" с идентификатором {id}
GET /api/v1.1/shop_groups/{id}/shop_item_property_for_groups/
Получить "SEO-фильтр" у "Группы товаров" с идентификатором {id}
GET /api/v1.1/shop_groups/{id}/shop_filter_seos/
Получить "Вкладки товаров и групп" у "Группы товаров" с идентификатором {id}
GET /api/v1.1/shop_groups/{id}/shop_tabs/
Получить "Вкладки, группы" у "Группы товаров" с идентификатором {id}
GET /api/v1.1/shop_groups/{id}/shop_tab_groups/
Получить "Библиотека файлов, группы товаров магазина" у "Группы товаров" с идентификатором {id}
GET /api/v1.1/shop_groups/{id}/media_shop_groups/
Получить "Библиотека файлов, файлы" у "Группы товаров" с идентификатором {id}
GET /api/v1.1/shop_groups/{id}/media_items/
Получить "Бонусы" у "Группы товаров" с идентификатором {id}
GET /api/v1.1/shop_groups/{id}/shop_bonuses/
Получить "Подарки" у "Группы товаров" с идентификатором {id}
GET /api/v1.1/shop_groups/{id}/shop_gifts/
Получить "Скидки" у "Группы товаров" с идентификатором {id}
GET /api/v1.1/shop_groups/{id}/shop_discounts/
Получить "Группы товаров со скидками" у "Группы товаров" с идентификатором {id}
GET /api/v1.1/shop_groups/{id}/shop_group_discounts/
Получить "Группы интернет-магазина, бонусы" у "Группы товаров" с идентификатором {id}
GET /api/v1.1/shop_groups/{id}/shop_group_bonuses/
Получить "Группы интернет-магазина, подарки" у "Группы товаров" с идентификатором {id}
GET /api/v1.1/shop_groups/{id}/shop_group_gifts/
Сопутствующие товары
Получить "Сопутствующие товары"
GET /api/v1.1/shop_item_associated/
Фильтрация "Сопутствующие товары" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_item_associated/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_item_id |
int |
|
|
| shop_item_associated_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| count |
int |
|
|
Создать "Сопутствующие товары"
POST /api/v1.1/shop_item_associated/
Обновить "Сопутствующие товары" с идентификатором {id}
PUT /api/v1.1/shop_item_associated/{id}/
{"shop_item_id": 1, "shop_item_associated_id": 1, ...}
Удалить "Сопутствующие товары" с переданным {id}
DELETE /api/v1.1/shop_item_associated/{id}/
Штрихкоды
Получить "Штрихкоды"
GET /api/v1.1/shop_item_barcodes/
Фильтрация "Штрихкоды" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_item_barcodes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_item_id |
int |
|
|
| value |
string |
|
|
| type |
int |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Штрихкоды"
POST /api/v1.1/shop_item_barcodes/
Обновить "Штрихкоды" с идентификатором {id}
PUT /api/v1.1/shop_item_barcodes/{id}/
{"shop_item_id": 1, "value": "...", ...}
Удалить "Штрихкоды" с переданным {id}
DELETE /api/v1.1/shop_item_barcodes/{id}/
Товары, бонусы
Получить "Товары, бонусы"
GET /api/v1.1/shop_item_bonuses/
Фильтрация "Товары, бонусы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_item_bonuses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_item_id |
int |
|
|
| shop_bonus_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Товары, бонусы"
POST /api/v1.1/shop_item_bonuses/
Обновить "Товары, бонусы" с идентификатором {id}
PUT /api/v1.1/shop_item_bonuses/{id}/
{"shop_item_id": 1, "shop_bonus_id": 1, ...}
Удалить "Товары, бонусы" с переданным {id}
DELETE /api/v1.1/shop_item_bonuses/{id}/
Товары интернет-магазина, сертификаты
Получить "Товары интернет-магазина, сертификаты"
GET /api/v1.1/shop_item_certificates/
Фильтрация "Товары интернет-магазина, сертификаты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_item_certificates/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_item_id |
int |
|
|
| shop_purchase_discount_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Товары интернет-магазина, сертификаты"
POST /api/v1.1/shop_item_certificates/
Обновить "Товары интернет-магазина, сертификаты" с идентификатором {id}
PUT /api/v1.1/shop_item_certificates/{id}/
{"shop_item_id": 1, "shop_purchase_discount_id": 1, ...}
Удалить "Товары интернет-магазина, сертификаты" с переданным {id}
DELETE /api/v1.1/shop_item_certificates/{id}/
Товары, опции доставок
Получить "Товары, опции доставок"
GET /api/v1.1/shop_item_delivery_options/
Фильтрация "Товары, опции доставок" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_item_delivery_options/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_id |
int |
|
|
| shop_item_id |
int |
|
|
| cost |
int |
Стоимость доставки |
|
| day |
string |
Срок доставки |
|
| order_before |
int |
Время заказа |
|
| type |
int |
Тип |
|
Создать "Товары, опции доставок"
POST /api/v1.1/shop_item_delivery_options/
Обновить "Товары, опции доставок" с идентификатором {id}
PUT /api/v1.1/shop_item_delivery_options/{id}/
{"shop_id": 1, "shop_item_id": 1, ...}
Удалить "Товары, опции доставок" с переданным {id}
DELETE /api/v1.1/shop_item_delivery_options/{id}/
Электронные товары
Получить "Электронные товары"
GET /api/v1.1/shop_item_digitals/
Фильтрация "Электронные товары" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_item_digitals/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_item_id |
int |
Идентификатор товара |
|
| name |
string |
Имя или описание электронного товара |
|
| value |
string |
Текст |
|
| filename |
string |
Файл |
|
| count |
int |
Количество |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Электронные товары"
POST /api/v1.1/shop_item_digitals/
Обновить "Электронные товары" с идентификатором {id}
PUT /api/v1.1/shop_item_digitals/{id}/
{"shop_item_id": 1, "name": "...", ...}
Удалить "Электронные товары" с переданным {id}
DELETE /api/v1.1/shop_item_digitals/{id}/
Связанные элементы
Получить "Товары заказа, электронные товары" у "Электронные товары" с идентификатором {id}
GET /api/v1.1/shop_item_digitals/{id}/shop_order_item_digitals/
Товары со скидками
Получить "Товары со скидками"
GET /api/v1.1/shop_item_discounts/
Фильтрация "Товары со скидками" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_item_discounts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_item_id |
int |
|
|
| shop_discount_id |
int |
|
|
| siteuser_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Товары со скидками"
POST /api/v1.1/shop_item_discounts/
Обновить "Товары со скидками" с идентификатором {id}
PUT /api/v1.1/shop_item_discounts/{id}/
{"shop_item_id": 1, "shop_discount_id": 1, ...}
Удалить "Товары со скидками" с переданным {id}
DELETE /api/v1.1/shop_item_discounts/{id}/
Товары, подарки
Получить "Товары, подарки"
GET /api/v1.1/shop_item_gifts/
Фильтрация "Товары, подарки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_item_gifts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_item_id |
int |
|
|
| shop_gift_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Товары, подарки"
POST /api/v1.1/shop_item_gifts/
Обновить "Товары, подарки" с идентификатором {id}
PUT /api/v1.1/shop_item_gifts/{id}/
{"shop_item_id": 1, "shop_gift_id": 1, ...}
Удалить "Товары, подарки" с переданным {id}
DELETE /api/v1.1/shop_item_gifts/{id}/
Товары интернет-магазина, цены
Получить "Товары интернет-магазина, цены"
GET /api/v1.1/shop_item_prices/
Фильтрация "Товары интернет-магазина, цены" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_item_prices/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_item_id |
int |
|
|
| shop_price_id |
int |
|
|
| value |
decimal |
|
|
Создать "Товары интернет-магазина, цены"
POST /api/v1.1/shop_item_prices/
Обновить "Товары интернет-магазина, цены" с идентификатором {id}
PUT /api/v1.1/shop_item_prices/{id}/
{"shop_item_id": 1, "shop_price_id": 1, ...}
Удалить "Товары интернет-магазина, цены" с переданным {id}
DELETE /api/v1.1/shop_item_prices/{id}/
Товары интернет-магазина, дополнительные свойства
Получить "Товары интернет-магазина, дополнительные свойства"
GET /api/v1.1/shop_item_properties/
Фильтрация "Товары интернет-магазина, дополнительные свойства" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_item_properties/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_id |
int |
|
|
| property_id |
int |
|
|
| shop_measure_id |
int |
|
|
| prefix |
string |
|
|
| filter |
int |
|
|
| show_in_group |
int |
|
|
| show_in_item |
int |
|
|
Создать "Товары интернет-магазина, дополнительные свойства"
POST /api/v1.1/shop_item_properties/
Обновить "Товары интернет-магазина, дополнительные свойства" с идентификатором {id}
PUT /api/v1.1/shop_item_properties/{id}/
{"shop_id": 1, "property_id": 1, ...}
Удалить "Товары интернет-магазина, дополнительные свойства" с переданным {id}
DELETE /api/v1.1/shop_item_properties/{id}/
Связанные элементы
Получить "Дополнительные свойства товара разрешенные для группы" у "Товары интернет-магазина, дополнительные свойства" с идентификатором {id}
GET /api/v1.1/shop_item_properties/{id}/shop_item_property_for_groups/
Товары интернет-магазина, группы дополнительных свойств
Получить "Товары интернет-магазина, группы дополнительных свойств"
GET /api/v1.1/shop_item_property_dirs/
Фильтрация "Товары интернет-магазина, группы дополнительных свойств" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_item_property_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_id |
int |
|
|
| property_dir_id |
int |
|
|
Создать "Товары интернет-магазина, группы дополнительных свойств"
POST /api/v1.1/shop_item_property_dirs/
Обновить "Товары интернет-магазина, группы дополнительных свойств" с идентификатором {id}
PUT /api/v1.1/shop_item_property_dirs/{id}/
{"shop_id": 1, "property_dir_id": 1, ...}
Удалить "Товары интернет-магазина, группы дополнительных свойств" с переданным {id}
DELETE /api/v1.1/shop_item_property_dirs/{id}/
Дополнительные свойства товара разрешенные для группы
Получить "Дополнительные свойства товара разрешенные для группы"
GET /api/v1.1/shop_item_property_for_groups/
Фильтрация "Дополнительные свойства товара разрешенные для группы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_item_property_for_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_group_id |
int |
|
|
| shop_item_property_id |
int |
|
|
| shop_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Дополнительные свойства товара разрешенные для группы"
POST /api/v1.1/shop_item_property_for_groups/
Обновить "Дополнительные свойства товара разрешенные для группы" с идентификатором {id}
PUT /api/v1.1/shop_item_property_for_groups/{id}/
{"shop_group_id": 1, "shop_item_property_id": 1, ...}
Удалить "Дополнительные свойства товара разрешенные для группы" с переданным {id}
DELETE /api/v1.1/shop_item_property_for_groups/{id}/
Товары интернет-магазина, резерв
Получить "Товары интернет-магазина, резерв"
GET /api/v1.1/shop_item_reserved/
Фильтрация "Товары интернет-магазина, резерв" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_item_reserved/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_item_id |
int |
|
|
| shop_order_id |
int |
|
|
| shop_warehouse_id |
int |
|
|
| count |
decimal |
|
|
| datetime |
string |
|
|
Создать "Товары интернет-магазина, резерв"
POST /api/v1.1/shop_item_reserved/
Обновить "Товары интернет-магазина, резерв" с идентификатором {id}
PUT /api/v1.1/shop_item_reserved/{id}/
{"shop_item_id": 1, "shop_order_id": 1, ...}
Удалить "Товары интернет-магазина, резерв" с переданным {id}
DELETE /api/v1.1/shop_item_reserved/{id}/
Товары интернет-магазина, комплекты
Получить "Товары интернет-магазина, комплекты"
GET /api/v1.1/shop_item_sets/
Фильтрация "Товары интернет-магазина, комплекты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_item_sets/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_item_id |
int |
|
|
| shop_item_set_id |
int |
|
|
| count |
decimal |
|
|
| sorting |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Товары интернет-магазина, комплекты"
POST /api/v1.1/shop_item_sets/
Обновить "Товары интернет-магазина, комплекты" с идентификатором {id}
PUT /api/v1.1/shop_item_sets/{id}/
{"shop_item_id": 1, "shop_item_set_id": 1, ...}
Удалить "Товары интернет-магазина, комплекты" с переданным {id}
DELETE /api/v1.1/shop_item_sets/{id}/
Виды номенклатуры
Получить "Виды номенклатуры"
GET /api/v1.1/shop_item_types/
Фильтрация "Виды номенклатуры" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_item_types/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| type |
int |
Тип |
|
| account |
int |
Счет учета |
|
| income_account |
int |
Счет доходов |
|
| expenditure_account |
int |
Счет расходов |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Виды номенклатуры"
POST /api/v1.1/shop_item_types/
Обновить "Виды номенклатуры" с идентификатором {id}
PUT /api/v1.1/shop_item_types/{id}/
{"name": "...", "type": 1, ...}
Удалить "Виды номенклатуры" с переданным {id}
DELETE /api/v1.1/shop_item_types/{id}/
Связанные элементы
Получить "Товары магазина" у "Виды номенклатуры" с идентификатором {id}
GET /api/v1.1/shop_item_types/{id}/shop_items/
Товары магазина
Получить "Товары магазина"
GET /api/v1.1/shop_items/
Фильтрация "Товары магазина" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shortcut_id |
int |
|
|
| shop_tax_id |
int |
Налог |
|
| shop_seller_id |
int |
Продавец |
|
| shop_group_id |
int |
Группа |
|
| shop_currency_id |
int |
|
|
| shop_id |
int |
Идентификатор магазина |
|
| shop_producer_id |
int |
Производитель |
|
| shop_measure_id |
int |
Единица измерения |
|
| shop_item_type_id |
int |
Вид номенклатуры |
|
| type |
int |
Тип товара |
|
| name |
string |
Название товара |
|
| marking |
string |
Артикул товара |
|
| vendorcode |
string |
Код товара от производителя |
|
| description |
string |
Описание |
|
| text |
string |
Текст |
|
| image_large |
string |
Изображение товара |
|
| image_small |
string |
Малое изображение товара |
|
| weight |
decimal |
Вес |
|
| package_weight |
decimal |
Вес с упаковкой |
|
| price |
decimal |
Основная цена |
|
| active |
int |
Товар активен |
|
| closed |
int |
Закрыт |
|
| siteuser_group_id |
int |
Группа клиентов |
|
| sorting |
int |
Порядок сортировки |
|
| path |
string |
Путь |
|
| seo_title |
string |
Заголовок (title) |
|
| seo_description |
string |
Описание (description) |
|
| seo_keywords |
string |
Ключевые слова (keywords) |
|
| indexing |
int |
Индексировать товар |
|
| image_small_height |
int |
|
|
| image_small_width |
int |
|
|
| image_large_height |
int |
|
|
| image_large_width |
int |
|
|
| yandex_market |
int |
Экспортировать в Яндекс.Маркет |
|
| yandex_market_bid |
int |
Яндекс.Маркет - основная расценка |
|
| yandex_market_cid |
int |
Яндекс.Маркет - расценка для карточек моделей |
|
| manufacturer_warranty |
int |
Гарантия производителя |
|
| country_of_origin |
string |
Страна производства |
|
| yandex_market_sales_notes |
string |
Отличие товара от других (значение тега <sales_notes>) |
|
| user_id |
int |
Идентификатор сотрудника |
|
| siteuser_id |
int |
Клиент |
|
| datetime |
string |
Дата |
|
| modification_id |
int |
|
|
| guid |
string |
Идентификатор товара CommerceML |
|
| start_datetime |
string |
Дата публикации |
|
| end_datetime |
string |
Дата завершения публикации |
|
| showed |
int |
Счетчик показов |
|
| length |
decimal |
|
|
| width |
decimal |
|
|
| height |
decimal |
|
|
| package_length |
decimal |
Длина упаковки |
|
| package_width |
decimal |
Ширина упаковки |
|
| package_height |
decimal |
Высота упаковки |
|
| min_quantity |
decimal |
Мин. кол-во |
|
| max_quantity |
decimal |
Макс. кол-во |
|
| quantity_step |
decimal |
Шаг |
|
| apply_purchase_discount |
int |
Учитывать для скидки от суммы заказа и карт |
|
| delivery |
int |
Доставка |
|
| pickup |
int |
Самовывоз |
|
| store |
int |
В розничном магазине |
|
| adult |
int |
Для взрослых |
|
| cpa |
int |
Публиковать в «Заказ на Маркете» |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Товары магазина"
POST /api/v1.1/shop_items/
Обновить "Товары магазина" с идентификатором {id}
PUT /api/v1.1/shop_items/{id}/
{"shortcut_id": 1, "shop_tax_id": 1, ...}
Удалить "Товары магазина" с переданным {id}
DELETE /api/v1.1/shop_items/{id}/
Связанные элементы
Получить "Интернет-магазин, корзина" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_carts/
Получить "Комментарии" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/comments/
Получить "Бонусы" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_bonuses/
Получить "Скидки" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_discounts/
Получить "Подарки" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_gifts/
Получить "Товары, бонусы" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_item_bonuses/
Получить "Товары со скидками" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_item_discounts/
Получить "Электронные товары" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_item_digitals/
Получить "Товары, подарки" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_item_gifts/
Получить "Товары магазина" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_items/
Получить "Библиотека файлов, товары магазина" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/media_shop_items/
Получить "Библиотека файлов, файлы" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/media_items/
Получить "Цены магазина" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_prices/
Получить "Товары интернет-магазина, цены" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_item_prices/
Получить "Сопутствующие товары" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_item_associateds/
Получить "Товары интернет-магазина, комплекты" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_item_sets/
Получить "Специальные цены" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_specialprices/
Получить "Товары интернет-магазина, резерв" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_item_reserveds/
Получить "Метки" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/tags/
Получить "Метки, товары" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/tag_shop_items/
Получить "Склады" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_warehouses/
Получить "Товары на складе" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_warehouse_items/
Получить "Голоса" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/votes/
Получить "Товары, опции доставок" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_item_delivery_options/
Получить "Избранное" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_favorites/
Получить "Штрихкоды" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_item_barcodes/
Получить "Проводки товаров" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_warehouse_entries/
Получить "Оприходование товаров, товары" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_warehouse_incoming_items/
Получить "Инвентаризация, товары" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_warehouse_inventory_items/
Получить "Списание товаров, товары" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_warehouse_writeoff_items/
Получить "Цены, проводки" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_price_entries/
Получить "Установка цен, товары" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_price_setting_items/
Получить "Адреса хранения, товары" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_warehouse_cell_items/
Получить "Вкладки товаров и групп" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_tabs/
Получить "Вкладки, товары" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_tab_items/
Получить "Товары интернет-магазина, сертификаты" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_item_certificates/
Получить "Товары лида" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/lead_shop_items/
Получить "Товары сделки" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/deal_shop_items/
Получить "Заказы поставщикам, товары" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_warehouse_purchaseorder_items/
Получить "Счета поставщиков, товары" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_warehouse_invoice_items/
Получить "Приемки товаров, товары" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/shop_warehouse_supply_items/
Получить "Материалы для этапа" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/production_process_stage_materials/
Получить "Технологические карты" у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/production_process_plans/
Получить "Key 'model_name' in 'ru' language does not exist for model 'production_task_process_plan_manufacture'." у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/production_task_process_plan_manufactures/
Получить "Key 'model_name' in 'ru' language does not exist for model 'production_task_process_plan_stage_material'." у "Товары магазина" с идентификатором {id}
GET /api/v1.1/shop_items/{id}/production_task_process_plan_stage_materials/
Единицы измерения
Получить "Единицы измерения"
GET /api/v1.1/shop_measures/
Фильтрация "Единицы измерения" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_measures/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| okei |
int |
Код ОКЕИ |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Единицы измерения"
POST /api/v1.1/shop_measures/
Обновить "Единицы измерения" с идентификатором {id}
PUT /api/v1.1/shop_measures/{id}/
{"name": "...", "description": "...", ...}
Удалить "Единицы измерения" с переданным {id}
DELETE /api/v1.1/shop_measures/{id}/
Связанные элементы
Получить "Интернет-магазины" у "Единицы измерения" с идентификатором {id}
GET /api/v1.1/shop_measures/{id}/shops/
Получить "Комментарии заказа, дополнительные свойства"
GET /api/v1.1/shop_order_comment_properties/
Фильтрация "Комментарии заказа, дополнительные свойства" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_order_comment_properties/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_id |
int |
|
|
| property_id |
int |
|
|
Создать "Комментарии заказа, дополнительные свойства"
POST /api/v1.1/shop_order_comment_properties/
Обновить "Комментарии заказа, дополнительные свойства" с идентификатором {id}
PUT /api/v1.1/shop_order_comment_properties/{id}/
{"shop_id": 1, "property_id": 1, ...}
Удалить "Комментарии заказа, дополнительные свойства" с переданным {id}
DELETE /api/v1.1/shop_order_comment_properties/{id}/
Получить "Комментарии заказа, группы дополнительных свойств"
GET /api/v1.1/shop_order_comment_property_dirs/
Фильтрация "Комментарии заказа, группы дополнительных свойств" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_order_comment_property_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_id |
int |
|
|
| property_dir_id |
int |
|
|
Создать "Комментарии заказа, группы дополнительных свойств"
POST /api/v1.1/shop_order_comment_property_dirs/
Обновить "Комментарии заказа, группы дополнительных свойств" с идентификатором {id}
PUT /api/v1.1/shop_order_comment_property_dirs/{id}/
{"shop_id": 1, "property_dir_id": 1, ...}
Удалить "Комментарии заказа, группы дополнительных свойств" с переданным {id}
DELETE /api/v1.1/shop_order_comment_property_dirs/{id}/
Заказы, история статусов
Получить "Заказы, история статусов"
GET /api/v1.1/shop_order_histories/
Фильтрация "Заказы, история статусов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_order_histories/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_order_id |
int |
|
|
| shop_order_status_id |
int |
|
|
| datetime |
string |
|
|
| text |
string |
|
|
| ip |
string |
|
|
| color |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Заказы, история статусов"
POST /api/v1.1/shop_order_histories/
Обновить "Заказы, история статусов" с идентификатором {id}
PUT /api/v1.1/shop_order_histories/{id}/
{"shop_order_id": 1, "shop_order_status_id": 1, ...}
Удалить "Заказы, история статусов" с переданным {id}
DELETE /api/v1.1/shop_order_histories/{id}/
Товары заказа, маркировка
Получить "Товары заказа, маркировка"
GET /api/v1.1/shop_order_item_codes/
Фильтрация "Товары заказа, маркировка" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_order_item_codes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_order_item_id |
int |
|
|
| shop_codetype_id |
int |
|
|
| code |
string |
|
|
Создать "Товары заказа, маркировка"
POST /api/v1.1/shop_order_item_codes/
Обновить "Товары заказа, маркировка" с идентификатором {id}
PUT /api/v1.1/shop_order_item_codes/{id}/
{"shop_order_item_id": 1, "shop_codetype_id": 1, ...}
Удалить "Товары заказа, маркировка" с переданным {id}
DELETE /api/v1.1/shop_order_item_codes/{id}/
Товары заказа, электронные товары
Получить "Товары заказа, электронные товары"
GET /api/v1.1/shop_order_item_digitals/
Фильтрация "Товары заказа, электронные товары" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_order_item_digitals/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_order_item_id |
int |
|
|
| shop_item_digital_id |
int |
|
|
| guid |
string |
|
|
Создать "Товары заказа, электронные товары"
POST /api/v1.1/shop_order_item_digitals/
Обновить "Товары заказа, электронные товары" с идентификатором {id}
PUT /api/v1.1/shop_order_item_digitals/{id}/
{"shop_order_item_id": 1, "shop_item_digital_id": 1, ...}
Удалить "Товары заказа, электронные товары" с переданным {id}
DELETE /api/v1.1/shop_order_item_digitals/{id}/
Статусы товаров заказа
Получить "Статусы товаров заказа"
GET /api/v1.1/shop_order_item_statuses/
Фильтрация "Статусы товаров заказа" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_order_item_statuses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_id |
int |
Идентификатор магазина |
|
| name |
string |
Название |
|
| parent_id |
int |
Родительский статус |
|
| description |
string |
Описание |
|
| canceled |
int |
Отмена позиции |
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок сортировки |
|
| shop_order_status_id |
int |
Зависимый статус заказа |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Статусы товаров заказа"
POST /api/v1.1/shop_order_item_statuses/
Обновить "Статусы товаров заказа" с идентификатором {id}
PUT /api/v1.1/shop_order_item_statuses/{id}/
{"shop_id": 1, "name": "...", ...}
Удалить "Статусы товаров заказа" с переданным {id}
DELETE /api/v1.1/shop_order_item_statuses/{id}/
Связанные элементы
Получить "Статусы товаров заказа" у "Статусы товаров заказа" с идентификатором {id}
GET /api/v1.1/shop_order_item_statuses/{id}/shop_order_item_statuses/
Товары заказа
Получить "Товары заказа"
GET /api/v1.1/shop_order_items/
Фильтрация "Товары заказа" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_order_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_item_id |
int |
Идентификатор товара |
|
| shop_order_id |
int |
Идентификатор заказа |
|
| shop_measure_id |
int |
|
|
| name |
string |
Название товара |
|
| quantity |
decimal |
Количество |
|
| price |
decimal |
Цена |
|
| marking |
string |
Артикул |
|
| rate |
decimal |
Налог |
|
| user_id |
int |
Идентификатор сотрудника |
|
| hash |
string |
|
|
| shop_item_digital_id |
int |
|
|
| type |
int |
Тип товара |
|
| shop_warehouse_id |
int |
Склад, с которого был списан товар |
|
| shop_order_item_status_id |
int |
Статус товара |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Товары заказа"
POST /api/v1.1/shop_order_items/
Обновить "Товары заказа" с идентификатором {id}
PUT /api/v1.1/shop_order_items/{id}/
{"shop_item_id": 1, "shop_order_id": 1, ...}
Удалить "Товары заказа" с переданным {id}
DELETE /api/v1.1/shop_order_items/{id}/
Связанные элементы
Получить "Товары заказа, электронные товары" у "Товары заказа" с идентификатором {id}
GET /api/v1.1/shop_order_items/{id}/shop_order_item_digitals/
Получить "Товары заказа, маркировка" у "Товары заказа" с идентификатором {id}
GET /api/v1.1/shop_order_items/{id}/shop_order_item_codes/
Заказы, дополнительные свойства
Получить "Заказы, дополнительные свойства"
GET /api/v1.1/shop_order_properties/
Фильтрация "Заказы, дополнительные свойства" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_order_properties/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_id |
int |
|
|
| property_id |
int |
|
|
| prefix |
string |
|
|
| display |
int |
|
|
Создать "Заказы, дополнительные свойства"
POST /api/v1.1/shop_order_properties/
Обновить "Заказы, дополнительные свойства" с идентификатором {id}
PUT /api/v1.1/shop_order_properties/{id}/
{"shop_id": 1, "property_id": 1, ...}
Удалить "Заказы, дополнительные свойства" с переданным {id}
DELETE /api/v1.1/shop_order_properties/{id}/
Заказы, группы дополнительных свойств
Получить "Заказы, группы дополнительных свойств"
GET /api/v1.1/shop_order_property_dirs/
Фильтрация "Заказы, группы дополнительных свойств" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_order_property_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_id |
int |
|
|
| property_dir_id |
int |
|
|
Создать "Заказы, группы дополнительных свойств"
POST /api/v1.1/shop_order_property_dirs/
Обновить "Заказы, группы дополнительных свойств" с идентификатором {id}
PUT /api/v1.1/shop_order_property_dirs/{id}/
{"shop_id": 1, "property_dir_id": 1, ...}
Удалить "Заказы, группы дополнительных свойств" с переданным {id}
DELETE /api/v1.1/shop_order_property_dirs/{id}/
Статусы заказов
Получить "Статусы заказов"
GET /api/v1.1/shop_order_statuses/
Фильтрация "Статусы заказов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_order_statuses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_id |
int |
Идентификатор магазина |
|
| name |
string |
Название |
|
| parent_id |
int |
Родительский статус |
|
| shop_order_item_status_id |
int |
Статус товаров, устанавливаемый при создании заказа |
|
| deadline_shop_order_status_id |
int |
Статус заказа, устанавливаемый при невыполнении в срок |
|
| lifetime |
int |
Время жизни, в минутах |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Статусы заказов"
POST /api/v1.1/shop_order_statuses/
Обновить "Статусы заказов" с идентификатором {id}
PUT /api/v1.1/shop_order_statuses/{id}/
{"shop_id": 1, "name": "...", ...}
Удалить "Статусы заказов" с переданным {id}
DELETE /api/v1.1/shop_order_statuses/{id}/
Связанные элементы
Получить "Интернет-магазины" у "Статусы заказов" с идентификатором {id}
GET /api/v1.1/shop_order_statuses/{id}/shops/
Получить "Статусы заказов" у "Статусы заказов" с идентификатором {id}
GET /api/v1.1/shop_order_statuses/{id}/shop_order_statuses/
Получить "Заказы, история статусов" у "Статусы заказов" с идентификатором {id}
GET /api/v1.1/shop_order_statuses/{id}/shop_order_histories/
Получить "Платежные системы" у "Статусы заказов" с идентификатором {id}
GET /api/v1.1/shop_order_statuses/{id}/shop_payment_systems/
Заказы магазина
Получить "Заказы магазина"
GET /api/v1.1/shop_orders/
Фильтрация "Заказы магазина" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_orders/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_id |
int |
Идентификатор магазина |
|
| company_id |
int |
Организация продавца |
|
| company_account_id |
int |
Расчетный счет |
|
| shop_country_location_id |
int |
|
|
| shop_country_id |
int |
|
|
| shop_country_location_city_id |
int |
|
|
| shop_country_location_city_area_id |
int |
|
|
| shop_delivery_id |
int |
|
|
| shop_delivery_condition_id |
int |
Условия доставки |
|
| siteuser_id |
int |
Клиент |
|
| source_id |
int |
Идентификатор URL метки |
|
| name |
string |
Имя |
|
| surname |
string |
Фамилия |
|
| patronymic |
string |
Отчество |
|
| email |
string |
E-mail |
|
| acceptance_report |
string |
|
|
| acceptance_report_datetime |
string |
|
|
| vat_invoice |
string |
|
|
| vat_invoice_datetime |
string |
|
|
| company |
string |
Компания |
|
| tin |
string |
ИНН |
|
| kpp |
string |
КПП |
|
| fax |
string |
Факс |
|
| shop_order_status_id |
int |
|
|
| shop_order_status_deadline |
string |
Время жизни статуса |
|
| shop_currency_id |
int |
|
|
| shop_payment_system_id |
int |
|
|
| datetime |
string |
Дата заказа |
|
| paid |
int |
Оплачен |
|
| posted |
int |
Отправлен |
|
| payment_datetime |
string |
Дата оплаты |
|
| address |
string |
Улица |
|
| house |
string |
Дом, корпус |
|
| flat |
string |
Квартира (офис) |
|
| postcode |
string |
Индекс |
|
| phone |
string |
Телефон |
|
| description |
string |
Описание заказа |
|
| system_information |
string |
Информация о заказе |
|
| canceled |
int |
Отменен |
|
| user_id |
int |
Идентификатор сотрудника |
|
| invoice |
string |
Номер заказа |
|
| status_datetime |
string |
Дата изменения статуса заказа |
|
| guid |
string |
GUID |
|
| delivery_information |
string |
Информация об отправлении |
|
| ip |
string |
IP-адрес заказчика |
|
| coupon |
string |
Купон |
|
| unloaded |
int |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Заказы магазина"
POST /api/v1.1/shop_orders/
Обновить "Заказы магазина" с идентификатором {id}
PUT /api/v1.1/shop_orders/{id}/
{"shop_id": 1, "company_id": 1, ...}
Удалить "Заказы магазина" с переданным {id}
DELETE /api/v1.1/shop_orders/{id}/
Связанные элементы
Получить "Комментарии" у "Заказы магазина" с идентификатором {id}
GET /api/v1.1/shop_orders/{id}/comments/
Получить "Товары заказа" у "Заказы магазина" с идентификатором {id}
GET /api/v1.1/shop_orders/{id}/shop_order_items/
Получить "Товары интернет-магазина, резерв" у "Заказы магазина" с идентификатором {id}
GET /api/v1.1/shop_orders/{id}/shop_item_reserveds/
Получить "Транзакции пользователя" у "Заказы магазина" с идентификатором {id}
GET /api/v1.1/shop_orders/{id}/shop_siteuser_transactions/
Получить "Бонусы дисконтной карты" у "Заказы магазина" с идентификатором {id}
GET /api/v1.1/shop_orders/{id}/shop_discountcard_bonuses/
Получить "Бонусы дисконтной карты, транзакции" у "Заказы магазина" с идентификатором {id}
GET /api/v1.1/shop_orders/{id}/shop_discountcard_bonus_transactions/
Получить "Купоны" у "Заказы магазина" с идентификатором {id}
GET /api/v1.1/shop_orders/{id}/shop_purchase_discount_coupons/
Получить "Заказы, история статусов" у "Заказы магазина" с идентификатором {id}
GET /api/v1.1/shop_orders/{id}/shop_order_histories/
Получить "Метки" у "Заказы магазина" с идентификатором {id}
GET /api/v1.1/shop_orders/{id}/tags/
Получить "Key 'model_name' in 'ru' language does not exist for model 'tag_shop_order'." у "Заказы магазина" с идентификатором {id}
GET /api/v1.1/shop_orders/{id}/tag_shop_orders/
Платежные системы, группы клиентов
Получить "Платежные системы, группы клиентов"
GET /api/v1.1/shop_payment_system_siteuser_groups/
Фильтрация "Платежные системы, группы клиентов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_payment_system_siteuser_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_payment_system_id |
int |
|
|
| siteuser_group_id |
int |
|
|
Создать "Платежные системы, группы клиентов"
POST /api/v1.1/shop_payment_system_siteuser_groups/
Обновить "Платежные системы, группы клиентов" с идентификатором {id}
PUT /api/v1.1/shop_payment_system_siteuser_groups/{id}/
{"shop_payment_system_id": 1, "siteuser_group_id": 1, ...}
Удалить "Платежные системы, группы клиентов" с переданным {id}
DELETE /api/v1.1/shop_payment_system_siteuser_groups/{id}/
Платежные системы
Получить "Платежные системы"
GET /api/v1.1/shop_payment_systems/
Фильтрация "Платежные системы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_payment_systems/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_currency_id |
int |
Валюта |
|
| shop_id |
int |
Интернет магазин |
|
| shop_order_status_id |
int |
Статус заказа при оплате |
|
| name |
string |
Название |
|
| sorting |
int |
Порядок сортировки |
|
| description |
string |
Описание |
|
| image |
string |
|
|
| image_height |
int |
|
|
| image_width |
int |
|
|
| active |
int |
Активность |
|
| type |
int |
Тип |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Платежные системы"
POST /api/v1.1/shop_payment_systems/
Обновить "Платежные системы" с идентификатором {id}
PUT /api/v1.1/shop_payment_systems/{id}/
{"shop_currency_id": 1, "shop_id": 1, ...}
Удалить "Платежные системы" с переданным {id}
DELETE /api/v1.1/shop_payment_systems/{id}/
Связанные элементы
Получить "Типы доставки, платежные системы" у "Платежные системы" с идентификатором {id}
GET /api/v1.1/shop_payment_systems/{id}/shop_delivery_payment_systems/
Получить "Платежные системы, группы клиентов" у "Платежные системы" с идентификатором {id}
GET /api/v1.1/shop_payment_systems/{id}/shop_payment_system_siteuser_groups/
Цены, проводки
Получить "Цены, проводки"
GET /api/v1.1/shop_price_entries/
Фильтрация "Цены, проводки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_price_entries/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| document_id |
int |
|
|
| datetime |
string |
|
|
| shop_price_id |
int |
|
|
| shop_item_id |
int |
|
|
| value |
decimal |
|
|
Создать "Цены, проводки"
POST /api/v1.1/shop_price_entries/
Обновить "Цены, проводки" с идентификатором {id}
PUT /api/v1.1/shop_price_entries/{id}/
{"document_id": 1, "datetime": "...", ...}
Удалить "Цены, проводки" с переданным {id}
DELETE /api/v1.1/shop_price_entries/{id}/
Установка цен, товары
Получить "Установка цен, товары"
GET /api/v1.1/shop_price_setting_items/
Фильтрация "Установка цен, товары" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_price_setting_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_price_setting_id |
int |
|
|
| shop_price_id |
int |
|
|
| shop_item_id |
int |
|
|
| old_price |
decimal |
|
|
| new_price |
decimal |
|
|
Создать "Установка цен, товары"
POST /api/v1.1/shop_price_setting_items/
Обновить "Установка цен, товары" с идентификатором {id}
PUT /api/v1.1/shop_price_setting_items/{id}/
{"shop_price_setting_id": 1, "shop_price_id": 1, ...}
Удалить "Установка цен, товары" с переданным {id}
DELETE /api/v1.1/shop_price_setting_items/{id}/
Установка цен
Получить "Установка цен"
GET /api/v1.1/shop_price_settings/
Фильтрация "Установка цен" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_price_settings/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_id |
int |
Идентификатор магазина |
|
| number |
string |
Номер документа |
|
| description |
string |
Описание |
|
| datetime |
string |
Дата создания |
|
| posted |
int |
Проведен |
|
| user_id |
int |
Ответственный |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Установка цен"
POST /api/v1.1/shop_price_settings/
Обновить "Установка цен" с идентификатором {id}
PUT /api/v1.1/shop_price_settings/{id}/
{"shop_id": 1, "number": "...", ...}
Удалить "Установка цен" с переданным {id}
DELETE /api/v1.1/shop_price_settings/{id}/
Связанные элементы
Получить "Установка цен, товары" у "Установка цен" с идентификатором {id}
GET /api/v1.1/shop_price_settings/{id}/shop_price_setting_items/
Цены магазина
Получить "Цены магазина"
GET /api/v1.1/shop_prices/
Фильтрация "Цены магазина" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_prices/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| shop_id |
int |
Идентификатор магазина |
|
| percent |
decimal |
Процент к базовой |
|
| siteuser_group_id |
int |
|
|
| guid |
string |
Идентификатор цены CommerceML |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Цены магазина"
POST /api/v1.1/shop_prices/
Обновить "Цены магазина" с идентификатором {id}
PUT /api/v1.1/shop_prices/{id}/
{"name": "...", "shop_id": 1, ...}
Удалить "Цены магазина" с переданным {id}
DELETE /api/v1.1/shop_prices/{id}/
Связанные элементы
Получить "Товары магазина" у "Цены магазина" с идентификатором {id}
GET /api/v1.1/shop_prices/{id}/shop_items/
Получить "Товары интернет-магазина, цены" у "Цены магазина" с идентификатором {id}
GET /api/v1.1/shop_prices/{id}/shop_item_prices/
Получить "Цены, проводки" у "Цены магазина" с идентификатором {id}
GET /api/v1.1/shop_prices/{id}/shop_price_entries/
Получить "Установка цен, товары" у "Цены магазина" с идентификатором {id}
GET /api/v1.1/shop_prices/{id}/shop_price_setting_items/
Получить "Печатные формы"
GET /api/v1.1/shop_print_forms/
Фильтрация "Печатные формы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_print_forms/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_id |
int |
Интернет магазин |
|
| name |
string |
Название |
|
| sorting |
int |
Порядок сортировки |
|
| description |
string |
Описание |
|
| active |
int |
Активность |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Печатные формы"
POST /api/v1.1/shop_print_forms/
Обновить "Печатные формы" с идентификатором {id}
PUT /api/v1.1/shop_print_forms/{id}/
{"shop_id": 1, "name": "...", ...}
Удалить "Печатные формы" с переданным {id}
DELETE /api/v1.1/shop_print_forms/{id}/
Производители, бонусы
Получить "Производители, бонусы"
GET /api/v1.1/shop_producer_bonuses/
Фильтрация "Производители, бонусы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_producer_bonuses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_producer_id |
int |
|
|
| shop_bonus_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Производители, бонусы"
POST /api/v1.1/shop_producer_bonuses/
Обновить "Производители, бонусы" с идентификатором {id}
PUT /api/v1.1/shop_producer_bonuses/{id}/
{"shop_producer_id": 1, "shop_bonus_id": 1, ...}
Удалить "Производители, бонусы" с переданным {id}
DELETE /api/v1.1/shop_producer_bonuses/{id}/
Группа производителей
Получить "Группа производителей"
GET /api/v1.1/shop_producer_dirs/
Фильтрация "Группа производителей" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_producer_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Группа производителей |
|
| shop_id |
int |
Идентификатор магазина |
|
| name |
string |
Название группы |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Группа производителей"
POST /api/v1.1/shop_producer_dirs/
Обновить "Группа производителей" с идентификатором {id}
PUT /api/v1.1/shop_producer_dirs/{id}/
{"parent_id": 1, "shop_id": 1, ...}
Удалить "Группа производителей" с переданным {id}
DELETE /api/v1.1/shop_producer_dirs/{id}/
Связанные элементы
Получить "Производители" у "Группа производителей" с идентификатором {id}
GET /api/v1.1/shop_producer_dirs/{id}/shop_producers/
Получить "Группа производителей" у "Группа производителей" с идентификатором {id}
GET /api/v1.1/shop_producer_dirs/{id}/shop_producer_dirs/
Производители товаров со скидками
Получить "Производители товаров со скидками"
GET /api/v1.1/shop_producer_discounts/
Фильтрация "Производители товаров со скидками" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_producer_discounts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_producer_id |
int |
|
|
| shop_discount_id |
int |
|
|
| siteuser_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Производители товаров со скидками"
POST /api/v1.1/shop_producer_discounts/
Обновить "Производители товаров со скидками" с идентификатором {id}
PUT /api/v1.1/shop_producer_discounts/{id}/
{"shop_producer_id": 1, "shop_discount_id": 1, ...}
Удалить "Производители товаров со скидками" с переданным {id}
DELETE /api/v1.1/shop_producer_discounts/{id}/
Производители
Получить "Производители"
GET /api/v1.1/shop_producers/
Фильтрация "Производители" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_producers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_producer_dir_id |
int |
|
|
| shop_id |
int |
Идентификатор магазина |
|
| name |
string |
Название |
|
| active |
int |
Активность |
|
| indexing |
int |
Индексировать |
|
| default |
int |
Производитель "по умолчанию" |
|
| description |
string |
Описание |
|
| image_large |
string |
Большое изображение |
|
| image_small |
string |
Малое изображение |
|
| sorting |
int |
Порядок сортировки |
|
| path |
string |
Путь |
|
| user_id |
int |
Идентификатор сотрудника |
|
| address |
string |
Адрес |
|
| phone |
string |
Телефон |
|
| fax |
string |
Факс |
|
| site |
string |
Сайт |
|
| email |
string |
E-Mail |
|
| tin |
string |
ИНН |
|
| kpp |
string |
КПП |
|
| psrn |
string |
ОГРН |
|
| okpo |
string |
ОКПО |
|
| okved |
string |
ОКВЭД |
|
| bik |
string |
БИК |
|
| current_account |
string |
Номер счета |
|
| correspondent_account |
string |
Номер корр. счета |
|
| bank_name |
string |
Название банка |
|
| bank_address |
string |
Адрес банка |
|
| seo_title |
string |
Заголовок (title) |
|
| seo_description |
string |
Описание (description) |
|
| seo_keywords |
string |
Ключевые слова (keywords) |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Производители"
POST /api/v1.1/shop_producers/
Обновить "Производители" с идентификатором {id}
PUT /api/v1.1/shop_producers/{id}/
{"shop_producer_dir_id": 1, "shop_id": 1, ...}
Удалить "Производители" с переданным {id}
DELETE /api/v1.1/shop_producers/{id}/
Связанные элементы
Получить "Товары магазина" у "Производители" с идентификатором {id}
GET /api/v1.1/shop_producers/{id}/shop_items/
Получить "SEO-фильтр" у "Производители" с идентификатором {id}
GET /api/v1.1/shop_producers/{id}/shop_filter_seos/
Получить "Вкладки товаров и групп" у "Производители" с идентификатором {id}
GET /api/v1.1/shop_producers/{id}/shop_tabs/
Получить "Вкладки, производители" у "Производители" с идентификатором {id}
GET /api/v1.1/shop_producers/{id}/shop_tab_producers/
Получить "Бонусы" у "Производители" с идентификатором {id}
GET /api/v1.1/shop_producers/{id}/shop_bonuses/
Получить "Скидки" у "Производители" с идентификатором {id}
GET /api/v1.1/shop_producers/{id}/shop_discounts/
Получить "Производители товаров со скидками" у "Производители" с идентификатором {id}
GET /api/v1.1/shop_producers/{id}/shop_producer_discounts/
Получить "Производители, бонусы" у "Производители" с идентификатором {id}
GET /api/v1.1/shop_producers/{id}/shop_producer_bonuses/
Разделы купонов
Получить "Разделы купонов"
GET /api/v1.1/shop_purchase_discount_coupon_dirs/
Фильтрация "Разделы купонов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_purchase_discount_coupon_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Раздел |
|
| shop_id |
int |
Идентификатор магазина |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Разделы купонов"
POST /api/v1.1/shop_purchase_discount_coupon_dirs/
Обновить "Разделы купонов" с идентификатором {id}
PUT /api/v1.1/shop_purchase_discount_coupon_dirs/{id}/
{"parent_id": 1, "shop_id": 1, ...}
Удалить "Разделы купонов" с переданным {id}
DELETE /api/v1.1/shop_purchase_discount_coupon_dirs/{id}/
Связанные элементы
Получить "Купоны" у "Разделы купонов" с идентификатором {id}
GET /api/v1.1/shop_purchase_discount_coupon_dirs/{id}/shop_purchase_discount_coupons/
Получить "Разделы купонов" у "Разделы купонов" с идентификатором {id}
GET /api/v1.1/shop_purchase_discount_coupon_dirs/{id}/shop_purchase_discount_coupon_dirs/
Купоны
Получить "Купоны"
GET /api/v1.1/shop_purchase_discount_coupons/
Фильтрация "Купоны" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_purchase_discount_coupons/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_purchase_discount_coupon_dir_id |
int |
Раздел |
|
| shop_purchase_discount_id |
int |
Скидка |
|
| shop_order_id |
int |
Заказ |
|
| siteuser_id |
int |
|
|
| name |
string |
Название |
|
| active |
int |
Активность |
|
| start_datetime |
string |
Действует от |
|
| end_datetime |
string |
Действует до |
|
| count |
int |
Количество |
|
| text |
string |
Код купона |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Купоны"
POST /api/v1.1/shop_purchase_discount_coupons/
Обновить "Купоны" с идентификатором {id}
PUT /api/v1.1/shop_purchase_discount_coupons/{id}/
{"shop_purchase_discount_coupon_dir_id": 1, "shop_purchase_discount_id": 1, ...}
Удалить "Купоны" с переданным {id}
DELETE /api/v1.1/shop_purchase_discount_coupons/{id}/
Разделы скидок
Получить "Разделы скидок"
GET /api/v1.1/shop_purchase_discount_dirs/
Фильтрация "Разделы скидок" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_purchase_discount_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Раздел |
|
| shop_id |
int |
Идентификатор магазина |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Разделы скидок"
POST /api/v1.1/shop_purchase_discount_dirs/
Обновить "Разделы скидок" с идентификатором {id}
PUT /api/v1.1/shop_purchase_discount_dirs/{id}/
{"parent_id": 1, "shop_id": 1, ...}
Удалить "Разделы скидок" с переданным {id}
DELETE /api/v1.1/shop_purchase_discount_dirs/{id}/
Связанные элементы
Получить "Скидки от суммы заказа" у "Разделы скидок" с идентификатором {id}
GET /api/v1.1/shop_purchase_discount_dirs/{id}/shop_purchase_discounts/
Получить "Разделы скидок" у "Разделы скидок" с идентификатором {id}
GET /api/v1.1/shop_purchase_discount_dirs/{id}/shop_purchase_discount_dirs/
Key 'model_name' in 'ru' language does not exist for model 'shop_purchase_discount_siteuser_group'.
Получить "Key 'model_name' in 'ru' language does not exist for model 'shop_purchase_discount_siteuser_group'."
GET /api/v1.1/shop_purchase_discount_siteuser_groups/
Фильтрация "Key 'model_name' in 'ru' language does not exist for model 'shop_purchase_discount_siteuser_group'." — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_purchase_discount_siteuser_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_purchase_discount_id |
int |
|
|
| siteuser_group_id |
int |
|
|
Создать "Key 'model_name' in 'ru' language does not exist for model 'shop_purchase_discount_siteuser_group'."
POST /api/v1.1/shop_purchase_discount_siteuser_groups/
Обновить "Key 'model_name' in 'ru' language does not exist for model 'shop_purchase_discount_siteuser_group'." с идентификатором {id}
PUT /api/v1.1/shop_purchase_discount_siteuser_groups/{id}/
{"shop_purchase_discount_id": 1, "siteuser_group_id": 1, ...}
Удалить "Key 'model_name' in 'ru' language does not exist for model 'shop_purchase_discount_siteuser_group'." с переданным {id}
DELETE /api/v1.1/shop_purchase_discount_siteuser_groups/{id}/
Скидки от суммы заказа
Получить "Скидки от суммы заказа"
GET /api/v1.1/shop_purchase_discounts/
Фильтрация "Скидки от суммы заказа" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_purchase_discounts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_purchase_discount_dir_id |
int |
Раздел |
|
| shop_id |
int |
Идентификатор магазина |
|
| shop_currency_id |
int |
Валюта |
|
| name |
string |
Название |
|
| active |
int |
Активность |
|
| coupon |
int |
Применять только с купоном |
|
| value |
decimal |
Величина скидки |
|
| type |
int |
Тип скидки |
|
| max_discount |
decimal |
Максимальная скидка |
|
| position |
int |
Позиция в заказе |
|
| start_datetime |
string |
Скидка активна с |
|
| end_datetime |
string |
Скидка активна до |
|
| min_amount |
decimal |
Сумма ⩾ |
|
| max_amount |
decimal |
Сумма < |
|
| min_weight |
decimal |
Вес ⩾, %s |
|
| max_weight |
decimal |
Вес <, %s |
|
| mode |
int |
|
|
| min_count |
int |
Кол-во ⩾ |
|
| max_count |
int |
Кол-во < |
|
| first_order |
int |
Применять к первому заказу |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Скидки от суммы заказа"
POST /api/v1.1/shop_purchase_discounts/
Обновить "Скидки от суммы заказа" с идентификатором {id}
PUT /api/v1.1/shop_purchase_discounts/{id}/
{"shop_purchase_discount_dir_id": 1, "shop_id": 1, ...}
Удалить "Скидки от суммы заказа" с переданным {id}
DELETE /api/v1.1/shop_purchase_discounts/{id}/
Связанные элементы
Получить "Купоны" у "Скидки от суммы заказа" с идентификатором {id}
GET /api/v1.1/shop_purchase_discounts/{id}/shop_purchase_discount_coupons/
Получить "Key 'model_name' in 'ru' language does not exist for model 'shop_purchase_discount_siteuser_group'." у "Скидки от суммы заказа" с идентификатором {id}
GET /api/v1.1/shop_purchase_discounts/{id}/shop_purchase_discount_siteuser_groups/
Продавцы
Получить "Продавцы"
GET /api/v1.1/shop_sellers/
Фильтрация "Продавцы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_sellers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_id |
int |
Магазин |
|
| siteuser_id |
int |
Клиент |
|
| name |
string |
Продавец |
|
| description |
string |
Описание |
|
| path |
string |
Путь |
|
| sorting |
int |
Порядок сортировки |
|
| contact_person |
string |
Контактное лицо |
|
| image_large |
string |
|
|
| image_small |
string |
|
|
| image_large_height |
int |
|
|
| image_large_width |
int |
|
|
| image_small_height |
int |
|
|
| image_small_width |
int |
|
|
| address |
string |
Адрес |
|
| phone |
string |
Телефон |
|
| fax |
string |
Факс |
|
| site |
string |
Сайт |
|
| email |
string |
E-Mail |
|
| tin |
string |
ИНН |
|
| user_id |
int |
Идентификатор сотрудника |
|
| default |
int |
Продавец "по умолчанию" |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Продавцы"
POST /api/v1.1/shop_sellers/
Обновить "Продавцы" с идентификатором {id}
PUT /api/v1.1/shop_sellers/{id}/
{"shop_id": 1, "siteuser_id": 1, ...}
Удалить "Продавцы" с переданным {id}
DELETE /api/v1.1/shop_sellers/{id}/
Связанные элементы
Получить "Товары магазина" у "Продавцы" с идентификатором {id}
GET /api/v1.1/shop_sellers/{id}/shop_items/
Транзакции пользователя
Получить "Транзакции пользователя"
GET /api/v1.1/shop_siteuser_transactions/
Фильтрация "Транзакции пользователя" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_siteuser_transactions/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_id |
int |
Идентификатор магазина |
|
| siteuser_id |
int |
Идентификатор пользователя |
|
| active |
int |
Активность |
|
| datetime |
string |
Время транзакции |
|
| amount |
decimal |
Сумма |
|
| shop_currency_id |
int |
|
|
| amount_base_currency |
decimal |
|
|
| shop_order_id |
int |
Номер заказа |
|
| description |
string |
Описание |
|
| user_id |
int |
Идентификатор сотрудника |
|
| type |
int |
Тип транзакции |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Транзакции пользователя"
POST /api/v1.1/shop_siteuser_transactions/
Обновить "Транзакции пользователя" с идентификатором {id}
PUT /api/v1.1/shop_siteuser_transactions/{id}/
{"shop_id": 1, "siteuser_id": 1, ...}
Удалить "Транзакции пользователя" с переданным {id}
DELETE /api/v1.1/shop_siteuser_transactions/{id}/
Связанные элементы
Получить "Группы товаров" у "Транзакции пользователя" с идентификатором {id}
GET /api/v1.1/shop_siteuser_transactions/{id}/shop_groups/
Специальные цены
Получить "Специальные цены"
GET /api/v1.1/shop_specialprices/
Фильтрация "Специальные цены" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_specialprices/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_item_id |
int |
|
|
| min_quantity |
int |
|
|
| max_quantity |
int |
|
|
| price |
decimal |
|
|
| percent |
decimal |
|
|
Создать "Специальные цены"
POST /api/v1.1/shop_specialprices/
Обновить "Специальные цены" с идентификатором {id}
PUT /api/v1.1/shop_specialprices/{id}/
{"shop_item_id": 1, "min_quantity": 1, ...}
Удалить "Специальные цены" с переданным {id}
DELETE /api/v1.1/shop_specialprices/{id}/
Раздел вкладок
Получить "Раздел вкладок"
GET /api/v1.1/shop_tab_dirs/
Фильтрация "Раздел вкладок" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_tab_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_id |
int |
Идентификатор магазина |
|
| parent_id |
int |
Раздел |
|
| name |
string |
Название |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Раздел вкладок"
POST /api/v1.1/shop_tab_dirs/
Обновить "Раздел вкладок" с идентификатором {id}
PUT /api/v1.1/shop_tab_dirs/{id}/
{"shop_id": 1, "parent_id": 1, ...}
Удалить "Раздел вкладок" с переданным {id}
DELETE /api/v1.1/shop_tab_dirs/{id}/
Связанные элементы
Получить "Вкладки товаров и групп" у "Раздел вкладок" с идентификатором {id}
GET /api/v1.1/shop_tab_dirs/{id}/shop_tabs/
Получить "Раздел вкладок" у "Раздел вкладок" с идентификатором {id}
GET /api/v1.1/shop_tab_dirs/{id}/shop_tab_dirs/
Вкладки, группы
Получить "Вкладки, группы"
GET /api/v1.1/shop_tab_groups/
Фильтрация "Вкладки, группы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_tab_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_id |
int |
|
|
| shop_group_id |
int |
|
|
| shop_tab_id |
int |
|
|
Создать "Вкладки, группы"
POST /api/v1.1/shop_tab_groups/
Обновить "Вкладки, группы" с идентификатором {id}
PUT /api/v1.1/shop_tab_groups/{id}/
{"shop_id": 1, "shop_group_id": 1, ...}
Удалить "Вкладки, группы" с переданным {id}
DELETE /api/v1.1/shop_tab_groups/{id}/
Вкладки, товары
Получить "Вкладки, товары"
GET /api/v1.1/shop_tab_items/
Фильтрация "Вкладки, товары" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_tab_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_id |
int |
|
|
| shop_item_id |
int |
|
|
| shop_tab_id |
int |
|
|
Создать "Вкладки, товары"
POST /api/v1.1/shop_tab_items/
Обновить "Вкладки, товары" с идентификатором {id}
PUT /api/v1.1/shop_tab_items/{id}/
{"shop_id": 1, "shop_item_id": 1, ...}
Удалить "Вкладки, товары" с переданным {id}
DELETE /api/v1.1/shop_tab_items/{id}/
Вкладки, производители
Получить "Вкладки, производители"
GET /api/v1.1/shop_tab_producers/
Фильтрация "Вкладки, производители" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_tab_producers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_id |
int |
|
|
| shop_producer_id |
int |
|
|
| shop_tab_id |
int |
|
|
Создать "Вкладки, производители"
POST /api/v1.1/shop_tab_producers/
Обновить "Вкладки, производители" с идентификатором {id}
PUT /api/v1.1/shop_tab_producers/{id}/
{"shop_id": 1, "shop_producer_id": 1, ...}
Удалить "Вкладки, производители" с переданным {id}
DELETE /api/v1.1/shop_tab_producers/{id}/
Вкладки товаров и групп
Получить "Вкладки товаров и групп"
GET /api/v1.1/shop_tabs/
Фильтрация "Вкладки товаров и групп" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_tabs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_id |
int |
Идентификатор магазина |
|
| shop_tab_dir_id |
int |
Раздел |
|
| name |
string |
Название |
|
| caption |
string |
Заголовок |
|
| text |
string |
Текст |
|
| icon |
string |
Иконка |
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Вкладки товаров и групп"
POST /api/v1.1/shop_tabs/
Обновить "Вкладки товаров и групп" с идентификатором {id}
PUT /api/v1.1/shop_tabs/{id}/
{"shop_id": 1, "shop_tab_dir_id": 1, ...}
Удалить "Вкладки товаров и групп" с переданным {id}
DELETE /api/v1.1/shop_tabs/{id}/
Связанные элементы
Получить "Вкладки, группы" у "Вкладки товаров и групп" с идентификатором {id}
GET /api/v1.1/shop_tabs/{id}/shop_tab_groups/
Получить "Вкладки, товары" у "Вкладки товаров и групп" с идентификатором {id}
GET /api/v1.1/shop_tabs/{id}/shop_tab_items/
Получить "Вкладки, производители" у "Вкладки товаров и групп" с идентификатором {id}
GET /api/v1.1/shop_tabs/{id}/shop_tab_producers/
Налоги
Получить "Налоги"
GET /api/v1.1/shop_taxes/
Фильтрация "Налоги" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_taxes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| rate |
decimal |
Ставка налога |
|
| tax_is_included |
int |
В цене |
|
| guid |
string |
Идентификатор налога CommerceML |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Налоги"
POST /api/v1.1/shop_taxes/
Обновить "Налоги" с идентификатором {id}
PUT /api/v1.1/shop_taxes/{id}/
{"name": "...", "rate": "...", ...}
Удалить "Налоги" с переданным {id}
DELETE /api/v1.1/shop_taxes/{id}/
Адреса хранения, товары
Получить "Адреса хранения, товары"
GET /api/v1.1/shop_warehouse_cell_items/
Фильтрация "Адреса хранения, товары" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_cell_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_warehouse_id |
int |
|
|
| shop_warehouse_cell_id |
int |
|
|
| shop_item_id |
int |
|
|
Создать "Адреса хранения, товары"
POST /api/v1.1/shop_warehouse_cell_items/
Обновить "Адреса хранения, товары" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_cell_items/{id}/
{"shop_warehouse_id": 1, "shop_warehouse_cell_id": 1, ...}
Удалить "Адреса хранения, товары" с переданным {id}
DELETE /api/v1.1/shop_warehouse_cell_items/{id}/
Адреса хранения
Получить "Адреса хранения"
GET /api/v1.1/shop_warehouse_cells/
Фильтрация "Адреса хранения" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_cells/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_warehouse_id |
int |
Идентификатор склада |
|
| parent_id |
int |
Родительский адрес хранения |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Адреса хранения"
POST /api/v1.1/shop_warehouse_cells/
Обновить "Адреса хранения" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_cells/{id}/
{"shop_warehouse_id": 1, "parent_id": 1, ...}
Удалить "Адреса хранения" с переданным {id}
DELETE /api/v1.1/shop_warehouse_cells/{id}/
Связанные элементы
Получить "Адреса хранения" у "Адреса хранения" с идентификатором {id}
GET /api/v1.1/shop_warehouse_cells/{id}/shop_warehouse_cells/
Получить "Адреса хранения, товары" у "Адреса хранения" с идентификатором {id}
GET /api/v1.1/shop_warehouse_cells/{id}/shop_warehouse_cell_items/
Проводки товаров
Получить "Проводки товаров"
GET /api/v1.1/shop_warehouse_entries/
Фильтрация "Проводки товаров" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_entries/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| document_id |
int |
|
|
| datetime |
string |
|
|
| shop_warehouse_id |
int |
|
|
| shop_item_id |
int |
|
|
| value |
decimal |
|
|
Создать "Проводки товаров"
POST /api/v1.1/shop_warehouse_entries/
Обновить "Проводки товаров" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_entries/{id}/
{"document_id": 1, "datetime": "...", ...}
Удалить "Проводки товаров" с переданным {id}
DELETE /api/v1.1/shop_warehouse_entries/{id}/
Проводки товаров, агрегированные данные
Получить "Проводки товаров, агрегированные данные"
GET /api/v1.1/shop_warehouse_entry_accumulates/
Фильтрация "Проводки товаров, агрегированные данные" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_entry_accumulates/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| datetime |
string |
|
|
| shop_warehouse_id |
int |
|
|
| shop_item_id |
int |
|
|
| value |
decimal |
|
|
Создать "Проводки товаров, агрегированные данные"
POST /api/v1.1/shop_warehouse_entry_accumulates/
Обновить "Проводки товаров, агрегированные данные" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_entry_accumulates/{id}/
{"datetime": "...", "shop_warehouse_id": 1, ...}
Удалить "Проводки товаров, агрегированные данные" с переданным {id}
DELETE /api/v1.1/shop_warehouse_entry_accumulates/{id}/
Оприходование товаров, товары
Получить "Оприходование товаров, товары"
GET /api/v1.1/shop_warehouse_incoming_items/
Фильтрация "Оприходование товаров, товары" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_incoming_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_warehouse_incoming_id |
int |
|
|
| shop_item_id |
int |
|
|
| price |
decimal |
|
|
| count |
decimal |
|
|
Создать "Оприходование товаров, товары"
POST /api/v1.1/shop_warehouse_incoming_items/
Обновить "Оприходование товаров, товары" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_incoming_items/{id}/
{"shop_warehouse_incoming_id": 1, "shop_item_id": 1, ...}
Удалить "Оприходование товаров, товары" с переданным {id}
DELETE /api/v1.1/shop_warehouse_incoming_items/{id}/
Оприходование товаров
Получить "Оприходование товаров"
GET /api/v1.1/shop_warehouse_incomings/
Фильтрация "Оприходование товаров" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_incomings/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_warehouse_id |
int |
Склад |
|
| number |
string |
Номер |
|
| description |
string |
Описание |
|
| datetime |
string |
Дата создания |
|
| posted |
int |
Проведено |
|
| shop_price_id |
int |
Цена |
|
| siteuser_id |
int |
Поставщик |
|
| siteuser_company_id |
int |
|
|
| user_id |
int |
Ответственный |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Оприходование товаров"
POST /api/v1.1/shop_warehouse_incomings/
Обновить "Оприходование товаров" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_incomings/{id}/
{"shop_warehouse_id": 1, "number": "...", ...}
Удалить "Оприходование товаров" с переданным {id}
DELETE /api/v1.1/shop_warehouse_incomings/{id}/
Связанные элементы
Получить "Оприходование товаров, товары" у "Оприходование товаров" с идентификатором {id}
GET /api/v1.1/shop_warehouse_incomings/{id}/shop_warehouse_incoming_items/
Инвентаризация
Получить "Инвентаризация"
GET /api/v1.1/shop_warehouse_inventories/
Фильтрация "Инвентаризация" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_inventories/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_warehouse_id |
int |
Склад |
|
| number |
string |
Номер |
|
| description |
string |
Описание |
|
| datetime |
string |
Дата создания |
|
| posted |
int |
Проведено |
|
| user_id |
int |
Ответственный |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Инвентаризация"
POST /api/v1.1/shop_warehouse_inventories/
Обновить "Инвентаризация" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_inventories/{id}/
{"shop_warehouse_id": 1, "number": "...", ...}
Удалить "Инвентаризация" с переданным {id}
DELETE /api/v1.1/shop_warehouse_inventories/{id}/
Связанные элементы
Получить "Инвентаризация, товары" у "Инвентаризация" с идентификатором {id}
GET /api/v1.1/shop_warehouse_inventories/{id}/shop_warehouse_inventory_items/
Инвентаризация, товары
Получить "Инвентаризация, товары"
GET /api/v1.1/shop_warehouse_inventory_items/
Фильтрация "Инвентаризация, товары" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_inventory_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_warehouse_inventory_id |
int |
|
|
| shop_item_id |
int |
|
|
| count |
decimal |
|
|
Создать "Инвентаризация, товары"
POST /api/v1.1/shop_warehouse_inventory_items/
Обновить "Инвентаризация, товары" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_inventory_items/{id}/
{"shop_warehouse_inventory_id": 1, "shop_item_id": 1, ...}
Удалить "Инвентаризация, товары" с переданным {id}
DELETE /api/v1.1/shop_warehouse_inventory_items/{id}/
Счета поставщиков, товары
Получить "Счета поставщиков, товары"
GET /api/v1.1/shop_warehouse_invoice_items/
Фильтрация "Счета поставщиков, товары" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_invoice_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_warehouse_invoice_id |
int |
|
|
| shop_item_id |
int |
|
|
| price |
decimal |
|
|
| count |
decimal |
|
|
Создать "Счета поставщиков, товары"
POST /api/v1.1/shop_warehouse_invoice_items/
Обновить "Счета поставщиков, товары" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_invoice_items/{id}/
{"shop_warehouse_invoice_id": 1, "shop_item_id": 1, ...}
Удалить "Счета поставщиков, товары" с переданным {id}
DELETE /api/v1.1/shop_warehouse_invoice_items/{id}/
Счета поставщиков
Получить "Счета поставщиков"
GET /api/v1.1/shop_warehouse_invoices/
Фильтрация "Счета поставщиков" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_invoices/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_warehouse_id |
int |
Склад |
|
| number |
string |
Номер |
|
| description |
string |
Описание |
|
| datetime |
string |
Дата создания |
|
| posted |
int |
Проведено |
|
| registration_number |
string |
Входящий номер |
|
| registration_date |
string |
Дата |
|
| shop_price_id |
int |
Цена |
|
| company_id |
int |
Наша компания |
|
| siteuser_company_id |
int |
Поставщик |
|
| siteuser_company_contract_id |
int |
Договор |
|
| user_id |
int |
Ответственный |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Счета поставщиков"
POST /api/v1.1/shop_warehouse_invoices/
Обновить "Счета поставщиков" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_invoices/{id}/
{"shop_warehouse_id": 1, "number": "...", ...}
Удалить "Счета поставщиков" с переданным {id}
DELETE /api/v1.1/shop_warehouse_invoices/{id}/
Связанные элементы
Получить "Счета поставщиков, товары" у "Счета поставщиков" с идентификатором {id}
GET /api/v1.1/shop_warehouse_invoices/{id}/shop_warehouse_invoice_items/
Товары на складе
Получить "Товары на складе"
GET /api/v1.1/shop_warehouse_items/
Фильтрация "Товары на складе" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_warehouse_id |
int |
|
|
| shop_item_id |
int |
|
|
| count |
decimal |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Товары на складе"
POST /api/v1.1/shop_warehouse_items/
Обновить "Товары на складе" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_items/{id}/
{"shop_warehouse_id": 1, "shop_item_id": 1, ...}
Удалить "Товары на складе" с переданным {id}
DELETE /api/v1.1/shop_warehouse_items/{id}/
Перемещение товаров, товары
Получить "Перемещение товаров, товары"
GET /api/v1.1/shop_warehouse_movement_items/
Фильтрация "Перемещение товаров, товары" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_movement_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_warehouse_movement_id |
int |
|
|
| shop_item_id |
int |
|
|
| count |
decimal |
|
|
Создать "Перемещение товаров, товары"
POST /api/v1.1/shop_warehouse_movement_items/
Обновить "Перемещение товаров, товары" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_movement_items/{id}/
{"shop_warehouse_movement_id": 1, "shop_item_id": 1, ...}
Удалить "Перемещение товаров, товары" с переданным {id}
DELETE /api/v1.1/shop_warehouse_movement_items/{id}/
Перемещение товаров
Получить "Перемещение товаров"
GET /api/v1.1/shop_warehouse_movements/
Фильтрация "Перемещение товаров" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_movements/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| source_shop_warehouse_id |
int |
Склад-отправитель |
|
| destination_shop_warehouse_id |
int |
Склад-получатель |
|
| number |
string |
Номер |
|
| description |
string |
Описание |
|
| datetime |
string |
Дата создания |
|
| posted |
int |
Проведено |
|
| user_id |
int |
Ответственный |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Перемещение товаров"
POST /api/v1.1/shop_warehouse_movements/
Обновить "Перемещение товаров" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_movements/{id}/
{"source_shop_warehouse_id": 1, "destination_shop_warehouse_id": 1, ...}
Удалить "Перемещение товаров" с переданным {id}
DELETE /api/v1.1/shop_warehouse_movements/{id}/
Связанные элементы
Получить "Перемещение товаров, товары" у "Перемещение товаров" с идентификатором {id}
GET /api/v1.1/shop_warehouse_movements/{id}/shop_warehouse_movement_items/
Заказы поставщикам, товары
Получить "Заказы поставщикам, товары"
GET /api/v1.1/shop_warehouse_purchaseorder_items/
Фильтрация "Заказы поставщикам, товары" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_purchaseorder_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_warehouse_purchaseorder_id |
int |
|
|
| shop_item_id |
int |
|
|
| price |
decimal |
|
|
| count |
decimal |
|
|
Создать "Заказы поставщикам, товары"
POST /api/v1.1/shop_warehouse_purchaseorder_items/
Обновить "Заказы поставщикам, товары" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_purchaseorder_items/{id}/
{"shop_warehouse_purchaseorder_id": 1, "shop_item_id": 1, ...}
Удалить "Заказы поставщикам, товары" с переданным {id}
DELETE /api/v1.1/shop_warehouse_purchaseorder_items/{id}/
Заказы поставщикам
Получить "Заказы поставщикам"
GET /api/v1.1/shop_warehouse_purchaseorders/
Фильтрация "Заказы поставщикам" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_purchaseorders/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_warehouse_id |
int |
Склад |
|
| number |
string |
Номер |
|
| description |
string |
Описание |
|
| datetime |
string |
Дата создания |
|
| posted |
int |
Проведено |
|
| shop_price_id |
int |
Цена |
|
| company_id |
int |
Наша компания |
|
| siteuser_company_id |
int |
Поставщик |
|
| siteuser_company_contract_id |
int |
Договор |
|
| user_id |
int |
Ответственный |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Заказы поставщикам"
POST /api/v1.1/shop_warehouse_purchaseorders/
Обновить "Заказы поставщикам" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_purchaseorders/{id}/
{"shop_warehouse_id": 1, "number": "...", ...}
Удалить "Заказы поставщикам" с переданным {id}
DELETE /api/v1.1/shop_warehouse_purchaseorders/{id}/
Связанные элементы
Получить "Заказы поставщикам, товары" у "Заказы поставщикам" с идентификатором {id}
GET /api/v1.1/shop_warehouse_purchaseorders/{id}/shop_warehouse_purchaseorder_items/
Возвраты поставщикам, товары
Получить "Возвраты поставщикам, товары"
GET /api/v1.1/shop_warehouse_purchasereturn_items/
Фильтрация "Возвраты поставщикам, товары" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_purchasereturn_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_warehouse_purchasereturn_id |
int |
|
|
| shop_item_id |
int |
|
|
| price |
decimal |
|
|
| count |
decimal |
|
|
Создать "Возвраты поставщикам, товары"
POST /api/v1.1/shop_warehouse_purchasereturn_items/
Обновить "Возвраты поставщикам, товары" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_purchasereturn_items/{id}/
{"shop_warehouse_purchasereturn_id": 1, "shop_item_id": 1, ...}
Удалить "Возвраты поставщикам, товары" с переданным {id}
DELETE /api/v1.1/shop_warehouse_purchasereturn_items/{id}/
Возвраты поставщикам
Получить "Возвраты поставщикам"
GET /api/v1.1/shop_warehouse_purchasereturns/
Фильтрация "Возвраты поставщикам" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_purchasereturns/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_warehouse_id |
int |
Склад |
|
| number |
string |
Номер |
|
| description |
string |
Описание |
|
| datetime |
string |
Дата создания |
|
| posted |
int |
Проведено |
|
| shop_price_id |
int |
Цена |
|
| company_id |
int |
Наша компания |
|
| siteuser_company_id |
int |
Поставщик |
|
| siteuser_company_contract_id |
int |
Договор |
|
| user_id |
int |
Ответственный |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Возвраты поставщикам"
POST /api/v1.1/shop_warehouse_purchasereturns/
Обновить "Возвраты поставщикам" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_purchasereturns/{id}/
{"shop_warehouse_id": 1, "number": "...", ...}
Удалить "Возвраты поставщикам" с переданным {id}
DELETE /api/v1.1/shop_warehouse_purchasereturns/{id}/
Связанные элементы
Получить "Возвраты поставщикам, товары" у "Возвраты поставщикам" с идентификатором {id}
GET /api/v1.1/shop_warehouse_purchasereturns/{id}/shop_warehouse_purchasereturn_items/
Пересортица, товары
Получить "Пересортица, товары"
GET /api/v1.1/shop_warehouse_regrade_items/
Фильтрация "Пересортица, товары" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_regrade_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_warehouse_regrade_id |
int |
|
|
| writeoff_shop_item_id |
int |
|
|
| writeoff_price |
decimal |
|
|
| incoming_shop_item_id |
int |
|
|
| incoming_price |
decimal |
|
|
| count |
decimal |
|
|
Создать "Пересортица, товары"
POST /api/v1.1/shop_warehouse_regrade_items/
Обновить "Пересортица, товары" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_regrade_items/{id}/
{"shop_warehouse_regrade_id": 1, "writeoff_shop_item_id": 1, ...}
Удалить "Пересортица, товары" с переданным {id}
DELETE /api/v1.1/shop_warehouse_regrade_items/{id}/
Пересортица
Получить "Пересортица"
GET /api/v1.1/shop_warehouse_regrades/
Фильтрация "Пересортица" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_regrades/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_warehouse_id |
int |
Склад |
|
| number |
string |
Номер |
|
| description |
string |
Описание |
|
| datetime |
string |
Дата создания |
|
| posted |
int |
Проведено |
|
| shop_price_id |
int |
Цена |
|
| user_id |
int |
Ответственный |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Пересортица"
POST /api/v1.1/shop_warehouse_regrades/
Обновить "Пересортица" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_regrades/{id}/
{"shop_warehouse_id": 1, "number": "...", ...}
Удалить "Пересортица" с переданным {id}
DELETE /api/v1.1/shop_warehouse_regrades/{id}/
Связанные элементы
Получить "Пересортица, товары" у "Пересортица" с идентификатором {id}
GET /api/v1.1/shop_warehouse_regrades/{id}/shop_warehouse_regrade_items/
Приемки товаров
Получить "Приемки товаров"
GET /api/v1.1/shop_warehouse_supplies/
Фильтрация "Приемки товаров" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_supplies/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_warehouse_id |
int |
Склад |
|
| number |
string |
Номер |
|
| description |
string |
Описание |
|
| datetime |
string |
Дата создания |
|
| posted |
int |
Проведено |
|
| registration_number |
string |
Входящий номер |
|
| registration_date |
string |
Дата |
|
| shop_price_id |
int |
Цена |
|
| company_id |
int |
Наша компания |
|
| siteuser_company_id |
int |
Поставщик |
|
| siteuser_company_contract_id |
int |
Договор |
|
| user_id |
int |
Ответственный |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Приемки товаров"
POST /api/v1.1/shop_warehouse_supplies/
Обновить "Приемки товаров" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_supplies/{id}/
{"shop_warehouse_id": 1, "number": "...", ...}
Удалить "Приемки товаров" с переданным {id}
DELETE /api/v1.1/shop_warehouse_supplies/{id}/
Связанные элементы
Получить "Приемки товаров, товары" у "Приемки товаров" с идентификатором {id}
GET /api/v1.1/shop_warehouse_supplies/{id}/shop_warehouse_supply_items/
Приемки товаров, товары
Получить "Приемки товаров, товары"
GET /api/v1.1/shop_warehouse_supply_items/
Фильтрация "Приемки товаров, товары" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_supply_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_warehouse_supply_id |
int |
|
|
| shop_item_id |
int |
|
|
| price |
decimal |
|
|
| count |
decimal |
|
|
Создать "Приемки товаров, товары"
POST /api/v1.1/shop_warehouse_supply_items/
Обновить "Приемки товаров, товары" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_supply_items/{id}/
{"shop_warehouse_supply_id": 1, "shop_item_id": 1, ...}
Удалить "Приемки товаров, товары" с переданным {id}
DELETE /api/v1.1/shop_warehouse_supply_items/{id}/
Типы складов
Получить "Типы складов"
GET /api/v1.1/shop_warehouse_types/
Фильтрация "Типы складов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_types/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Типы складов"
POST /api/v1.1/shop_warehouse_types/
Обновить "Типы складов" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_types/{id}/
{"name": "...", "description": "...", ...}
Удалить "Типы складов" с переданным {id}
DELETE /api/v1.1/shop_warehouse_types/{id}/
Связанные элементы
Получить "Склады" у "Типы складов" с идентификатором {id}
GET /api/v1.1/shop_warehouse_types/{id}/shop_warehouses/
Списание товаров, товары
Получить "Списание товаров, товары"
GET /api/v1.1/shop_warehouse_writeoff_items/
Фильтрация "Списание товаров, товары" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_writeoff_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shop_warehouse_writeoff_id |
int |
|
|
| shop_item_id |
int |
|
|
| count |
decimal |
|
|
| price |
decimal |
|
|
Создать "Списание товаров, товары"
POST /api/v1.1/shop_warehouse_writeoff_items/
Обновить "Списание товаров, товары" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_writeoff_items/{id}/
{"shop_warehouse_writeoff_id": 1, "shop_item_id": 1, ...}
Удалить "Списание товаров, товары" с переданным {id}
DELETE /api/v1.1/shop_warehouse_writeoff_items/{id}/
Списание товаров
Получить "Списание товаров"
GET /api/v1.1/shop_warehouse_writeoffs/
Фильтрация "Списание товаров" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouse_writeoffs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_warehouse_id |
int |
Склад |
|
| number |
string |
Номер |
|
| description |
string |
Описание |
|
| datetime |
string |
Дата создания |
|
| reason |
string |
Причина |
|
| posted |
int |
Проведено |
|
| shop_price_id |
int |
Цена |
|
| user_id |
int |
Ответственный |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Списание товаров"
POST /api/v1.1/shop_warehouse_writeoffs/
Обновить "Списание товаров" с идентификатором {id}
PUT /api/v1.1/shop_warehouse_writeoffs/{id}/
{"shop_warehouse_id": 1, "number": "...", ...}
Удалить "Списание товаров" с переданным {id}
DELETE /api/v1.1/shop_warehouse_writeoffs/{id}/
Связанные элементы
Получить "Списание товаров, товары" у "Списание товаров" с идентификатором {id}
GET /api/v1.1/shop_warehouse_writeoffs/{id}/shop_warehouse_writeoff_items/
Склады
Получить "Склады"
GET /api/v1.1/shop_warehouses/
Фильтрация "Склады" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warehouses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_id |
int |
Идентификатор магазина |
|
| shop_warehouse_type_id |
int |
|
|
| shop_company_id |
int |
|
|
| name |
string |
Наименование склада |
|
| sorting |
int |
Порядок сортировки |
|
| active |
int |
Активность |
|
| default |
int |
Склад "по умолчанию" |
|
| shop_country_id |
int |
|
|
| shop_country_location_id |
int |
|
|
| shop_country_location_city_id |
int |
|
|
| shop_country_location_city_area_id |
int |
|
|
| address |
string |
Адрес |
|
| name_other |
string |
Альтернативное название |
|
| address_info |
string |
Дополнительная информация |
|
| latitude |
string |
Широта |
|
| longitude |
string |
Долгота |
|
| phone |
string |
Телефон |
|
| website |
string |
Сайт |
|
| working_time |
string |
Часы работы |
|
| user_id |
int |
Идентификатор сотрудника |
|
| guid |
string |
Идентификатор склада CommerceML |
|
| separator |
string |
Разделитель ячейки |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Склады"
POST /api/v1.1/shop_warehouses/
Обновить "Склады" с идентификатором {id}
PUT /api/v1.1/shop_warehouses/{id}/
{"shop_id": 1, "shop_warehouse_type_id": 1, ...}
Удалить "Склады" с переданным {id}
DELETE /api/v1.1/shop_warehouses/{id}/
Связанные элементы
Получить "Товары магазина" у "Склады" с идентификатором {id}
GET /api/v1.1/shop_warehouses/{id}/shop_items/
Получить "Товары на складе" у "Склады" с идентификатором {id}
GET /api/v1.1/shop_warehouses/{id}/shop_warehouse_items/
Получить "Товары интернет-магазина, резерв" у "Склады" с идентификатором {id}
GET /api/v1.1/shop_warehouses/{id}/shop_item_reserveds/
Получить "Интернет-магазин, корзина" у "Склады" с идентификатором {id}
GET /api/v1.1/shop_warehouses/{id}/shop_carts/
Получить "Проводки товаров" у "Склады" с идентификатором {id}
GET /api/v1.1/shop_warehouses/{id}/shop_warehouse_entries/
Получить "Проводки товаров, агрегированные данные" у "Склады" с идентификатором {id}
GET /api/v1.1/shop_warehouses/{id}/shop_warehouse_entry_accumulates/
Получить "Инвентаризация" у "Склады" с идентификатором {id}
GET /api/v1.1/shop_warehouses/{id}/shop_warehouse_inventories/
Получить "Оприходование товаров" у "Склады" с идентификатором {id}
GET /api/v1.1/shop_warehouses/{id}/shop_warehouse_incomings/
Получить "Списание товаров" у "Склады" с идентификатором {id}
GET /api/v1.1/shop_warehouses/{id}/shop_warehouse_writeoffs/
Получить "Пересортица" у "Склады" с идентификатором {id}
GET /api/v1.1/shop_warehouses/{id}/shop_warehouse_regrades/
Получить "Адреса хранения" у "Склады" с идентификатором {id}
GET /api/v1.1/shop_warehouses/{id}/shop_warehouse_cells/
Получить "Адреса хранения, товары" у "Склады" с идентификатором {id}
GET /api/v1.1/shop_warehouses/{id}/shop_warehouse_cell_items/
Получить "Метки" у "Склады" с идентификатором {id}
GET /api/v1.1/shop_warehouses/{id}/tags/
Получить "Метки, склады" у "Склады" с идентификатором {id}
GET /api/v1.1/shop_warehouses/{id}/tag_shop_warehouses/
Получить "Заказы поставщикам" у "Склады" с идентификатором {id}
GET /api/v1.1/shop_warehouses/{id}/shop_warehouse_purchaseorders/
Получить "Счета поставщиков" у "Склады" с идентификатором {id}
GET /api/v1.1/shop_warehouses/{id}/shop_warehouse_invoices/
Получить "Приемки товаров" у "Склады" с идентификатором {id}
GET /api/v1.1/shop_warehouses/{id}/shop_warehouse_supplies/
Получить "Возвраты поставщикам" у "Склады" с идентификатором {id}
GET /api/v1.1/shop_warehouses/{id}/shop_warehouse_purchasereturns/
Получить "Производственные задания" у "Склады" с идентификатором {id}
GET /api/v1.1/shop_warehouses/{id}/production_tasks/
Платежи
Получить "Платежи"
GET /api/v1.1/shop_warrants/
Фильтрация "Платежи" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shop_warrants/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_id |
int |
Идентификатор магазина |
|
| company_id |
int |
Наша компания |
|
| chartaccount_cashflow_id |
int |
Движение денежных средств |
|
| company_cashbox_id |
int |
Касса |
|
| company_account_id |
int |
Расчетный счет |
|
| chartaccount_id |
int |
Корр.счет |
|
| sc0 |
int |
|
|
| sc1 |
int |
|
|
| sc2 |
int |
|
|
| number |
string |
Номер |
|
| datetime |
string |
Дата создания |
|
| reason |
string |
Основание |
|
| amount |
decimal |
Сумма |
|
| tax |
decimal |
Налог |
|
| description |
string |
Описание |
|
| type |
int |
|
|
| posted |
int |
Проведено |
|
| user_id |
int |
Сотрудник |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Платежи"
POST /api/v1.1/shop_warrants/
Обновить "Платежи" с идентификатором {id}
PUT /api/v1.1/shop_warrants/{id}/
{"shop_id": 1, "company_id": 1, ...}
Удалить "Платежи" с переданным {id}
DELETE /api/v1.1/shop_warrants/{id}/
Интернет-магазины
Получить "Интернет-магазины"
GET /api/v1.1/shops/
Фильтрация "Интернет-магазины" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shops/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shop_dir_id |
int |
Раздел |
|
| shop_company_id |
int |
Компания |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Название интернет-магазина |
|
| description |
string |
Описание интернет-магазина |
|
| yandex_market_name |
string |
Название для Yandex.Market |
|
| image_small_max_width |
int |
Максимальная ширина малого изображения товара |
|
| image_small_max_height |
int |
Максимальная высота малого изображения товара |
|
| image_large_max_width |
int |
Максимальная ширина большого изображения товара |
|
| image_large_max_height |
int |
Максимальная высота большого изображения товара |
|
| structure_id |
int |
Узел структуры |
|
| producer_structure_id |
int |
Узел структуры производителей |
|
| shop_country_id |
int |
Страна по умолчанию |
|
| shop_currency_id |
int |
Валюта по умолчанию |
|
| shop_tax_id |
int |
Налог по умолчанию |
|
| shop_order_status_id |
int |
Статус заказа по умолчанию |
|
| shop_codetype_id |
int |
Маркировка по умолчанию |
|
| shop_measure_id |
int |
Ед.изм. веса |
|
| default_shop_measure_id |
int |
Ед.изм. товара |
|
| email |
string |
E-mail куратора магазина |
|
| items_on_page |
int |
Элементов на страницу |
|
| url_type |
int |
Тип формирования URL |
|
| path_date_format |
string |
Формат пути типа "Дата" |
|
| reserve |
int |
Резервировать заказанные товары |
|
| send_order_email_admin |
int |
Отправлять письмо с информацией о поступившем заказе администратору |
|
| send_order_email_user |
int |
Отправлять письмо с информацией об оформленном заказе пользователю |
|
| items_sorting_field |
int |
Поле сортировки товара |
|
| items_sorting_direction |
int |
Направление сортировки товара |
|
| groups_sorting_field |
int |
Поле сортировки групп |
|
| groups_sorting_direction |
int |
Направление сортировки групп |
|
| user_id |
int |
Идентификатор сотрудника |
|
| comment_active |
int |
Постмодерировать отзывы на товары |
|
| watermark_file |
string |
Изображение для водяного знака |
|
| watermark_default_use_large_image |
int |
Использовать водяной знак |
|
| watermark_default_use_small_image |
int |
Использовать водяной знак для малых изображений |
|
| watermark_default_position_x |
string |
Позиция по оси X (по умолчанию) |
|
| watermark_default_position_y |
string |
Позиция по оси Y (по умолчанию) |
|
| create_small_image |
int |
Создавать малое изображение из большого |
|
| guid |
string |
Идентификатор GUID |
|
| format_date |
string |
Формат даты |
|
| format_datetime |
string |
Формат даты/времени |
|
| typograph_default_items |
int |
Типографировать товары |
|
| typograph_default_groups |
int |
Типографировать группы товаров |
|
| apply_tags_automatically |
int |
Автоматически применять метки (теги) |
|
| write_off_paid_items |
int |
Списывать товары при оплате |
|
| apply_keywords_automatically |
int |
Автоматически генерировать ключевые слова |
|
| change_filename |
int |
Изменять названия загружаемых файлов |
|
| attach_digital_items |
int |
Отправлять файл электронного товара в письме пользователю |
|
| yandex_market_sales_notes_default |
string |
Значение по умолчанию тега <sales_notes> для Yandex.Market |
|
| siteuser_group_id |
int |
Группа клиентов |
|
| use_captcha |
int |
Использовать CAPTCHA |
|
| group_image_small_max_width |
int |
Максимальная ширина малого изображения для группы |
|
| group_image_large_max_width |
int |
Максимальная ширина большого изображения для группы |
|
| group_image_small_max_height |
int |
Максимальная высота малого изображения для группы |
|
| group_image_large_max_height |
int |
Максимальная высота большого изображения для группы |
|
| producer_image_small_max_width |
int |
Максимальная ширина малого изображения производителя |
|
| producer_image_large_max_width |
int |
Максимальная ширина большого изображения производителя |
|
| producer_image_small_max_height |
int |
Максимальная высота малого изображения производителя |
|
| producer_image_large_max_height |
int |
Максимальная высота большого изображения производителя |
|
| preserve_aspect_ratio |
int |
Сохранять пропорции изображения товара |
|
| preserve_aspect_ratio_small |
int |
Сохранять пропорции малого изображения товара |
|
| preserve_aspect_ratio_group |
int |
Сохранять пропорции изображения для групп |
|
| preserve_aspect_ratio_group_small |
int |
Сохранять пропорции малого изображения для групп |
|
| size_measure |
int |
Ед.изм. габаритов |
|
| reserve_hours |
decimal |
Резервировать (в часах) |
|
| max_bonus |
int |
Списывать бонус, % |
|
| adult |
int |
Для взрослых |
|
| cpa |
int |
Публиковать в «Заказ на Маркете» |
|
| issue_discountcard |
int |
Выдавать дисконтную карту при заказе |
|
| filter |
int |
Быстрый фильтр |
|
| discountcard_template |
string |
Шаблон номера карты |
|
| invoice_template |
string |
Шаблон номера заказа |
|
| marking_template |
string |
Шаблон артикула товара |
|
| order_admin_subject |
string |
Тема письма о поступившем заказе куратору магазина |
|
| order_user_subject |
string |
Тема письма о поступившем заказе пользователю |
|
| confirm_admin_subject |
string |
Тема письма подтверждения оплаты куратору магазина |
|
| confirm_user_subject |
string |
Тема письма подтверждения оплаты пользователю |
|
| cancel_admin_subject |
string |
Тема письма об отмене заказа куратору магазина |
|
| cancel_user_subject |
string |
Тема письма об отмене заказа пользователю |
|
| filter_mode |
int |
Режим URL |
|
| seo_group_title_template |
string |
Шаблон title |
|
| seo_group_keywords_template |
string |
Шаблон keywords |
|
| seo_group_description_template |
string |
Шаблон description |
|
| seo_group_h1_template |
string |
Шаблон H1 |
|
| seo_item_title_template |
string |
Шаблон title |
|
| seo_item_keywords_template |
string |
Шаблон keywords |
|
| seo_item_description_template |
string |
Шаблон description |
|
| seo_item_h1_template |
string |
Шаблон H1 |
|
| seo_root_title_template |
string |
Шаблон title |
|
| seo_root_keywords_template |
string |
Шаблон keywords |
|
| seo_root_description_template |
string |
Шаблон description |
|
| seo_root_h1_template |
string |
Шаблон H1 |
|
| certificate_template |
string |
Шаблон номера купона |
|
| certificate_subject |
string |
Тема письма |
|
| certificate_text |
string |
Текст письма |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Интернет-магазины"
POST /api/v1.1/shops/
Обновить "Интернет-магазины" с идентификатором {id}
PUT /api/v1.1/shops/{id}/
{"shop_dir_id": 1, "shop_company_id": 1, ...}
Удалить "Интернет-магазины" с переданным {id}
DELETE /api/v1.1/shops/{id}/
Связанные элементы
Получить "Партнерские программы" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/affiliate_plans/
Получить "Уровни партнерской программы" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_affiliate_plans/
Получить "Интернет-магазин, корзина" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_carts/
Получить "Избранное" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_favorites/
Получить "Списки избранного" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_favorite_lists/
Получить "Интернет-магазин, сравнение" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_compares/
Получить "Типы доставки" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_deliveries/
Получить "Бонусы" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_bonuses/
Получить "Разделы бонусов" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_bonus_dirs/
Получить "Скидки" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_discounts/
Получить "Разделы скидок" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_discount_dirs/
Получить "Группы товаров" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_groups/
Получить "Группы интернет-магазина, дополнительные свойства" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_group_properties/
Получить "Группы интернет-магазина, группы дополнительных свойств" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_group_property_dirs/
Получить "Товары магазина" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_items/
Получить "Товары интернет-магазина, дополнительные свойства" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_item_properties/
Получить "Товары интернет-магазина, группы дополнительных свойств" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_item_property_dirs/
Получить "Подарки" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_gifts/
Получить "Разделы подарков" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_gift_dirs/
Получить "Заказы магазина" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_orders/
Получить "Заказы, дополнительные свойства" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_order_properties/
Получить "Заказы, группы дополнительных свойств" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_order_property_dirs/
Получить "Платежные системы" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_payment_systems/
Получить "Печатные формы" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_print_forms/
Получить "Цены магазина" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_prices/
Получить "Производители" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_producers/
Получить "Группа производителей" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_producer_dirs/
Получить "Скидки от суммы заказа" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_purchase_discounts/
Получить "Разделы скидок" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_purchase_discount_dirs/
Получить "Разделы купонов" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_purchase_discount_coupon_dirs/
Получить "Продавцы" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_sellers/
Получить "Транзакции пользователя" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_siteuser_transactions/
Получить "Склады" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_warehouses/
Получить "Дополнительные свойства товара разрешенные для группы" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_item_property_for_groups/
Получить "Товары, опции доставок" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_item_delivery_options/
Получить "Сделки" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/deals/
Получить "Дисконтные карты" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_discountcards/
Получить "Уровни дисконтных карт" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_discountcard_levels/
Получить "Типы зачислений" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_discountcard_bonus_types/
Получить "Установка цен" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_price_settings/
Получить "SEO-фильтр" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_filter_seos/
Получить "Группа SEO-фильтров" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_filter_seo_dirs/
Получить "Раздел вкладок" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_tab_dirs/
Получить "Вкладки товаров и групп" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_tabs/
Получить "Комментарии, дополнительные свойства" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_comment_properties/
Получить "Комментарии, группы дополнительных свойств" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_comment_property_dirs/
Получить "Статусы заказов" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_order_statuses/
Получить "Статусы товаров заказа" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/shop_order_item_statuses/
Получить "Технологические процессы" у "Интернет-магазины" с идентификатором {id}
GET /api/v1.1/shops/{id}/production_processes/
Получить "Комментарии информационных систем, дополнительные свойства"
GET /api/v1.1/informationsystem_comment_properties/
Фильтрация "Комментарии информационных систем, дополнительные свойства" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/informationsystem_comment_properties/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| informationsystem_id |
int |
|
|
| property_id |
int |
|
|
Создать "Комментарии информационных систем, дополнительные свойства"
POST /api/v1.1/informationsystem_comment_properties/
Обновить "Комментарии информационных систем, дополнительные свойства" с идентификатором {id}
PUT /api/v1.1/informationsystem_comment_properties/{id}/
{"informationsystem_id": 1, "property_id": 1, ...}
Удалить "Комментарии информационных систем, дополнительные свойства" с переданным {id}
DELETE /api/v1.1/informationsystem_comment_properties/{id}/
Получить "Комментарии информационных систем, группы дополнительных свойств"
GET /api/v1.1/informationsystem_comment_property_dirs/
Фильтрация "Комментарии информационных систем, группы дополнительных свойств" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/informationsystem_comment_property_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| informationsystem_id |
int |
|
|
| property_dir_id |
int |
|
|
Создать "Комментарии информационных систем, группы дополнительных свойств"
POST /api/v1.1/informationsystem_comment_property_dirs/
Обновить "Комментарии информационных систем, группы дополнительных свойств" с идентификатором {id}
PUT /api/v1.1/informationsystem_comment_property_dirs/{id}/
{"informationsystem_id": 1, "property_dir_id": 1, ...}
Удалить "Комментарии информационных систем, группы дополнительных свойств" с переданным {id}
DELETE /api/v1.1/informationsystem_comment_property_dirs/{id}/
Получить "Разделы информационных систем"
GET /api/v1.1/informationsystem_dirs/
Фильтрация "Разделы информационных систем" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/informationsystem_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
|
|
| name |
string |
Название раздела информационных систем |
|
| description |
string |
Описание раздела информационных систем |
|
| site_id |
int |
Код сайта |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Разделы информационных систем"
POST /api/v1.1/informationsystem_dirs/
Обновить "Разделы информационных систем" с идентификатором {id}
PUT /api/v1.1/informationsystem_dirs/{id}/
{"parent_id": 1, "name": "...", ...}
Удалить "Разделы информационных систем" с переданным {id}
DELETE /api/v1.1/informationsystem_dirs/{id}/
Связанные элементы
Получить "Информационные системы" у "Разделы информационных систем" с идентификатором {id}
GET /api/v1.1/informationsystem_dirs/{id}/informationsystems/
Получить "Разделы информационных систем" у "Разделы информационных систем" с идентификатором {id}
GET /api/v1.1/informationsystem_dirs/{id}/informationsystem_dirs/
Получить "Группы информационных систем, дополнительные свойства"
GET /api/v1.1/informationsystem_group_properties/
Фильтрация "Группы информационных систем, дополнительные свойства" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/informationsystem_group_properties/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| informationsystem_id |
int |
|
|
| property_id |
int |
|
|
Создать "Группы информационных систем, дополнительные свойства"
POST /api/v1.1/informationsystem_group_properties/
Обновить "Группы информационных систем, дополнительные свойства" с идентификатором {id}
PUT /api/v1.1/informationsystem_group_properties/{id}/
{"informationsystem_id": 1, "property_id": 1, ...}
Удалить "Группы информационных систем, дополнительные свойства" с переданным {id}
DELETE /api/v1.1/informationsystem_group_properties/{id}/
Получить "Группы информационных систем, группы дополнительных свойств"
GET /api/v1.1/informationsystem_group_property_dirs/
Фильтрация "Группы информационных систем, группы дополнительных свойств" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/informationsystem_group_property_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| informationsystem_id |
int |
|
|
| property_dir_id |
int |
|
|
Создать "Группы информационных систем, группы дополнительных свойств"
POST /api/v1.1/informationsystem_group_property_dirs/
Обновить "Группы информационных систем, группы дополнительных свойств" с идентификатором {id}
PUT /api/v1.1/informationsystem_group_property_dirs/{id}/
{"informationsystem_id": 1, "property_dir_id": 1, ...}
Удалить "Группы информационных систем, группы дополнительных свойств" с переданным {id}
DELETE /api/v1.1/informationsystem_group_property_dirs/{id}/
Получить "Информационные группы"
GET /api/v1.1/informationsystem_groups/
Фильтрация "Информационные группы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/informationsystem_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| informationsystem_id |
int |
Идентификатор информационной системы |
|
| siteuser_id |
int |
Клиент |
|
| parent_id |
int |
Родительская группа |
|
| shortcut_id |
int |
|
|
| name |
string |
Название информационной группы |
|
| description |
string |
Описание информационной группы |
|
| sorting |
int |
Порядок сортировки |
|
| path |
string |
Путь |
|
| image_large |
string |
Изображение |
|
| image_small |
string |
Малое изображение |
|
| indexing |
int |
Индексировать |
|
| subgroups_count |
int |
|
|
| subgroups_total_count |
int |
|
|
| items_count |
int |
|
|
| items_total_count |
int |
|
|
| seo_title |
string |
Заголовок (Title) |
|
| seo_description |
string |
Описание (Description) |
|
| seo_keywords |
string |
Ключевые слова (Keywords) |
|
| seo_group_title_template |
string |
Шаблон title |
|
| seo_group_keywords_template |
string |
Шаблон keywords |
|
| seo_group_description_template |
string |
Шаблон description |
|
| seo_group_h1_template |
string |
Шаблон H1 |
|
| seo_item_title_template |
string |
Шаблон title |
|
| seo_item_keywords_template |
string |
Шаблон keywords |
|
| seo_item_description_template |
string |
Шаблон description |
|
| seo_item_h1_template |
string |
Шаблон H1 |
|
| siteuser_group_id |
int |
Группа клиентов |
|
| active |
int |
Активна |
|
| user_id |
int |
Идентификатор сотрудника |
|
| guid |
string |
GUID |
|
| sns_type_id |
int |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Информационные группы"
POST /api/v1.1/informationsystem_groups/
Обновить "Информационные группы" с идентификатором {id}
PUT /api/v1.1/informationsystem_groups/{id}/
{"informationsystem_id": 1, "siteuser_id": 1, ...}
Удалить "Информационные группы" с переданным {id}
DELETE /api/v1.1/informationsystem_groups/{id}/
Связанные элементы
Получить "Информационные элементы" у "Информационные группы" с идентификатором {id}
GET /api/v1.1/informationsystem_groups/{id}/informationsystem_items/
Получить "Информационные группы" у "Информационные группы" с идентификатором {id}
GET /api/v1.1/informationsystem_groups/{id}/informationsystem_groups/
Получить "Библиотека файлов, группы информационных элементов" у "Информационные группы" с идентификатором {id}
GET /api/v1.1/informationsystem_groups/{id}/media_informationsystem_groups/
Получить "Библиотека файлов, файлы" у "Информационные группы" с идентификатором {id}
GET /api/v1.1/informationsystem_groups/{id}/media_items/
Получить "Элементы информационных систем, дополнительные свойства"
GET /api/v1.1/informationsystem_item_properties/
Фильтрация "Элементы информационных систем, дополнительные свойства" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/informationsystem_item_properties/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| informationsystem_id |
int |
|
|
| property_id |
int |
|
|
Создать "Элементы информационных систем, дополнительные свойства"
POST /api/v1.1/informationsystem_item_properties/
Обновить "Элементы информационных систем, дополнительные свойства" с идентификатором {id}
PUT /api/v1.1/informationsystem_item_properties/{id}/
{"informationsystem_id": 1, "property_id": 1, ...}
Удалить "Элементы информационных систем, дополнительные свойства" с переданным {id}
DELETE /api/v1.1/informationsystem_item_properties/{id}/
Получить "Элементы информационных систем, группы дополнительных свойств"
GET /api/v1.1/informationsystem_item_property_dirs/
Фильтрация "Элементы информационных систем, группы дополнительных свойств" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/informationsystem_item_property_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| informationsystem_id |
int |
|
|
| property_dir_id |
int |
|
|
Создать "Элементы информационных систем, группы дополнительных свойств"
POST /api/v1.1/informationsystem_item_property_dirs/
Обновить "Элементы информационных систем, группы дополнительных свойств" с идентификатором {id}
PUT /api/v1.1/informationsystem_item_property_dirs/{id}/
{"informationsystem_id": 1, "property_dir_id": 1, ...}
Удалить "Элементы информационных систем, группы дополнительных свойств" с переданным {id}
DELETE /api/v1.1/informationsystem_item_property_dirs/{id}/
Получить "Информационные элементы"
GET /api/v1.1/informationsystem_items/
Фильтрация "Информационные элементы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/informationsystem_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| informationsystem_id |
int |
Идентификатор информационной системы |
|
| informationsystem_group_id |
int |
Группа |
|
| shortcut_id |
int |
Идентификатор родительского элемента |
|
| datetime |
string |
Дата |
|
| start_datetime |
string |
Дата публикации |
|
| end_datetime |
string |
Дата завершения публикации |
|
| name |
string |
Название информационного элемента |
|
| description |
string |
Описание информационного элемента |
|
| active |
int |
Активен |
|
| text |
string |
Текст |
|
| image_large |
string |
Большое изображение |
|
| image_small |
string |
Малое изображение |
|
| image_large_width |
int |
|
|
| image_large_height |
int |
|
|
| image_small_width |
int |
|
|
| image_small_height |
int |
|
|
| sorting |
int |
Порядок сортировки |
|
| ip |
string |
IP-адрес |
|
| path |
string |
Название элемента в URL |
|
| indexing |
int |
Индексировать |
|
| closed |
int |
Закрыт |
|
| seo_title |
string |
Заголовок (Title) |
|
| seo_description |
string |
Описание (Description) |
|
| seo_keywords |
string |
Ключевые слова (Keywords) |
|
| siteuser_group_id |
int |
Группа клиентов |
|
| showed |
int |
Число просмотров |
|
| user_id |
int |
Идентификатор сотрудника |
|
| siteuser_id |
int |
Клиент |
|
| guid |
string |
GUID |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Информационные элементы"
POST /api/v1.1/informationsystem_items/
Обновить "Информационные элементы" с идентификатором {id}
PUT /api/v1.1/informationsystem_items/{id}/
{"informationsystem_id": 1, "informationsystem_group_id": 1, ...}
Удалить "Информационные элементы" с переданным {id}
DELETE /api/v1.1/informationsystem_items/{id}/
Связанные элементы
Получить "Информационные элементы" у "Информационные элементы" с идентификатором {id}
GET /api/v1.1/informationsystem_items/{id}/informationsystem_items/
Получить "Метки" у "Информационные элементы" с идентификатором {id}
GET /api/v1.1/informationsystem_items/{id}/tags/
Получить "Метки, информационные элементы" у "Информационные элементы" с идентификатором {id}
GET /api/v1.1/informationsystem_items/{id}/tag_informationsystem_items/
Получить "Комментарии" у "Информационные элементы" с идентификатором {id}
GET /api/v1.1/informationsystem_items/{id}/comments/
Получить "Голоса" у "Информационные элементы" с идентификатором {id}
GET /api/v1.1/informationsystem_items/{id}/votes/
Получить "Библиотека файлов, информационные элементы" у "Информационные элементы" с идентификатором {id}
GET /api/v1.1/informationsystem_items/{id}/media_informationsystem_items/
Получить "Библиотека файлов, файлы" у "Информационные элементы" с идентификатором {id}
GET /api/v1.1/informationsystem_items/{id}/media_items/
Получить "Информационные системы"
GET /api/v1.1/informationsystems/
Фильтрация "Информационные системы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/informationsystems/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| informationsystem_dir_id |
int |
|
|
| structure_id |
int |
|
|
| site_id |
int |
|
|
| name |
string |
Название информационной системы |
|
| description |
string |
Описание информационной системы |
|
| items_sorting_direction |
int |
|
|
| items_sorting_field |
int |
|
|
| groups_sorting_direction |
int |
|
|
| groups_sorting_field |
int |
|
|
| image_large_max_width |
int |
Максимальная ширина большой картинки элемента |
|
| image_large_max_height |
int |
Максимальная высота большой картинки элемента |
|
| image_small_max_width |
int |
Максимальная ширина малой картинки элемента |
|
| image_small_max_height |
int |
Максимальная высота малой картинки элемента |
|
| siteuser_group_id |
int |
Группа клиентов |
|
| use_captcha |
int |
Использовать CAPTCHA |
|
| watermark_file |
string |
Изображение для водяного знака |
|
| watermark_default_use_large_image |
int |
Использовать водяной знак |
|
| watermark_default_use_small_image |
int |
Использовать водяной знак для малых изображений |
|
| watermark_default_position_x |
string |
Позиция по оси X по умолчанию |
|
| watermark_default_position_y |
string |
Позиция по оси Y по умолчанию |
|
| create_small_image |
int |
Создавать малое изображение из большого |
|
| user_id |
int |
Идентификатор сотрудника |
|
| items_on_page |
int |
Число элементов на странице |
|
| format_date |
string |
Формат даты |
|
| format_datetime |
string |
Формат даты/времени |
|
| url_type |
int |
Тип формирования URL |
|
| path_date_format |
string |
Формат пути типа "Дата" |
|
| typograph_default_items |
int |
Типографировать элементы |
|
| typograph_default_groups |
int |
Типографировать группы |
|
| apply_tags_automatically |
int |
Автоматически применять метки (теги) |
|
| change_filename |
int |
Изменять названия загружаемых файлов |
|
| apply_keywords_automatically |
int |
Автоматически генерировать ключевые слова |
|
| group_image_large_max_width |
int |
Максимальная ширина большой картинки группы |
|
| group_image_large_max_height |
int |
Максимальная высота большой картинки группы |
|
| group_image_small_max_width |
int |
Максимальная ширина малой картинки группы |
|
| group_image_small_max_height |
int |
Максимальная высота малой картинки группы |
|
| preserve_aspect_ratio |
int |
Сохранять пропорции изображений элемента |
|
| preserve_aspect_ratio_small |
int |
Сохранять пропорции малых изображений элемента |
|
| preserve_aspect_ratio_group |
int |
Сохранять пропорции изображений для групп |
|
| preserve_aspect_ratio_group_small |
int |
Сохранять пропорции малых изображений для групп |
|
| seo_group_title_template |
string |
Шаблон title |
|
| seo_group_keywords_template |
string |
Шаблон keywords |
|
| seo_group_description_template |
string |
Шаблон description |
|
| seo_group_h1_template |
string |
Шаблон H1 |
|
| seo_item_title_template |
string |
Шаблон title |
|
| seo_item_keywords_template |
string |
Шаблон keywords |
|
| seo_item_description_template |
string |
Шаблон description |
|
| seo_item_h1_template |
string |
Шаблон H1 |
|
| seo_root_title_template |
string |
Шаблон title |
|
| seo_root_keywords_template |
string |
Шаблон keywords |
|
| seo_root_description_template |
string |
Шаблон description |
|
| seo_root_h1_template |
string |
Шаблон H1 |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Информационные системы"
POST /api/v1.1/informationsystems/
Обновить "Информационные системы" с идентификатором {id}
PUT /api/v1.1/informationsystems/{id}/
{"informationsystem_dir_id": 1, "structure_id": 1, ...}
Удалить "Информационные системы" с переданным {id}
DELETE /api/v1.1/informationsystems/{id}/
Связанные элементы
Получить "Информационные элементы" у "Информационные системы" с идентификатором {id}
GET /api/v1.1/informationsystems/{id}/informationsystem_items/
Получить "Информационные группы" у "Информационные системы" с идентификатором {id}
GET /api/v1.1/informationsystems/{id}/informationsystem_groups/
Получить "Группы информационных систем, дополнительные свойства" у "Информационные системы" с идентификатором {id}
GET /api/v1.1/informationsystems/{id}/informationsystem_group_properties/
Получить "Группы информационных систем, группы дополнительных свойств" у "Информационные системы" с идентификатором {id}
GET /api/v1.1/informationsystems/{id}/informationsystem_group_property_dirs/
Получить "Элементы информационных систем, дополнительные свойства" у "Информационные системы" с идентификатором {id}
GET /api/v1.1/informationsystems/{id}/informationsystem_item_properties/
Получить "Элементы информационных систем, группы дополнительных свойств" у "Информационные системы" с идентификатором {id}
GET /api/v1.1/informationsystems/{id}/informationsystem_item_property_dirs/
Получить "Комментарии информационных систем, дополнительные свойства" у "Информационные системы" с идентификатором {id}
GET /api/v1.1/informationsystems/{id}/informationsystem_comment_properties/
Получить "Комментарии информационных систем, группы дополнительных свойств" у "Информационные системы" с идентификатором {id}
GET /api/v1.1/informationsystems/{id}/informationsystem_comment_property_dirs/
Календарь
Настройки CalDAV-сервера
Получить "Настройки CalDAV-сервера"
GET /api/v1.1/calendar_caldav_users/
Фильтрация "Настройки CalDAV-сервера" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/calendar_caldav_users/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентфиикатор |
|
| user_id |
int |
Идентификатор сотрудника |
|
| calendar_caldav_id |
int |
Идентификатор календаря |
|
| caldav_server |
string |
Сервер CalDAV |
|
| username |
string |
Пользователь |
|
| password |
string |
Пароль |
|
| data |
string |
|
|
| synchronized_datetime |
string |
|
|
Создать "Настройки CalDAV-сервера"
POST /api/v1.1/calendar_caldav_users/
Обновить "Настройки CalDAV-сервера" с идентификатором {id}
PUT /api/v1.1/calendar_caldav_users/{id}/
{"user_id": 1, "calendar_caldav_id": 1, ...}
Удалить "Настройки CalDAV-сервера" с переданным {id}
DELETE /api/v1.1/calendar_caldav_users/{id}/
Настройки календарей
Получить "Настройки календарей"
GET /api/v1.1/calendar_caldavs/
Фильтрация "Настройки календарей" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/calendar_caldavs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| icon |
string |
Иконка |
|
| driver |
string |
Драйвер |
|
| active |
int |
Активность |
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок сортировки |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Настройки календарей"
POST /api/v1.1/calendar_caldavs/
Обновить "Настройки календарей" с идентификатором {id}
PUT /api/v1.1/calendar_caldavs/{id}/
{"name": "...", "icon": "...", ...}
Удалить "Настройки календарей" с переданным {id}
DELETE /api/v1.1/calendar_caldavs/{id}/
Связанные элементы
Получить "Настройки CalDAV-сервера" у "Настройки календарей" с идентификатором {id}
GET /api/v1.1/calendar_caldavs/{id}/calendar_caldav_users/
Получить "Сотрудники" у "Настройки календарей" с идентификатором {id}
GET /api/v1.1/calendar_caldavs/{id}/users/
Получить "Дела, календари" у "Настройки календарей" с идентификатором {id}
GET /api/v1.1/calendar_caldavs/{id}/event_calendar_caldavs/
Клиенты
Клиенты, неудачные попытки авторизации
Получить "Клиенты, неудачные попытки авторизации"
GET /api/v1.1/siteuser_accessdenieds/
Фильтрация "Клиенты, неудачные попытки авторизации" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_accessdenieds/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| datetime |
string |
|
|
| ip |
string |
|
|
Создать "Клиенты, неудачные попытки авторизации"
POST /api/v1.1/siteuser_accessdenieds/
Обновить "Клиенты, неудачные попытки авторизации" с идентификатором {id}
PUT /api/v1.1/siteuser_accessdenieds/{id}/
{"datetime": "...", "ip": "...", ...}
Удалить "Клиенты, неудачные попытки авторизации" с переданным {id}
DELETE /api/v1.1/siteuser_accessdenieds/{id}/
Привлеченные аффилиатом пользователи
Получить "Привлеченные аффилиатом пользователи"
GET /api/v1.1/siteuser_affiliates/
Фильтрация "Привлеченные аффилиатом пользователи" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_affiliates/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| referral_siteuser_id |
int |
Идентификатор пользователя сайта |
|
| siteuser_id |
int |
Идентификатор клиента |
|
| active |
int |
Активность пользователя |
|
| user_id |
int |
Идентификатор сотрудника |
|
| date |
string |
Дата |
|
Создать "Привлеченные аффилиатом пользователи"
POST /api/v1.1/siteuser_affiliates/
Обновить "Привлеченные аффилиатом пользователи" с идентификатором {id}
PUT /api/v1.1/siteuser_affiliates/{id}/
{"referral_siteuser_id": 1, "siteuser_id": 1, ...}
Удалить "Привлеченные аффилиатом пользователи" с переданным {id}
DELETE /api/v1.1/siteuser_affiliates/{id}/
Компания
Получить "Компания"
GET /api/v1.1/siteuser_companies/
Фильтрация "Компания" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_companies/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| siteuser_id |
int |
Идентификатор клиента |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| tin |
string |
ИНН |
|
| kpp |
string |
КПП |
|
| bic |
string |
БИК |
|
| current_account |
string |
Номер счета |
|
| correspondent_account |
string |
Номер корр. счета |
|
| bank_name |
string |
Название банка |
|
| bank_address |
string |
Адрес банка |
|
| bank_account |
string |
Банковские реквизиты |
|
| image |
string |
Логотип |
|
| headcount |
int |
Число сотрудников |
|
| annual_turnover |
string |
Годовой оборот |
|
| business_area |
string |
Сфера деятельности |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Компания"
POST /api/v1.1/siteuser_companies/
Обновить "Компания" с идентификатором {id}
PUT /api/v1.1/siteuser_companies/{id}/
{"siteuser_id": 1, "name": "...", ...}
Удалить "Компания" с переданным {id}
DELETE /api/v1.1/siteuser_companies/{id}/
Связанные элементы
Получить "Компания клиента, электронная почта" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/siteuser_company_directory_emails/
Получить "Электронные адреса" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/directory_emails/
Получить "Компания клиента, адреса" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/siteuser_company_directory_addresses/
Получить "Адреса" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/directory_addresses/
Получить "Компания клиента, телефон" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/siteuser_company_directory_phones/
Получить "Телефоны" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/directory_phones/
Получить "Компания клиента, мессенджер" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/siteuser_company_directory_messengers/
Получить "Мессенджеры" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/directory_messengers/
Получить "Компания клиента, социальные сети" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/siteuser_company_directory_socials/
Получить "Социальные сети" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/directory_socials/
Получить "Компания клиента, сайты" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/siteuser_company_directory_websites/
Получить "Сайты" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/directory_websites/
Получить "Дела, клиенты" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/event_siteusers/
Получить "Сделки" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/deals/
Получить "Договоры" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/siteuser_company_contracts/
Получить "Заказы поставщикам" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/shop_warehouse_purchaseorders/
Получить "Счета поставщиков" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/shop_warehouse_invoices/
Получить "Приемки товаров" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/shop_warehouse_supplies/
Получить "Возвраты поставщикам" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/shop_warehouse_purchasereturns/
Договоры
Получить "Договоры"
GET /api/v1.1/siteuser_company_contracts/
Фильтрация "Договоры" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_company_contracts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| company_id |
int |
Наша компания |
|
| siteuser_company_id |
int |
Клиент |
|
| type |
int |
Тип |
|
| comission_method |
int |
Способ расчета |
|
| comission_percent |
decimal |
Процент |
|
| number |
string |
Номер |
|
| date |
string |
Дата |
|
| name |
string |
Наименование |
|
| amount |
decimal |
Сумма |
|
| shop_currency_id |
int |
Валюта |
|
| payment_term |
string |
Срок оплаты |
|
| expiration |
string |
Срок действия |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Договоры"
POST /api/v1.1/siteuser_company_contracts/
Обновить "Договоры" с идентификатором {id}
PUT /api/v1.1/siteuser_company_contracts/{id}/
{"company_id": 1, "siteuser_company_id": 1, ...}
Удалить "Договоры" с переданным {id}
DELETE /api/v1.1/siteuser_company_contracts/{id}/
Связанные элементы
Получить "Заказы поставщикам" у "Договоры" с идентификатором {id}
GET /api/v1.1/siteuser_company_contracts/{id}/shop_warehouse_purchaseorders/
Получить "Счета поставщиков" у "Договоры" с идентификатором {id}
GET /api/v1.1/siteuser_company_contracts/{id}/shop_warehouse_invoices/
Получить "Приемки товаров" у "Договоры" с идентификатором {id}
GET /api/v1.1/siteuser_company_contracts/{id}/shop_warehouse_supplies/
Получить "Возвраты поставщикам" у "Договоры" с идентификатором {id}
GET /api/v1.1/siteuser_company_contracts/{id}/shop_warehouse_purchasereturns/
Компания клиента, адреса
Получить "Компания клиента, адреса"
GET /api/v1.1/siteuser_company_directory_addresses/
Фильтрация "Компания клиента, адреса" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_company_directory_addresses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_company_id |
int |
|
|
| directory_address_id |
int |
|
|
Создать "Компания клиента, адреса"
POST /api/v1.1/siteuser_company_directory_addresses/
Обновить "Компания клиента, адреса" с идентификатором {id}
PUT /api/v1.1/siteuser_company_directory_addresses/{id}/
{"siteuser_company_id": 1, "directory_address_id": 1, ...}
Удалить "Компания клиента, адреса" с переданным {id}
DELETE /api/v1.1/siteuser_company_directory_addresses/{id}/
Компания клиента, электронная почта
Получить "Компания клиента, электронная почта"
GET /api/v1.1/siteuser_company_directory_emails/
Фильтрация "Компания клиента, электронная почта" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_company_directory_emails/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_company_id |
int |
|
|
| directory_email_id |
int |
|
|
Создать "Компания клиента, электронная почта"
POST /api/v1.1/siteuser_company_directory_emails/
Обновить "Компания клиента, электронная почта" с идентификатором {id}
PUT /api/v1.1/siteuser_company_directory_emails/{id}/
{"siteuser_company_id": 1, "directory_email_id": 1, ...}
Удалить "Компания клиента, электронная почта" с переданным {id}
DELETE /api/v1.1/siteuser_company_directory_emails/{id}/
Компания клиента, мессенджер
Получить "Компания клиента, мессенджер"
GET /api/v1.1/siteuser_company_directory_messengers/
Фильтрация "Компания клиента, мессенджер" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_company_directory_messengers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_company_id |
int |
|
|
| directory_messenger_id |
int |
|
|
Создать "Компания клиента, мессенджер"
POST /api/v1.1/siteuser_company_directory_messengers/
Обновить "Компания клиента, мессенджер" с идентификатором {id}
PUT /api/v1.1/siteuser_company_directory_messengers/{id}/
{"siteuser_company_id": 1, "directory_messenger_id": 1, ...}
Удалить "Компания клиента, мессенджер" с переданным {id}
DELETE /api/v1.1/siteuser_company_directory_messengers/{id}/
Компания клиента, телефон
Получить "Компания клиента, телефон"
GET /api/v1.1/siteuser_company_directory_phones/
Фильтрация "Компания клиента, телефон" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_company_directory_phones/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_company_id |
int |
|
|
| directory_phone_id |
int |
|
|
Создать "Компания клиента, телефон"
POST /api/v1.1/siteuser_company_directory_phones/
Обновить "Компания клиента, телефон" с идентификатором {id}
PUT /api/v1.1/siteuser_company_directory_phones/{id}/
{"siteuser_company_id": 1, "directory_phone_id": 1, ...}
Удалить "Компания клиента, телефон" с переданным {id}
DELETE /api/v1.1/siteuser_company_directory_phones/{id}/
Компания клиента, социальные сети
Получить "Компания клиента, социальные сети"
GET /api/v1.1/siteuser_company_directory_socials/
Фильтрация "Компания клиента, социальные сети" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_company_directory_socials/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_company_id |
int |
|
|
| directory_social_id |
int |
|
|
Создать "Компания клиента, социальные сети"
POST /api/v1.1/siteuser_company_directory_socials/
Обновить "Компания клиента, социальные сети" с идентификатором {id}
PUT /api/v1.1/siteuser_company_directory_socials/{id}/
{"siteuser_company_id": 1, "directory_social_id": 1, ...}
Удалить "Компания клиента, социальные сети" с переданным {id}
DELETE /api/v1.1/siteuser_company_directory_socials/{id}/
Компания клиента, сайты
Получить "Компания клиента, сайты"
GET /api/v1.1/siteuser_company_directory_websites/
Фильтрация "Компания клиента, сайты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_company_directory_websites/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_company_id |
int |
|
|
| directory_website_id |
int |
|
|
Создать "Компания клиента, сайты"
POST /api/v1.1/siteuser_company_directory_websites/
Обновить "Компания клиента, сайты" с идентификатором {id}
PUT /api/v1.1/siteuser_company_directory_websites/{id}/
{"siteuser_company_id": 1, "directory_website_id": 1, ...}
Удалить "Компания клиента, сайты" с переданным {id}
DELETE /api/v1.1/siteuser_company_directory_websites/{id}/
Клиенты, заметки
Получить "Клиенты, заметки"
GET /api/v1.1/siteuser_crm_notes/
Фильтрация "Клиенты, заметки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_crm_notes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| crm_note_id |
int |
|
|
| siteuser_id |
int |
|
|
Создать "Клиенты, заметки"
POST /api/v1.1/siteuser_crm_notes/
Обновить "Клиенты, заметки" с идентификатором {id}
PUT /api/v1.1/siteuser_crm_notes/{id}/
{"crm_note_id": 1, "siteuser_id": 1, ...}
Удалить "Клиенты, заметки" с переданным {id}
DELETE /api/v1.1/siteuser_crm_notes/{id}/
Клиенты, вложения писем
Получить "Клиенты, вложения писем"
GET /api/v1.1/siteuser_email_attachments/
Фильтрация "Клиенты, вложения писем" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_email_attachments/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_email_id |
int |
|
|
| name |
string |
|
|
| filename |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Клиенты, вложения писем"
POST /api/v1.1/siteuser_email_attachments/
Обновить "Клиенты, вложения писем" с идентификатором {id}
PUT /api/v1.1/siteuser_email_attachments/{id}/
{"siteuser_email_id": 1, "name": "...", ...}
Удалить "Клиенты, вложения писем" с переданным {id}
DELETE /api/v1.1/siteuser_email_attachments/{id}/
Письма
Получить "Письма"
GET /api/v1.1/siteuser_emails/
Фильтрация "Письма" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_emails/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| siteuser_id |
int |
Идентификатор клиента |
|
| email |
string |
Кому |
|
| from |
string |
От |
|
| cc |
string |
Копия (CC) |
|
| bcc |
string |
Скрытая копия (BCC) |
|
| subject |
string |
Тема |
|
| datetime |
string |
Дата |
|
| important |
int |
Важное |
|
| type |
int |
Тип |
|
| text |
string |
Текст |
|
| read |
string |
Прочитано |
|
| guid |
string |
GUID |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Письма"
POST /api/v1.1/siteuser_emails/
Обновить "Письма" с идентификатором {id}
PUT /api/v1.1/siteuser_emails/{id}/
{"siteuser_id": 1, "email": "...", ...}
Удалить "Письма" с переданным {id}
DELETE /api/v1.1/siteuser_emails/{id}/
Связанные элементы
Получить "Клиенты, вложения писем" у "Письма" с идентификатором {id}
GET /api/v1.1/siteuser_emails/{id}/siteuser_email_attachments/
Клиенты, список групп
Получить "Клиенты, список групп"
GET /api/v1.1/siteuser_group_lists/
Фильтрация "Клиенты, список групп" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_group_lists/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_group_id |
int |
|
|
| siteuser_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Клиенты, список групп"
POST /api/v1.1/siteuser_group_lists/
Обновить "Клиенты, список групп" с идентификатором {id}
PUT /api/v1.1/siteuser_group_lists/{id}/
{"siteuser_group_id": 1, "siteuser_id": 1, ...}
Удалить "Клиенты, список групп" с переданным {id}
DELETE /api/v1.1/siteuser_group_lists/{id}/
Группы клиентов
Получить "Группы клиентов"
GET /api/v1.1/siteuser_groups/
Фильтрация "Группы клиентов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Сайт |
|
| name |
string |
Имя группы |
|
| description |
string |
Описание |
|
| default |
int |
Группа по умолчанию |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Группы клиентов"
POST /api/v1.1/siteuser_groups/
Обновить "Группы клиентов" с идентификатором {id}
PUT /api/v1.1/siteuser_groups/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Группы клиентов" с переданным {id}
DELETE /api/v1.1/siteuser_groups/{id}/
Связанные элементы
Получить "Клиенты, список групп" у "Группы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_groups/{id}/siteuser_group_lists/
Получить "Клиенты" у "Группы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_groups/{id}/siteusers/
Получить "Группы подписчиков рассылки" у "Группы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_groups/{id}/maillist_siteuser_groups/
Получить "Группы посетителей категории" у "Группы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_groups/{id}/forum_category_siteuser_groups/
Получить "Группы персональной скидки" у "Группы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_groups/{id}/shop_discount_siteuser_groups/
Получить "Key 'model_name' in 'ru' language does not exist for model 'shop_purchase_discount_siteuser_group'." у "Группы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_groups/{id}/shop_purchase_discount_siteuser_groups/
Получить "Key 'model_name' in 'ru' language does not exist for model 'shop_gift_siteuser_group'." у "Группы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_groups/{id}/shop_gift_siteuser_groups/
Получить "Платежные системы, группы клиентов" у "Группы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_groups/{id}/shop_payment_system_siteuser_groups/
Получить "Типы доставки, группы клиентов" у "Группы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_groups/{id}/shop_delivery_siteuser_groups/
Клиенты, аутентификации провайдеров
Получить "Клиенты, аутентификации провайдеров"
GET /api/v1.1/siteuser_identities/
Фильтрация "Клиенты, аутентификации провайдеров" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_identities/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_identity_provider_id |
int |
|
|
| siteuser_id |
int |
|
|
| identity |
string |
|
|
Создать "Клиенты, аутентификации провайдеров"
POST /api/v1.1/siteuser_identities/
Обновить "Клиенты, аутентификации провайдеров" с идентификатором {id}
PUT /api/v1.1/siteuser_identities/{id}/
{"siteuser_identity_provider_id": 1, "siteuser_id": 1, ...}
Удалить "Клиенты, аутентификации провайдеров" с переданным {id}
DELETE /api/v1.1/siteuser_identities/{id}/
Провайдеры аутентификации
Получить "Провайдеры аутентификации"
GET /api/v1.1/siteuser_identity_providers/
Фильтрация "Провайдеры аутентификации" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_identity_providers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентфикатор провайдера |
|
| site_id |
int |
Идентфикатор сайта |
|
| name |
string |
Название провайдера |
|
| active |
int |
Активность провайдера |
|
| url |
string |
Ссылка провайдера |
|
| image |
string |
Изображение провайдера |
|
| icon |
string |
Иконка |
|
| sorting |
int |
Порядок сортировки |
|
| type |
int |
Тип |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Провайдеры аутентификации"
POST /api/v1.1/siteuser_identity_providers/
Обновить "Провайдеры аутентификации" с идентификатором {id}
PUT /api/v1.1/siteuser_identity_providers/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Провайдеры аутентификации" с переданным {id}
DELETE /api/v1.1/siteuser_identity_providers/{id}/
Связанные элементы
Получить "Клиенты, аутентификации провайдеров" у "Провайдеры аутентификации" с идентификатором {id}
GET /api/v1.1/siteuser_identity_providers/{id}/siteuser_identities/
Представитель клиента (Физическое лицо)
Получить "Представитель клиента (Физическое лицо)"
GET /api/v1.1/siteuser_people/
Фильтрация "Представитель клиента (Физическое лицо)" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_people/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| siteuser_id |
int |
Идентификатор клиента |
|
| name |
string |
Имя |
|
| surname |
string |
Фамилия |
|
| patronymic |
string |
Отчество |
|
| post |
string |
Должность |
|
| birthday |
string |
День рождения |
|
| sex |
int |
Пол |
|
| image |
string |
Фотография |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Представитель клиента (Физическое лицо)"
POST /api/v1.1/siteuser_people/
Обновить "Представитель клиента (Физическое лицо)" с идентификатором {id}
PUT /api/v1.1/siteuser_people/{id}/
{"siteuser_id": 1, "name": "...", ...}
Удалить "Представитель клиента (Физическое лицо)" с переданным {id}
DELETE /api/v1.1/siteuser_people/{id}/
Связанные элементы
Получить "Представитель клиента, адреса" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/siteuser_person_directory_addresses/
Получить "Адреса" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/directory_addresses/
Получить "Представитель клиента, электронная почта" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/siteuser_person_directory_emails/
Получить "Электронные адреса" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/directory_emails/
Получить "Представитель клиента, телефон" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/siteuser_person_directory_phones/
Получить "Телефоны" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/directory_phones/
Получить "Представитель клиента, мессенджер" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/siteuser_person_directory_messengers/
Получить "Мессенджеры" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/directory_messengers/
Получить "Представитель клиента, социальные сети" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/siteuser_person_directory_socials/
Получить "Социальные сети" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/directory_socials/
Получить "Представитель клиента, сайты" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/siteuser_person_directory_websites/
Получить "Сайты" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/directory_websites/
Получить "Дела, клиенты" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/event_siteusers/
Получить "Сделки" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/deals/
Клиенты, дополнительные свойства
Получить "Клиенты, дополнительные свойства"
GET /api/v1.1/siteuser_properties/
Фильтрация "Клиенты, дополнительные свойства" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_properties/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| site_id |
int |
|
|
| property_id |
int |
|
|
Создать "Клиенты, дополнительные свойства"
POST /api/v1.1/siteuser_properties/
Обновить "Клиенты, дополнительные свойства" с идентификатором {id}
PUT /api/v1.1/siteuser_properties/{id}/
{"site_id": 1, "property_id": 1, ...}
Удалить "Клиенты, дополнительные свойства" с переданным {id}
DELETE /api/v1.1/siteuser_properties/{id}/
Клиенты, группы дополнительных свойств
Получить "Клиенты, группы дополнительных свойств"
GET /api/v1.1/siteuser_property_dirs/
Фильтрация "Клиенты, группы дополнительных свойств" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_property_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| site_id |
int |
|
|
| property_dir_id |
int |
|
|
Создать "Клиенты, группы дополнительных свойств"
POST /api/v1.1/siteuser_property_dirs/
Обновить "Клиенты, группы дополнительных свойств" с идентификатором {id}
PUT /api/v1.1/siteuser_property_dirs/{id}/
{"site_id": 1, "property_dir_id": 1, ...}
Удалить "Клиенты, группы дополнительных свойств" с переданным {id}
DELETE /api/v1.1/siteuser_property_dirs/{id}/
Виды друзей
Получить "Виды друзей"
GET /api/v1.1/siteuser_relationship_types/
Фильтрация "Виды друзей" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_relationship_types/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентфикатор |
|
| site_id |
int |
|
|
| name |
string |
Название |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Виды друзей"
POST /api/v1.1/siteuser_relationship_types/
Обновить "Виды друзей" с идентификатором {id}
PUT /api/v1.1/siteuser_relationship_types/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Виды друзей" с переданным {id}
DELETE /api/v1.1/siteuser_relationship_types/{id}/
Связанные элементы
Получить "Клиенты, друзья" у "Виды друзей" с идентификатором {id}
GET /api/v1.1/siteuser_relationship_types/{id}/siteuser_relationships/
Клиенты, друзья
Получить "Клиенты, друзья"
GET /api/v1.1/siteuser_relationships/
Фильтрация "Клиенты, друзья" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_relationships/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_id |
int |
|
|
| recipient_siteuser_id |
int |
|
|
| siteuser_relationship_type_id |
int |
|
|
| read |
int |
|
|
Создать "Клиенты, друзья"
POST /api/v1.1/siteuser_relationships/
Обновить "Клиенты, друзья" с идентификатором {id}
PUT /api/v1.1/siteuser_relationships/{id}/
{"siteuser_id": 1, "recipient_siteuser_id": 1, ...}
Удалить "Клиенты, друзья" с переданным {id}
DELETE /api/v1.1/siteuser_relationships/{id}/
Сессии
Получить "Сессии"
GET /api/v1.1/siteuser_sessions/
Фильтрация "Сессии" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_sessions/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
string |
|
|
| siteuser_id |
int |
|
|
| ip |
string |
|
|
| user_agent |
string |
|
|
| time |
int |
|
|
Создать "Сессии"
POST /api/v1.1/siteuser_sessions/
Обновить "Сессии" с идентификатором {id}
PUT /api/v1.1/siteuser_sessions/{id}/
{"siteuser_id": 1, "ip": "...", ...}
Удалить "Сессии" с переданным {id}
DELETE /api/v1.1/siteuser_sessions/{id}/
Статусы клиентов
Получить "Статусы клиентов"
GET /api/v1.1/siteuser_statuses/
Фильтрация "Статусы клиентов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_statuses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Назание |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Статусы клиентов"
POST /api/v1.1/siteuser_statuses/
Обновить "Статусы клиентов" с идентификатором {id}
PUT /api/v1.1/siteuser_statuses/{id}/
{"name": "...", "description": "...", ...}
Удалить "Статусы клиентов" с переданным {id}
DELETE /api/v1.1/siteuser_statuses/{id}/
Связанные элементы
Получить "Клиенты" у "Статусы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_statuses/{id}/siteusers/
Типы клиентов
Получить "Типы клиентов"
GET /api/v1.1/siteuser_types/
Фильтрация "Типы клиентов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_types/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Назание |
|
| color |
string |
Цвет |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Типы клиентов"
POST /api/v1.1/siteuser_types/
Обновить "Типы клиентов" с идентификатором {id}
PUT /api/v1.1/siteuser_types/{id}/
{"name": "...", "color": "...", ...}
Удалить "Типы клиентов" с переданным {id}
DELETE /api/v1.1/siteuser_types/{id}/
Связанные элементы
Получить "Клиенты" у "Типы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_types/{id}/siteusers/
Клиенты, сотрудники
Получить "Клиенты, сотрудники"
GET /api/v1.1/siteuser_users/
Фильтрация "Клиенты, сотрудники" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_users/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Клиенты, сотрудники"
POST /api/v1.1/siteuser_users/
Обновить "Клиенты, сотрудники" с идентификатором {id}
PUT /api/v1.1/siteuser_users/{id}/
{"siteuser_id": 1, "user_id": 1, ...}
Удалить "Клиенты, сотрудники" с переданным {id}
DELETE /api/v1.1/siteuser_users/{id}/
Клиенты
Получить "Клиенты"
GET /api/v1.1/siteusers/
Фильтрация "Клиенты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteusers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Сайт |
|
| siteuser_type_id |
int |
Тип клиента |
|
| siteuser_status_id |
int |
Статус клиента |
|
| crm_source_id |
int |
Источник |
|
| login |
string |
Логин |
|
| password |
string |
Пароль |
|
| email |
string |
E-mail |
|
| datetime |
string |
Дата регистрации |
|
| ip |
string |
IP-адрес |
|
| guid |
string |
|
|
| active |
int |
Активность |
|
| user_id |
int |
Идентификатор сотрудника |
|
| last_activity |
string |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Клиенты"
POST /api/v1.1/siteusers/
Обновить "Клиенты" с идентификатором {id}
PUT /api/v1.1/siteusers/{id}/
{"site_id": 1, "siteuser_type_id": 1, ...}
Удалить "Клиенты" с переданным {id}
DELETE /api/v1.1/siteusers/{id}/
Связанные элементы
Получить "Группы клиентов" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_groups/
Получить "Клиенты, список групп" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_group_lists/
Получить "Привлеченные аффилиатом пользователи" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_affiliates/
Получить "Клиенты, аутентификации провайдеров" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_identities/
Получить "Интернет-магазин, корзина" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/shop_carts/
Получить "Дисконтные карты" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/shop_discountcards/
Получить "Списки избранного" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/shop_favorite_lists/
Получить "Избранное" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/shop_favorites/
Получить "Заказы магазина" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/shop_orders/
Получить "Транзакции пользователя" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/shop_siteuser_transactions/
Получить "Почтовые рассылки" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/maillists/
Получить "Подписчики рассылки" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/maillist_siteusers/
Получить "Трекинг выпуска рассылки" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/maillist_fascicle_logs/
Получить "Отписавшиеся" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/maillist_unsubscribers/
Получить "Сообщения форума" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/forum_topic_posts/
Получить "Форум, просмотр тем клиентами" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/forum_topic_views/
Получить "Форум, подписчики" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/forum_topic_subscribers/
Получить "Форум, количество клиентов" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/forum_siteuser_counts/
Получить "Инцидент службы поддержки" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/helpdesk_tickets/
Получить "Клиенты, друзья" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_relationships/
Получить "Клиенты" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteusers/
Получить "Представитель клиента (Физическое лицо)" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_people/
Получить "Компания" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_companies/
Получить "Клиенты, сотрудники" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_users/
Получить "Дела" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/events/
Получить "Дела, клиенты" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/event_siteusers/
Получить "Сотрудники" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/users/
Получить "Лиды" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/leads/
Получить "Письма" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_emails/
Получить "Сессии" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_sessions/
Получить "Клиенты, заметки" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_crm_notes/
Получить "CRM: Заметки" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/crm_notes/
Получить "Комментарии, инфомационные элементы"
GET /api/v1.1/comment_informationsystem_items/
Фильтрация "Комментарии, инфомационные элементы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/comment_informationsystem_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| comment_id |
int |
|
|
| informationsystem_item_id |
int |
|
|
Создать "Комментарии, инфомационные элементы"
POST /api/v1.1/comment_informationsystem_items/
Обновить "Комментарии, инфомационные элементы" с идентификатором {id}
PUT /api/v1.1/comment_informationsystem_items/{id}/
{"comment_id": 1, "informationsystem_item_id": 1, ...}
Удалить "Комментарии, инфомационные элементы" с переданным {id}
DELETE /api/v1.1/comment_informationsystem_items/{id}/
Получить "Комментарии, товары"
GET /api/v1.1/comment_shop_items/
Фильтрация "Комментарии, товары" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/comment_shop_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| comment_id |
int |
|
|
| shop_item_id |
int |
|
|
Создать "Комментарии, товары"
POST /api/v1.1/comment_shop_items/
Обновить "Комментарии, товары" с идентификатором {id}
PUT /api/v1.1/comment_shop_items/{id}/
{"comment_id": 1, "shop_item_id": 1, ...}
Удалить "Комментарии, товары" с переданным {id}
DELETE /api/v1.1/comment_shop_items/{id}/
Получить "Комментарии, заказы"
GET /api/v1.1/comment_shop_orders/
Фильтрация "Комментарии, заказы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/comment_shop_orders/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| comment_id |
int |
|
|
| shop_order_id |
int |
|
|
Создать "Комментарии, заказы"
POST /api/v1.1/comment_shop_orders/
Обновить "Комментарии, заказы" с идентификатором {id}
PUT /api/v1.1/comment_shop_orders/{id}/
{"comment_id": 1, "shop_order_id": 1, ...}
Удалить "Комментарии, заказы" с переданным {id}
DELETE /api/v1.1/comment_shop_orders/{id}/
Получить "Комментарии"
GET /api/v1.1/comments/
Фильтрация "Комментарии" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/comments/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Код родительского комментария |
|
| subject |
string |
Тема |
|
| text |
string |
Текст |
|
| author |
string |
Автор |
|
| email |
string |
E-mail |
|
| phone |
string |
Телефон |
|
| active |
int |
Активен |
|
| ip |
string |
IP-адрес |
|
| datetime |
string |
Дата и время |
|
| grade |
int |
Оценка |
|
| siteuser_id |
int |
Клиент |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Комментарии"
POST /api/v1.1/comments/
Обновить "Комментарии" с идентификатором {id}
PUT /api/v1.1/comments/{id}/
{"parent_id": 1, "subject": "...", ...}
Удалить "Комментарии" с переданным {id}
DELETE /api/v1.1/comments/{id}/
Связанные элементы
Получить "Комментарии" у "Комментарии" с идентификатором {id}
GET /api/v1.1/comments/{id}/comments/
Получить "Голоса" у "Комментарии" с идентификатором {id}
GET /api/v1.1/comments/{id}/votes/
Компании
Компании
Получить "Компании"
GET /api/v1.1/companies/
Фильтрация "Компании" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/companies/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| image |
string |
Изображение |
|
| tin |
string |
ИНН |
|
| kpp |
string |
КПП |
|
| psrn |
string |
ОГРН |
|
| okpo |
string |
ОКПО |
|
| okved |
string |
ОКВЭД |
|
| legal_name |
string |
ФИО директора |
|
| accountant_legal_name |
string |
ФИО главного бухгалтера |
|
| user_id |
int |
Идентификатор сотрудника |
|
| guid |
string |
GUID |
|
| sorting |
int |
Порядок сортировки |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Компании"
POST /api/v1.1/companies/
Обновить "Компании" с идентификатором {id}
PUT /api/v1.1/companies/{id}/
{"name": "...", "description": "...", ...}
Удалить "Компании" с переданным {id}
DELETE /api/v1.1/companies/{id}/
Связанные элементы
Получить "Структура" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/company_departments/
Получить "Компании, сайты" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/company_sites/
Получить "Кассы" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/company_cashboxes/
Получить "Расчетные счета" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/company_accounts/
Получить "Операции" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/chartaccount_operations/
Получить "Закрытие периода" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/chartaccount_closure_periods/
Получить "Журнал проводок" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/chartaccount_entries/
Получить "Интернет-магазины" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/shops/
Получить "Склады" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/shop_warehouses/
Получить "Платежи" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/shop_warrants/
Получить "Заказы поставщикам" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/shop_warehouse_purchaseorders/
Получить "Счета поставщиков" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/shop_warehouse_invoices/
Получить "Приемки товаров" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/shop_warehouse_supplies/
Получить "Возвраты поставщикам" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/shop_warehouse_purchasereturns/
Получить "Сайты" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/sites/
Получить "Договоры" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/siteuser_company_contracts/
Получить "Компании, электронная почта" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/company_directory_emails/
Получить "Электронные адреса" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/directory_emails/
Получить "Компании, телефоны" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/company_directory_phones/
Получить "Телефоны" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/directory_phones/
Получить "Компании, адреса" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/company_directory_addresses/
Получить "Адреса" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/directory_addresses/
Получить "Компании, сайты" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/company_directory_websites/
Получить "Сайты" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/directory_websites/
Получить "Компании, социальные сети" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/company_directory_socials/
Получить "Социальные сети" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/directory_socials/
Получить "Компании, мессенджеры" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/company_directory_messengers/
Получить "Мессенджеры" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/directory_messengers/
Получить "Сотрудники" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/users/
Получить "Компании, должности отдела" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/company_department_post_users/
Получить "Направления деятельности" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/company_activities/
Получить "Места" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/company_locations/
Получить "Архив дел" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/dms_case_archives/
Получить "Уничтожение дел" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/dms_case_destructions/
Получить "Документооборот" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/dms_documents/
Получить "Номенклатура" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/dms_nomenclatures/
Получить "Раздел номенклатуры" у "Компании" с идентификатором {id}
GET /api/v1.1/companies/{id}/dms_nomenclature_dirs/
Расчетные счета
Получить "Расчетные счета"
GET /api/v1.1/company_accounts/
Фильтрация "Расчетные счета" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/company_accounts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| company_id |
int |
Идентификатор компании |
|
| name |
string |
Название |
|
| bic |
string |
БИК |
|
| current_account |
string |
Номер счета |
|
| correspondent_account |
string |
Номер корр. счета |
|
| bank_name |
string |
Название банка |
|
| bank_address |
string |
Адрес банка |
|
| default |
int |
Счет по умолчанию |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Расчетные счета"
POST /api/v1.1/company_accounts/
Обновить "Расчетные счета" с идентификатором {id}
PUT /api/v1.1/company_accounts/{id}/
{"company_id": 1, "name": "...", ...}
Удалить "Расчетные счета" с переданным {id}
DELETE /api/v1.1/company_accounts/{id}/
Направления деятельности
Получить "Направления деятельности"
GET /api/v1.1/company_activities/
Фильтрация "Направления деятельности" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/company_activities/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| company_id |
int |
Идентификатор компании |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Направления деятельности"
POST /api/v1.1/company_activities/
Обновить "Направления деятельности" с идентификатором {id}
PUT /api/v1.1/company_activities/{id}/
{"company_id": 1, "name": "...", ...}
Удалить "Направления деятельности" с переданным {id}
DELETE /api/v1.1/company_activities/{id}/
Связанные элементы
Получить "Документооборот" у "Направления деятельности" с идентификатором {id}
GET /api/v1.1/company_activities/{id}/dms_documents/
Кассы
Получить "Кассы"
GET /api/v1.1/company_cashboxes/
Фильтрация "Кассы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/company_cashboxes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| company_id |
int |
Идентификатор компании |
|
| name |
string |
Название |
|
| default |
int |
Касса по умолчанию |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Кассы"
POST /api/v1.1/company_cashboxes/
Обновить "Кассы" с идентификатором {id}
PUT /api/v1.1/company_cashboxes/{id}/
{"company_id": 1, "name": "...", ...}
Удалить "Кассы" с переданным {id}
DELETE /api/v1.1/company_cashboxes/{id}/
Доступы для группы
Получить "Доступы для группы"
GET /api/v1.1/company_department_action_accesses/
Фильтрация "Доступы для группы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/company_department_action_accesses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| company_department_id |
int |
|
|
| admin_form_action_id |
int |
|
|
| site_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Доступы для группы"
POST /api/v1.1/company_department_action_accesses/
Обновить "Доступы для группы" с идентификатором {id}
PUT /api/v1.1/company_department_action_accesses/{id}/
{"company_department_id": 1, "admin_form_action_id": 1, ...}
Удалить "Доступы для группы" с переданным {id}
DELETE /api/v1.1/company_department_action_accesses/{id}/
Компании, электронная почта отдела
Получить "Компании, электронная почта отдела"
GET /api/v1.1/company_department_directory_emails/
Фильтрация "Компании, электронная почта отдела" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/company_department_directory_emails/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| company_department_id |
int |
|
|
| directory_email_id |
int |
|
|
Создать "Компании, электронная почта отдела"
POST /api/v1.1/company_department_directory_emails/
Обновить "Компании, электронная почта отдела" с идентификатором {id}
PUT /api/v1.1/company_department_directory_emails/{id}/
{"company_department_id": 1, "directory_email_id": 1, ...}
Удалить "Компании, электронная почта отдела" с переданным {id}
DELETE /api/v1.1/company_department_directory_emails/{id}/
Компании, телефоны отдела
Получить "Компании, телефоны отдела"
GET /api/v1.1/company_department_directory_phones/
Фильтрация "Компании, телефоны отдела" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/company_department_directory_phones/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| company_department_id |
int |
|
|
| directory_phone_id |
int |
|
|
Создать "Компании, телефоны отдела"
POST /api/v1.1/company_department_directory_phones/
Обновить "Компании, телефоны отдела" с идентификатором {id}
PUT /api/v1.1/company_department_directory_phones/{id}/
{"company_department_id": 1, "directory_phone_id": 1, ...}
Удалить "Компании, телефоны отдела" с переданным {id}
DELETE /api/v1.1/company_department_directory_phones/{id}/
Доступ к модулям сайта
Получить "Доступ к модулям сайта"
GET /api/v1.1/company_department_modules/
Фильтрация "Доступ к модулям сайта" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/company_department_modules/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| company_department_id |
int |
|
|
| module_id |
int |
|
|
| site_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Доступ к модулям сайта"
POST /api/v1.1/company_department_modules/
Обновить "Доступ к модулям сайта" с идентификатором {id}
PUT /api/v1.1/company_department_modules/{id}/
{"company_department_id": 1, "module_id": 1, ...}
Удалить "Доступ к модулям сайта" с переданным {id}
DELETE /api/v1.1/company_department_modules/{id}/
Компании, должности отдела
Получить "Компании, должности отдела"
GET /api/v1.1/company_department_post_users/
Фильтрация "Компании, должности отдела" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/company_department_post_users/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| company_id |
int |
|
|
| company_department_id |
int |
|
|
| company_post_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| head |
int |
|
|
Создать "Компании, должности отдела"
POST /api/v1.1/company_department_post_users/
Обновить "Компании, должности отдела" с идентификатором {id}
PUT /api/v1.1/company_department_post_users/{id}/
{"company_id": 1, "company_department_id": 1, ...}
Удалить "Компании, должности отдела" с переданным {id}
DELETE /api/v1.1/company_department_post_users/{id}/
Структура
Получить "Структура"
GET /api/v1.1/company_departments/
Фильтрация "Структура" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/company_departments/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| parent_id |
int |
Вышестоящий отдел |
|
| company_id |
int |
|
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| address |
string |
Адрес |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Структура"
POST /api/v1.1/company_departments/
Обновить "Структура" с идентификатором {id}
PUT /api/v1.1/company_departments/{id}/
{"parent_id": 1, "company_id": 1, ...}
Удалить "Структура" с переданным {id}
DELETE /api/v1.1/company_departments/{id}/
Связанные элементы
Получить "Сотрудники" у "Структура" с идентификатором {id}
GET /api/v1.1/company_departments/{id}/users/
Получить "Доступ к модулям сайта" у "Структура" с идентификатором {id}
GET /api/v1.1/company_departments/{id}/company_department_modules/
Получить "Доступы для группы" у "Структура" с идентификатором {id}
GET /api/v1.1/company_departments/{id}/company_department_action_accesses/
Получить "Компании, должности отдела" у "Структура" с идентификатором {id}
GET /api/v1.1/company_departments/{id}/company_department_post_users/
Получить "Компании, электронная почта отдела" у "Структура" с идентификатором {id}
GET /api/v1.1/company_departments/{id}/company_department_directory_emails/
Получить "Электронные адреса" у "Структура" с идентификатором {id}
GET /api/v1.1/company_departments/{id}/directory_emails/
Получить "Компании, телефоны отдела" у "Структура" с идентификатором {id}
GET /api/v1.1/company_departments/{id}/company_department_directory_phones/
Получить "Телефоны" у "Структура" с идентификатором {id}
GET /api/v1.1/company_departments/{id}/directory_phones/
Получить "Структура" у "Структура" с идентификатором {id}
GET /api/v1.1/company_departments/{id}/company_departments/
Получить "Сделки, доступ отдела к шаблону" у "Структура" с идентификатором {id}
GET /api/v1.1/company_departments/{id}/deal_template_step_access_departments/
Получить "Раздел номенклатуры" у "Структура" с идентификатором {id}
GET /api/v1.1/company_departments/{id}/dms_nomenclature_dirs/
Получить "Документооборот, права доступа отдела к типам документов" у "Структура" с идентификатором {id}
GET /api/v1.1/company_departments/{id}/dms_document_type_department_accesses/
Компании, адреса
Получить "Компании, адреса"
GET /api/v1.1/company_directory_addresses/
Фильтрация "Компании, адреса" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/company_directory_addresses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| company_id |
int |
|
|
| directory_address_id |
int |
|
|
Создать "Компании, адреса"
POST /api/v1.1/company_directory_addresses/
Обновить "Компании, адреса" с идентификатором {id}
PUT /api/v1.1/company_directory_addresses/{id}/
{"company_id": 1, "directory_address_id": 1, ...}
Удалить "Компании, адреса" с переданным {id}
DELETE /api/v1.1/company_directory_addresses/{id}/
Компании, электронная почта
Получить "Компании, электронная почта"
GET /api/v1.1/company_directory_emails/
Фильтрация "Компании, электронная почта" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/company_directory_emails/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| company_id |
int |
|
|
| directory_email_id |
int |
|
|
Создать "Компании, электронная почта"
POST /api/v1.1/company_directory_emails/
Обновить "Компании, электронная почта" с идентификатором {id}
PUT /api/v1.1/company_directory_emails/{id}/
{"company_id": 1, "directory_email_id": 1, ...}
Удалить "Компании, электронная почта" с переданным {id}
DELETE /api/v1.1/company_directory_emails/{id}/
Компании, мессенджеры
Получить "Компании, мессенджеры"
GET /api/v1.1/company_directory_messengers/
Фильтрация "Компании, мессенджеры" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/company_directory_messengers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| company_id |
int |
|
|
| directory_messenger_id |
int |
|
|
Создать "Компании, мессенджеры"
POST /api/v1.1/company_directory_messengers/
Обновить "Компании, мессенджеры" с идентификатором {id}
PUT /api/v1.1/company_directory_messengers/{id}/
{"company_id": 1, "directory_messenger_id": 1, ...}
Удалить "Компании, мессенджеры" с переданным {id}
DELETE /api/v1.1/company_directory_messengers/{id}/
Компании, телефоны
Получить "Компании, телефоны"
GET /api/v1.1/company_directory_phones/
Фильтрация "Компании, телефоны" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/company_directory_phones/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| company_id |
int |
|
|
| directory_phone_id |
int |
|
|
Создать "Компании, телефоны"
POST /api/v1.1/company_directory_phones/
Обновить "Компании, телефоны" с идентификатором {id}
PUT /api/v1.1/company_directory_phones/{id}/
{"company_id": 1, "directory_phone_id": 1, ...}
Удалить "Компании, телефоны" с переданным {id}
DELETE /api/v1.1/company_directory_phones/{id}/
Компании, социальные сети
Получить "Компании, социальные сети"
GET /api/v1.1/company_directory_socials/
Фильтрация "Компании, социальные сети" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/company_directory_socials/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| company_id |
int |
|
|
| directory_social_id |
int |
|
|
Создать "Компании, социальные сети"
POST /api/v1.1/company_directory_socials/
Обновить "Компании, социальные сети" с идентификатором {id}
PUT /api/v1.1/company_directory_socials/{id}/
{"company_id": 1, "directory_social_id": 1, ...}
Удалить "Компании, социальные сети" с переданным {id}
DELETE /api/v1.1/company_directory_socials/{id}/
Компании, сайты
Получить "Компании, сайты"
GET /api/v1.1/company_directory_websites/
Фильтрация "Компании, сайты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/company_directory_websites/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| company_id |
int |
|
|
| directory_website_id |
int |
|
|
Создать "Компании, сайты"
POST /api/v1.1/company_directory_websites/
Обновить "Компании, сайты" с идентификатором {id}
PUT /api/v1.1/company_directory_websites/{id}/
{"company_id": 1, "directory_website_id": 1, ...}
Удалить "Компании, сайты" с переданным {id}
DELETE /api/v1.1/company_directory_websites/{id}/
Места
Получить "Места"
GET /api/v1.1/company_locations/
Фильтрация "Места" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/company_locations/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| company_id |
int |
Компания |
|
| company_department_id |
int |
Отдел |
|
| parent_id |
int |
Родительское место |
|
| name |
string |
Название |
|
| responsible_user_id |
int |
Ответственный |
|
| description |
string |
Описание |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Места"
POST /api/v1.1/company_locations/
Обновить "Места" с идентификатором {id}
PUT /api/v1.1/company_locations/{id}/
{"company_id": 1, "company_department_id": 1, ...}
Удалить "Места" с переданным {id}
DELETE /api/v1.1/company_locations/{id}/
Связанные элементы
Получить "Места" у "Места" с идентификатором {id}
GET /api/v1.1/company_locations/{id}/company_locations/
Получить "Дела в документообороте" у "Места" с идентификатором {id}
GET /api/v1.1/company_locations/{id}/dms_cases/
Должности
Получить "Должности"
GET /api/v1.1/company_posts/
Фильтрация "Должности" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/company_posts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название должности |
|
| description |
string |
Описание должности |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Должности"
POST /api/v1.1/company_posts/
Обновить "Должности" с идентификатором {id}
PUT /api/v1.1/company_posts/{id}/
{"name": "...", "description": "...", ...}
Удалить "Должности" с переданным {id}
DELETE /api/v1.1/company_posts/{id}/
Связанные элементы
Получить "Компании, должности отдела" у "Должности" с идентификатором {id}
GET /api/v1.1/company_posts/{id}/company_department_post_users/
Компании, сайты
Получить "Компании, сайты"
GET /api/v1.1/company_sites/
Фильтрация "Компании, сайты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/company_sites/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| site_id |
int |
|
|
| company_id |
int |
|
|
Создать "Компании, сайты"
POST /api/v1.1/company_sites/
Обновить "Компании, сайты" с идентификатором {id}
PUT /api/v1.1/company_sites/{id}/
{"site_id": 1, "company_id": 1, ...}
Удалить "Компании, сайты" с переданным {id}
DELETE /api/v1.1/company_sites/{id}/
Константы
Группа констант
Получить "Группа констант"
GET /api/v1.1/constant_dirs/
Фильтрация "Группа констант" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/constant_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Родительский раздел |
|
| name |
string |
Название |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Группа констант"
POST /api/v1.1/constant_dirs/
Обновить "Группа констант" с идентификатором {id}
PUT /api/v1.1/constant_dirs/{id}/
{"parent_id": 1, "name": "...", ...}
Удалить "Группа констант" с переданным {id}
DELETE /api/v1.1/constant_dirs/{id}/
Связанные элементы
Получить "Константы" у "Группа констант" с идентификатором {id}
GET /api/v1.1/constant_dirs/{id}/constants/
Получить "Группа констант" у "Группа констант" с идентификатором {id}
GET /api/v1.1/constant_dirs/{id}/constant_dirs/
Константы
Получить "Константы"
GET /api/v1.1/constants/
Фильтрация "Константы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/constants/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| constant_dir_id |
int |
|
|
| name |
string |
Название константы |
|
| value |
string |
Значение константы |
|
| description |
string |
Описание константы |
|
| active |
int |
Активность |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Константы"
POST /api/v1.1/constants/
Обновить "Константы" с идентификатором {id}
PUT /api/v1.1/constants/{id}/
{"constant_dir_id": 1, "name": "...", ...}
Удалить "Константы" с переданным {id}
DELETE /api/v1.1/constants/{id}/
Короткие ссылки
Группы коротких ссылок
Получить "Группы коротких ссылок"
GET /api/v1.1/shortlink_dirs/
Фильтрация "Группы коротких ссылок" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shortlink_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| parent_id |
int |
Родительская группа |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Группы коротких ссылок"
POST /api/v1.1/shortlink_dirs/
Обновить "Группы коротких ссылок" с идентификатором {id}
PUT /api/v1.1/shortlink_dirs/{id}/
{"site_id": 1, "parent_id": 1, ...}
Удалить "Группы коротких ссылок" с переданным {id}
DELETE /api/v1.1/shortlink_dirs/{id}/
Связанные элементы
Получить "Группы коротких ссылок" у "Группы коротких ссылок" с идентификатором {id}
GET /api/v1.1/shortlink_dirs/{id}/shortlink_dirs/
Получить "Короткие ссылки" у "Группы коротких ссылок" с идентификатором {id}
GET /api/v1.1/shortlink_dirs/{id}/shortlinks/
Короткие ссылки Статистика
Получить "Короткие ссылки Статистика"
GET /api/v1.1/shortlink_stats/
Фильтрация "Короткие ссылки Статистика" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shortlink_stats/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| shortlink_id |
int |
|
|
| datetime |
string |
|
|
| ip |
string |
|
|
| referrer |
string |
|
|
| useragent |
string |
|
|
Создать "Короткие ссылки Статистика"
POST /api/v1.1/shortlink_stats/
Обновить "Короткие ссылки Статистика" с идентификатором {id}
PUT /api/v1.1/shortlink_stats/{id}/
{"shortlink_id": 1, "datetime": "...", ...}
Удалить "Короткие ссылки Статистика" с переданным {id}
DELETE /api/v1.1/shortlink_stats/{id}/
Короткие ссылки
Получить "Короткие ссылки"
GET /api/v1.1/shortlinks/
Фильтрация "Короткие ссылки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shortlinks/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| shortlink_dir_id |
int |
Группа ссылок |
|
| source |
string |
Ссылка |
|
| shortlink |
string |
Короткая ссылка |
|
| description |
string |
Описание |
|
| type |
int |
Тип |
|
| hits |
int |
Переходов |
|
| datetime |
string |
Дата создания |
|
| active |
int |
Активность |
|
| log |
int |
Логировать |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Короткие ссылки"
POST /api/v1.1/shortlinks/
Обновить "Короткие ссылки" с идентификатором {id}
PUT /api/v1.1/shortlinks/{id}/
{"site_id": 1, "shortlink_dir_id": 1, ...}
Удалить "Короткие ссылки" с переданным {id}
DELETE /api/v1.1/shortlinks/{id}/
Связанные элементы
Получить "Короткие ссылки Статистика" у "Короткие ссылки" с идентификатором {id}
GET /api/v1.1/shortlinks/{id}/shortlink_stats/
Лента
Key 'model_name' in 'ru' language does not exist for model 'timeline_user'.
Получить "Key 'model_name' in 'ru' language does not exist for model 'timeline_user'."
GET /api/v1.1/timeline_users/
Фильтрация "Key 'model_name' in 'ru' language does not exist for model 'timeline_user'." — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/timeline_users/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| timeline_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Key 'model_name' in 'ru' language does not exist for model 'timeline_user'."
POST /api/v1.1/timeline_users/
Обновить "Key 'model_name' in 'ru' language does not exist for model 'timeline_user'." с идентификатором {id}
PUT /api/v1.1/timeline_users/{id}/
{"timeline_id": 1, "user_id": 1, ...}
Удалить "Key 'model_name' in 'ru' language does not exist for model 'timeline_user'." с переданным {id}
DELETE /api/v1.1/timeline_users/{id}/
Лента
Получить "Лента"
GET /api/v1.1/timelines/
Фильтрация "Лента" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/timelines/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| crm_note_id |
int |
|
|
| datetime |
string |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Лента"
POST /api/v1.1/timelines/
Обновить "Лента" с идентификатором {id}
PUT /api/v1.1/timelines/{id}/
{"crm_note_id": 1, "datetime": "...", ...}
Удалить "Лента" с переданным {id}
DELETE /api/v1.1/timelines/{id}/
Связанные элементы
Получить "Key 'model_name' in 'ru' language does not exist for model 'timeline_user'." у "Лента" с идентификатором {id}
GET /api/v1.1/timelines/{id}/timeline_users/
Лиды
Лиды, заметки
Получить "Лиды, заметки"
GET /api/v1.1/lead_crm_notes/
Фильтрация "Лиды, заметки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/lead_crm_notes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| crm_note_id |
int |
|
|
| lead_id |
int |
|
|
Создать "Лиды, заметки"
POST /api/v1.1/lead_crm_notes/
Обновить "Лиды, заметки" с идентификатором {id}
PUT /api/v1.1/lead_crm_notes/{id}/
{"crm_note_id": 1, "lead_id": 1, ...}
Удалить "Лиды, заметки" с переданным {id}
DELETE /api/v1.1/lead_crm_notes/{id}/
Лиды, адреса
Получить "Лиды, адреса"
GET /api/v1.1/lead_directory_addresses/
Фильтрация "Лиды, адреса" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/lead_directory_addresses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| lead_id |
int |
|
|
| directory_address_id |
int |
|
|
Создать "Лиды, адреса"
POST /api/v1.1/lead_directory_addresses/
Обновить "Лиды, адреса" с идентификатором {id}
PUT /api/v1.1/lead_directory_addresses/{id}/
{"lead_id": 1, "directory_address_id": 1, ...}
Удалить "Лиды, адреса" с переданным {id}
DELETE /api/v1.1/lead_directory_addresses/{id}/
Лиды, электронные адреса
Получить "Лиды, электронные адреса"
GET /api/v1.1/lead_directory_emails/
Фильтрация "Лиды, электронные адреса" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/lead_directory_emails/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| lead_id |
int |
|
|
| directory_email_id |
int |
|
|
Создать "Лиды, электронные адреса"
POST /api/v1.1/lead_directory_emails/
Обновить "Лиды, электронные адреса" с идентификатором {id}
PUT /api/v1.1/lead_directory_emails/{id}/
{"lead_id": 1, "directory_email_id": 1, ...}
Удалить "Лиды, электронные адреса" с переданным {id}
DELETE /api/v1.1/lead_directory_emails/{id}/
Лиды, телефоны
Получить "Лиды, телефоны"
GET /api/v1.1/lead_directory_phones/
Фильтрация "Лиды, телефоны" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/lead_directory_phones/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| lead_id |
int |
|
|
| directory_phone_id |
int |
|
|
Создать "Лиды, телефоны"
POST /api/v1.1/lead_directory_phones/
Обновить "Лиды, телефоны" с идентификатором {id}
PUT /api/v1.1/lead_directory_phones/{id}/
{"lead_id": 1, "directory_phone_id": 1, ...}
Удалить "Лиды, телефоны" с переданным {id}
DELETE /api/v1.1/lead_directory_phones/{id}/
Лиды, сайты
Получить "Лиды, сайты"
GET /api/v1.1/lead_directory_websites/
Фильтрация "Лиды, сайты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/lead_directory_websites/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| lead_id |
int |
|
|
| directory_website_id |
int |
|
|
Создать "Лиды, сайты"
POST /api/v1.1/lead_directory_websites/
Обновить "Лиды, сайты" с идентификатором {id}
PUT /api/v1.1/lead_directory_websites/{id}/
{"lead_id": 1, "directory_website_id": 1, ...}
Удалить "Лиды, сайты" с переданным {id}
DELETE /api/v1.1/lead_directory_websites/{id}/
Лиды, документы
Получить "Лиды, документы"
GET /api/v1.1/lead_dms_documents/
Фильтрация "Лиды, документы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/lead_dms_documents/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| lead_id |
int |
|
|
| dms_document_id |
int |
|
|
Создать "Лиды, документы"
POST /api/v1.1/lead_dms_documents/
Обновить "Лиды, документы" с идентификатором {id}
PUT /api/v1.1/lead_dms_documents/{id}/
{"lead_id": 1, "dms_document_id": 1, ...}
Удалить "Лиды, документы" с переданным {id}
DELETE /api/v1.1/lead_dms_documents/{id}/
Дела в лидах
Получить "Дела в лидах"
GET /api/v1.1/lead_events/
Фильтрация "Дела в лидах" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/lead_events/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| lead_id |
int |
|
|
| event_id |
int |
|
|
Создать "Дела в лидах"
POST /api/v1.1/lead_events/
Обновить "Дела в лидах" с идентификатором {id}
PUT /api/v1.1/lead_events/{id}/
{"lead_id": 1, "event_id": 1, ...}
Удалить "Дела в лидах" с переданным {id}
DELETE /api/v1.1/lead_events/{id}/
Лиды, история
Получить "Лиды, история"
GET /api/v1.1/lead_histories/
Фильтрация "Лиды, история" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/lead_histories/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| lead_id |
int |
|
|
| datetime |
string |
|
|
| text |
string |
|
|
| ip |
string |
|
|
| color |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Лиды, история"
POST /api/v1.1/lead_histories/
Обновить "Лиды, история" с идентификатором {id}
PUT /api/v1.1/lead_histories/{id}/
{"lead_id": 1, "datetime": "...", ...}
Удалить "Лиды, история" с переданным {id}
DELETE /api/v1.1/lead_histories/{id}/
Зрелость лидов
Получить "Зрелость лидов"
GET /api/v1.1/lead_maturities/
Фильтрация "Зрелость лидов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/lead_maturities/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Зрелость лидов"
POST /api/v1.1/lead_maturities/
Обновить "Зрелость лидов" с идентификатором {id}
PUT /api/v1.1/lead_maturities/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Зрелость лидов" с переданным {id}
DELETE /api/v1.1/lead_maturities/{id}/
Связанные элементы
Получить "Лиды" у "Зрелость лидов" с идентификатором {id}
GET /api/v1.1/lead_maturities/{id}/leads/
Потребности лидов
Получить "Потребности лидов"
GET /api/v1.1/lead_needs/
Фильтрация "Потребности лидов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/lead_needs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Потребности лидов"
POST /api/v1.1/lead_needs/
Обновить "Потребности лидов" с идентификатором {id}
PUT /api/v1.1/lead_needs/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Потребности лидов" с переданным {id}
DELETE /api/v1.1/lead_needs/{id}/
Связанные элементы
Получить "Лиды" у "Потребности лидов" с идентификатором {id}
GET /api/v1.1/lead_needs/{id}/leads/
Товары лида
Получить "Товары лида"
GET /api/v1.1/lead_shop_items/
Фильтрация "Товары лида" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/lead_shop_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| lead_id |
int |
Идентификатор лида |
|
| shop_item_id |
int |
Идентификатор товара |
|
| shop_currency_id |
int |
|
|
| name |
string |
Название товара |
|
| quantity |
decimal |
Количество |
|
| price |
decimal |
Цена |
|
| marking |
string |
Артикул |
|
| rate |
decimal |
Налог |
|
| user_id |
int |
Идентификатор сотрудника |
|
| type |
int |
Тип товара |
|
| shop_warehouse_id |
int |
Склад, с которого был списан товар |
|
| datetime |
string |
Дата |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Товары лида"
POST /api/v1.1/lead_shop_items/
Обновить "Товары лида" с идентификатором {id}
PUT /api/v1.1/lead_shop_items/{id}/
{"lead_id": 1, "shop_item_id": 1, ...}
Удалить "Товары лида" с переданным {id}
DELETE /api/v1.1/lead_shop_items/{id}/
Статусы лидов
Получить "Статусы лидов"
GET /api/v1.1/lead_statuses/
Фильтрация "Статусы лидов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/lead_statuses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок сортировки |
|
| type |
int |
Тип |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Статусы лидов"
POST /api/v1.1/lead_statuses/
Обновить "Статусы лидов" с идентификатором {id}
PUT /api/v1.1/lead_statuses/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Статусы лидов" с переданным {id}
DELETE /api/v1.1/lead_statuses/{id}/
Связанные элементы
Получить "Лиды" у "Статусы лидов" с идентификатором {id}
GET /api/v1.1/lead_statuses/{id}/leads/
Получить "Лиды, этапы" у "Статусы лидов" с идентификатором {id}
GET /api/v1.1/lead_statuses/{id}/lead_steps/
Лиды, этапы
Получить "Лиды, этапы"
GET /api/v1.1/lead_steps/
Фильтрация "Лиды, этапы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/lead_steps/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| lead_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| lead_status_id |
int |
|
|
| datetime |
string |
|
|
Создать "Лиды, этапы"
POST /api/v1.1/lead_steps/
Обновить "Лиды, этапы" с идентификатором {id}
PUT /api/v1.1/lead_steps/{id}/
{"lead_id": 1, "user_id": 1, ...}
Удалить "Лиды, этапы" с переданным {id}
DELETE /api/v1.1/lead_steps/{id}/
Лиды
Получить "Лиды"
GET /api/v1.1/leads/
Фильтрация "Лиды" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/leads/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| lead_status_id |
int |
Статус |
|
| lead_need_id |
int |
Потребность |
|
| lead_maturity_id |
int |
Зрелость |
|
| crm_source_id |
int |
Источник |
|
| siteuser_id |
int |
Клиент |
|
| shop_id |
int |
Магазин |
|
| shop_order_id |
int |
Заказ |
|
| shop_currency_id |
int |
|
|
| deal_id |
int |
Сделка |
|
| datetime |
string |
Создан |
|
| amount |
decimal |
Бюджет |
|
| name |
string |
Имя |
|
| surname |
string |
Фамилия |
|
| patronymic |
string |
Отчество |
|
| birthday |
string |
День рождения |
|
| last_contacted |
string |
Последний контакт |
|
| post |
string |
Должность |
|
| company |
string |
Компания |
|
| comment |
string |
Комментарий |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Лиды"
POST /api/v1.1/leads/
Обновить "Лиды" с идентификатором {id}
PUT /api/v1.1/leads/{id}/
{"site_id": 1, "lead_status_id": 1, ...}
Удалить "Лиды" с переданным {id}
DELETE /api/v1.1/leads/{id}/
Связанные элементы
Получить "Лиды, электронные адреса" у "Лиды" с идентификатором {id}
GET /api/v1.1/leads/{id}/lead_directory_emails/
Получить "Электронные адреса" у "Лиды" с идентификатором {id}
GET /api/v1.1/leads/{id}/directory_emails/
Получить "Лиды, телефоны" у "Лиды" с идентификатором {id}
GET /api/v1.1/leads/{id}/lead_directory_phones/
Получить "Телефоны" у "Лиды" с идентификатором {id}
GET /api/v1.1/leads/{id}/directory_phones/
Получить "Лиды, сайты" у "Лиды" с идентификатором {id}
GET /api/v1.1/leads/{id}/lead_directory_websites/
Получить "Сайты" у "Лиды" с идентификатором {id}
GET /api/v1.1/leads/{id}/directory_websites/
Получить "Лиды, адреса" у "Лиды" с идентификатором {id}
GET /api/v1.1/leads/{id}/lead_directory_addresses/
Получить "Адреса" у "Лиды" с идентификатором {id}
GET /api/v1.1/leads/{id}/directory_addresses/
Получить "Товары лида" у "Лиды" с идентификатором {id}
GET /api/v1.1/leads/{id}/lead_shop_items/
Получить "Лиды, этапы" у "Лиды" с идентификатором {id}
GET /api/v1.1/leads/{id}/lead_steps/
Получить "Дела в лидах" у "Лиды" с идентификатором {id}
GET /api/v1.1/leads/{id}/lead_events/
Получить "Дела" у "Лиды" с идентификатором {id}
GET /api/v1.1/leads/{id}/events/
Получить "Лиды, история" у "Лиды" с идентификатором {id}
GET /api/v1.1/leads/{id}/lead_histories/
Получить "Лиды, заметки" у "Лиды" с идентификатором {id}
GET /api/v1.1/leads/{id}/lead_crm_notes/
Получить "CRM: Заметки" у "Лиды" с идентификатором {id}
GET /api/v1.1/leads/{id}/crm_notes/
Получить "Документооборот" у "Лиды" с идентификатором {id}
GET /api/v1.1/leads/{id}/dms_documents/
Получить "Лиды, документы" у "Лиды" с идентификатором {id}
GET /api/v1.1/leads/{id}/lead_dms_documents/
Получить "Метки" у "Лиды" с идентификатором {id}
GET /api/v1.1/leads/{id}/tags/
Получить "Key 'model_name' in 'ru' language does not exist for model 'tag_lead'." у "Лиды" с идентификатором {id}
GET /api/v1.1/leads/{id}/tag_leads/
Личные сообщения
Ветки сообщений
Получить "Ветки сообщений"
GET /api/v1.1/message_topics/
Фильтрация "Ветки сообщений" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/message_topics/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| subject |
string |
Тема |
|
| datetime |
string |
Дата |
|
| sender_siteuser_id |
int |
От кого |
|
| recipient_siteuser_id |
int |
Кому |
|
| count_sender_unread |
int |
Не прочитано отправителем |
|
| count_recipient_unread |
int |
Не прочитано получателем |
|
| deleted_by_sender |
int |
Удалено отправителем |
|
| deleted_by_recipient |
int |
Удалено получателем |
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Ветки сообщений"
POST /api/v1.1/message_topics/
Обновить "Ветки сообщений" с идентификатором {id}
PUT /api/v1.1/message_topics/{id}/
{"subject": "...", "datetime": "...", ...}
Удалить "Ветки сообщений" с переданным {id}
DELETE /api/v1.1/message_topics/{id}/
Связанные элементы
Получить "Сообщения" у "Ветки сообщений" с идентификатором {id}
GET /api/v1.1/message_topics/{id}/messages/
Сообщения
Получить "Сообщения"
GET /api/v1.1/messages/
Фильтрация "Сообщения" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/messages/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| message_topic_id |
int |
Идентификатор ветки сообщений |
|
| datetime |
string |
Дата |
|
| text |
string |
Текст |
|
| read |
int |
Прочитано |
|
| siteuser_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Сообщения"
POST /api/v1.1/messages/
Обновить "Сообщения" с идентификатором {id}
PUT /api/v1.1/messages/{id}/
{"message_topic_id": 1, "datetime": "...", ...}
Удалить "Сообщения" с переданным {id}
DELETE /api/v1.1/messages/{id}/
Макеты
Раздел макетов
Получить "Раздел макетов"
GET /api/v1.1/template_dirs/
Фильтрация "Раздел макетов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/template_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Родительский раздел макетов |
|
| name |
string |
Название раздела макетов |
|
| sorting |
int |
Сортировка |
|
| user_id |
int |
Идентификатор сотрудника |
|
| site_id |
int |
Идентификатор сайта |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Раздел макетов"
POST /api/v1.1/template_dirs/
Обновить "Раздел макетов" с идентификатором {id}
PUT /api/v1.1/template_dirs/{id}/
{"parent_id": 1, "name": "...", ...}
Удалить "Раздел макетов" с переданным {id}
DELETE /api/v1.1/template_dirs/{id}/
Связанные элементы
Получить "Макеты сайта" у "Раздел макетов" с идентификатором {id}
GET /api/v1.1/template_dirs/{id}/templates/
Получить "Раздел макетов" у "Раздел макетов" с идентификатором {id}
GET /api/v1.1/template_dirs/{id}/template_dirs/
Виджеты секции макета сайта
Получить "Виджеты секции макета сайта"
GET /api/v1.1/template_section_libs/
Фильтрация "Виджеты секции макета сайта" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/template_section_libs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| template_section_id |
int |
Идентификатор секции макета |
|
| lib_id |
int |
Страница |
|
| description |
string |
Описание виджета |
|
| options |
string |
Опции |
|
| field_classes |
string |
|
|
| field_styles |
string |
|
|
| class |
string |
Атрибут "class" |
|
| style |
string |
Атрибут "style" |
|
| user_css |
string |
Пользовательский CSS |
|
| active |
int |
Активность |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Виджеты секции макета сайта"
POST /api/v1.1/template_section_libs/
Обновить "Виджеты секции макета сайта" с идентификатором {id}
PUT /api/v1.1/template_section_libs/{id}/
{"template_section_id": 1, "lib_id": 1, ...}
Удалить "Виджеты секции макета сайта" с переданным {id}
DELETE /api/v1.1/template_section_libs/{id}/
Секции макета сайта
Получить "Секции макета сайта"
GET /api/v1.1/template_sections/
Фильтрация "Секции макета сайта" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/template_sections/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| template_id |
int |
Идентификатор макета |
|
| name |
string |
Название |
|
| alias |
string |
Псевдоним |
|
| color |
string |
Цвет границы секции |
|
| prefix |
string |
Код перед секцией |
|
| suffix |
string |
Код после секции |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Секции макета сайта"
POST /api/v1.1/template_sections/
Обновить "Секции макета сайта" с идентификатором {id}
PUT /api/v1.1/template_sections/{id}/
{"template_id": 1, "name": "...", ...}
Удалить "Секции макета сайта" с переданным {id}
DELETE /api/v1.1/template_sections/{id}/
Связанные элементы
Получить "Виджеты секции макета сайта" у "Секции макета сайта" с идентификатором {id}
GET /api/v1.1/template_sections/{id}/template_section_libs/
Макеты сайта
Получить "Макеты сайта"
GET /api/v1.1/templates/
Фильтрация "Макеты сайта" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/templates/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| template_id |
int |
Родительский макет |
|
| template_dir_id |
int |
Раздел макетов |
|
| name |
string |
Название макета |
|
| sorting |
int |
Сортировка |
|
| type |
int |
Тип |
|
| timestamp |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| site_id |
int |
Идентификатор сайта |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Макеты сайта"
POST /api/v1.1/templates/
Обновить "Макеты сайта" с идентификатором {id}
PUT /api/v1.1/templates/{id}/
{"template_id": 1, "template_dir_id": 1, ...}
Удалить "Макеты сайта" с переданным {id}
DELETE /api/v1.1/templates/{id}/
Связанные элементы
Получить "Макеты сайта" у "Макеты сайта" с идентификатором {id}
GET /api/v1.1/templates/{id}/templates/
Получить "Секции макета сайта" у "Макеты сайта" с идентификатором {id}
GET /api/v1.1/templates/{id}/template_sections/
Метки
Key 'model_name' in 'ru' language does not exist for model 'tag_deal'.
Получить "Key 'model_name' in 'ru' language does not exist for model 'tag_deal'."
GET /api/v1.1/tag_deals/
Фильтрация "Key 'model_name' in 'ru' language does not exist for model 'tag_deal'." — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/tag_deals/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| tag_id |
int |
|
|
| deal_id |
int |
|
|
| site_id |
int |
|
|
Создать "Key 'model_name' in 'ru' language does not exist for model 'tag_deal'."
POST /api/v1.1/tag_deals/
Обновить "Key 'model_name' in 'ru' language does not exist for model 'tag_deal'." с идентификатором {id}
PUT /api/v1.1/tag_deals/{id}/
{"tag_id": 1, "deal_id": 1, ...}
Удалить "Key 'model_name' in 'ru' language does not exist for model 'tag_deal'." с переданным {id}
DELETE /api/v1.1/tag_deals/{id}/
Группы меток
Получить "Группы меток"
GET /api/v1.1/tag_dirs/
Фильтрация "Группы меток" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/tag_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
|
|
| name |
string |
Название группы меток (тегов) |
|
| description |
string |
Описание группы |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Группы меток"
POST /api/v1.1/tag_dirs/
Обновить "Группы меток" с идентификатором {id}
PUT /api/v1.1/tag_dirs/{id}/
{"parent_id": 1, "name": "...", ...}
Удалить "Группы меток" с переданным {id}
DELETE /api/v1.1/tag_dirs/{id}/
Связанные элементы
Получить "Метки" у "Группы меток" с идентификатором {id}
GET /api/v1.1/tag_dirs/{id}/tags/
Получить "Группы меток" у "Группы меток" с идентификатором {id}
GET /api/v1.1/tag_dirs/{id}/tag_dirs/
Key 'model_name' in 'ru' language does not exist for model 'tag_event'.
Получить "Key 'model_name' in 'ru' language does not exist for model 'tag_event'."
GET /api/v1.1/tag_events/
Фильтрация "Key 'model_name' in 'ru' language does not exist for model 'tag_event'." — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/tag_events/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| tag_id |
int |
|
|
| event_id |
int |
|
|
| site_id |
int |
|
|
Создать "Key 'model_name' in 'ru' language does not exist for model 'tag_event'."
POST /api/v1.1/tag_events/
Обновить "Key 'model_name' in 'ru' language does not exist for model 'tag_event'." с идентификатором {id}
PUT /api/v1.1/tag_events/{id}/
{"tag_id": 1, "event_id": 1, ...}
Удалить "Key 'model_name' in 'ru' language does not exist for model 'tag_event'." с переданным {id}
DELETE /api/v1.1/tag_events/{id}/
Получить "Метки, информационные элементы"
GET /api/v1.1/tag_informationsystem_items/
Фильтрация "Метки, информационные элементы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/tag_informationsystem_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| tag_id |
int |
|
|
| informationsystem_item_id |
int |
|
|
| site_id |
int |
|
|
Создать "Метки, информационные элементы"
POST /api/v1.1/tag_informationsystem_items/
Обновить "Метки, информационные элементы" с идентификатором {id}
PUT /api/v1.1/tag_informationsystem_items/{id}/
{"tag_id": 1, "informationsystem_item_id": 1, ...}
Удалить "Метки, информационные элементы" с переданным {id}
DELETE /api/v1.1/tag_informationsystem_items/{id}/
Key 'model_name' in 'ru' language does not exist for model 'tag_lead'.
Получить "Key 'model_name' in 'ru' language does not exist for model 'tag_lead'."
GET /api/v1.1/tag_leads/
Фильтрация "Key 'model_name' in 'ru' language does not exist for model 'tag_lead'." — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/tag_leads/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| tag_id |
int |
|
|
| lead_id |
int |
|
|
| site_id |
int |
|
|
Создать "Key 'model_name' in 'ru' language does not exist for model 'tag_lead'."
POST /api/v1.1/tag_leads/
Обновить "Key 'model_name' in 'ru' language does not exist for model 'tag_lead'." с идентификатором {id}
PUT /api/v1.1/tag_leads/{id}/
{"tag_id": 1, "lead_id": 1, ...}
Удалить "Key 'model_name' in 'ru' language does not exist for model 'tag_lead'." с переданным {id}
DELETE /api/v1.1/tag_leads/{id}/
Метки, товары
Получить "Метки, товары"
GET /api/v1.1/tag_shop_items/
Фильтрация "Метки, товары" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/tag_shop_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| tag_id |
int |
|
|
| shop_item_id |
int |
|
|
| site_id |
int |
|
|
Создать "Метки, товары"
POST /api/v1.1/tag_shop_items/
Обновить "Метки, товары" с идентификатором {id}
PUT /api/v1.1/tag_shop_items/{id}/
{"tag_id": 1, "shop_item_id": 1, ...}
Удалить "Метки, товары" с переданным {id}
DELETE /api/v1.1/tag_shop_items/{id}/
Key 'model_name' in 'ru' language does not exist for model 'tag_shop_order'.
Получить "Key 'model_name' in 'ru' language does not exist for model 'tag_shop_order'."
GET /api/v1.1/tag_shop_orders/
Фильтрация "Key 'model_name' in 'ru' language does not exist for model 'tag_shop_order'." — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/tag_shop_orders/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| tag_id |
int |
|
|
| shop_order_id |
int |
|
|
| site_id |
int |
|
|
Создать "Key 'model_name' in 'ru' language does not exist for model 'tag_shop_order'."
POST /api/v1.1/tag_shop_orders/
Обновить "Key 'model_name' in 'ru' language does not exist for model 'tag_shop_order'." с идентификатором {id}
PUT /api/v1.1/tag_shop_orders/{id}/
{"tag_id": 1, "shop_order_id": 1, ...}
Удалить "Key 'model_name' in 'ru' language does not exist for model 'tag_shop_order'." с переданным {id}
DELETE /api/v1.1/tag_shop_orders/{id}/
Метки, склады
Получить "Метки, склады"
GET /api/v1.1/tag_shop_warehouses/
Фильтрация "Метки, склады" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/tag_shop_warehouses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| tag_id |
int |
|
|
| shop_warehouse_id |
int |
|
|
| site_id |
int |
|
|
Создать "Метки, склады"
POST /api/v1.1/tag_shop_warehouses/
Обновить "Метки, склады" с идентификатором {id}
PUT /api/v1.1/tag_shop_warehouses/{id}/
{"tag_id": 1, "shop_warehouse_id": 1, ...}
Удалить "Метки, склады" с переданным {id}
DELETE /api/v1.1/tag_shop_warehouses/{id}/
Метки
Получить "Метки"
GET /api/v1.1/tags/
Фильтрация "Метки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/tags/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| tag_dir_id |
int |
|
|
| name |
string |
Название метки |
|
| path |
string |
Название метки в URL |
|
| user_id |
int |
Идентификатор сотрудника |
|
| description |
string |
Описание метки |
|
| h1 |
string |
Заголовок H1 |
|
| showed |
int |
Показов |
|
| seo_title |
string |
Заголовок (title) |
|
| seo_description |
string |
Описание (description) |
|
| seo_keywords |
string |
Ключевые слова (keywords) |
|
| sorting |
int |
Порядок сортировки |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Метки"
POST /api/v1.1/tags/
Обновить "Метки" с идентификатором {id}
PUT /api/v1.1/tags/{id}/
{"tag_dir_id": 1, "name": "...", ...}
Удалить "Метки" с переданным {id}
DELETE /api/v1.1/tags/{id}/
Связанные элементы
Получить "Информационные элементы" у "Метки" с идентификатором {id}
GET /api/v1.1/tags/{id}/informationsystem_items/
Получить "Товары магазина" у "Метки" с идентификатором {id}
GET /api/v1.1/tags/{id}/shop_items/
Получить "Склады" у "Метки" с идентификатором {id}
GET /api/v1.1/tags/{id}/shop_warehouses/
Получить "Заказы магазина" у "Метки" с идентификатором {id}
GET /api/v1.1/tags/{id}/shop_orders/
Получить "Лиды" у "Метки" с идентификатором {id}
GET /api/v1.1/tags/{id}/leads/
Получить "Сделки" у "Метки" с идентификатором {id}
GET /api/v1.1/tags/{id}/deals/
Получить "Дела" у "Метки" с идентификатором {id}
GET /api/v1.1/tags/{id}/events/
Получить "Метки, информационные элементы" у "Метки" с идентификатором {id}
GET /api/v1.1/tags/{id}/tag_informationsystem_items/
Получить "Метки, товары" у "Метки" с идентификатором {id}
GET /api/v1.1/tags/{id}/tag_shop_items/
Получить "Метки, склады" у "Метки" с идентификатором {id}
GET /api/v1.1/tags/{id}/tag_shop_warehouses/
Получить "Key 'model_name' in 'ru' language does not exist for model 'tag_shop_order'." у "Метки" с идентификатором {id}
GET /api/v1.1/tags/{id}/tag_shop_orders/
Получить "Key 'model_name' in 'ru' language does not exist for model 'tag_lead'." у "Метки" с идентификатором {id}
GET /api/v1.1/tags/{id}/tag_leads/
Получить "Key 'model_name' in 'ru' language does not exist for model 'tag_deal'." у "Метки" с идентификатором {id}
GET /api/v1.1/tags/{id}/tag_deals/
Получить "Key 'model_name' in 'ru' language does not exist for model 'tag_event'." у "Метки" с идентификатором {id}
GET /api/v1.1/tags/{id}/tag_events/
Модули
Модули
Получить "Модули"
GET /api/v1.1/modules/
Фильтрация "Модули" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/modules/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название модуля |
|
| description |
string |
Описание модуля |
|
| active |
int |
Активен |
|
| indexing |
int |
Индексировать |
|
| path |
string |
Путь к модулю |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Модули"
POST /api/v1.1/modules/
Обновить "Модули" с идентификатором {id}
PUT /api/v1.1/modules/{id}/
{"name": "...", "description": "...", ...}
Удалить "Модули" с переданным {id}
DELETE /api/v1.1/modules/{id}/
Связанные элементы
Получить "Доступ к модулям сайта" у "Модули" с идентификатором {id}
GET /api/v1.1/modules/{id}/company_department_modules/
Получить "Уведомления" у "Модули" с идентификатором {id}
GET /api/v1.1/modules/{id}/notifications/
Получить "Уведомления, подписчики" у "Модули" с идентификатором {id}
GET /api/v1.1/modules/{id}/notification_subscribers/
Облачные хранилища
Облачные хранилища
Получить "Облачные хранилища"
GET /api/v1.1/clouds/
Фильтрация "Облачные хранилища" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/clouds/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Название |
|
| type |
string |
Облако |
|
| active |
int |
Активность |
|
| key |
string |
Ключ приложения |
|
| secret |
string |
Пароль приложения (секретный ключ) |
|
| code |
string |
Код доступа |
|
| access_token |
string |
Токен доступа |
|
| root_folder |
string |
Корневая папка в облаке |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Облачные хранилища"
POST /api/v1.1/clouds/
Обновить "Облачные хранилища" с идентификатором {id}
PUT /api/v1.1/clouds/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Облачные хранилища" с переданным {id}
DELETE /api/v1.1/clouds/{id}/
Опросы
Группы опросов
Получить "Группы опросов"
GET /api/v1.1/poll_groups/
Фильтрация "Группы опросов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/poll_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| structure_id |
int |
Узел структуры |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Название группы опросов |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Группы опросов"
POST /api/v1.1/poll_groups/
Обновить "Группы опросов" с идентификатором {id}
PUT /api/v1.1/poll_groups/{id}/
{"structure_id": 1, "site_id": 1, ...}
Удалить "Группы опросов" с переданным {id}
DELETE /api/v1.1/poll_groups/{id}/
Связанные элементы
Получить "Опросы" у "Группы опросов" с идентификатором {id}
GET /api/v1.1/poll_groups/{id}/polls/
Варианты ответов на опрос
Получить "Варианты ответов на опрос"
GET /api/v1.1/poll_responses/
Фильтрация "Варианты ответов на опрос" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/poll_responses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| poll_id |
int |
Идентификатор опроса |
|
| name |
string |
Вариант ответа |
|
| voted |
int |
Отдано голосов |
|
| sorting |
int |
Порядок сортировки |
|
| grade |
int |
Количество баллов |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Варианты ответов на опрос"
POST /api/v1.1/poll_responses/
Обновить "Варианты ответов на опрос" с идентификатором {id}
PUT /api/v1.1/poll_responses/{id}/
{"poll_id": 1, "name": "...", ...}
Удалить "Варианты ответов на опрос" с переданным {id}
DELETE /api/v1.1/poll_responses/{id}/
Опросы, голоса
Получить "Опросы, голоса"
GET /api/v1.1/poll_votes/
Фильтрация "Опросы, голоса" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/poll_votes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| poll_id |
int |
|
|
| ip |
string |
|
|
Создать "Опросы, голоса"
POST /api/v1.1/poll_votes/
Обновить "Опросы, голоса" с идентификатором {id}
PUT /api/v1.1/poll_votes/{id}/
{"poll_id": 1, "ip": "...", ...}
Удалить "Опросы, голоса" с переданным {id}
DELETE /api/v1.1/poll_votes/{id}/
Опросы
Получить "Опросы"
GET /api/v1.1/polls/
Фильтрация "Опросы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/polls/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название опроса |
|
| description |
string |
Описание опроса |
|
| type |
int |
Вид голосования |
|
| show_results |
int |
Предоставлять результат голосования пользователю |
|
| active |
int |
Отображать опрос |
|
| start_date |
string |
Дата начала действия опроса |
|
| end_date |
string |
Дата окончания действия опроса |
|
| voted |
int |
Отдано голосов |
|
| poll_group_id |
int |
Идентификатор группы опросов |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Опросы"
POST /api/v1.1/polls/
Обновить "Опросы" с идентификатором {id}
PUT /api/v1.1/polls/{id}/
{"name": "...", "description": "...", ...}
Удалить "Опросы" с переданным {id}
DELETE /api/v1.1/polls/{id}/
Связанные элементы
Получить "Варианты ответов на опрос" у "Опросы" с идентификатором {id}
GET /api/v1.1/polls/{id}/poll_responses/
Получить "Опросы, голоса" у "Опросы" с идентификатором {id}
GET /api/v1.1/polls/{id}/poll_votes/
Оценка производительности
Оценка производительности. URL.
Получить "Оценка производительности. URL."
GET /api/v1.1/benchmark_urls/
Фильтрация "Оценка производительности. URL." — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/benchmark_urls/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| structure_id |
int |
|
|
| waiting_time |
int |
|
|
| load_page_time |
int |
|
|
| dns_lookup |
int |
|
|
| connect_server |
int |
|
|
| datetime |
string |
|
|
| ip |
string |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Оценка производительности. URL."
POST /api/v1.1/benchmark_urls/
Обновить "Оценка производительности. URL." с идентификатором {id}
PUT /api/v1.1/benchmark_urls/{id}/
{"structure_id": 1, "waiting_time": 1, ...}
Удалить "Оценка производительности. URL." с переданным {id}
DELETE /api/v1.1/benchmark_urls/{id}/
Оценка производительности
Получить "Оценка производительности"
GET /api/v1.1/benchmarks/
Фильтрация "Оценка производительности" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/benchmarks/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| site_id |
int |
|
|
| datetime |
string |
|
|
| mysql_write |
int |
|
|
| mysql_read |
int |
|
|
| mysql_update |
int |
|
|
| filesystem |
int |
Файловая система |
|
| cpu_math |
int |
Процессор, алгебра |
|
| cpu_string |
int |
Процессор, строки |
|
| network |
decimal |
|
|
| mail |
decimal |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Оценка производительности"
POST /api/v1.1/benchmarks/
Обновить "Оценка производительности" с идентификатором {id}
PUT /api/v1.1/benchmarks/{id}/
{"site_id": 1, "datetime": "...", ...}
Удалить "Оценка производительности" с переданным {id}
DELETE /api/v1.1/benchmarks/{id}/
План счетов
Статьи ДДС
Получить "Статьи ДДС"
GET /api/v1.1/chartaccount_cashflows/
Фильтрация "Статьи ДДС" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/chartaccount_cashflows/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Статьи ДДС"
POST /api/v1.1/chartaccount_cashflows/
Обновить "Статьи ДДС" с идентификатором {id}
PUT /api/v1.1/chartaccount_cashflows/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Статьи ДДС" с переданным {id}
DELETE /api/v1.1/chartaccount_cashflows/{id}/
Связанные элементы
Получить "Платежи" у "Статьи ДДС" с идентификатором {id}
GET /api/v1.1/chartaccount_cashflows/{id}/shop_warrants/
Закрытие периода
Получить "Закрытие периода"
GET /api/v1.1/chartaccount_closure_periods/
Фильтрация "Закрытие периода" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/chartaccount_closure_periods/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| company_id |
int |
Компания |
|
| number |
string |
Номер |
|
| datetime |
string |
Дата |
|
| description |
string |
Описание |
|
| posted |
int |
Проведено |
|
| closure_cost_accounting |
int |
|
|
| financial_result |
int |
Определение финансового результата |
|
| balance_reformation |
int |
Реформация баланса |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Закрытие периода"
POST /api/v1.1/chartaccount_closure_periods/
Обновить "Закрытие периода" с идентификатором {id}
PUT /api/v1.1/chartaccount_closure_periods/{id}/
{"company_id": 1, "number": "...", ...}
Удалить "Закрытие периода" с переданным {id}
DELETE /api/v1.1/chartaccount_closure_periods/{id}/
Корректные проводки
Получить "Корректные проводки"
GET /api/v1.1/chartaccount_correct_entries/
Фильтрация "Корректные проводки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/chartaccount_correct_entries/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| debit |
int |
Дебeт |
|
| credit |
int |
Кредит |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Корректные проводки"
POST /api/v1.1/chartaccount_correct_entries/
Обновить "Корректные проводки" с идентификатором {id}
PUT /api/v1.1/chartaccount_correct_entries/{id}/
{"debit": 1, "credit": 1, ...}
Удалить "Корректные проводки" с переданным {id}
DELETE /api/v1.1/chartaccount_correct_entries/{id}/
Журнал проводок
Получить "Журнал проводок"
GET /api/v1.1/chartaccount_entries/
Фильтрация "Журнал проводок" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/chartaccount_entries/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| company_id |
int |
|
|
| document_id |
int |
|
|
| datetime |
string |
|
|
| amount |
decimal |
|
|
| description |
string |
|
|
| dchartaccount_id |
int |
|
|
| dsc0 |
int |
|
|
| dsc1 |
int |
|
|
| dsc2 |
int |
|
|
| cchartaccount_id |
int |
|
|
| csc0 |
int |
|
|
| csc1 |
int |
|
|
| csc2 |
int |
|
|
Создать "Журнал проводок"
POST /api/v1.1/chartaccount_entries/
Обновить "Журнал проводок" с идентификатором {id}
PUT /api/v1.1/chartaccount_entries/{id}/
{"company_id": 1, "document_id": 1, ...}
Удалить "Журнал проводок" с переданным {id}
DELETE /api/v1.1/chartaccount_entries/{id}/
Связанные элементы
Получить "Журнал проводок, субконто" у "Журнал проводок" с идентификатором {id}
GET /api/v1.1/chartaccount_entries/{id}/chartaccount_entry_subcounts/
Журнал проводок, субконто
Получить "Журнал проводок, субконто"
GET /api/v1.1/chartaccount_entry_subcounts/
Фильтрация "Журнал проводок, субконто" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/chartaccount_entry_subcounts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| chartaccount_entry_id |
int |
|
|
| type |
int |
|
|
| value |
int |
|
|
Создать "Журнал проводок, субконто"
POST /api/v1.1/chartaccount_entry_subcounts/
Обновить "Журнал проводок, субконто" с идентификатором {id}
PUT /api/v1.1/chartaccount_entry_subcounts/{id}/
{"chartaccount_entry_id": 1, "type": 1, ...}
Удалить "Журнал проводок, субконто" с переданным {id}
DELETE /api/v1.1/chartaccount_entry_subcounts/{id}/
Операции, элементы
Получить "Операции, элементы"
GET /api/v1.1/chartaccount_operation_items/
Фильтрация "Операции, элементы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/chartaccount_operation_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| chartaccount_operation_id |
int |
Идентификатор операции |
|
| dchartaccount_id |
int |
Дебет |
|
| dsc0 |
int |
|
|
| dsc1 |
int |
|
|
| dsc2 |
int |
|
|
| cchartaccount_id |
int |
Кредит |
|
| csc0 |
int |
|
|
| csc1 |
int |
|
|
| csc2 |
int |
|
|
| amount |
decimal |
Сумма |
|
| description |
string |
Содержание проводки |
|
Создать "Операции, элементы"
POST /api/v1.1/chartaccount_operation_items/
Обновить "Операции, элементы" с идентификатором {id}
PUT /api/v1.1/chartaccount_operation_items/{id}/
{"chartaccount_operation_id": 1, "dchartaccount_id": 1, ...}
Удалить "Операции, элементы" с переданным {id}
DELETE /api/v1.1/chartaccount_operation_items/{id}/
Операции
Получить "Операции"
GET /api/v1.1/chartaccount_operations/
Фильтрация "Операции" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/chartaccount_operations/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| company_id |
int |
Компания |
|
| number |
string |
Номер |
|
| datetime |
string |
Дата |
|
| description |
string |
Описание |
|
| posted |
int |
Проведено |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Операции"
POST /api/v1.1/chartaccount_operations/
Обновить "Операции" с идентификатором {id}
PUT /api/v1.1/chartaccount_operations/{id}/
{"company_id": 1, "number": "...", ...}
Удалить "Операции" с переданным {id}
DELETE /api/v1.1/chartaccount_operations/{id}/
Связанные элементы
Получить "Операции, элементы" у "Операции" с идентификатором {id}
GET /api/v1.1/chartaccount_operations/{id}/chartaccount_operation_items/
План счетов
Получить "План счетов"
GET /api/v1.1/chartaccounts/
Фильтрация "План счетов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/chartaccounts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| code |
string |
Счет |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| type |
int |
Тип |
|
| folder |
int |
Директория |
|
| currency |
int |
Валютный |
|
| quantitative |
int |
Количественный |
|
| off_balance |
int |
Забалансовый |
|
| sc0 |
int |
Субконто1 |
|
| sc1 |
int |
Субконто2 |
|
| sc2 |
int |
Субконто3 |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "План счетов"
POST /api/v1.1/chartaccounts/
Обновить "План счетов" с идентификатором {id}
PUT /api/v1.1/chartaccounts/{id}/
{"code": "...", "name": "...", ...}
Удалить "План счетов" с переданным {id}
DELETE /api/v1.1/chartaccounts/{id}/
Связанные элементы
Планировщик событий
Планировщик задач
Получить "Планировщик задач"
GET /api/v1.1/schedules/
Фильтрация "Планировщик задач" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/schedules/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор задачи |
|
| start_datetime |
string |
Дата следующего выполнения задачи |
|
| datetime |
string |
Дата добавления задачи |
|
| site_id |
int |
Идентификатор сайта |
|
| description |
string |
Описание |
|
| module_id |
int |
Модуль |
|
| action |
int |
Действие |
|
| entity_id |
string |
Идентификатор элемента |
|
| completed |
int |
Активность задачи |
|
| interval |
int |
Интервал |
|
| active |
int |
Активность |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Планировщик задач"
POST /api/v1.1/schedules/
Обновить "Планировщик задач" с идентификатором {id}
PUT /api/v1.1/schedules/{id}/
{"start_datetime": "...", "datetime": "...", ...}
Удалить "Планировщик задач" с переданным {id}
DELETE /api/v1.1/schedules/{id}/
Подсветка синтаксиса
Подсветка синтаксиса
Получить "Подсветка синтаксиса"
GET /api/v1.1/syntaxhighlighters/
Фильтрация "Подсветка синтаксиса" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/syntaxhighlighters/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| driver |
string |
Драйвер |
|
| default |
int |
По умолчанию |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Подсветка синтаксиса"
POST /api/v1.1/syntaxhighlighters/
Обновить "Подсветка синтаксиса" с идентификатором {id}
PUT /api/v1.1/syntaxhighlighters/{id}/
{"name": "...", "driver": "...", ...}
Удалить "Подсветка синтаксиса" с переданным {id}
DELETE /api/v1.1/syntaxhighlighters/{id}/
Поисковая индексация
Key 'model_name' in 'ru' language does not exist for model 'search_dictionary_en'.
Получить "Key 'model_name' in 'ru' language does not exist for model 'search_dictionary_en'."
GET /api/v1.1/search_dictionary_ens/
Фильтрация "Key 'model_name' in 'ru' language does not exist for model 'search_dictionary_en'." — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/search_dictionary_ens/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| word |
string |
|
|
| first_char |
string |
|
|
| len |
int |
|
|
Создать "Key 'model_name' in 'ru' language does not exist for model 'search_dictionary_en'."
POST /api/v1.1/search_dictionary_ens/
Обновить "Key 'model_name' in 'ru' language does not exist for model 'search_dictionary_en'." с идентификатором {id}
PUT /api/v1.1/search_dictionary_ens/{id}/
{"word": "...", "first_char": "...", ...}
Удалить "Key 'model_name' in 'ru' language does not exist for model 'search_dictionary_en'." с переданным {id}
DELETE /api/v1.1/search_dictionary_ens/{id}/
Key 'model_name' in 'ru' language does not exist for model 'search_dictionary_ru'.
Получить "Key 'model_name' in 'ru' language does not exist for model 'search_dictionary_ru'."
GET /api/v1.1/search_dictionary_rus/
Фильтрация "Key 'model_name' in 'ru' language does not exist for model 'search_dictionary_ru'." — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/search_dictionary_rus/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| word |
string |
|
|
| first_char |
string |
|
|
| len |
int |
|
|
Создать "Key 'model_name' in 'ru' language does not exist for model 'search_dictionary_ru'."
POST /api/v1.1/search_dictionary_rus/
Обновить "Key 'model_name' in 'ru' language does not exist for model 'search_dictionary_ru'." с идентификатором {id}
PUT /api/v1.1/search_dictionary_rus/{id}/
{"word": "...", "first_char": "...", ...}
Удалить "Key 'model_name' in 'ru' language does not exist for model 'search_dictionary_ru'." с переданным {id}
DELETE /api/v1.1/search_dictionary_rus/{id}/
Статичные страницы
Получить "Статичные страницы"
GET /api/v1.1/search_links/
Фильтрация "Статичные страницы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/search_links/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| url |
string |
Ссылка |
|
| ext |
string |
Расширения |
|
| site_id |
int |
Идентификатор сайта |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Статичные страницы"
POST /api/v1.1/search_links/
Обновить "Статичные страницы" с идентификатором {id}
PUT /api/v1.1/search_links/{id}/
{"url": "...", "ext": "...", ...}
Удалить "Статичные страницы" с переданным {id}
DELETE /api/v1.1/search_links/{id}/
Журнал поисковых запросов
Получить "Журнал поисковых запросов"
GET /api/v1.1/search_logs/
Фильтрация "Журнал поисковых запросов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/search_logs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_id |
int |
|
|
| site_id |
int |
|
|
| query |
string |
|
|
| ip |
string |
|
|
| datetime |
string |
|
|
| hash |
int |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Журнал поисковых запросов"
POST /api/v1.1/search_logs/
Обновить "Журнал поисковых запросов" с идентификатором {id}
PUT /api/v1.1/search_logs/{id}/
{"siteuser_id": 1, "site_id": 1, ...}
Удалить "Журнал поисковых запросов" с переданным {id}
DELETE /api/v1.1/search_logs/{id}/
Пользовательские поля
Раздел пользовательских полей
Получить "Раздел пользовательских полей"
GET /api/v1.1/field_dirs/
Фильтрация "Раздел пользовательских полей" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/field_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор раздела |
|
| parent_id |
int |
Родительский раздел |
|
| model |
string |
Модель |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| sorting |
int |
Сортировка |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Раздел пользовательских полей"
POST /api/v1.1/field_dirs/
Обновить "Раздел пользовательских полей" с идентификатором {id}
PUT /api/v1.1/field_dirs/{id}/
{"parent_id": 1, "model": "...", ...}
Удалить "Раздел пользовательских полей" с переданным {id}
DELETE /api/v1.1/field_dirs/{id}/
Связанные элементы
Получить "Пользовательские поля" у "Раздел пользовательских полей" с идентификатором {id}
GET /api/v1.1/field_dirs/{id}/fields/
Получить "Раздел пользовательских полей" у "Раздел пользовательских полей" с идентификатором {id}
GET /api/v1.1/field_dirs/{id}/field_dirs/
Пользовательские поля, большое целое число
Получить "Пользовательские поля, большое целое число"
GET /api/v1.1/field_value_bigints/
Фильтрация "Пользовательские поля, большое целое число" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/field_value_bigints/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| field_id |
int |
|
|
| entity_id |
int |
|
|
| value |
int |
|
|
Создать "Пользовательские поля, большое целое число"
POST /api/v1.1/field_value_bigints/
Обновить "Пользовательские поля, большое целое число" с идентификатором {id}
PUT /api/v1.1/field_value_bigints/{id}/
{"field_id": 1, "entity_id": 1, ...}
Удалить "Пользовательские поля, большое целое число" с переданным {id}
DELETE /api/v1.1/field_value_bigints/{id}/
Пользовательские поля, значения дата-время
Получить "Пользовательские поля, значения дата-время"
GET /api/v1.1/field_value_datetimes/
Фильтрация "Пользовательские поля, значения дата-время" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/field_value_datetimes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| field_id |
int |
|
|
| entity_id |
int |
|
|
| value |
string |
|
|
Создать "Пользовательские поля, значения дата-время"
POST /api/v1.1/field_value_datetimes/
Обновить "Пользовательские поля, значения дата-время" с идентификатором {id}
PUT /api/v1.1/field_value_datetimes/{id}/
{"field_id": 1, "entity_id": 1, ...}
Удалить "Пользовательские поля, значения дата-время" с переданным {id}
DELETE /api/v1.1/field_value_datetimes/{id}/
Пользовательские поля, значения файлов
Получить "Пользовательские поля, значения файлов"
GET /api/v1.1/field_value_files/
Фильтрация "Пользовательские поля, значения файлов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/field_value_files/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| field_id |
int |
|
|
| entity_id |
int |
|
|
| file |
string |
|
|
| file_name |
string |
|
|
| file_description |
string |
|
|
| file_small |
string |
|
|
| file_small_name |
string |
|
|
| file_small_description |
string |
|
|
Создать "Пользовательские поля, значения файлов"
POST /api/v1.1/field_value_files/
Обновить "Пользовательские поля, значения файлов" с идентификатором {id}
PUT /api/v1.1/field_value_files/{id}/
{"field_id": 1, "entity_id": 1, ...}
Удалить "Пользовательские поля, значения файлов" с переданным {id}
DELETE /api/v1.1/field_value_files/{id}/
Пользовательские поля, число с плавающей запятой
Получить "Пользовательские поля, число с плавающей запятой"
GET /api/v1.1/field_value_floats/
Фильтрация "Пользовательские поля, число с плавающей запятой" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/field_value_floats/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| field_id |
int |
|
|
| entity_id |
int |
|
|
| value |
float |
|
|
Создать "Пользовательские поля, число с плавающей запятой"
POST /api/v1.1/field_value_floats/
Обновить "Пользовательские поля, число с плавающей запятой" с идентификатором {id}
PUT /api/v1.1/field_value_floats/{id}/
{"field_id": 1, "entity_id": 1, ...}
Удалить "Пользовательские поля, число с плавающей запятой" с переданным {id}
DELETE /api/v1.1/field_value_floats/{id}/
Пользовательские поля, целое число
Получить "Пользовательские поля, целое число"
GET /api/v1.1/field_value_ints/
Фильтрация "Пользовательские поля, целое число" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/field_value_ints/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| field_id |
int |
|
|
| entity_id |
int |
|
|
| value |
int |
|
|
Создать "Пользовательские поля, целое число"
POST /api/v1.1/field_value_ints/
Обновить "Пользовательские поля, целое число" с идентификатором {id}
PUT /api/v1.1/field_value_ints/{id}/
{"field_id": 1, "entity_id": 1, ...}
Удалить "Пользовательские поля, целое число" с переданным {id}
DELETE /api/v1.1/field_value_ints/{id}/
Пользовательские поля, значения строка
Получить "Пользовательские поля, значения строка"
GET /api/v1.1/field_value_strings/
Фильтрация "Пользовательские поля, значения строка" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/field_value_strings/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| field_id |
int |
|
|
| entity_id |
int |
|
|
| value |
string |
|
|
Создать "Пользовательские поля, значения строка"
POST /api/v1.1/field_value_strings/
Обновить "Пользовательские поля, значения строка" с идентификатором {id}
PUT /api/v1.1/field_value_strings/{id}/
{"field_id": 1, "entity_id": 1, ...}
Удалить "Пользовательские поля, значения строка" с переданным {id}
DELETE /api/v1.1/field_value_strings/{id}/
Пользовательские поля, значения текст
Получить "Пользовательские поля, значения текст"
GET /api/v1.1/field_value_texts/
Фильтрация "Пользовательские поля, значения текст" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/field_value_texts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| field_id |
int |
|
|
| entity_id |
int |
|
|
| value |
string |
|
|
Создать "Пользовательские поля, значения текст"
POST /api/v1.1/field_value_texts/
Обновить "Пользовательские поля, значения текст" с идентификатором {id}
PUT /api/v1.1/field_value_texts/{id}/
{"field_id": 1, "entity_id": 1, ...}
Удалить "Пользовательские поля, значения текст" с переданным {id}
DELETE /api/v1.1/field_value_texts/{id}/
Пользовательские поля
Получить "Пользовательские поля"
GET /api/v1.1/fields/
Фильтрация "Пользовательские поля" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/fields/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор поля |
|
| field_dir_id |
int |
Код раздела |
|
| model |
string |
Модель |
|
| site_id |
int |
Сайт |
|
| list_id |
int |
Список |
|
| informationsystem_id |
int |
Информационная система |
|
| shop_id |
int |
Интернет-магазин |
|
| default_value |
string |
Значение по умолчанию |
|
| tag_name |
string |
Название XML-тега |
|
| name |
string |
Название поля |
|
| description |
string |
Описание |
|
| type |
int |
Тип поля |
|
| sorting |
int |
Сортировка |
|
| visible |
int |
Видимость поля |
|
| image_large_max_width |
int |
Максимальная ширина большого изображения |
|
| image_large_max_height |
int |
Максимальная высота большого изображения |
|
| image_small_max_width |
int |
Максимальная ширина малого изображения |
|
| image_small_max_height |
int |
Максимальная высота малого изображения |
|
| hide_small_image |
int |
Скрыть поле малого изображения |
|
| preserve_aspect_ratio |
int |
Сохранять пропорции изображения |
|
| preserve_aspect_ratio_small |
int |
Сохранять пропорции малого изображения |
|
| change_filename |
int |
Изменять названия загружаемых файлов |
|
| multiple |
int |
Разрешить множественные значения для поля |
|
| obligatory |
int |
Обязательное для заполнения |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Пользовательские поля"
POST /api/v1.1/fields/
Обновить "Пользовательские поля" с идентификатором {id}
PUT /api/v1.1/fields/{id}/
{"field_dir_id": 1, "model": "...", ...}
Удалить "Пользовательские поля" с переданным {id}
DELETE /api/v1.1/fields/{id}/
Связанные элементы
Получить "Пользовательские поля, большое целое число" у "Пользовательские поля" с идентификатором {id}
GET /api/v1.1/fields/{id}/field_value_bigints/
Получить "Пользовательские поля, целое число" у "Пользовательские поля" с идентификатором {id}
GET /api/v1.1/fields/{id}/field_value_ints/
Получить "Пользовательские поля, число с плавающей запятой" у "Пользовательские поля" с идентификатором {id}
GET /api/v1.1/fields/{id}/field_value_floats/
Получить "Пользовательские поля, значения строка" у "Пользовательские поля" с идентификатором {id}
GET /api/v1.1/fields/{id}/field_value_strings/
Получить "Пользовательские поля, значения текст" у "Пользовательские поля" с идентификатором {id}
GET /api/v1.1/fields/{id}/field_value_texts/
Получить "Пользовательские поля, значения дата-время" у "Пользовательские поля" с идентификатором {id}
GET /api/v1.1/fields/{id}/field_value_datetimes/
Получить "Пользовательские поля, значения файлов" у "Пользовательские поля" с идентификатором {id}
GET /api/v1.1/fields/{id}/field_value_files/
Почта
Выпуски рассылки, файлы
Получить "Выпуски рассылки, файлы"
GET /api/v1.1/maillist_fascicle_files/
Фильтрация "Выпуски рассылки, файлы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/maillist_fascicle_files/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| maillist_fascicle_id |
int |
|
|
| name |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Выпуски рассылки, файлы"
POST /api/v1.1/maillist_fascicle_files/
Обновить "Выпуски рассылки, файлы" с идентификатором {id}
PUT /api/v1.1/maillist_fascicle_files/{id}/
{"maillist_fascicle_id": 1, "name": "...", ...}
Удалить "Выпуски рассылки, файлы" с переданным {id}
DELETE /api/v1.1/maillist_fascicle_files/{id}/
Трекинг выпуска рассылки
Получить "Трекинг выпуска рассылки"
GET /api/v1.1/maillist_fascicle_logs/
Фильтрация "Трекинг выпуска рассылки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/maillist_fascicle_logs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| maillist_fascicle_id |
int |
|
|
| siteuser_id |
int |
|
|
| type |
int |
|
|
| sent |
string |
|
|
| opened |
string |
|
|
| guid |
string |
|
|
Создать "Трекинг выпуска рассылки"
POST /api/v1.1/maillist_fascicle_logs/
Обновить "Трекинг выпуска рассылки" с идентификатором {id}
PUT /api/v1.1/maillist_fascicle_logs/{id}/
{"maillist_fascicle_id": 1, "siteuser_id": 1, ...}
Удалить "Трекинг выпуска рассылки" с переданным {id}
DELETE /api/v1.1/maillist_fascicle_logs/{id}/
Выпуски рассылки
Получить "Выпуски рассылки"
GET /api/v1.1/maillist_fascicles/
Фильтрация "Выпуски рассылки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/maillist_fascicles/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| maillist_id |
int |
Идентификатор почтовой рассылки |
|
| datetime |
string |
|
|
| subject |
string |
Тема выпуска рассылки |
|
| text |
string |
Текстовая версия выпуска |
|
| sent_datetime |
string |
|
|
| html |
string |
HTML версия выпуска |
|
| changed |
int |
|
|
| utm |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Выпуски рассылки"
POST /api/v1.1/maillist_fascicles/
Обновить "Выпуски рассылки" с идентификатором {id}
PUT /api/v1.1/maillist_fascicles/{id}/
{"maillist_id": 1, "datetime": "...", ...}
Удалить "Выпуски рассылки" с переданным {id}
DELETE /api/v1.1/maillist_fascicles/{id}/
Связанные элементы
Получить "Выпуски рассылки, файлы" у "Выпуски рассылки" с идентификатором {id}
GET /api/v1.1/maillist_fascicles/{id}/maillist_fascicle_files/
Получить "Трекинг выпуска рассылки" у "Выпуски рассылки" с идентификатором {id}
GET /api/v1.1/maillist_fascicles/{id}/maillist_fascicle_logs/
Группы подписчиков рассылки
Получить "Группы подписчиков рассылки"
GET /api/v1.1/maillist_siteuser_groups/
Фильтрация "Группы подписчиков рассылки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/maillist_siteuser_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_group_id |
int |
|
|
| maillist_id |
int |
|
|
Создать "Группы подписчиков рассылки"
POST /api/v1.1/maillist_siteuser_groups/
Обновить "Группы подписчиков рассылки" с идентификатором {id}
PUT /api/v1.1/maillist_siteuser_groups/{id}/
{"siteuser_group_id": 1, "maillist_id": 1, ...}
Удалить "Группы подписчиков рассылки" с переданным {id}
DELETE /api/v1.1/maillist_siteuser_groups/{id}/
Подписчики рассылки
Получить "Подписчики рассылки"
GET /api/v1.1/maillist_siteusers/
Фильтрация "Подписчики рассылки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/maillist_siteusers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_id |
int |
|
|
| maillist_id |
int |
|
|
| type |
int |
|
|
Создать "Подписчики рассылки"
POST /api/v1.1/maillist_siteusers/
Обновить "Подписчики рассылки" с идентификатором {id}
PUT /api/v1.1/maillist_siteusers/{id}/
{"siteuser_id": 1, "maillist_id": 1, ...}
Удалить "Подписчики рассылки" с переданным {id}
DELETE /api/v1.1/maillist_siteusers/{id}/
Причины отписки
Получить "Причины отписки"
GET /api/v1.1/maillist_unsubscribe_reasons/
Фильтрация "Причины отписки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/maillist_unsubscribe_reasons/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| maillist_id |
int |
Идентификатор рассылки |
|
| reason |
string |
Причина |
|
| color |
string |
Цвет |
|
| active |
int |
Активность |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Причины отписки"
POST /api/v1.1/maillist_unsubscribe_reasons/
Обновить "Причины отписки" с идентификатором {id}
PUT /api/v1.1/maillist_unsubscribe_reasons/{id}/
{"maillist_id": 1, "reason": "...", ...}
Удалить "Причины отписки" с переданным {id}
DELETE /api/v1.1/maillist_unsubscribe_reasons/{id}/
Связанные элементы
Получить "Отписавшиеся" у "Причины отписки" с идентификатором {id}
GET /api/v1.1/maillist_unsubscribe_reasons/{id}/maillist_unsubscribers/
Отписавшиеся
Получить "Отписавшиеся"
GET /api/v1.1/maillist_unsubscribers/
Фильтрация "Отписавшиеся" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/maillist_unsubscribers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_id |
int |
|
|
| maillist_id |
int |
|
|
| maillist_unsubscribe_reason_id |
int |
|
|
| reason |
string |
|
|
| datetime |
string |
|
|
Создать "Отписавшиеся"
POST /api/v1.1/maillist_unsubscribers/
Обновить "Отписавшиеся" с идентификатором {id}
PUT /api/v1.1/maillist_unsubscribers/{id}/
{"siteuser_id": 1, "maillist_id": 1, ...}
Удалить "Отписавшиеся" с переданным {id}
DELETE /api/v1.1/maillist_unsubscribers/{id}/
Почтовые рассылки
Получить "Почтовые рассылки"
GET /api/v1.1/maillists/
Фильтрация "Почтовые рассылки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/maillists/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название почтовой рассылки |
|
| description |
string |
Описание почтовой рассылки |
|
| email |
string |
E-mail отправителя |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| site_id |
int |
Сайт |
|
| template |
string |
Шаблон рассылки |
|
| author |
string |
Отправитель |
|
| unsubscribe |
int |
Страница для unsubscribe |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Почтовые рассылки"
POST /api/v1.1/maillists/
Обновить "Почтовые рассылки" с идентификатором {id}
PUT /api/v1.1/maillists/{id}/
{"name": "...", "description": "...", ...}
Удалить "Почтовые рассылки" с переданным {id}
DELETE /api/v1.1/maillists/{id}/
Связанные элементы
Получить "Выпуски рассылки" у "Почтовые рассылки" с идентификатором {id}
GET /api/v1.1/maillists/{id}/maillist_fascicles/
Получить "Подписчики рассылки" у "Почтовые рассылки" с идентификатором {id}
GET /api/v1.1/maillists/{id}/maillist_siteusers/
Получить "Клиенты" у "Почтовые рассылки" с идентификатором {id}
GET /api/v1.1/maillists/{id}/siteusers/
Получить "Группы подписчиков рассылки" у "Почтовые рассылки" с идентификатором {id}
GET /api/v1.1/maillists/{id}/maillist_siteuser_groups/
Получить "Причины отписки" у "Почтовые рассылки" с идентификатором {id}
GET /api/v1.1/maillists/{id}/maillist_unsubscribe_reasons/
Почта
Получить "Почта"
GET /api/v1.1/mails/
Фильтрация "Почта" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/mails/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| crm_source_id |
int |
Источник |
|
| name |
string |
Название электронного адреса |
|
| email |
string |
E-mail |
|
| login |
string |
Пользователь (логин) |
|
| password |
string |
Пароль |
|
| smtp |
string |
SMTP-сервер |
|
| pop3 |
string |
POP3-сервер |
|
| imap |
string |
IMAP-сервер |
|
| encryption |
string |
Шифрование |
|
| cert_validation |
int |
Валидация сертификата |
|
| sorting |
int |
Порядок сортировки |
|
| folders |
string |
Папки |
|
| active |
int |
Активен |
|
| default |
int |
Использовать для отправки через SMTP |
|
| create_leads |
int |
Создавать лид для входящих писем |
|
| lead_days |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Почта"
POST /api/v1.1/mails/
Обновить "Почта" с идентификатором {id}
PUT /api/v1.1/mails/{id}/
{"site_id": 1, "crm_source_id": 1, ...}
Удалить "Почта" с переданным {id}
DELETE /api/v1.1/mails/{id}/
Почтовые рассылки
Выпуски рассылки, файлы
Получить "Выпуски рассылки, файлы"
GET /api/v1.1/maillist_fascicle_files/
Фильтрация "Выпуски рассылки, файлы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/maillist_fascicle_files/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| maillist_fascicle_id |
int |
|
|
| name |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Выпуски рассылки, файлы"
POST /api/v1.1/maillist_fascicle_files/
Обновить "Выпуски рассылки, файлы" с идентификатором {id}
PUT /api/v1.1/maillist_fascicle_files/{id}/
{"maillist_fascicle_id": 1, "name": "...", ...}
Удалить "Выпуски рассылки, файлы" с переданным {id}
DELETE /api/v1.1/maillist_fascicle_files/{id}/
Трекинг выпуска рассылки
Получить "Трекинг выпуска рассылки"
GET /api/v1.1/maillist_fascicle_logs/
Фильтрация "Трекинг выпуска рассылки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/maillist_fascicle_logs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| maillist_fascicle_id |
int |
|
|
| siteuser_id |
int |
|
|
| type |
int |
|
|
| sent |
string |
|
|
| opened |
string |
|
|
| guid |
string |
|
|
Создать "Трекинг выпуска рассылки"
POST /api/v1.1/maillist_fascicle_logs/
Обновить "Трекинг выпуска рассылки" с идентификатором {id}
PUT /api/v1.1/maillist_fascicle_logs/{id}/
{"maillist_fascicle_id": 1, "siteuser_id": 1, ...}
Удалить "Трекинг выпуска рассылки" с переданным {id}
DELETE /api/v1.1/maillist_fascicle_logs/{id}/
Выпуски рассылки
Получить "Выпуски рассылки"
GET /api/v1.1/maillist_fascicles/
Фильтрация "Выпуски рассылки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/maillist_fascicles/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| maillist_id |
int |
Идентификатор почтовой рассылки |
|
| datetime |
string |
|
|
| subject |
string |
Тема выпуска рассылки |
|
| text |
string |
Текстовая версия выпуска |
|
| sent_datetime |
string |
|
|
| html |
string |
HTML версия выпуска |
|
| changed |
int |
|
|
| utm |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Выпуски рассылки"
POST /api/v1.1/maillist_fascicles/
Обновить "Выпуски рассылки" с идентификатором {id}
PUT /api/v1.1/maillist_fascicles/{id}/
{"maillist_id": 1, "datetime": "...", ...}
Удалить "Выпуски рассылки" с переданным {id}
DELETE /api/v1.1/maillist_fascicles/{id}/
Связанные элементы
Получить "Выпуски рассылки, файлы" у "Выпуски рассылки" с идентификатором {id}
GET /api/v1.1/maillist_fascicles/{id}/maillist_fascicle_files/
Получить "Трекинг выпуска рассылки" у "Выпуски рассылки" с идентификатором {id}
GET /api/v1.1/maillist_fascicles/{id}/maillist_fascicle_logs/
Группы подписчиков рассылки
Получить "Группы подписчиков рассылки"
GET /api/v1.1/maillist_siteuser_groups/
Фильтрация "Группы подписчиков рассылки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/maillist_siteuser_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_group_id |
int |
|
|
| maillist_id |
int |
|
|
Создать "Группы подписчиков рассылки"
POST /api/v1.1/maillist_siteuser_groups/
Обновить "Группы подписчиков рассылки" с идентификатором {id}
PUT /api/v1.1/maillist_siteuser_groups/{id}/
{"siteuser_group_id": 1, "maillist_id": 1, ...}
Удалить "Группы подписчиков рассылки" с переданным {id}
DELETE /api/v1.1/maillist_siteuser_groups/{id}/
Подписчики рассылки
Получить "Подписчики рассылки"
GET /api/v1.1/maillist_siteusers/
Фильтрация "Подписчики рассылки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/maillist_siteusers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_id |
int |
|
|
| maillist_id |
int |
|
|
| type |
int |
|
|
Создать "Подписчики рассылки"
POST /api/v1.1/maillist_siteusers/
Обновить "Подписчики рассылки" с идентификатором {id}
PUT /api/v1.1/maillist_siteusers/{id}/
{"siteuser_id": 1, "maillist_id": 1, ...}
Удалить "Подписчики рассылки" с переданным {id}
DELETE /api/v1.1/maillist_siteusers/{id}/
Причины отписки
Получить "Причины отписки"
GET /api/v1.1/maillist_unsubscribe_reasons/
Фильтрация "Причины отписки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/maillist_unsubscribe_reasons/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| maillist_id |
int |
Идентификатор рассылки |
|
| reason |
string |
Причина |
|
| color |
string |
Цвет |
|
| active |
int |
Активность |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Причины отписки"
POST /api/v1.1/maillist_unsubscribe_reasons/
Обновить "Причины отписки" с идентификатором {id}
PUT /api/v1.1/maillist_unsubscribe_reasons/{id}/
{"maillist_id": 1, "reason": "...", ...}
Удалить "Причины отписки" с переданным {id}
DELETE /api/v1.1/maillist_unsubscribe_reasons/{id}/
Связанные элементы
Получить "Отписавшиеся" у "Причины отписки" с идентификатором {id}
GET /api/v1.1/maillist_unsubscribe_reasons/{id}/maillist_unsubscribers/
Отписавшиеся
Получить "Отписавшиеся"
GET /api/v1.1/maillist_unsubscribers/
Фильтрация "Отписавшиеся" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/maillist_unsubscribers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_id |
int |
|
|
| maillist_id |
int |
|
|
| maillist_unsubscribe_reason_id |
int |
|
|
| reason |
string |
|
|
| datetime |
string |
|
|
Создать "Отписавшиеся"
POST /api/v1.1/maillist_unsubscribers/
Обновить "Отписавшиеся" с идентификатором {id}
PUT /api/v1.1/maillist_unsubscribers/{id}/
{"siteuser_id": 1, "maillist_id": 1, ...}
Удалить "Отписавшиеся" с переданным {id}
DELETE /api/v1.1/maillist_unsubscribers/{id}/
Почтовые рассылки
Получить "Почтовые рассылки"
GET /api/v1.1/maillists/
Фильтрация "Почтовые рассылки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/maillists/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название почтовой рассылки |
|
| description |
string |
Описание почтовой рассылки |
|
| email |
string |
E-mail отправителя |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| site_id |
int |
Сайт |
|
| template |
string |
Шаблон рассылки |
|
| author |
string |
Отправитель |
|
| unsubscribe |
int |
Страница для unsubscribe |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Почтовые рассылки"
POST /api/v1.1/maillists/
Обновить "Почтовые рассылки" с идентификатором {id}
PUT /api/v1.1/maillists/{id}/
{"name": "...", "description": "...", ...}
Удалить "Почтовые рассылки" с переданным {id}
DELETE /api/v1.1/maillists/{id}/
Связанные элементы
Получить "Выпуски рассылки" у "Почтовые рассылки" с идентификатором {id}
GET /api/v1.1/maillists/{id}/maillist_fascicles/
Получить "Подписчики рассылки" у "Почтовые рассылки" с идентификатором {id}
GET /api/v1.1/maillists/{id}/maillist_siteusers/
Получить "Клиенты" у "Почтовые рассылки" с идентификатором {id}
GET /api/v1.1/maillists/{id}/siteusers/
Получить "Группы подписчиков рассылки" у "Почтовые рассылки" с идентификатором {id}
GET /api/v1.1/maillists/{id}/maillist_siteuser_groups/
Получить "Причины отписки" у "Почтовые рассылки" с идентификатором {id}
GET /api/v1.1/maillists/{id}/maillist_unsubscribe_reasons/
Проекты
Проекты, вложения
Получить "Проекты, вложения"
GET /api/v1.1/crm_project_attachments/
Фильтрация "Проекты, вложения" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/crm_project_attachments/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| crm_project_id |
int |
Идентификатор проекта |
|
| user_id |
int |
Идентификатор сотрудника |
|
| file_name |
string |
|
|
| file |
string |
|
|
| datetime |
string |
|
|
Создать "Проекты, вложения"
POST /api/v1.1/crm_project_attachments/
Обновить "Проекты, вложения" с идентификатором {id}
PUT /api/v1.1/crm_project_attachments/{id}/
{"crm_project_id": 1, "user_id": 1, ...}
Удалить "Проекты, вложения" с переданным {id}
DELETE /api/v1.1/crm_project_attachments/{id}/
Проекты, заметки
Получить "Проекты, заметки"
GET /api/v1.1/crm_project_crm_notes/
Фильтрация "Проекты, заметки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/crm_project_crm_notes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| crm_note_id |
int |
|
|
| crm_project_id |
int |
|
|
Создать "Проекты, заметки"
POST /api/v1.1/crm_project_crm_notes/
Обновить "Проекты, заметки" с идентификатором {id}
PUT /api/v1.1/crm_project_crm_notes/{id}/
{"crm_note_id": 1, "crm_project_id": 1, ...}
Удалить "Проекты, заметки" с переданным {id}
DELETE /api/v1.1/crm_project_crm_notes/{id}/
Проекты
Получить "Проекты"
GET /api/v1.1/crm_projects/
Фильтрация "Проекты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/crm_projects/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| crm_icon_id |
int |
Иконка |
|
| name |
string |
Назание |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| datetime |
string |
Дата |
|
| deadline |
string |
Выполнить до |
|
| completed |
int |
Завершен |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Проекты"
POST /api/v1.1/crm_projects/
Обновить "Проекты" с идентификатором {id}
PUT /api/v1.1/crm_projects/{id}/
{"site_id": 1, "crm_icon_id": 1, ...}
Удалить "Проекты" с переданным {id}
DELETE /api/v1.1/crm_projects/{id}/
Связанные элементы
Получить "Дела" у "Проекты" с идентификатором {id}
GET /api/v1.1/crm_projects/{id}/events/
Получить "Сделки" у "Проекты" с идентификатором {id}
GET /api/v1.1/crm_projects/{id}/deals/
Получить "Проекты, заметки" у "Проекты" с идентификатором {id}
GET /api/v1.1/crm_projects/{id}/crm_project_crm_notes/
Получить "CRM: Заметки" у "Проекты" с идентификатором {id}
GET /api/v1.1/crm_projects/{id}/crm_notes/
Получить "Проекты, вложения" у "Проекты" с идентификатором {id}
GET /api/v1.1/crm_projects/{id}/crm_project_attachments/
Получить "Документооборот" у "Проекты" с идентификатором {id}
GET /api/v1.1/crm_projects/{id}/dms_documents/
Получить "Дела, проекты" у "Проекты" с идентификатором {id}
GET /api/v1.1/crm_projects/{id}/event_crm_projects/
Рекламные баннеры
Контекстные фразы баннера
Получить "Контекстные фразы баннера"
GET /api/v1.1/advertisement_contextualwords/
Фильтрация "Контекстные фразы баннера" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/advertisement_contextualwords/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| advertisement_id |
int |
|
|
| value |
string |
Контекстная фраза |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Контекстные фразы баннера"
POST /api/v1.1/advertisement_contextualwords/
Обновить "Контекстные фразы баннера" с идентификатором {id}
PUT /api/v1.1/advertisement_contextualwords/{id}/
{"advertisement_id": 1, "value": "...", ...}
Удалить "Контекстные фразы баннера" с переданным {id}
DELETE /api/v1.1/advertisement_contextualwords/{id}/
Рекламные баннеры, список групп
Получить "Рекламные баннеры, список групп"
GET /api/v1.1/advertisement_group_lists/
Фильтрация "Рекламные баннеры, список групп" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/advertisement_group_lists/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| advertisement_group_id |
int |
|
|
| advertisement_id |
int |
|
|
| probability |
int |
|
|
Создать "Рекламные баннеры, список групп"
POST /api/v1.1/advertisement_group_lists/
Обновить "Рекламные баннеры, список групп" с идентификатором {id}
PUT /api/v1.1/advertisement_group_lists/{id}/
{"advertisement_group_id": 1, "advertisement_id": 1, ...}
Удалить "Рекламные баннеры, список групп" с переданным {id}
DELETE /api/v1.1/advertisement_group_lists/{id}/
Рекламные баннеры
Получить "Рекламные баннеры"
GET /api/v1.1/advertisement_groups/
Фильтрация "Рекламные баннеры" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/advertisement_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название группы |
|
| description |
string |
Описание группы |
|
| user_id |
int |
Идентификатор сотрудника |
|
| site_id |
int |
Идентификатор сайта |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Рекламные баннеры"
POST /api/v1.1/advertisement_groups/
Обновить "Рекламные баннеры" с идентификатором {id}
PUT /api/v1.1/advertisement_groups/{id}/
{"name": "...", "description": "...", ...}
Удалить "Рекламные баннеры" с переданным {id}
DELETE /api/v1.1/advertisement_groups/{id}/
Связанные элементы
Получить "Рекламные баннеры, список групп" у "Рекламные баннеры" с идентификатором {id}
GET /api/v1.1/advertisement_groups/{id}/advertisement_group_lists/
Получить "Список баннеров" у "Рекламные баннеры" с идентификатором {id}
GET /api/v1.1/advertisement_groups/{id}/advertisements/
Рекламные баннеры, показы
Получить "Рекламные баннеры, показы"
GET /api/v1.1/advertisement_shows/
Фильтрация "Рекламные баннеры, показы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/advertisement_shows/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| advertisement_id |
int |
|
|
| date |
string |
|
|
| time |
string |
|
|
| click |
int |
|
|
Создать "Рекламные баннеры, показы"
POST /api/v1.1/advertisement_shows/
Обновить "Рекламные баннеры, показы" с идентификатором {id}
PUT /api/v1.1/advertisement_shows/{id}/
{"advertisement_id": 1, "date": "...", ...}
Удалить "Рекламные баннеры, показы" с переданным {id}
DELETE /api/v1.1/advertisement_shows/{id}/
Статистика показа баннера
Получить "Статистика показа баннера"
GET /api/v1.1/advertisement_statistics/
Фильтрация "Статистика показа баннера" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/advertisement_statistics/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| advertisement_id |
int |
|
|
| date |
string |
|
|
| showed |
int |
|
|
| clicks |
int |
|
|
Создать "Статистика показа баннера"
POST /api/v1.1/advertisement_statistics/
Обновить "Статистика показа баннера" с идентификатором {id}
PUT /api/v1.1/advertisement_statistics/{id}/
{"advertisement_id": 1, "date": "...", ...}
Удалить "Статистика показа баннера" с переданным {id}
DELETE /api/v1.1/advertisement_statistics/{id}/
Список баннеров
Получить "Список баннеров"
GET /api/v1.1/advertisements/
Фильтрация "Список баннеров" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/advertisements/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название баннера |
|
| description |
string |
Описание баннера |
|
| type |
int |
Тип баннера |
|
| width |
string |
Ширина баннера |
|
| height |
string |
Высота баннера |
|
| last_date |
string |
|
|
| show_per_day |
int |
Количество показов в день |
|
| showed_today |
int |
Сегодня показано раз |
|
| show_total |
int |
Общее количество показов |
|
| showed |
int |
Показано раз |
|
| popup_structure_id |
int |
Узел структуры |
|
| href |
string |
Ссылка с баннера |
|
| html |
string |
HTML-код баннера |
|
| source |
string |
Файл баннера |
|
| clicks |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| site_id |
int |
Идентификатор сайта |
|
| start_datetime |
string |
Показывать с |
|
| end_datetime |
string |
Показывать по |
|
| structure_id |
int |
Узел структуры |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Список баннеров"
POST /api/v1.1/advertisements/
Обновить "Список баннеров" с идентификатором {id}
PUT /api/v1.1/advertisements/{id}/
{"name": "...", "description": "...", ...}
Удалить "Список баннеров" с переданным {id}
DELETE /api/v1.1/advertisements/{id}/
Связанные элементы
Получить "Контекстные фразы баннера" у "Список баннеров" с идентификатором {id}
GET /api/v1.1/advertisements/{id}/advertisement_contextualwords/
Получить "Статистика показа баннера" у "Список баннеров" с идентификатором {id}
GET /api/v1.1/advertisements/{id}/advertisement_statistics/
Получить "Рекламные баннеры, показы" у "Список баннеров" с идентификатором {id}
GET /api/v1.1/advertisements/{id}/advertisement_shows/
Получить "Рекламные баннеры, список групп" у "Список баннеров" с идентификатором {id}
GET /api/v1.1/advertisements/{id}/advertisement_group_lists/
Получить "Рекламные баннеры" у "Список баннеров" с идентификатором {id}
GET /api/v1.1/advertisements/{id}/advertisement_groups/
Сайты
Домены
Получить "Домены"
GET /api/v1.1/site_aliases/
Фильтрация "Домены" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/site_aliases/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Домен (без http://) |
|
| current |
int |
Основной домен |
|
| redirect |
int |
Редирект |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Домены"
POST /api/v1.1/site_aliases/
Обновить "Домены" с идентификатором {id}
PUT /api/v1.1/site_aliases/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Домены" с переданным {id}
DELETE /api/v1.1/site_aliases/{id}/
Иконки сайта
Получить "Иконки сайта"
GET /api/v1.1/site_favicons/
Фильтрация "Иконки сайта" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/site_favicons/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| site_id |
int |
|
|
| filename |
string |
Файл |
|
| rel |
string |
rel |
|
| type |
string |
|
|
| sizes |
string |
Размер |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Иконки сайта"
POST /api/v1.1/site_favicons/
Обновить "Иконки сайта" с идентификатором {id}
PUT /api/v1.1/site_favicons/{id}/
{"site_id": 1, "filename": "...", ...}
Удалить "Иконки сайта" с переданным {id}
DELETE /api/v1.1/site_favicons/{id}/
Сайты
Получить "Сайты"
GET /api/v1.1/sites/
Фильтрация "Сайты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/sites/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название сайта |
|
| active |
int |
Активность |
|
| coding |
string |
Кодировка |
|
| sorting |
int |
Порядок сортировки |
|
| locale |
string |
Локаль |
|
| timezone |
string |
Часовой пояс |
|
| max_size_load_image |
int |
Максимальный размер малого изображения |
|
| max_size_load_image_big |
int |
Максимальный размер большого изображения |
|
| admin_email |
string |
E-mail |
|
| sender_name |
string |
Имя отправителя |
|
| error_email |
string |
Технический e-mail |
|
| lng |
string |
Язык сайта |
|
| send_attendance_report |
int |
Отправлять ежедневный отчет о посещаемости |
|
| date_format |
string |
Формат даты |
|
| date_time_format |
string |
Формат даты и времени |
|
| error |
string |
Режим вывода ошибок |
|
| error404 |
int |
Страница для "Ошибка 404" (страница не найдена) |
|
| error403 |
int |
Страница для "Ошибка 403" (доступ запрещен) |
|
| error_bot |
int |
Страница для проверки ботов |
|
| robots |
string |
robots.txt |
|
| key |
string |
Лицензионный ключ |
|
| user_id |
int |
Идентификатор сотрудника |
|
| closed |
int |
Страница, отображаемая при отключении сайта |
|
| safe_email |
int |
Защищать e-mail на страницах сайта |
|
| protect |
int |
Защита от атак |
|
| protect_frame |
int |
Защита от фреймов |
|
| protect_frame_exclusions |
string |
Не защищать страницы |
|
| https |
int |
HTTPS |
|
| html_cache_use |
int |
Кэшировать страницы сайта в статичные файлы |
|
| html_cache_with |
string |
Включать страницы в кэш |
|
| html_cache_without |
string |
Не включать страницы в кэш |
|
| css_left |
string |
CSS-стиль для левого оптического выравнивания |
|
| css_right |
string |
CSS-стиль для правого оптического выравнивания |
|
| html_cache_clear_probability |
int |
Число, определяющее вероятность очистки кэша. |
|
| notes |
string |
Заметки |
|
| uploaddir |
string |
Директория для хранения загруженных файлов |
|
| nesting_level |
int |
Уровень вложенности |
|
| ~favicon |
string |
|
|
| csp |
string |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Сайты"
POST /api/v1.1/sites/
Обновить "Сайты" с идентификатором {id}
PUT /api/v1.1/sites/{id}/
{"name": "...", "active": 1, ...}
Удалить "Сайты" с переданным {id}
DELETE /api/v1.1/sites/{id}/
Связанные элементы
Получить "AI" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/ais/
Получить "Промпты" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/ai_prompts/
Получить "Разделы промптов" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/ai_prompt_dirs/
Получить "Партнерские программы" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/affiliate_plans/
Получить "Список баннеров" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/advertisements/
Получить "Рекламные баннеры" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/advertisement_groups/
Получить "Оценка производительности" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/benchmarks/
Получить "Облачные хранилища" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/clouds/
Получить "Доступы для группы" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/company_department_action_accesses/
Получить "Доступ к модулям сайта" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/company_department_modules/
Получить "Компании, сайты" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/company_sites/
Получить "Компании" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/companies/
Получить "Статистика посещаемости" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/counters/
Получить "Статистика посещаемости, браузеры" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/counter_browsers/
Получить "Статистика посещаемости, устройства" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/counter_devices/
Получить "Статистика посещаемости, разрешения экранов" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/counter_displays/
Получить "Популярность страниц" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/counter_pages/
Получить "Статистика посещаемости, переходы" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/counter_referrers/
Получить "Статистика посещаемости, поисковые запросы" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/counter_searchqueries/
Получить "Статистика посещаемости, сессии" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/counter_sessions/
Получить "Статистика посещаемости, useragent" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/counter_useragents/
Получить "Статистика посещаемости, посещения" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/counter_visits/
Получить "Опции CDN" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/cdn_sites/
Получить "Статьи ДДС" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/chartaccount_cashflows/
Получить "Сделки" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/deals/
Получить "Типы сделок" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/deal_templates/
Получить "Страницы и документы" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/documents/
Получить "Разделы документов" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/document_dirs/
Получить "Статусы документов" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/document_statuses/
Получить "Документооборот" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/dms_documents/
Получить "Классы документов" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/dms_classes/
Получить "Архив дел" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/dms_case_archives/
Получить "Уничтожение дел" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/dms_case_destructions/
Получить "Способы связи" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/dms_communications/
Получить "Группы полей" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/dms_field_dirs/
Получить "Состояния" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/dms_states/
Получить "Группа шаблонов резолюций" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/dms_template_instruction_dirs/
Получить "Шаблоны резолюций" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/dms_template_instructions/
Получить "Шаблоны участников" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/dms_participants/
Получить "Раздел шаблонов бизнес-процессов" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/dms_workflow_template_dirs/
Получить "Шаблоны бизнес-процессов" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/dms_workflow_templates/
Получить "Бизнес-процессы" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/dms_workflows/
Получить "Журнал передачи" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/dms_document_transfers/
Получить "Контрольные точки" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/dms_document_checkpoints/
Получить "Пользовательские поля" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/fields/
Получить "Формы" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/forms/
Получить "Форумы" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/forums/
Получить "Службы поддержки" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/helpdesks/
Получить "Информационные системы" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/informationsystems/
Получить "Разделы информационных систем" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/informationsystem_dirs/
Получить "Лиды" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/leads/
Получить "Потребности лидов" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/lead_needs/
Получить "Зрелость лидов" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/lead_maturities/
Получить "Статусы лидов" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/lead_statuses/
Получить "Списки" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/lists/
Получить "Разделы списков" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/list_dirs/
Получить "Почтовые рассылки" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/maillists/
Получить "Форматы" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/media_formats/
Получить "Библиотека файлов, группы" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/media_groups/
Получить "Библиотека файлов, файлы" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/media_items/
Получить "Группы опросов" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/poll_groups/
Получить "Статичные страницы" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/search_links/
Получить "Журнал поисковых запросов" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/search_logs/
Получить "Поисковые системы" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/seo_sites/
Получить "Интернет-магазины" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/shops/
Получить "Разделы интернет-магазинов" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/shop_dirs/
Получить "Короткие ссылки" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/shortlinks/
Получить "Группы коротких ссылок" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/shortlink_dirs/
Получить "Клиенты" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/siteusers/
Получить "Клиенты, дополнительные свойства" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/siteuser_properties/
Получить "Клиенты, группы дополнительных свойств" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/siteuser_property_dirs/
Получить "Группы клиентов" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/siteuser_groups/
Получить "Провайдеры аутентификации" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/siteuser_identity_providers/
Получить "Виды друзей" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/siteuser_relationship_types/
Получить "Домены" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/site_aliases/
Получить "Иконки сайта" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/site_favicons/
Получить "Структура сайта" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/structures/
Получить "Структура, дополнительные свойства" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/structure_properties/
Получить "Структура, группы дополнительных свойств" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/structure_property_dirs/
Получить "Меню сайта" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/structure_menus/
Получить "Макеты сайта" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/templates/
Получить "Раздел макетов" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/template_dirs/
Получить "Телефония" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/telephonies/
Получить "Вебхуки" у "Сайты" с идентификатором {id}
GET /api/v1.1/sites/{id}/webhooks/
Клиенты, неудачные попытки авторизации
Получить "Клиенты, неудачные попытки авторизации"
GET /api/v1.1/siteuser_accessdenieds/
Фильтрация "Клиенты, неудачные попытки авторизации" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_accessdenieds/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| datetime |
string |
|
|
| ip |
string |
|
|
Создать "Клиенты, неудачные попытки авторизации"
POST /api/v1.1/siteuser_accessdenieds/
Обновить "Клиенты, неудачные попытки авторизации" с идентификатором {id}
PUT /api/v1.1/siteuser_accessdenieds/{id}/
{"datetime": "...", "ip": "...", ...}
Удалить "Клиенты, неудачные попытки авторизации" с переданным {id}
DELETE /api/v1.1/siteuser_accessdenieds/{id}/
Привлеченные аффилиатом пользователи
Получить "Привлеченные аффилиатом пользователи"
GET /api/v1.1/siteuser_affiliates/
Фильтрация "Привлеченные аффилиатом пользователи" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_affiliates/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| referral_siteuser_id |
int |
Идентификатор пользователя сайта |
|
| siteuser_id |
int |
Идентификатор клиента |
|
| active |
int |
Активность пользователя |
|
| user_id |
int |
Идентификатор сотрудника |
|
| date |
string |
Дата |
|
Создать "Привлеченные аффилиатом пользователи"
POST /api/v1.1/siteuser_affiliates/
Обновить "Привлеченные аффилиатом пользователи" с идентификатором {id}
PUT /api/v1.1/siteuser_affiliates/{id}/
{"referral_siteuser_id": 1, "siteuser_id": 1, ...}
Удалить "Привлеченные аффилиатом пользователи" с переданным {id}
DELETE /api/v1.1/siteuser_affiliates/{id}/
Компания
Получить "Компания"
GET /api/v1.1/siteuser_companies/
Фильтрация "Компания" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_companies/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| siteuser_id |
int |
Идентификатор клиента |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| tin |
string |
ИНН |
|
| kpp |
string |
КПП |
|
| bic |
string |
БИК |
|
| current_account |
string |
Номер счета |
|
| correspondent_account |
string |
Номер корр. счета |
|
| bank_name |
string |
Название банка |
|
| bank_address |
string |
Адрес банка |
|
| bank_account |
string |
Банковские реквизиты |
|
| image |
string |
Логотип |
|
| headcount |
int |
Число сотрудников |
|
| annual_turnover |
string |
Годовой оборот |
|
| business_area |
string |
Сфера деятельности |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Компания"
POST /api/v1.1/siteuser_companies/
Обновить "Компания" с идентификатором {id}
PUT /api/v1.1/siteuser_companies/{id}/
{"siteuser_id": 1, "name": "...", ...}
Удалить "Компания" с переданным {id}
DELETE /api/v1.1/siteuser_companies/{id}/
Связанные элементы
Получить "Компания клиента, электронная почта" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/siteuser_company_directory_emails/
Получить "Электронные адреса" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/directory_emails/
Получить "Компания клиента, адреса" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/siteuser_company_directory_addresses/
Получить "Адреса" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/directory_addresses/
Получить "Компания клиента, телефон" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/siteuser_company_directory_phones/
Получить "Телефоны" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/directory_phones/
Получить "Компания клиента, мессенджер" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/siteuser_company_directory_messengers/
Получить "Мессенджеры" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/directory_messengers/
Получить "Компания клиента, социальные сети" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/siteuser_company_directory_socials/
Получить "Социальные сети" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/directory_socials/
Получить "Компания клиента, сайты" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/siteuser_company_directory_websites/
Получить "Сайты" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/directory_websites/
Получить "Дела, клиенты" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/event_siteusers/
Получить "Сделки" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/deals/
Получить "Договоры" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/siteuser_company_contracts/
Получить "Заказы поставщикам" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/shop_warehouse_purchaseorders/
Получить "Счета поставщиков" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/shop_warehouse_invoices/
Получить "Приемки товаров" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/shop_warehouse_supplies/
Получить "Возвраты поставщикам" у "Компания" с идентификатором {id}
GET /api/v1.1/siteuser_companies/{id}/shop_warehouse_purchasereturns/
Договоры
Получить "Договоры"
GET /api/v1.1/siteuser_company_contracts/
Фильтрация "Договоры" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_company_contracts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| company_id |
int |
Наша компания |
|
| siteuser_company_id |
int |
Клиент |
|
| type |
int |
Тип |
|
| comission_method |
int |
Способ расчета |
|
| comission_percent |
decimal |
Процент |
|
| number |
string |
Номер |
|
| date |
string |
Дата |
|
| name |
string |
Наименование |
|
| amount |
decimal |
Сумма |
|
| shop_currency_id |
int |
Валюта |
|
| payment_term |
string |
Срок оплаты |
|
| expiration |
string |
Срок действия |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Договоры"
POST /api/v1.1/siteuser_company_contracts/
Обновить "Договоры" с идентификатором {id}
PUT /api/v1.1/siteuser_company_contracts/{id}/
{"company_id": 1, "siteuser_company_id": 1, ...}
Удалить "Договоры" с переданным {id}
DELETE /api/v1.1/siteuser_company_contracts/{id}/
Связанные элементы
Получить "Заказы поставщикам" у "Договоры" с идентификатором {id}
GET /api/v1.1/siteuser_company_contracts/{id}/shop_warehouse_purchaseorders/
Получить "Счета поставщиков" у "Договоры" с идентификатором {id}
GET /api/v1.1/siteuser_company_contracts/{id}/shop_warehouse_invoices/
Получить "Приемки товаров" у "Договоры" с идентификатором {id}
GET /api/v1.1/siteuser_company_contracts/{id}/shop_warehouse_supplies/
Получить "Возвраты поставщикам" у "Договоры" с идентификатором {id}
GET /api/v1.1/siteuser_company_contracts/{id}/shop_warehouse_purchasereturns/
Компания клиента, адреса
Получить "Компания клиента, адреса"
GET /api/v1.1/siteuser_company_directory_addresses/
Фильтрация "Компания клиента, адреса" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_company_directory_addresses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_company_id |
int |
|
|
| directory_address_id |
int |
|
|
Создать "Компания клиента, адреса"
POST /api/v1.1/siteuser_company_directory_addresses/
Обновить "Компания клиента, адреса" с идентификатором {id}
PUT /api/v1.1/siteuser_company_directory_addresses/{id}/
{"siteuser_company_id": 1, "directory_address_id": 1, ...}
Удалить "Компания клиента, адреса" с переданным {id}
DELETE /api/v1.1/siteuser_company_directory_addresses/{id}/
Компания клиента, электронная почта
Получить "Компания клиента, электронная почта"
GET /api/v1.1/siteuser_company_directory_emails/
Фильтрация "Компания клиента, электронная почта" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_company_directory_emails/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_company_id |
int |
|
|
| directory_email_id |
int |
|
|
Создать "Компания клиента, электронная почта"
POST /api/v1.1/siteuser_company_directory_emails/
Обновить "Компания клиента, электронная почта" с идентификатором {id}
PUT /api/v1.1/siteuser_company_directory_emails/{id}/
{"siteuser_company_id": 1, "directory_email_id": 1, ...}
Удалить "Компания клиента, электронная почта" с переданным {id}
DELETE /api/v1.1/siteuser_company_directory_emails/{id}/
Компания клиента, мессенджер
Получить "Компания клиента, мессенджер"
GET /api/v1.1/siteuser_company_directory_messengers/
Фильтрация "Компания клиента, мессенджер" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_company_directory_messengers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_company_id |
int |
|
|
| directory_messenger_id |
int |
|
|
Создать "Компания клиента, мессенджер"
POST /api/v1.1/siteuser_company_directory_messengers/
Обновить "Компания клиента, мессенджер" с идентификатором {id}
PUT /api/v1.1/siteuser_company_directory_messengers/{id}/
{"siteuser_company_id": 1, "directory_messenger_id": 1, ...}
Удалить "Компания клиента, мессенджер" с переданным {id}
DELETE /api/v1.1/siteuser_company_directory_messengers/{id}/
Компания клиента, телефон
Получить "Компания клиента, телефон"
GET /api/v1.1/siteuser_company_directory_phones/
Фильтрация "Компания клиента, телефон" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_company_directory_phones/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_company_id |
int |
|
|
| directory_phone_id |
int |
|
|
Создать "Компания клиента, телефон"
POST /api/v1.1/siteuser_company_directory_phones/
Обновить "Компания клиента, телефон" с идентификатором {id}
PUT /api/v1.1/siteuser_company_directory_phones/{id}/
{"siteuser_company_id": 1, "directory_phone_id": 1, ...}
Удалить "Компания клиента, телефон" с переданным {id}
DELETE /api/v1.1/siteuser_company_directory_phones/{id}/
Компания клиента, социальные сети
Получить "Компания клиента, социальные сети"
GET /api/v1.1/siteuser_company_directory_socials/
Фильтрация "Компания клиента, социальные сети" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_company_directory_socials/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_company_id |
int |
|
|
| directory_social_id |
int |
|
|
Создать "Компания клиента, социальные сети"
POST /api/v1.1/siteuser_company_directory_socials/
Обновить "Компания клиента, социальные сети" с идентификатором {id}
PUT /api/v1.1/siteuser_company_directory_socials/{id}/
{"siteuser_company_id": 1, "directory_social_id": 1, ...}
Удалить "Компания клиента, социальные сети" с переданным {id}
DELETE /api/v1.1/siteuser_company_directory_socials/{id}/
Компания клиента, сайты
Получить "Компания клиента, сайты"
GET /api/v1.1/siteuser_company_directory_websites/
Фильтрация "Компания клиента, сайты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_company_directory_websites/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_company_id |
int |
|
|
| directory_website_id |
int |
|
|
Создать "Компания клиента, сайты"
POST /api/v1.1/siteuser_company_directory_websites/
Обновить "Компания клиента, сайты" с идентификатором {id}
PUT /api/v1.1/siteuser_company_directory_websites/{id}/
{"siteuser_company_id": 1, "directory_website_id": 1, ...}
Удалить "Компания клиента, сайты" с переданным {id}
DELETE /api/v1.1/siteuser_company_directory_websites/{id}/
Клиенты, заметки
Получить "Клиенты, заметки"
GET /api/v1.1/siteuser_crm_notes/
Фильтрация "Клиенты, заметки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_crm_notes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| crm_note_id |
int |
|
|
| siteuser_id |
int |
|
|
Создать "Клиенты, заметки"
POST /api/v1.1/siteuser_crm_notes/
Обновить "Клиенты, заметки" с идентификатором {id}
PUT /api/v1.1/siteuser_crm_notes/{id}/
{"crm_note_id": 1, "siteuser_id": 1, ...}
Удалить "Клиенты, заметки" с переданным {id}
DELETE /api/v1.1/siteuser_crm_notes/{id}/
Клиенты, вложения писем
Получить "Клиенты, вложения писем"
GET /api/v1.1/siteuser_email_attachments/
Фильтрация "Клиенты, вложения писем" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_email_attachments/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_email_id |
int |
|
|
| name |
string |
|
|
| filename |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Клиенты, вложения писем"
POST /api/v1.1/siteuser_email_attachments/
Обновить "Клиенты, вложения писем" с идентификатором {id}
PUT /api/v1.1/siteuser_email_attachments/{id}/
{"siteuser_email_id": 1, "name": "...", ...}
Удалить "Клиенты, вложения писем" с переданным {id}
DELETE /api/v1.1/siteuser_email_attachments/{id}/
Письма
Получить "Письма"
GET /api/v1.1/siteuser_emails/
Фильтрация "Письма" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_emails/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| siteuser_id |
int |
Идентификатор клиента |
|
| email |
string |
Кому |
|
| from |
string |
От |
|
| cc |
string |
Копия (CC) |
|
| bcc |
string |
Скрытая копия (BCC) |
|
| subject |
string |
Тема |
|
| datetime |
string |
Дата |
|
| important |
int |
Важное |
|
| type |
int |
Тип |
|
| text |
string |
Текст |
|
| read |
string |
Прочитано |
|
| guid |
string |
GUID |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Письма"
POST /api/v1.1/siteuser_emails/
Обновить "Письма" с идентификатором {id}
PUT /api/v1.1/siteuser_emails/{id}/
{"siteuser_id": 1, "email": "...", ...}
Удалить "Письма" с переданным {id}
DELETE /api/v1.1/siteuser_emails/{id}/
Связанные элементы
Получить "Клиенты, вложения писем" у "Письма" с идентификатором {id}
GET /api/v1.1/siteuser_emails/{id}/siteuser_email_attachments/
Клиенты, список групп
Получить "Клиенты, список групп"
GET /api/v1.1/siteuser_group_lists/
Фильтрация "Клиенты, список групп" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_group_lists/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_group_id |
int |
|
|
| siteuser_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Клиенты, список групп"
POST /api/v1.1/siteuser_group_lists/
Обновить "Клиенты, список групп" с идентификатором {id}
PUT /api/v1.1/siteuser_group_lists/{id}/
{"siteuser_group_id": 1, "siteuser_id": 1, ...}
Удалить "Клиенты, список групп" с переданным {id}
DELETE /api/v1.1/siteuser_group_lists/{id}/
Группы клиентов
Получить "Группы клиентов"
GET /api/v1.1/siteuser_groups/
Фильтрация "Группы клиентов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Сайт |
|
| name |
string |
Имя группы |
|
| description |
string |
Описание |
|
| default |
int |
Группа по умолчанию |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Группы клиентов"
POST /api/v1.1/siteuser_groups/
Обновить "Группы клиентов" с идентификатором {id}
PUT /api/v1.1/siteuser_groups/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Группы клиентов" с переданным {id}
DELETE /api/v1.1/siteuser_groups/{id}/
Связанные элементы
Получить "Клиенты, список групп" у "Группы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_groups/{id}/siteuser_group_lists/
Получить "Клиенты" у "Группы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_groups/{id}/siteusers/
Получить "Группы подписчиков рассылки" у "Группы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_groups/{id}/maillist_siteuser_groups/
Получить "Группы посетителей категории" у "Группы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_groups/{id}/forum_category_siteuser_groups/
Получить "Группы персональной скидки" у "Группы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_groups/{id}/shop_discount_siteuser_groups/
Получить "Key 'model_name' in 'ru' language does not exist for model 'shop_purchase_discount_siteuser_group'." у "Группы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_groups/{id}/shop_purchase_discount_siteuser_groups/
Получить "Key 'model_name' in 'ru' language does not exist for model 'shop_gift_siteuser_group'." у "Группы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_groups/{id}/shop_gift_siteuser_groups/
Получить "Платежные системы, группы клиентов" у "Группы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_groups/{id}/shop_payment_system_siteuser_groups/
Получить "Типы доставки, группы клиентов" у "Группы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_groups/{id}/shop_delivery_siteuser_groups/
Клиенты, аутентификации провайдеров
Получить "Клиенты, аутентификации провайдеров"
GET /api/v1.1/siteuser_identities/
Фильтрация "Клиенты, аутентификации провайдеров" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_identities/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_identity_provider_id |
int |
|
|
| siteuser_id |
int |
|
|
| identity |
string |
|
|
Создать "Клиенты, аутентификации провайдеров"
POST /api/v1.1/siteuser_identities/
Обновить "Клиенты, аутентификации провайдеров" с идентификатором {id}
PUT /api/v1.1/siteuser_identities/{id}/
{"siteuser_identity_provider_id": 1, "siteuser_id": 1, ...}
Удалить "Клиенты, аутентификации провайдеров" с переданным {id}
DELETE /api/v1.1/siteuser_identities/{id}/
Провайдеры аутентификации
Получить "Провайдеры аутентификации"
GET /api/v1.1/siteuser_identity_providers/
Фильтрация "Провайдеры аутентификации" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_identity_providers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентфикатор провайдера |
|
| site_id |
int |
Идентфикатор сайта |
|
| name |
string |
Название провайдера |
|
| active |
int |
Активность провайдера |
|
| url |
string |
Ссылка провайдера |
|
| image |
string |
Изображение провайдера |
|
| icon |
string |
Иконка |
|
| sorting |
int |
Порядок сортировки |
|
| type |
int |
Тип |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Провайдеры аутентификации"
POST /api/v1.1/siteuser_identity_providers/
Обновить "Провайдеры аутентификации" с идентификатором {id}
PUT /api/v1.1/siteuser_identity_providers/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Провайдеры аутентификации" с переданным {id}
DELETE /api/v1.1/siteuser_identity_providers/{id}/
Связанные элементы
Получить "Клиенты, аутентификации провайдеров" у "Провайдеры аутентификации" с идентификатором {id}
GET /api/v1.1/siteuser_identity_providers/{id}/siteuser_identities/
Представитель клиента (Физическое лицо)
Получить "Представитель клиента (Физическое лицо)"
GET /api/v1.1/siteuser_people/
Фильтрация "Представитель клиента (Физическое лицо)" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_people/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| siteuser_id |
int |
Идентификатор клиента |
|
| name |
string |
Имя |
|
| surname |
string |
Фамилия |
|
| patronymic |
string |
Отчество |
|
| post |
string |
Должность |
|
| birthday |
string |
День рождения |
|
| sex |
int |
Пол |
|
| image |
string |
Фотография |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Представитель клиента (Физическое лицо)"
POST /api/v1.1/siteuser_people/
Обновить "Представитель клиента (Физическое лицо)" с идентификатором {id}
PUT /api/v1.1/siteuser_people/{id}/
{"siteuser_id": 1, "name": "...", ...}
Удалить "Представитель клиента (Физическое лицо)" с переданным {id}
DELETE /api/v1.1/siteuser_people/{id}/
Связанные элементы
Получить "Представитель клиента, адреса" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/siteuser_person_directory_addresses/
Получить "Адреса" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/directory_addresses/
Получить "Представитель клиента, электронная почта" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/siteuser_person_directory_emails/
Получить "Электронные адреса" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/directory_emails/
Получить "Представитель клиента, телефон" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/siteuser_person_directory_phones/
Получить "Телефоны" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/directory_phones/
Получить "Представитель клиента, мессенджер" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/siteuser_person_directory_messengers/
Получить "Мессенджеры" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/directory_messengers/
Получить "Представитель клиента, социальные сети" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/siteuser_person_directory_socials/
Получить "Социальные сети" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/directory_socials/
Получить "Представитель клиента, сайты" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/siteuser_person_directory_websites/
Получить "Сайты" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/directory_websites/
Получить "Дела, клиенты" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/event_siteusers/
Получить "Сделки" у "Представитель клиента (Физическое лицо)" с идентификатором {id}
GET /api/v1.1/siteuser_people/{id}/deals/
Клиенты, дополнительные свойства
Получить "Клиенты, дополнительные свойства"
GET /api/v1.1/siteuser_properties/
Фильтрация "Клиенты, дополнительные свойства" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_properties/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| site_id |
int |
|
|
| property_id |
int |
|
|
Создать "Клиенты, дополнительные свойства"
POST /api/v1.1/siteuser_properties/
Обновить "Клиенты, дополнительные свойства" с идентификатором {id}
PUT /api/v1.1/siteuser_properties/{id}/
{"site_id": 1, "property_id": 1, ...}
Удалить "Клиенты, дополнительные свойства" с переданным {id}
DELETE /api/v1.1/siteuser_properties/{id}/
Клиенты, группы дополнительных свойств
Получить "Клиенты, группы дополнительных свойств"
GET /api/v1.1/siteuser_property_dirs/
Фильтрация "Клиенты, группы дополнительных свойств" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_property_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| site_id |
int |
|
|
| property_dir_id |
int |
|
|
Создать "Клиенты, группы дополнительных свойств"
POST /api/v1.1/siteuser_property_dirs/
Обновить "Клиенты, группы дополнительных свойств" с идентификатором {id}
PUT /api/v1.1/siteuser_property_dirs/{id}/
{"site_id": 1, "property_dir_id": 1, ...}
Удалить "Клиенты, группы дополнительных свойств" с переданным {id}
DELETE /api/v1.1/siteuser_property_dirs/{id}/
Виды друзей
Получить "Виды друзей"
GET /api/v1.1/siteuser_relationship_types/
Фильтрация "Виды друзей" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_relationship_types/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентфикатор |
|
| site_id |
int |
|
|
| name |
string |
Название |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Виды друзей"
POST /api/v1.1/siteuser_relationship_types/
Обновить "Виды друзей" с идентификатором {id}
PUT /api/v1.1/siteuser_relationship_types/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Виды друзей" с переданным {id}
DELETE /api/v1.1/siteuser_relationship_types/{id}/
Связанные элементы
Получить "Клиенты, друзья" у "Виды друзей" с идентификатором {id}
GET /api/v1.1/siteuser_relationship_types/{id}/siteuser_relationships/
Клиенты, друзья
Получить "Клиенты, друзья"
GET /api/v1.1/siteuser_relationships/
Фильтрация "Клиенты, друзья" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_relationships/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_id |
int |
|
|
| recipient_siteuser_id |
int |
|
|
| siteuser_relationship_type_id |
int |
|
|
| read |
int |
|
|
Создать "Клиенты, друзья"
POST /api/v1.1/siteuser_relationships/
Обновить "Клиенты, друзья" с идентификатором {id}
PUT /api/v1.1/siteuser_relationships/{id}/
{"siteuser_id": 1, "recipient_siteuser_id": 1, ...}
Удалить "Клиенты, друзья" с переданным {id}
DELETE /api/v1.1/siteuser_relationships/{id}/
Сессии
Получить "Сессии"
GET /api/v1.1/siteuser_sessions/
Фильтрация "Сессии" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_sessions/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
string |
|
|
| siteuser_id |
int |
|
|
| ip |
string |
|
|
| user_agent |
string |
|
|
| time |
int |
|
|
Создать "Сессии"
POST /api/v1.1/siteuser_sessions/
Обновить "Сессии" с идентификатором {id}
PUT /api/v1.1/siteuser_sessions/{id}/
{"siteuser_id": 1, "ip": "...", ...}
Удалить "Сессии" с переданным {id}
DELETE /api/v1.1/siteuser_sessions/{id}/
Статусы клиентов
Получить "Статусы клиентов"
GET /api/v1.1/siteuser_statuses/
Фильтрация "Статусы клиентов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_statuses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Назание |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Статусы клиентов"
POST /api/v1.1/siteuser_statuses/
Обновить "Статусы клиентов" с идентификатором {id}
PUT /api/v1.1/siteuser_statuses/{id}/
{"name": "...", "description": "...", ...}
Удалить "Статусы клиентов" с переданным {id}
DELETE /api/v1.1/siteuser_statuses/{id}/
Связанные элементы
Получить "Клиенты" у "Статусы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_statuses/{id}/siteusers/
Типы клиентов
Получить "Типы клиентов"
GET /api/v1.1/siteuser_types/
Фильтрация "Типы клиентов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_types/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Назание |
|
| color |
string |
Цвет |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Типы клиентов"
POST /api/v1.1/siteuser_types/
Обновить "Типы клиентов" с идентификатором {id}
PUT /api/v1.1/siteuser_types/{id}/
{"name": "...", "color": "...", ...}
Удалить "Типы клиентов" с переданным {id}
DELETE /api/v1.1/siteuser_types/{id}/
Связанные элементы
Получить "Клиенты" у "Типы клиентов" с идентификатором {id}
GET /api/v1.1/siteuser_types/{id}/siteusers/
Клиенты, сотрудники
Получить "Клиенты, сотрудники"
GET /api/v1.1/siteuser_users/
Фильтрация "Клиенты, сотрудники" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteuser_users/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Клиенты, сотрудники"
POST /api/v1.1/siteuser_users/
Обновить "Клиенты, сотрудники" с идентификатором {id}
PUT /api/v1.1/siteuser_users/{id}/
{"siteuser_id": 1, "user_id": 1, ...}
Удалить "Клиенты, сотрудники" с переданным {id}
DELETE /api/v1.1/siteuser_users/{id}/
Клиенты
Получить "Клиенты"
GET /api/v1.1/siteusers/
Фильтрация "Клиенты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/siteusers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Сайт |
|
| siteuser_type_id |
int |
Тип клиента |
|
| siteuser_status_id |
int |
Статус клиента |
|
| crm_source_id |
int |
Источник |
|
| login |
string |
Логин |
|
| password |
string |
Пароль |
|
| email |
string |
E-mail |
|
| datetime |
string |
Дата регистрации |
|
| ip |
string |
IP-адрес |
|
| guid |
string |
|
|
| active |
int |
Активность |
|
| user_id |
int |
Идентификатор сотрудника |
|
| last_activity |
string |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Клиенты"
POST /api/v1.1/siteusers/
Обновить "Клиенты" с идентификатором {id}
PUT /api/v1.1/siteusers/{id}/
{"site_id": 1, "siteuser_type_id": 1, ...}
Удалить "Клиенты" с переданным {id}
DELETE /api/v1.1/siteusers/{id}/
Связанные элементы
Получить "Группы клиентов" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_groups/
Получить "Клиенты, список групп" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_group_lists/
Получить "Привлеченные аффилиатом пользователи" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_affiliates/
Получить "Клиенты, аутентификации провайдеров" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_identities/
Получить "Интернет-магазин, корзина" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/shop_carts/
Получить "Дисконтные карты" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/shop_discountcards/
Получить "Списки избранного" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/shop_favorite_lists/
Получить "Избранное" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/shop_favorites/
Получить "Заказы магазина" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/shop_orders/
Получить "Транзакции пользователя" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/shop_siteuser_transactions/
Получить "Почтовые рассылки" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/maillists/
Получить "Подписчики рассылки" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/maillist_siteusers/
Получить "Трекинг выпуска рассылки" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/maillist_fascicle_logs/
Получить "Отписавшиеся" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/maillist_unsubscribers/
Получить "Сообщения форума" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/forum_topic_posts/
Получить "Форум, просмотр тем клиентами" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/forum_topic_views/
Получить "Форум, подписчики" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/forum_topic_subscribers/
Получить "Форум, количество клиентов" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/forum_siteuser_counts/
Получить "Инцидент службы поддержки" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/helpdesk_tickets/
Получить "Клиенты, друзья" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_relationships/
Получить "Клиенты" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteusers/
Получить "Представитель клиента (Физическое лицо)" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_people/
Получить "Компания" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_companies/
Получить "Клиенты, сотрудники" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_users/
Получить "Дела" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/events/
Получить "Дела, клиенты" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/event_siteusers/
Получить "Сотрудники" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/users/
Получить "Лиды" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/leads/
Получить "Письма" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_emails/
Получить "Сессии" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_sessions/
Получить "Клиенты, заметки" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/siteuser_crm_notes/
Получить "CRM: Заметки" у "Клиенты" с идентификатором {id}
GET /api/v1.1/siteusers/{id}/crm_notes/
Сделки
Сделки, вложения
Получить "Сделки, вложения"
GET /api/v1.1/deal_attachments/
Фильтрация "Сделки, вложения" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/deal_attachments/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| deal_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| datetime |
string |
|
|
| file_name |
string |
|
|
| file_path |
string |
|
|
| description |
string |
|
|
Создать "Сделки, вложения"
POST /api/v1.1/deal_attachments/
Обновить "Сделки, вложения" с идентификатором {id}
PUT /api/v1.1/deal_attachments/{id}/
{"deal_id": 1, "user_id": 1, ...}
Удалить "Сделки, вложения" с переданным {id}
DELETE /api/v1.1/deal_attachments/{id}/
Сделки, заметки
Получить "Сделки, заметки"
GET /api/v1.1/deal_crm_notes/
Фильтрация "Сделки, заметки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/deal_crm_notes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| crm_note_id |
int |
|
|
| deal_id |
int |
|
|
Создать "Сделки, заметки"
POST /api/v1.1/deal_crm_notes/
Обновить "Сделки, заметки" с идентификатором {id}
PUT /api/v1.1/deal_crm_notes/{id}/
{"crm_note_id": 1, "deal_id": 1, ...}
Удалить "Сделки, заметки" с переданным {id}
DELETE /api/v1.1/deal_crm_notes/{id}/
Сделки, документы
Получить "Сделки, документы"
GET /api/v1.1/deal_dms_documents/
Фильтрация "Сделки, документы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/deal_dms_documents/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| deal_id |
int |
|
|
| dms_document_id |
int |
|
|
Создать "Сделки, документы"
POST /api/v1.1/deal_dms_documents/
Обновить "Сделки, документы" с идентификатором {id}
PUT /api/v1.1/deal_dms_documents/{id}/
{"deal_id": 1, "dms_document_id": 1, ...}
Удалить "Сделки, документы" с переданным {id}
DELETE /api/v1.1/deal_dms_documents/{id}/
Дела в сделках
Получить "Дела в сделках"
GET /api/v1.1/deal_events/
Фильтрация "Дела в сделках" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/deal_events/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| deal_id |
int |
|
|
| event_id |
int |
|
|
Создать "Дела в сделках"
POST /api/v1.1/deal_events/
Обновить "Дела в сделках" с идентификатором {id}
PUT /api/v1.1/deal_events/{id}/
{"deal_id": 1, "event_id": 1, ...}
Удалить "Дела в сделках" с переданным {id}
DELETE /api/v1.1/deal_events/{id}/
Сделки, история
Получить "Сделки, история"
GET /api/v1.1/deal_histories/
Фильтрация "Сделки, история" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/deal_histories/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| deal_id |
int |
|
|
| datetime |
string |
|
|
| text |
string |
|
|
| ip |
string |
|
|
| color |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Сделки, история"
POST /api/v1.1/deal_histories/
Обновить "Сделки, история" с идентификатором {id}
PUT /api/v1.1/deal_histories/{id}/
{"deal_id": 1, "datetime": "...", ...}
Удалить "Сделки, история" с переданным {id}
DELETE /api/v1.1/deal_histories/{id}/
Товары сделки
Получить "Товары сделки"
GET /api/v1.1/deal_shop_items/
Фильтрация "Товары сделки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/deal_shop_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| deal_id |
int |
|
|
| shop_item_id |
int |
Идентификатор товара |
|
| shop_currency_id |
int |
|
|
| name |
string |
Название товара |
|
| quantity |
decimal |
Количество |
|
| price |
decimal |
Цена |
|
| marking |
string |
Артикул |
|
| rate |
decimal |
Налог |
|
| user_id |
int |
Идентификатор сотрудника |
|
| type |
int |
Тип товара |
|
| shop_warehouse_id |
int |
Склад, с которого был списан товар |
|
| datetime |
string |
Дата |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Товары сделки"
POST /api/v1.1/deal_shop_items/
Обновить "Товары сделки" с идентификатором {id}
PUT /api/v1.1/deal_shop_items/{id}/
{"deal_id": 1, "shop_item_id": 1, ...}
Удалить "Товары сделки" с переданным {id}
DELETE /api/v1.1/deal_shop_items/{id}/
Сделки, клиенты
Получить "Сделки, клиенты"
GET /api/v1.1/deal_siteusers/
Фильтрация "Сделки, клиенты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/deal_siteusers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| deal_id |
int |
|
|
| siteuser_company_id |
int |
|
|
| siteuser_person_id |
int |
|
|
Создать "Сделки, клиенты"
POST /api/v1.1/deal_siteusers/
Обновить "Сделки, клиенты" с идентификатором {id}
PUT /api/v1.1/deal_siteusers/{id}/
{"deal_id": 1, "siteuser_company_id": 1, ...}
Удалить "Сделки, клиенты" с переданным {id}
DELETE /api/v1.1/deal_siteusers/{id}/
Сделки, ответственные за выполнение этапа
Получить "Сделки, ответственные за выполнение этапа"
GET /api/v1.1/deal_step_users/
Фильтрация "Сделки, ответственные за выполнение этапа" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/deal_step_users/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| deal_step_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| datetime |
string |
|
|
Создать "Сделки, ответственные за выполнение этапа"
POST /api/v1.1/deal_step_users/
Обновить "Сделки, ответственные за выполнение этапа" с идентификатором {id}
PUT /api/v1.1/deal_step_users/{id}/
{"deal_step_id": 1, "user_id": 1, ...}
Удалить "Сделки, ответственные за выполнение этапа" с переданным {id}
DELETE /api/v1.1/deal_step_users/{id}/
Сделки, этапы
Получить "Сделки, этапы"
GET /api/v1.1/deal_steps/
Фильтрация "Сделки, этапы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/deal_steps/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| deal_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| deal_template_step_id |
int |
|
|
| datetime |
string |
|
|
| comment |
string |
|
|
Создать "Сделки, этапы"
POST /api/v1.1/deal_steps/
Обновить "Сделки, этапы" с идентификатором {id}
PUT /api/v1.1/deal_steps/{id}/
{"deal_id": 1, "user_id": 1, ...}
Удалить "Сделки, этапы" с переданным {id}
DELETE /api/v1.1/deal_steps/{id}/
Связанные элементы
Получить "Сделки, ответственные за выполнение этапа" у "Сделки, этапы" с идентификатором {id}
GET /api/v1.1/deal_steps/{id}/deal_step_users/
Сделки, дополнительные свойства шаблонов
Получить "Сделки, дополнительные свойства шаблонов"
GET /api/v1.1/deal_template_properties/
Фильтрация "Сделки, дополнительные свойства шаблонов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/deal_template_properties/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| deal_template_id |
int |
|
|
| property_id |
int |
|
|
Создать "Сделки, дополнительные свойства шаблонов"
POST /api/v1.1/deal_template_properties/
Обновить "Сделки, дополнительные свойства шаблонов" с идентификатором {id}
PUT /api/v1.1/deal_template_properties/{id}/
{"deal_template_id": 1, "property_id": 1, ...}
Удалить "Сделки, дополнительные свойства шаблонов" с переданным {id}
DELETE /api/v1.1/deal_template_properties/{id}/
Сделки, группы дополнительных свойств шаблонов
Получить "Сделки, группы дополнительных свойств шаблонов"
GET /api/v1.1/deal_template_property_dirs/
Фильтрация "Сделки, группы дополнительных свойств шаблонов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/deal_template_property_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| deal_template_id |
int |
|
|
| property_dir_id |
int |
|
|
Создать "Сделки, группы дополнительных свойств шаблонов"
POST /api/v1.1/deal_template_property_dirs/
Обновить "Сделки, группы дополнительных свойств шаблонов" с идентификатором {id}
PUT /api/v1.1/deal_template_property_dirs/{id}/
{"deal_template_id": 1, "property_dir_id": 1, ...}
Удалить "Сделки, группы дополнительных свойств шаблонов" с переданным {id}
DELETE /api/v1.1/deal_template_property_dirs/{id}/
Сделки, доступ отдела к шаблону
Получить "Сделки, доступ отдела к шаблону"
GET /api/v1.1/deal_template_step_access_departments/
Фильтрация "Сделки, доступ отдела к шаблону" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/deal_template_step_access_departments/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| deal_template_step_id |
int |
|
|
| company_department_id |
int |
|
|
| access |
int |
|
|
Создать "Сделки, доступ отдела к шаблону"
POST /api/v1.1/deal_template_step_access_departments/
Обновить "Сделки, доступ отдела к шаблону" с идентификатором {id}
PUT /api/v1.1/deal_template_step_access_departments/{id}/
{"deal_template_step_id": 1, "company_department_id": 1, ...}
Удалить "Сделки, доступ отдела к шаблону" с переданным {id}
DELETE /api/v1.1/deal_template_step_access_departments/{id}/
Сделки, доступа сотрудника к этапу
Получить "Сделки, доступа сотрудника к этапу"
GET /api/v1.1/deal_template_step_access_users/
Фильтрация "Сделки, доступа сотрудника к этапу" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/deal_template_step_access_users/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| deal_template_step_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| access |
int |
|
|
Создать "Сделки, доступа сотрудника к этапу"
POST /api/v1.1/deal_template_step_access_users/
Обновить "Сделки, доступа сотрудника к этапу" с идентификатором {id}
PUT /api/v1.1/deal_template_step_access_users/{id}/
{"deal_template_step_id": 1, "user_id": 1, ...}
Удалить "Сделки, доступа сотрудника к этапу" с переданным {id}
DELETE /api/v1.1/deal_template_step_access_users/{id}/
Сделки, переход по этапам
Получить "Сделки, переход по этапам"
GET /api/v1.1/deal_template_step_conversions/
Фильтрация "Сделки, переход по этапам" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/deal_template_step_conversions/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| begin_step_id |
int |
|
|
| end_step_id |
int |
|
|
Создать "Сделки, переход по этапам"
POST /api/v1.1/deal_template_step_conversions/
Обновить "Сделки, переход по этапам" с идентификатором {id}
PUT /api/v1.1/deal_template_step_conversions/{id}/
{"begin_step_id": 1, "end_step_id": 1, ...}
Удалить "Сделки, переход по этапам" с переданным {id}
DELETE /api/v1.1/deal_template_step_conversions/{id}/
Этапы сделок
Получить "Этапы сделок"
GET /api/v1.1/deal_template_steps/
Фильтрация "Этапы сделок" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/deal_template_steps/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| deal_template_id |
int |
Идентификатор типа сделок |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок следования |
|
| status |
int |
Статус |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Этапы сделок"
POST /api/v1.1/deal_template_steps/
Обновить "Этапы сделок" с идентификатором {id}
PUT /api/v1.1/deal_template_steps/{id}/
{"deal_template_id": 1, "name": "...", ...}
Удалить "Этапы сделок" с переданным {id}
DELETE /api/v1.1/deal_template_steps/{id}/
Связанные элементы
Получить "Сделки" у "Этапы сделок" с идентификатором {id}
GET /api/v1.1/deal_template_steps/{id}/deals/
Получить "Сделки, этапы" у "Этапы сделок" с идентификатором {id}
GET /api/v1.1/deal_template_steps/{id}/deal_steps/
Получить "Сделки, доступ отдела к шаблону" у "Этапы сделок" с идентификатором {id}
GET /api/v1.1/deal_template_steps/{id}/deal_template_step_access_departments/
Получить "Сделки, доступа сотрудника к этапу" у "Этапы сделок" с идентификатором {id}
GET /api/v1.1/deal_template_steps/{id}/deal_template_step_access_users/
Типы сделок
Получить "Типы сделок"
GET /api/v1.1/deal_templates/
Фильтрация "Типы сделок" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/deal_templates/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| sorting |
int |
Порядок сортировки |
|
| color |
string |
Цвет |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Типы сделок"
POST /api/v1.1/deal_templates/
Обновить "Типы сделок" с идентификатором {id}
PUT /api/v1.1/deal_templates/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Типы сделок" с переданным {id}
DELETE /api/v1.1/deal_templates/{id}/
Связанные элементы
Получить "Сделки" у "Типы сделок" с идентификатором {id}
GET /api/v1.1/deal_templates/{id}/deals/
Получить "Этапы сделок" у "Типы сделок" с идентификатором {id}
GET /api/v1.1/deal_templates/{id}/deal_template_steps/
Получить "Сделки, дополнительные свойства шаблонов" у "Типы сделок" с идентификатором {id}
GET /api/v1.1/deal_templates/{id}/deal_template_properties/
Получить "Сделки, группы дополнительных свойств шаблонов" у "Типы сделок" с идентификатором {id}
GET /api/v1.1/deal_templates/{id}/deal_template_property_dirs/
Сделки
Получить "Сделки"
GET /api/v1.1/deals/
Фильтрация "Сделки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/deals/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| siteuser_id |
int |
Клиент |
|
| company_id |
int |
Компания |
|
| deal_template_id |
int |
Тип сделок |
|
| deal_template_step_id |
int |
|
|
| creator_id |
int |
Создал |
|
| user_id |
int |
Ответственный |
|
| shop_currency_id |
int |
|
|
| shop_id |
int |
Интернет-магазин |
|
| crm_project_id |
int |
Проект |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| start_datetime |
string |
Создано |
|
| end_datetime |
string |
Дата завершения |
|
| deadline |
string |
Завершить до |
|
| perspective |
int |
Перспективность |
|
| amount |
decimal |
Доход |
|
| expenditure |
decimal |
Расход |
|
| site_id |
int |
Идентификатор сайта |
|
| guid |
string |
GUID |
|
| last_modified |
string |
Последнее изменение |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Сделки"
POST /api/v1.1/deals/
Обновить "Сделки" с идентификатором {id}
PUT /api/v1.1/deals/{id}/
{"siteuser_id": 1, "company_id": 1, ...}
Удалить "Сделки" с переданным {id}
DELETE /api/v1.1/deals/{id}/
Связанные элементы
Получить "Сделки, этапы" у "Сделки" с идентификатором {id}
GET /api/v1.1/deals/{id}/deal_steps/
Получить "Дела в сделках" у "Сделки" с идентификатором {id}
GET /api/v1.1/deals/{id}/deal_events/
Получить "Дела" у "Сделки" с идентификатором {id}
GET /api/v1.1/deals/{id}/events/
Получить "Сделки, вложения" у "Сделки" с идентификатором {id}
GET /api/v1.1/deals/{id}/deal_attachments/
Получить "Товары сделки" у "Сделки" с идентификатором {id}
GET /api/v1.1/deals/{id}/deal_shop_items/
Получить "Товары магазина" у "Сделки" с идентификатором {id}
GET /api/v1.1/deals/{id}/shop_items/
Получить "Сделки, клиенты" у "Сделки" с идентификатором {id}
GET /api/v1.1/deals/{id}/deal_siteusers/
Получить "Сделки, история" у "Сделки" с идентификатором {id}
GET /api/v1.1/deals/{id}/deal_histories/
Получить "Сделки, заметки" у "Сделки" с идентификатором {id}
GET /api/v1.1/deals/{id}/deal_crm_notes/
Получить "CRM: Заметки" у "Сделки" с идентификатором {id}
GET /api/v1.1/deals/{id}/crm_notes/
Получить "Документооборот" у "Сделки" с идентификатором {id}
GET /api/v1.1/deals/{id}/dms_documents/
Получить "Сделки, документы" у "Сделки" с идентификатором {id}
GET /api/v1.1/deals/{id}/deal_dms_documents/
Получить "Метки" у "Сделки" с идентификатором {id}
GET /api/v1.1/deals/{id}/tags/
Получить "Key 'model_name' in 'ru' language does not exist for model 'tag_deal'." у "Сделки" с идентификатором {id}
GET /api/v1.1/deals/{id}/tag_deals/
Сертификаты
Типы сертификатов
Получить "Типы сертификатов"
GET /api/v1.1/certificate_types/
Фильтрация "Типы сертификатов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/certificate_types/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| driver |
string |
Драйвер |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Типы сертификатов"
POST /api/v1.1/certificate_types/
Обновить "Типы сертификатов" с идентификатором {id}
PUT /api/v1.1/certificate_types/{id}/
{"name": "...", "driver": "...", ...}
Удалить "Типы сертификатов" с переданным {id}
DELETE /api/v1.1/certificate_types/{id}/
Связанные элементы
Получить "Сертификаты" у "Типы сертификатов" с идентификатором {id}
GET /api/v1.1/certificate_types/{id}/certificates/
Сертификаты
Получить "Сертификаты"
GET /api/v1.1/certificates/
Фильтрация "Сертификаты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/certificates/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| certificate_type_id |
int |
Тип сертификата |
|
| content |
string |
Сертификат |
|
| private_key |
string |
Приватный ключ |
|
| revoked |
int |
Отозван |
|
| user_id |
int |
Сотрудник |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Сертификаты"
POST /api/v1.1/certificates/
Обновить "Сертификаты" с идентификатором {id}
PUT /api/v1.1/certificates/{id}/
{"certificate_type_id": 1, "content": "...", ...}
Удалить "Сертификаты" с переданным {id}
DELETE /api/v1.1/certificates/{id}/
Службы технической поддержки
Электронные адрес службы техподдержки
Получить "Электронные адрес службы техподдержки"
GET /api/v1.1/helpdesk_accounts/
Фильтрация "Электронные адрес службы техподдержки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/helpdesk_accounts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| user_id |
int |
Идентификатор сотрудника |
|
| helpdesk_id |
int |
Идентификатор службы поддержки |
|
| mail_id |
int |
Почтовый адрес |
|
| name |
string |
Название электронного адреса |
|
| delete_messages |
int |
Удалять письма с сервера |
|
| sorting |
int |
Порядок сортировки |
|
| helpdesk_category_id |
int |
Категория тикетов |
|
| active |
int |
Активен |
|
| default |
int |
Использовать для отправки через SMTP |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Электронные адрес службы техподдержки"
POST /api/v1.1/helpdesk_accounts/
Обновить "Электронные адрес службы техподдержки" с идентификатором {id}
PUT /api/v1.1/helpdesk_accounts/{id}/
{"user_id": 1, "helpdesk_id": 1, ...}
Удалить "Электронные адрес службы техподдержки" с переданным {id}
DELETE /api/v1.1/helpdesk_accounts/{id}/
Связанные элементы
Получить "Инцидент службы поддержки" у "Электронные адрес службы техподдержки" с идентификатором {id}
GET /api/v1.1/helpdesk_accounts/{id}/helpdesk_tickets/
Службы поддержки, вложения
Получить "Службы поддержки, вложения"
GET /api/v1.1/helpdesk_attachments/
Фильтрация "Службы поддержки, вложения" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/helpdesk_attachments/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| helpdesk_message_id |
int |
|
|
| file_name |
string |
|
|
| file_path |
string |
|
|
Создать "Службы поддержки, вложения"
POST /api/v1.1/helpdesk_attachments/
Обновить "Службы поддержки, вложения" с идентификатором {id}
PUT /api/v1.1/helpdesk_attachments/{id}/
{"user_id": 1, "helpdesk_message_id": 1, ...}
Удалить "Службы поддержки, вложения" с переданным {id}
DELETE /api/v1.1/helpdesk_attachments/{id}/
Категория службы поддержки
Получить "Категория службы поддержки"
GET /api/v1.1/helpdesk_categories/
Фильтрация "Категория службы поддержки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/helpdesk_categories/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| helpdesk_id |
int |
Идентификатор службы поддержки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| helpdesk_account_id |
int |
E-mail |
|
| parent_id |
int |
Родительская категория |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| image_large |
string |
Изображение |
|
| image_small |
string |
Малое изображение |
|
| image_large_width |
int |
Ширина большого изображения |
|
| image_large_height |
int |
Высота большого изображения |
|
| image_small_width |
int |
Ширина малого изображения |
|
| image_small_height |
int |
Высота малого изображения |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Категория службы поддержки"
POST /api/v1.1/helpdesk_categories/
Обновить "Категория службы поддержки" с идентификатором {id}
PUT /api/v1.1/helpdesk_categories/{id}/
{"helpdesk_id": 1, "user_id": 1, ...}
Удалить "Категория службы поддержки" с переданным {id}
DELETE /api/v1.1/helpdesk_categories/{id}/
Связанные элементы
Получить "Категория службы поддержки" у "Категория службы поддержки" с идентификатором {id}
GET /api/v1.1/helpdesk_categories/{id}/helpdesk_categories/
Получить "Инцидент службы поддержки" у "Категория службы поддержки" с идентификатором {id}
GET /api/v1.1/helpdesk_categories/{id}/helpdesk_tickets/
Получить "Ответственные пользователи для категории" у "Категория службы поддержки" с идентификатором {id}
GET /api/v1.1/helpdesk_categories/{id}/helpdesk_responsible_users/
Получить "Сотрудники" у "Категория службы поддержки" с идентификатором {id}
GET /api/v1.1/helpdesk_categories/{id}/users/
Уровень критичности
Получить "Уровень критичности"
GET /api/v1.1/helpdesk_criticality_levels/
Фильтрация "Уровень критичности" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/helpdesk_criticality_levels/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| user_id |
int |
Идентификатор сотрудника |
|
| helpdesk_id |
int |
Служба поддержки |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| time |
int |
Время ответа (минуты) |
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок сортировки |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Уровень критичности"
POST /api/v1.1/helpdesk_criticality_levels/
Обновить "Уровень критичности" с идентификатором {id}
PUT /api/v1.1/helpdesk_criticality_levels/{id}/
{"user_id": 1, "helpdesk_id": 1, ...}
Удалить "Уровень критичности" с переданным {id}
DELETE /api/v1.1/helpdesk_criticality_levels/{id}/
Связанные элементы
Получить "Службы поддержки" у "Уровень критичности" с идентификатором {id}
GET /api/v1.1/helpdesk_criticality_levels/{id}/helpdesks/
Получить "Инцидент службы поддержки" у "Уровень критичности" с идентификатором {id}
GET /api/v1.1/helpdesk_criticality_levels/{id}/helpdesk_tickets/
Переносы дней
Получить "Переносы дней"
GET /api/v1.1/helpdesk_holidays/
Фильтрация "Переносы дней" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/helpdesk_holidays/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| helpdesk_id |
int |
Идентификатор службы поддержки |
|
| date |
string |
Дата |
|
| week_day |
int |
День недели, по режиму которого будет работать служба поддержки |
|
| holiday |
int |
Выходной |
|
| description |
string |
Описание |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Переносы дней"
POST /api/v1.1/helpdesk_holidays/
Обновить "Переносы дней" с идентификатором {id}
PUT /api/v1.1/helpdesk_holidays/{id}/
{"helpdesk_id": 1, "date": "...", ...}
Удалить "Переносы дней" с переданным {id}
DELETE /api/v1.1/helpdesk_holidays/{id}/
Условие фильтра тикетов
Получить "Условие фильтра тикетов"
GET /api/v1.1/helpdesk_message_filter_conditions/
Фильтрация "Условие фильтра тикетов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/helpdesk_message_filter_conditions/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| helpdesk_message_filter_id |
int |
Идентификатор фильтра |
|
| field |
int |
Поле |
|
| condition |
int |
Условие |
|
| value |
string |
Значение |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Условие фильтра тикетов"
POST /api/v1.1/helpdesk_message_filter_conditions/
Обновить "Условие фильтра тикетов" с идентификатором {id}
PUT /api/v1.1/helpdesk_message_filter_conditions/{id}/
{"helpdesk_message_filter_id": 1, "field": 1, ...}
Удалить "Условие фильтра тикетов" с переданным {id}
DELETE /api/v1.1/helpdesk_message_filter_conditions/{id}/
Фильтр тикетов
Получить "Фильтр тикетов"
GET /api/v1.1/helpdesk_message_filters/
Фильтрация "Фильтр тикетов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/helpdesk_message_filters/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| helpdesk_id |
int |
Идентификатор службы поддержки |
|
| name |
string |
Название |
|
| active |
int |
Активность |
|
| mode |
int |
Режим |
|
| action |
int |
|
|
| helpdesk_category_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Фильтр тикетов"
POST /api/v1.1/helpdesk_message_filters/
Обновить "Фильтр тикетов" с идентификатором {id}
PUT /api/v1.1/helpdesk_message_filters/{id}/
{"helpdesk_id": 1, "name": "...", ...}
Удалить "Фильтр тикетов" с переданным {id}
DELETE /api/v1.1/helpdesk_message_filters/{id}/
Связанные элементы
Получить "Условие фильтра тикетов" у "Фильтр тикетов" с идентификатором {id}
GET /api/v1.1/helpdesk_message_filters/{id}/helpdesk_message_filter_conditions/
Сообщение инцидента
Получить "Сообщение инцидента"
GET /api/v1.1/helpdesk_messages/
Фильтрация "Сообщение инцидента" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/helpdesk_messages/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| helpdesk_ticket_id |
int |
Идентификатор тикета |
|
| helpdesk_status_id |
int |
Статус |
|
| user_id |
int |
Идентификатор сотрудника |
|
| parent_id |
int |
Родительское сообщение |
|
| subject |
string |
Тема |
|
| message |
string |
Текст |
|
| datetime |
string |
Дата |
|
| modification_datetime |
string |
|
|
| responsible_user_id |
int |
Ответственный пользователь |
|
| grade |
int |
Оценка |
|
| responsible_description |
string |
Служебный текст |
|
| processed |
int |
|
|
| sorting |
int |
|
|
| inbox |
int |
Входящее |
|
| type |
int |
|
|
| headers |
string |
Заголовки |
|
| blocked |
string |
|
|
| user_blocked |
int |
|
|
| indexing |
int |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Сообщение инцидента"
POST /api/v1.1/helpdesk_messages/
Обновить "Сообщение инцидента" с идентификатором {id}
PUT /api/v1.1/helpdesk_messages/{id}/
{"helpdesk_ticket_id": 1, "helpdesk_status_id": 1, ...}
Удалить "Сообщение инцидента" с переданным {id}
DELETE /api/v1.1/helpdesk_messages/{id}/
Связанные элементы
Получить "Службы поддержки, вложения" у "Сообщение инцидента" с идентификатором {id}
GET /api/v1.1/helpdesk_messages/{id}/helpdesk_attachments/
Получить "Сообщение инцидента" у "Сообщение инцидента" с идентификатором {id}
GET /api/v1.1/helpdesk_messages/{id}/helpdesk_messages/
Ответственные пользователи для категории
Получить "Ответственные пользователи для категории"
GET /api/v1.1/helpdesk_responsible_users/
Фильтрация "Ответственные пользователи для категории" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/helpdesk_responsible_users/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| helpdesk_category_id |
int |
Категория инцидентов |
|
| responsible_user_id |
int |
Ответственный пользователь |
|
| helpdesk_id |
int |
Идентификатор службы поддержки |
|
Создать "Ответственные пользователи для категории"
POST /api/v1.1/helpdesk_responsible_users/
Обновить "Ответственные пользователи для категории" с идентификатором {id}
PUT /api/v1.1/helpdesk_responsible_users/{id}/
{"user_id": 1, "helpdesk_category_id": 1, ...}
Удалить "Ответственные пользователи для категории" с переданным {id}
DELETE /api/v1.1/helpdesk_responsible_users/{id}/
Категория стандартных ответов
Получить "Категория стандартных ответов"
GET /api/v1.1/helpdesk_standart_answer_dirs/
Фильтрация "Категория стандартных ответов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/helpdesk_standart_answer_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| user_id |
int |
Идентификатор сотрудника |
|
| helpdesk_id |
int |
Идентификатор службы поддержки |
|
| parent_id |
int |
Родительская категория |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| sorting |
int |
Порядок сортировки |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Категория стандартных ответов"
POST /api/v1.1/helpdesk_standart_answer_dirs/
Обновить "Категория стандартных ответов" с идентификатором {id}
PUT /api/v1.1/helpdesk_standart_answer_dirs/{id}/
{"user_id": 1, "helpdesk_id": 1, ...}
Удалить "Категория стандартных ответов" с переданным {id}
DELETE /api/v1.1/helpdesk_standart_answer_dirs/{id}/
Связанные элементы
Получить "Справочник стандартных ответов" у "Категория стандартных ответов" с идентификатором {id}
GET /api/v1.1/helpdesk_standart_answer_dirs/{id}/helpdesk_standart_answers/
Получить "Категория стандартных ответов" у "Категория стандартных ответов" с идентификатором {id}
GET /api/v1.1/helpdesk_standart_answer_dirs/{id}/helpdesk_standart_answer_dirs/
Ключевое слово стандартного ответа
Получить "Ключевое слово стандартного ответа"
GET /api/v1.1/helpdesk_standart_answer_words/
Фильтрация "Ключевое слово стандартного ответа" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/helpdesk_standart_answer_words/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| user_id |
int |
Идентификатор сотрудника |
|
| helpdesk_standart_answer_id |
int |
Идентификатор стандартного ответа |
|
| value |
string |
Ключевое слово или словосочетание |
|
Создать "Ключевое слово стандартного ответа"
POST /api/v1.1/helpdesk_standart_answer_words/
Обновить "Ключевое слово стандартного ответа" с идентификатором {id}
PUT /api/v1.1/helpdesk_standart_answer_words/{id}/
{"user_id": 1, "helpdesk_standart_answer_id": 1, ...}
Удалить "Ключевое слово стандартного ответа" с переданным {id}
DELETE /api/v1.1/helpdesk_standart_answer_words/{id}/
Справочник стандартных ответов
Получить "Справочник стандартных ответов"
GET /api/v1.1/helpdesk_standart_answers/
Фильтрация "Справочник стандартных ответов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/helpdesk_standart_answers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| helpdesk_id |
int |
Идентификатор службы поддержки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| helpdesk_standart_answer_dir_id |
int |
Родительская категория |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| text |
string |
Текст |
|
| answer_user_id |
int |
Автор автоответа |
|
| type |
int |
|
|
| sorting |
int |
Порядок сортировки |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Справочник стандартных ответов"
POST /api/v1.1/helpdesk_standart_answers/
Обновить "Справочник стандартных ответов" с идентификатором {id}
PUT /api/v1.1/helpdesk_standart_answers/{id}/
{"helpdesk_id": 1, "user_id": 1, ...}
Удалить "Справочник стандартных ответов" с переданным {id}
DELETE /api/v1.1/helpdesk_standart_answers/{id}/
Связанные элементы
Получить "Ключевое слово стандартного ответа" у "Справочник стандартных ответов" с идентификатором {id}
GET /api/v1.1/helpdesk_standart_answers/{id}/helpdesk_standart_answer_words/
Статус сообщения
Получить "Статус сообщения"
GET /api/v1.1/helpdesk_statuses/
Фильтрация "Статус сообщения" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/helpdesk_statuses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| user_id |
int |
Идентификатор сотрудника |
|
| helpdesk_id |
int |
Идентификатор службы поддержки |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| sorting |
int |
Порядок сортировки |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Статус сообщения"
POST /api/v1.1/helpdesk_statuses/
Обновить "Статус сообщения" с идентификатором {id}
PUT /api/v1.1/helpdesk_statuses/{id}/
{"user_id": 1, "helpdesk_id": 1, ...}
Удалить "Статус сообщения" с переданным {id}
DELETE /api/v1.1/helpdesk_statuses/{id}/
Связанные элементы
Получить "Сообщение инцидента" у "Статус сообщения" с идентификатором {id}
GET /api/v1.1/helpdesk_statuses/{id}/helpdesk_messages/
Флаг тикета
Получить "Флаг тикета"
GET /api/v1.1/helpdesk_ticket_flags/
Фильтрация "Флаг тикета" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/helpdesk_ticket_flags/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| helpdesk_id |
int |
Идентификатор службы поддержки |
|
| name |
string |
Название |
|
| path |
string |
Изображение |
|
| user_id |
int |
Идентификатор сотрудника |
|
| sorting |
int |
Порядок сортировки |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Флаг тикета"
POST /api/v1.1/helpdesk_ticket_flags/
Обновить "Флаг тикета" с идентификатором {id}
PUT /api/v1.1/helpdesk_ticket_flags/{id}/
{"helpdesk_id": 1, "name": "...", ...}
Удалить "Флаг тикета" с переданным {id}
DELETE /api/v1.1/helpdesk_ticket_flags/{id}/
Связанные элементы
Получить "Инцидент службы поддержки" у "Флаг тикета" с идентификатором {id}
GET /api/v1.1/helpdesk_ticket_flags/{id}/helpdesk_tickets/
Инцидент службы поддержки
Получить "Инцидент службы поддержки"
GET /api/v1.1/helpdesk_tickets/
Фильтрация "Инцидент службы поддержки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/helpdesk_tickets/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| number |
string |
Номер тикета |
|
| user_id |
int |
Идентификатор сотрудника |
|
| helpdesk_criticality_level_id |
int |
Уровень критичности |
|
| helpdesk_category_id |
int |
Родительская категория |
|
| siteuser_id |
int |
Клиент |
|
| helpdesk_id |
int |
Идентификатор службы поддержки |
|
| email |
string |
E-mail пользователя |
|
| helpdesk_account_id |
int |
Электронный адрес |
|
| datetime |
string |
Дата |
|
| notify_change_status |
int |
Уведомлять пользователя о смене статуса сообщения |
|
| send_email |
int |
Отсылать ответы по почте |
|
| open |
int |
Инцидент открыт |
|
| source |
int |
Источник |
|
| deadline |
string |
Примерная дата ответа |
|
| blocked |
string |
|
|
| user_blocked |
int |
|
|
| helpdesk_ticket_flag_id |
int |
|
|
| messages_count |
int |
|
|
| processed_messages_count |
int |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Инцидент службы поддержки"
POST /api/v1.1/helpdesk_tickets/
Обновить "Инцидент службы поддержки" с идентификатором {id}
PUT /api/v1.1/helpdesk_tickets/{id}/
{"number": "...", "user_id": 1, ...}
Удалить "Инцидент службы поддержки" с переданным {id}
DELETE /api/v1.1/helpdesk_tickets/{id}/
Связанные элементы
Получить "Сообщение инцидента" у "Инцидент службы поддержки" с идентификатором {id}
GET /api/v1.1/helpdesk_tickets/{id}/helpdesk_messages/
Шаблоны писем
Получить "Шаблоны писем"
GET /api/v1.1/helpdesk_user_letter_templates/
Фильтрация "Шаблоны писем" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/helpdesk_user_letter_templates/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| helpdesk_id |
int |
Идентификатор службы поддержки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| new_mail |
string |
Шаблон нового письма |
|
| reply |
string |
Шаблон ответа |
|
| type |
int |
|
|
Создать "Шаблоны писем"
POST /api/v1.1/helpdesk_user_letter_templates/
Обновить "Шаблоны писем" с идентификатором {id}
PUT /api/v1.1/helpdesk_user_letter_templates/{id}/
{"helpdesk_id": 1, "user_id": 1, ...}
Удалить "Шаблоны писем" с переданным {id}
DELETE /api/v1.1/helpdesk_user_letter_templates/{id}/
Режим работы
Получить "Режим работы"
GET /api/v1.1/helpdesk_working_hours/
Фильтрация "Режим работы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/helpdesk_working_hours/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| day |
int |
|
|
| hour |
int |
|
|
| helpdesk_id |
int |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Режим работы"
POST /api/v1.1/helpdesk_working_hours/
Обновить "Режим работы" с идентификатором {id}
PUT /api/v1.1/helpdesk_working_hours/{id}/
{"day": 1, "hour": 1, ...}
Удалить "Режим работы" с переданным {id}
DELETE /api/v1.1/helpdesk_working_hours/{id}/
Службы поддержки
Получить "Службы поддержки"
GET /api/v1.1/helpdesks/
Фильтрация "Службы поддержки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/helpdesks/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| user_id |
int |
Идентификатор сотрудника |
|
| helpdesk_category_id |
int |
Категория инцидентов |
|
| helpdesk_status_reply_id |
int |
Статус для отвеченных сообщений |
|
| helpdesk_status_new_id |
int |
Статус для новых сообщений |
|
| helpdesk_criticality_level_id |
int |
Уровень критичности для новых инцидентов |
|
| site_id |
int |
Сайт |
|
| structure_id |
int |
Узел структуры |
|
| helpdesk_account_id |
int |
E-mail для новых тикетов, созданных с сайта |
|
| name |
string |
Название |
|
| notify_change_criticality_level |
int |
Отправлять отчет об изменении уровня критичности тикета |
|
| notify |
int |
Отправлять отчет о получении запроса пользователя |
|
| description |
string |
Описание |
|
| ticket_mask |
string |
Маска формирования имени тикета |
|
| report |
string |
Отчет о получении запроса |
|
| criticality_level_report |
string |
Отчет о смене уровня критичности тикета |
|
| message_number_mask |
string |
Маска формирования имени тикета и номера сообщения |
|
| message_subject_mask |
string |
Маска формирования темы ответа на сообщение |
|
| criticality_level_report_subject |
string |
Тема отчета о смене уровня критичности тикета |
|
| report_subject |
string |
Тема отчета о получении запроса |
|
| autoanswer_subject |
string |
Тема автоответа |
|
| ticket_sorting_field |
int |
Поле сортировки тикетов |
|
| ticket_sorting_direction |
int |
Направление сортировки тикетов |
|
| change_status_report |
string |
Отчет о смене статуса сообщения |
|
| change_status_report_subject |
string |
Тема отчета о смене статуса сообщения |
|
| message_type |
int |
Тип писем |
|
| ticket_block_time |
int |
Время блокирования тикета (минуты) |
|
| ticket_close_time |
int |
Время закрытия тикета (дни) |
|
| message_block_time |
int |
Время блокирования сообщения (минуты) |
|
| delete_attach_in_days |
int |
Удалять старые файлы |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Службы поддержки"
POST /api/v1.1/helpdesks/
Обновить "Службы поддержки" с идентификатором {id}
PUT /api/v1.1/helpdesks/{id}/
{"user_id": 1, "helpdesk_category_id": 1, ...}
Удалить "Службы поддержки" с переданным {id}
DELETE /api/v1.1/helpdesks/{id}/
Связанные элементы
Получить "Категория службы поддержки" у "Службы поддержки" с идентификатором {id}
GET /api/v1.1/helpdesks/{id}/helpdesk_categories/
Получить "Электронные адрес службы техподдержки" у "Службы поддержки" с идентификатором {id}
GET /api/v1.1/helpdesks/{id}/helpdesk_accounts/
Получить "Переносы дней" у "Службы поддержки" с идентификатором {id}
GET /api/v1.1/helpdesks/{id}/helpdesk_holidays/
Получить "Инцидент службы поддержки" у "Службы поддержки" с идентификатором {id}
GET /api/v1.1/helpdesks/{id}/helpdesk_tickets/
Получить "Статус сообщения" у "Службы поддержки" с идентификатором {id}
GET /api/v1.1/helpdesks/{id}/helpdesk_statuses/
Получить "Справочник стандартных ответов" у "Службы поддержки" с идентификатором {id}
GET /api/v1.1/helpdesks/{id}/helpdesk_standart_answers/
Получить "Категория стандартных ответов" у "Службы поддержки" с идентификатором {id}
GET /api/v1.1/helpdesks/{id}/helpdesk_standart_answer_dirs/
Получить "Шаблоны писем" у "Службы поддержки" с идентификатором {id}
GET /api/v1.1/helpdesks/{id}/helpdesk_user_letter_templates/
Получить "Режим работы" у "Службы поддержки" с идентификатором {id}
GET /api/v1.1/helpdesks/{id}/helpdesk_working_hours/
Получить "Уровень критичности" у "Службы поддержки" с идентификатором {id}
GET /api/v1.1/helpdesks/{id}/helpdesk_criticality_levels/
Получить "Ответственные пользователи для категории" у "Службы поддержки" с идентификатором {id}
GET /api/v1.1/helpdesks/{id}/helpdesk_responsible_users/
Получить "Флаг тикета" у "Службы поддержки" с идентификатором {id}
GET /api/v1.1/helpdesks/{id}/helpdesk_ticket_flags/
Получить "Фильтр тикетов" у "Службы поддержки" с идентификатором {id}
GET /api/v1.1/helpdesks/{id}/helpdesk_message_filters/
Сотрудники
Типы
Получить "Типы"
GET /api/v1.1/user_absence_types/
Фильтрация "Типы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/user_absence_types/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| abbr |
string |
Аббревиатура |
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок сортировки |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Типы"
POST /api/v1.1/user_absence_types/
Обновить "Типы" с идентификатором {id}
PUT /api/v1.1/user_absence_types/{id}/
{"name": "...", "abbr": "...", ...}
Удалить "Типы" с переданным {id}
DELETE /api/v1.1/user_absence_types/{id}/
Связанные элементы
Получить "Отсутствия" у "Типы" с идентификатором {id}
GET /api/v1.1/user_absence_types/{id}/user_absences/
Отсутствия
Получить "Отсутствия"
GET /api/v1.1/user_absences/
Фильтрация "Отсутствия" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/user_absences/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| employee_id |
int |
Сотрудник |
|
| user_absence_type_id |
int |
Тип |
|
| reason |
string |
Причина отсутствия |
|
| start |
string |
Начало |
|
| end |
string |
Завершение |
|
| datetime |
string |
Создано |
|
| user_id |
int |
Руководитель |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Отсутствия"
POST /api/v1.1/user_absences/
Обновить "Отсутствия" с идентификатором {id}
PUT /api/v1.1/user_absences/{id}/
{"employee_id": 1, "user_absence_type_id": 1, ...}
Удалить "Отсутствия" с переданным {id}
DELETE /api/v1.1/user_absences/{id}/
Сотрудники, запрещенный доступ
Получить "Сотрудники, запрещенный доступ"
GET /api/v1.1/user_accessdenieds/
Фильтрация "Сотрудники, запрещенный доступ" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/user_accessdenieds/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| datetime |
string |
|
|
| ip |
string |
|
|
Создать "Сотрудники, запрещенный доступ"
POST /api/v1.1/user_accessdenieds/
Обновить "Сотрудники, запрещенный доступ" с идентификатором {id}
PUT /api/v1.1/user_accessdenieds/{id}/
{"datetime": "...", "ip": "...", ...}
Удалить "Сотрудники, запрещенный доступ" с переданным {id}
DELETE /api/v1.1/user_accessdenieds/{id}/
Закладки
Получить "Закладки"
GET /api/v1.1/user_bookmarks/
Фильтрация "Закладки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/user_bookmarks/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| module_id |
int |
|
|
| name |
string |
|
|
| path |
string |
|
|
| sorting |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Закладки"
POST /api/v1.1/user_bookmarks/
Обновить "Закладки" с идентификатором {id}
PUT /api/v1.1/user_bookmarks/{id}/
{"module_id": 1, "name": "...", ...}
Удалить "Закладки" с переданным {id}
DELETE /api/v1.1/user_bookmarks/{id}/
Сотрудники, электронная почта
Получить "Сотрудники, электронная почта"
GET /api/v1.1/user_directory_emails/
Фильтрация "Сотрудники, электронная почта" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/user_directory_emails/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| directory_email_id |
int |
|
|
Создать "Сотрудники, электронная почта"
POST /api/v1.1/user_directory_emails/
Обновить "Сотрудники, электронная почта" с идентификатором {id}
PUT /api/v1.1/user_directory_emails/{id}/
{"user_id": 1, "directory_email_id": 1, ...}
Удалить "Сотрудники, электронная почта" с переданным {id}
DELETE /api/v1.1/user_directory_emails/{id}/
Сотрудники, мессенджеры
Получить "Сотрудники, мессенджеры"
GET /api/v1.1/user_directory_messengers/
Фильтрация "Сотрудники, мессенджеры" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/user_directory_messengers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| directory_messenger_id |
int |
|
|
Создать "Сотрудники, мессенджеры"
POST /api/v1.1/user_directory_messengers/
Обновить "Сотрудники, мессенджеры" с идентификатором {id}
PUT /api/v1.1/user_directory_messengers/{id}/
{"user_id": 1, "directory_messenger_id": 1, ...}
Удалить "Сотрудники, мессенджеры" с переданным {id}
DELETE /api/v1.1/user_directory_messengers/{id}/
Сотрудники, телефоны
Получить "Сотрудники, телефоны"
GET /api/v1.1/user_directory_phones/
Фильтрация "Сотрудники, телефоны" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/user_directory_phones/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| directory_phone_id |
int |
|
|
Создать "Сотрудники, телефоны"
POST /api/v1.1/user_directory_phones/
Обновить "Сотрудники, телефоны" с идентификатором {id}
PUT /api/v1.1/user_directory_phones/{id}/
{"user_id": 1, "directory_phone_id": 1, ...}
Удалить "Сотрудники, телефоны" с переданным {id}
DELETE /api/v1.1/user_directory_phones/{id}/
Сотрудники, социальные сети
Получить "Сотрудники, социальные сети"
GET /api/v1.1/user_directory_socials/
Фильтрация "Сотрудники, социальные сети" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/user_directory_socials/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| directory_social_id |
int |
|
|
Создать "Сотрудники, социальные сети"
POST /api/v1.1/user_directory_socials/
Обновить "Сотрудники, социальные сети" с идентификатором {id}
PUT /api/v1.1/user_directory_socials/{id}/
{"user_id": 1, "directory_social_id": 1, ...}
Удалить "Сотрудники, социальные сети" с переданным {id}
DELETE /api/v1.1/user_directory_socials/{id}/
Сотрудники, сайты
Получить "Сотрудники, сайты"
GET /api/v1.1/user_directory_websites/
Фильтрация "Сотрудники, сайты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/user_directory_websites/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| directory_website_id |
int |
|
|
Создать "Сотрудники, сайты"
POST /api/v1.1/user_directory_websites/
Обновить "Сотрудники, сайты" с идентификатором {id}
PUT /api/v1.1/user_directory_websites/{id}/
{"user_id": 1, "directory_website_id": 1, ...}
Удалить "Сотрудники, сайты" с переданным {id}
DELETE /api/v1.1/user_directory_websites/{id}/
Сотрудники, сообщения
Получить "Сотрудники, сообщения"
GET /api/v1.1/user_messages/
Фильтрация "Сотрудники, сообщения" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/user_messages/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| recipient_user_id |
int |
|
|
| datetime |
string |
|
|
| text |
string |
|
|
| read |
int |
|
|
| alert |
int |
|
|
Создать "Сотрудники, сообщения"
POST /api/v1.1/user_messages/
Обновить "Сотрудники, сообщения" с идентификатором {id}
PUT /api/v1.1/user_messages/{id}/
{"user_id": 1, "recipient_user_id": 1, ...}
Удалить "Сотрудники, сообщения" с переданным {id}
DELETE /api/v1.1/user_messages/{id}/
Заметки пользователей
Получить "Заметки пользователей"
GET /api/v1.1/user_notes/
Фильтрация "Заметки пользователей" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/user_notes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| value |
string |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Заметки пользователей"
POST /api/v1.1/user_notes/
Обновить "Заметки пользователей" с идентификатором {id}
PUT /api/v1.1/user_notes/{id}/
{"user_id": 1, "value": "...", ...}
Удалить "Заметки пользователей" с переданным {id}
DELETE /api/v1.1/user_notes/{id}/
Сессии
Получить "Сессии"
GET /api/v1.1/user_sessions/
Фильтрация "Сессии" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/user_sessions/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| ip |
string |
|
|
| user_agent |
string |
|
|
| time |
int |
|
|
Создать "Сессии"
POST /api/v1.1/user_sessions/
Обновить "Сессии" с идентификатором {id}
PUT /api/v1.1/user_sessions/{id}/
{"user_id": 1, "ip": "...", ...}
Удалить "Сессии" с переданным {id}
DELETE /api/v1.1/user_sessions/{id}/
Сотрудники, настройки
Получить "Сотрудники, настройки"
GET /api/v1.1/user_settings/
Фильтрация "Сотрудники, настройки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/user_settings/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| status |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| module_id |
int |
|
|
| type |
int |
|
|
| entity_id |
int |
|
|
| active |
int |
|
|
Создать "Сотрудники, настройки"
POST /api/v1.1/user_settings/
Обновить "Сотрудники, настройки" с идентификатором {id}
PUT /api/v1.1/user_settings/{id}/
{"status": 1, "user_id": 1, ...}
Удалить "Сотрудники, настройки" с переданным {id}
DELETE /api/v1.1/user_settings/{id}/
Обои
Получить "Обои"
GET /api/v1.1/user_wallpapers/
Фильтрация "Обои" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/user_wallpapers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| image_large |
string |
|
|
| image_small |
string |
|
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Обои"
POST /api/v1.1/user_wallpapers/
Обновить "Обои" с идентификатором {id}
PUT /api/v1.1/user_wallpapers/{id}/
{"name": "...", "image_large": "...", ...}
Удалить "Обои" с переданным {id}
DELETE /api/v1.1/user_wallpapers/{id}/
Сотрудники, веб-аутентификация
Получить "Сотрудники, веб-аутентификация"
GET /api/v1.1/user_webauthns/
Фильтрация "Сотрудники, веб-аутентификация" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/user_webauthns/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| credential_id |
string |
|
|
| credential_public_key |
string |
|
|
| signature_counter |
int |
|
|
| ip |
string |
|
|
| user_agent |
string |
|
|
| datetime |
string |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Сотрудники, веб-аутентификация"
POST /api/v1.1/user_webauthns/
Обновить "Сотрудники, веб-аутентификация" с идентификатором {id}
PUT /api/v1.1/user_webauthns/{id}/
{"user_id": 1, "credential_id": "...", ...}
Удалить "Сотрудники, веб-аутентификация" с переданным {id}
DELETE /api/v1.1/user_webauthns/{id}/
Сотрудники, перерыв
Получить "Сотрудники, перерыв"
GET /api/v1.1/user_workday_breaks/
Фильтрация "Сотрудники, перерыв" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/user_workday_breaks/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| user_workday_id |
int |
|
|
| begin |
string |
|
|
| end |
string |
|
|
Создать "Сотрудники, перерыв"
POST /api/v1.1/user_workday_breaks/
Обновить "Сотрудники, перерыв" с идентификатором {id}
PUT /api/v1.1/user_workday_breaks/{id}/
{"user_workday_id": 1, "begin": "...", ...}
Удалить "Сотрудники, перерыв" с переданным {id}
DELETE /api/v1.1/user_workday_breaks/{id}/
Сотрудники, рабочее время
Получить "Сотрудники, рабочее время"
GET /api/v1.1/user_workdays/
Фильтрация "Сотрудники, рабочее время" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/user_workdays/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| date |
string |
Дата |
|
| begin |
string |
Время начала |
|
| end |
string |
Время завершения |
|
| notify_day_end |
int |
|
|
| notify_day_expired |
int |
|
|
| sent_request |
string |
|
|
| approved |
int |
Подтверждено |
|
| reason |
string |
Укажите причину |
|
Создать "Сотрудники, рабочее время"
POST /api/v1.1/user_workdays/
Обновить "Сотрудники, рабочее время" с идентификатором {id}
PUT /api/v1.1/user_workdays/{id}/
{"user_id": 1, "date": "...", ...}
Удалить "Сотрудники, рабочее время" с переданным {id}
DELETE /api/v1.1/user_workdays/{id}/
Связанные элементы
Получить "Сотрудники, перерыв" у "Сотрудники, рабочее время" с идентификатором {id}
GET /api/v1.1/user_workdays/{id}/user_workday_breaks/
Режим работы
Получить "Режим работы"
GET /api/v1.1/user_worktimes/
Фильтрация "Режим работы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/user_worktimes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| day |
int |
|
|
| from |
string |
|
|
| to |
string |
|
|
| break_from |
string |
|
|
| break_to |
string |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Режим работы"
POST /api/v1.1/user_worktimes/
Обновить "Режим работы" с идентификатором {id}
PUT /api/v1.1/user_worktimes/{id}/
{"user_id": 1, "day": 1, ...}
Удалить "Режим работы" с переданным {id}
DELETE /api/v1.1/user_worktimes/{id}/
Сотрудники
Получить "Сотрудники"
GET /api/v1.1/users/
Фильтрация "Сотрудники" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/users/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| user_group_id |
int |
|
|
| login |
string |
Логин |
|
| password |
string |
Пароль |
|
| superuser |
int |
Администратор |
|
| settings |
int |
|
|
| name |
string |
Имя |
|
| surname |
string |
Фамилия |
|
| patronymic |
string |
Отчество |
|
| dismissed |
int |
Уволен |
|
| freelance |
int |
Внештатный |
|
| address |
string |
Адрес |
|
| birthday |
string |
День рождения |
|
| description |
string |
Характеристика |
|
| sex |
int |
Пол |
|
| image |
string |
Фотография |
|
| last_activity |
string |
|
|
| guid |
string |
|
|
| active |
int |
Активен |
|
| only_access_my_own |
int |
Доступ только к элементам сотрудника |
|
| read_only |
int |
Только чтение |
|
| sound |
int |
|
|
| root_dir |
string |
Корневая директория для сотрудника |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Сотрудники"
POST /api/v1.1/users/
Обновить "Сотрудники" с идентификатором {id}
PUT /api/v1.1/users/{id}/
{"user_group_id": 1, "login": "...", ...}
Удалить "Сотрудники" с переданным {id}
DELETE /api/v1.1/users/{id}/
Связанные элементы
Получить "Формы центра администрирования, настройки" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/admin_form_settings/
Получить "Формы центра администрирования, автосохранение" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/admin_form_autosaves/
Получить "Формы центра администрирования, настройки полей" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/admin_form_field_settings/
Получить "AI, чаты" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/ai_chats/
Получить "Должности" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/company_posts/
Получить "Структура" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/company_departments/
Получить "Компании, должности отдела" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/company_department_post_users/
Получить "CRM: Заметки" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/crm_notes/
Получить "CRM: Заметки, вложения" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/crm_note_attachments/
Получить "Key 'model_name' in 'ru' language does not exist for model 'crm_note_reaction'." у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/crm_note_reactions/
Получить "Дела" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/events/
Получить "Дела, сотрудники" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/event_users/
Получить "Форумы" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/forums/
Получить "Группы форума" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/forum_groups/
Получить "Группы посетителей категории" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/forum_category_siteuser_groups/
Получить "Категории группы форума" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/forum_categories/
Получить "Темы форума" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/forum_topics/
Получить "Службы поддержки" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/helpdesks/
Получить "Категория службы поддержки" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/helpdesk_categories/
Получить "Службы поддержки, вложения" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/helpdesk_attachments/
Получить "Сообщение инцидента" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/helpdesk_messages/
Получить "Электронные адрес службы техподдержки" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/helpdesk_accounts/
Получить "Переносы дней" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/helpdesk_holidays/
Получить "Инцидент службы поддержки" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/helpdesk_tickets/
Получить "Флаг тикета" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/helpdesk_ticket_flags/
Получить "Статус сообщения" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/helpdesk_statuses/
Получить "Уровень критичности" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/helpdesk_criticality_levels/
Получить "Ответственные пользователи для категории" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/helpdesk_responsible_users/
Получить "Шаблоны писем" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/helpdesk_user_letter_templates/
Получить "Разделы информационных систем" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/informationsystem_dirs/
Получить "Информационные системы" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/informationsystems/
Получить "Сотрудники, электронная почта" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/user_directory_emails/
Получить "Электронные адреса" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/directory_emails/
Получить "Сотрудники, телефоны" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/user_directory_phones/
Получить "Телефоны" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/directory_phones/
Получить "Сотрудники, мессенджеры" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/user_directory_messengers/
Получить "Мессенджеры" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/directory_messengers/
Получить "Сотрудники, социальные сети" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/user_directory_socials/
Получить "Социальные сети" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/directory_socials/
Получить "Сотрудники, сайты" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/user_directory_websites/
Получить "Сайты" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/directory_websites/
Получить "Уведомления, сотрудники" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/notification_users/
Получить "Уведомления, подписчики" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/notification_subscribers/
Получить "Уведомления" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/notifications/
Получить "Сделки" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/deals/
Получить "Сделки, доступа сотрудника к этапу" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/deal_template_step_access_users/
Получить "Сделки, вложения" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/deal_attachments/
Получить "Сделки, ответственные за выполнение этапа" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/deal_step_users/
Получить "Заметки пользователей" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/user_notes/
Получить "Сотрудники, настройки" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/user_settings/
Получить "Сессии" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/user_sessions/
Получить "Сотрудники, сообщения" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/user_messages/
Получить "Сотрудники, веб-аутентификация" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/user_webauthns/
Получить "Клиенты, сотрудники" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/siteuser_users/
Получить "Настройки CalDAV-сервера" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/calendar_caldav_users/
Получить "Закладки" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/user_bookmarks/
Получить "Токены REST API" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/restapi_tokens/
Получить "Режим работы" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/user_worktimes/
Получить "Сотрудники, рабочее время" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/user_workdays/
Получить "Отсутствия" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/user_absences/
Получить "Лиды, этапы" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/lead_steps/
Получить "Вкладки баз данных" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/sql_user_tabs/
Получить "Статьи ДДС" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/chartaccount_cashflows/
Получить "Заказы поставщикам" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/shop_warehouse_purchaseorders/
Получить "Счета поставщиков" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/shop_warehouse_invoices/
Получить "Приемки товаров" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/shop_warehouse_supplies/
Получить "Возвраты поставщикам" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/shop_warehouse_purchasereturns/
Получить "Телефония" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/telephonies/
Получить "Линии" у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/telephony_lines/
Получить "Key 'model_name' in 'ru' language does not exist for model 'timeline_user'." у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/timeline_users/
Получить "Key 'model_name' in 'ru' language does not exist for model 'production_process_stage'." у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/production_process_stages/
Получить "Key 'model_name' in 'ru' language does not exist for model 'production_task_process_plan_stage_user'." у "Сотрудники" с идентификатором {id}
GET /api/v1.1/users/{id}/production_task_process_plan_stage_users/
Списки
Разделы списков
Получить "Разделы списков"
GET /api/v1.1/list_dirs/
Фильтрация "Разделы списков" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/list_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
|
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| site_id |
int |
Код сайта |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Разделы списков"
POST /api/v1.1/list_dirs/
Обновить "Разделы списков" с идентификатором {id}
PUT /api/v1.1/list_dirs/{id}/
{"parent_id": 1, "name": "...", ...}
Удалить "Разделы списков" с переданным {id}
DELETE /api/v1.1/list_dirs/{id}/
Связанные элементы
Получить "Списки" у "Разделы списков" с идентификатором {id}
GET /api/v1.1/list_dirs/{id}/lists/
Получить "Разделы списков" у "Разделы списков" с идентификатором {id}
GET /api/v1.1/list_dirs/{id}/list_dirs/
Элементы списков
Получить "Элементы списков"
GET /api/v1.1/list_items/
Фильтрация "Элементы списков" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/list_items/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| list_id |
int |
Код списка |
|
| parent_id |
int |
Родительский элемент |
|
| value |
string |
Значение элемента списка |
|
| path |
string |
Путь |
|
| sorting |
int |
Порядок сортировки |
|
| description |
string |
Описание элемента списка |
|
| color |
string |
Цвет |
|
| icon |
string |
Иконка |
|
| image_large |
string |
Изображение |
|
| image_small |
string |
Малое изображение |
|
| image_small_height |
int |
|
|
| image_small_width |
int |
|
|
| image_large_height |
int |
|
|
| image_large_width |
int |
|
|
| active |
int |
Активен |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Элементы списков"
POST /api/v1.1/list_items/
Обновить "Элементы списков" с идентификатором {id}
PUT /api/v1.1/list_items/{id}/
{"list_id": 1, "parent_id": 1, ...}
Удалить "Элементы списков" с переданным {id}
DELETE /api/v1.1/list_items/{id}/
Связанные элементы
Получить "Элементы списков" у "Элементы списков" с идентификатором {id}
GET /api/v1.1/list_items/{id}/list_items/
Списки
Получить "Списки"
GET /api/v1.1/lists/
Фильтрация "Списки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/lists/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| list_dir_id |
int |
|
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| url_type |
int |
Тип формирования URL |
|
| change_filename |
int |
Изменять названия загружаемых файлов |
|
| image_small_max_width |
int |
Максимальная ширина малого изображения |
|
| image_small_max_height |
int |
Максимальная высота малого изображения |
|
| image_large_max_width |
int |
Максимальная ширина большого изображения |
|
| image_large_max_height |
int |
Максимальная высота большого изображения |
|
| preserve_aspect_ratio |
int |
Сохранять пропорции большого изображения |
|
| preserve_aspect_ratio_small |
int |
Сохранять пропорции малого изображения |
|
| create_small_image |
int |
Создавать малое изображение из большого |
|
| user_id |
int |
Идентификатор сотрудника |
|
| site_id |
int |
Сайт |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Списки"
POST /api/v1.1/lists/
Обновить "Списки" с идентификатором {id}
PUT /api/v1.1/lists/{id}/
{"list_dir_id": 1, "name": "...", ...}
Удалить "Списки" с переданным {id}
DELETE /api/v1.1/lists/{id}/
Связанные элементы
Получить "Элементы списков" у "Списки" с идентификатором {id}
GET /api/v1.1/lists/{id}/list_items/
Статистика посещаемости
Статистика посещаемости, браузеры
Получить "Статистика посещаемости, браузеры"
GET /api/v1.1/counter_browsers/
Фильтрация "Статистика посещаемости, браузеры" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/counter_browsers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| site_id |
int |
|
|
| date |
string |
|
|
| browser |
string |
|
|
| count |
int |
|
|
Создать "Статистика посещаемости, браузеры"
POST /api/v1.1/counter_browsers/
Обновить "Статистика посещаемости, браузеры" с идентификатором {id}
PUT /api/v1.1/counter_browsers/{id}/
{"site_id": 1, "date": "...", ...}
Удалить "Статистика посещаемости, браузеры" с переданным {id}
DELETE /api/v1.1/counter_browsers/{id}/
Статистика посещаемости, устройства
Получить "Статистика посещаемости, устройства"
GET /api/v1.1/counter_devices/
Фильтрация "Статистика посещаемости, устройства" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/counter_devices/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| site_id |
int |
|
|
| date |
string |
|
|
| device |
int |
|
|
| count |
int |
|
|
Создать "Статистика посещаемости, устройства"
POST /api/v1.1/counter_devices/
Обновить "Статистика посещаемости, устройства" с идентификатором {id}
PUT /api/v1.1/counter_devices/{id}/
{"site_id": 1, "date": "...", ...}
Удалить "Статистика посещаемости, устройства" с переданным {id}
DELETE /api/v1.1/counter_devices/{id}/
Статистика посещаемости, разрешения экранов
Получить "Статистика посещаемости, разрешения экранов"
GET /api/v1.1/counter_displays/
Фильтрация "Статистика посещаемости, разрешения экранов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/counter_displays/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| site_id |
int |
|
|
| date |
string |
|
|
| display |
string |
|
|
| count |
int |
|
|
Создать "Статистика посещаемости, разрешения экранов"
POST /api/v1.1/counter_displays/
Обновить "Статистика посещаемости, разрешения экранов" с идентификатором {id}
PUT /api/v1.1/counter_displays/{id}/
{"site_id": 1, "date": "...", ...}
Удалить "Статистика посещаемости, разрешения экранов" с переданным {id}
DELETE /api/v1.1/counter_displays/{id}/
Популярность страниц
Получить "Популярность страниц"
GET /api/v1.1/counter_pages/
Фильтрация "Популярность страниц" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/counter_pages/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| site_id |
int |
|
|
| date |
string |
|
|
| page |
string |
|
|
| count |
int |
|
|
Создать "Популярность страниц"
POST /api/v1.1/counter_pages/
Обновить "Популярность страниц" с идентификатором {id}
PUT /api/v1.1/counter_pages/{id}/
{"site_id": 1, "date": "...", ...}
Удалить "Популярность страниц" с переданным {id}
DELETE /api/v1.1/counter_pages/{id}/
Статистика посещаемости, переходы
Получить "Статистика посещаемости, переходы"
GET /api/v1.1/counter_referrers/
Фильтрация "Статистика посещаемости, переходы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/counter_referrers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| site_id |
int |
|
|
| date |
string |
|
|
| referrer |
string |
|
|
| inner |
int |
|
|
| count |
int |
|
|
Создать "Статистика посещаемости, переходы"
POST /api/v1.1/counter_referrers/
Обновить "Статистика посещаемости, переходы" с идентификатором {id}
PUT /api/v1.1/counter_referrers/{id}/
{"site_id": 1, "date": "...", ...}
Удалить "Статистика посещаемости, переходы" с переданным {id}
DELETE /api/v1.1/counter_referrers/{id}/
Статистика посещаемости, поисковые запросы
Получить "Статистика посещаемости, поисковые запросы"
GET /api/v1.1/counter_searchqueries/
Фильтрация "Статистика посещаемости, поисковые запросы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/counter_searchqueries/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| site_id |
int |
|
|
| date |
string |
|
|
| searchquery |
string |
|
|
| searchsystem |
string |
|
|
| count |
int |
|
|
Создать "Статистика посещаемости, поисковые запросы"
POST /api/v1.1/counter_searchqueries/
Обновить "Статистика посещаемости, поисковые запросы" с идентификатором {id}
PUT /api/v1.1/counter_searchqueries/{id}/
{"site_id": 1, "date": "...", ...}
Удалить "Статистика посещаемости, поисковые запросы" с переданным {id}
DELETE /api/v1.1/counter_searchqueries/{id}/
Статистика посещаемости, сессии
Получить "Статистика посещаемости, сессии"
GET /api/v1.1/counter_sessions/
Фильтрация "Статистика посещаемости, сессии" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/counter_sessions/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| site_id |
int |
|
|
| counter_display_id |
int |
|
|
| counter_useragent_id |
int |
|
|
| counter_os_id |
int |
|
|
| counter_browser_id |
int |
|
|
| counter_device_id |
int |
|
|
| tag |
string |
|
|
| last_active |
string |
|
|
Создать "Статистика посещаемости, сессии"
POST /api/v1.1/counter_sessions/
Обновить "Статистика посещаемости, сессии" с идентификатором {id}
PUT /api/v1.1/counter_sessions/{id}/
{"site_id": 1, "counter_display_id": 1, ...}
Удалить "Статистика посещаемости, сессии" с переданным {id}
DELETE /api/v1.1/counter_sessions/{id}/
Связанные элементы
Получить "Популярность страниц" у "Статистика посещаемости, сессии" с идентификатором {id}
GET /api/v1.1/counter_sessions/{id}/counter_pages/
Получить "Статистика посещаемости, посещения" у "Статистика посещаемости, сессии" с идентификатором {id}
GET /api/v1.1/counter_sessions/{id}/counter_visits/
Статистика посещаемости, useragent
Получить "Статистика посещаемости, useragent"
GET /api/v1.1/counter_useragents/
Фильтрация "Статистика посещаемости, useragent" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/counter_useragents/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| site_id |
int |
|
|
| date |
string |
|
|
| useragent |
string |
|
|
| count |
int |
|
|
| crawler |
int |
|
|
Создать "Статистика посещаемости, useragent"
POST /api/v1.1/counter_useragents/
Обновить "Статистика посещаемости, useragent" с идентификатором {id}
PUT /api/v1.1/counter_useragents/{id}/
{"site_id": 1, "date": "...", ...}
Удалить "Статистика посещаемости, useragent" с переданным {id}
DELETE /api/v1.1/counter_useragents/{id}/
Статистика посещаемости, посещения
Получить "Статистика посещаемости, посещения"
GET /api/v1.1/counter_visits/
Фильтрация "Статистика посещаемости, посещения" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/counter_visits/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| site_id |
int |
|
|
| datetime |
string |
|
|
| counter_session_id |
int |
|
|
| counter_referrer_id |
int |
|
|
| counter_page_id |
int |
|
|
| counter_searchquery_id |
int |
|
|
| new_user |
int |
|
|
| ip |
string |
|
|
| host |
string |
|
|
| lng |
string |
|
|
| siteuser_id |
int |
|
|
Создать "Статистика посещаемости, посещения"
POST /api/v1.1/counter_visits/
Обновить "Статистика посещаемости, посещения" с идентификатором {id}
PUT /api/v1.1/counter_visits/{id}/
{"site_id": 1, "datetime": "...", ...}
Удалить "Статистика посещаемости, посещения" с переданным {id}
DELETE /api/v1.1/counter_visits/{id}/
Статистика посещаемости
Получить "Статистика посещаемости"
GET /api/v1.1/counters/
Фильтрация "Статистика посещаемости" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/counters/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| date |
string |
|
|
| hits |
int |
Хиты: |
|
| hosts |
int |
Хосты: |
|
| sessions |
int |
Сессии: |
|
| bots |
int |
Поисковые боты: |
|
| new_users |
int |
Новые посетители: |
|
| sent |
int |
|
|
Создать "Статистика посещаемости"
POST /api/v1.1/counters/
Обновить "Статистика посещаемости" с идентификатором {id}
PUT /api/v1.1/counters/{id}/
{"site_id": 1, "date": "...", ...}
Удалить "Статистика посещаемости" с переданным {id}
DELETE /api/v1.1/counters/{id}/
Страницы и документы
Разделы документов
Получить "Разделы документов"
GET /api/v1.1/document_dirs/
Фильтрация "Разделы документов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/document_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Родительский раздел |
|
| name |
string |
Название |
|
| user_id |
int |
Идентификатор сотрудника |
|
| site_id |
int |
Идентификатор сайта |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Разделы документов"
POST /api/v1.1/document_dirs/
Обновить "Разделы документов" с идентификатором {id}
PUT /api/v1.1/document_dirs/{id}/
{"parent_id": 1, "name": "...", ...}
Удалить "Разделы документов" с переданным {id}
DELETE /api/v1.1/document_dirs/{id}/
Связанные элементы
Получить "Разделы документов" у "Разделы документов" с идентификатором {id}
GET /api/v1.1/document_dirs/{id}/document_dirs/
Получить "Страницы и документы" у "Разделы документов" с идентификатором {id}
GET /api/v1.1/document_dirs/{id}/documents/
Статусы документов
Получить "Статусы документов"
GET /api/v1.1/document_statuses/
Фильтрация "Статусы документов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/document_statuses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Сайт |
|
| name |
string |
Название статуса |
|
| description |
string |
Описание статуса |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Статусы документов"
POST /api/v1.1/document_statuses/
Обновить "Статусы документов" с идентификатором {id}
PUT /api/v1.1/document_statuses/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Статусы документов" с переданным {id}
DELETE /api/v1.1/document_statuses/{id}/
Версии документов
Получить "Версии документов"
GET /api/v1.1/document_versions/
Фильтрация "Версии документов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/document_versions/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| document_id |
int |
|
|
| datetime |
string |
|
|
| current |
int |
|
|
| description |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| template_id |
int |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Версии документов"
POST /api/v1.1/document_versions/
Обновить "Версии документов" с идентификатором {id}
PUT /api/v1.1/document_versions/{id}/
{"document_id": 1, "datetime": "...", ...}
Удалить "Версии документов" с переданным {id}
DELETE /api/v1.1/document_versions/{id}/
Страницы и документы
Получить "Страницы и документы"
GET /api/v1.1/documents/
Фильтрация "Страницы и документы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/documents/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| document_dir_id |
int |
Раздел |
|
| document_status_id |
int |
Статус документа |
|
| template_id |
int |
Макет |
|
| name |
string |
Название |
|
| text |
string |
Содержание документа |
|
| datetime |
string |
Дата |
|
| typograph |
int |
|
|
| trailing_punctuation |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| site_id |
int |
Идентификатор сайта |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Страницы и документы"
POST /api/v1.1/documents/
Обновить "Страницы и документы" с идентификатором {id}
PUT /api/v1.1/documents/{id}/
{"document_dir_id": 1, "document_status_id": 1, ...}
Удалить "Страницы и документы" с переданным {id}
DELETE /api/v1.1/documents/{id}/
Структура сайта
Получить "Меню сайта"
GET /api/v1.1/structure_menus/
Фильтрация "Меню сайта" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/structure_menus/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Название |
|
| color |
string |
Цвет |
|
| user_id |
int |
Идентификатор сотрудника |
|
| sorting |
int |
Порядок сортировки |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Меню сайта"
POST /api/v1.1/structure_menus/
Обновить "Меню сайта" с идентификатором {id}
PUT /api/v1.1/structure_menus/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "Меню сайта" с переданным {id}
DELETE /api/v1.1/structure_menus/{id}/
Структура, дополнительные свойства
Получить "Структура, дополнительные свойства"
GET /api/v1.1/structure_properties/
Фильтрация "Структура, дополнительные свойства" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/structure_properties/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| site_id |
int |
|
|
| property_id |
int |
|
|
Создать "Структура, дополнительные свойства"
POST /api/v1.1/structure_properties/
Обновить "Структура, дополнительные свойства" с идентификатором {id}
PUT /api/v1.1/structure_properties/{id}/
{"site_id": 1, "property_id": 1, ...}
Удалить "Структура, дополнительные свойства" с переданным {id}
DELETE /api/v1.1/structure_properties/{id}/
Структура, группы дополнительных свойств
Получить "Структура, группы дополнительных свойств"
GET /api/v1.1/structure_property_dirs/
Фильтрация "Структура, группы дополнительных свойств" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/structure_property_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| site_id |
int |
|
|
| property_dir_id |
int |
|
|
Создать "Структура, группы дополнительных свойств"
POST /api/v1.1/structure_property_dirs/
Обновить "Структура, группы дополнительных свойств" с идентификатором {id}
PUT /api/v1.1/structure_property_dirs/{id}/
{"site_id": 1, "property_dir_id": 1, ...}
Удалить "Структура, группы дополнительных свойств" с переданным {id}
DELETE /api/v1.1/structure_property_dirs/{id}/
Структура сайта
Получить "Структура сайта"
GET /api/v1.1/structures/
Фильтрация "Структура сайта" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/structures/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| structure_menu_id |
int |
Меню |
|
| template_id |
int |
Макет |
|
| site_id |
int |
Идентификатор сайта |
|
| document_id |
int |
Название документа |
|
| lib_id |
int |
Страница |
|
| parent_id |
int |
Родительский раздел |
|
| shortcut_id |
int |
|
|
| options |
string |
|
|
| name |
string |
Название раздела в меню |
|
| seo_title |
string |
Заголовок страницы [Title] |
|
| seo_description |
string |
Описание страницы [Description] |
|
| seo_keywords |
string |
Ключевые слова [Keywords] |
|
| show |
int |
Отображать в меню сайта |
|
| url |
string |
Ссылка на другой файл |
|
| sorting |
int |
Порядок сортировки |
|
| path |
string |
Путь |
|
| type |
int |
Тип раздела |
|
| siteuser_group_id |
int |
Группа клиентов |
|
| https |
int |
Доступ через HTTPS |
|
| active |
int |
Активность страницы |
|
| indexing |
int |
Индексировать |
|
| changefreq |
int |
Частота обновления |
|
| priority |
float |
Приоритет |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Структура сайта"
POST /api/v1.1/structures/
Обновить "Структура сайта" с идентификатором {id}
PUT /api/v1.1/structures/{id}/
{"structure_menu_id": 1, "template_id": 1, ...}
Удалить "Структура сайта" с переданным {id}
DELETE /api/v1.1/structures/{id}/
Связанные элементы
Получить "Структура сайта" у "Структура сайта" с идентификатором {id}
GET /api/v1.1/structures/{id}/structures/
Получить "Библиотека файлов, узлы структуры" у "Структура сайта" с идентификатором {id}
GET /api/v1.1/structures/{id}/media_structures/
Получить "Библиотека файлов, файлы" у "Структура сайта" с идентификатором {id}
GET /api/v1.1/structures/{id}/media_items/
Телефония
Телефония
Получить "Телефония"
GET /api/v1.1/telephonies/
Фильтрация "Телефония" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/telephonies/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| telephony_driver_id |
int |
Драйвер телефонии |
|
| name |
string |
Название |
|
| login |
string |
Логин АТС |
|
| password |
string |
Пароль АТС |
|
| server |
string |
WSS-сервер |
|
| active |
int |
Активность |
|
| settings |
string |
|
|
| sorting |
int |
Порядок сортировки |
|
| guid |
string |
GUID |
|
| create_lead |
int |
Создавать лида |
|
| crm_source_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Телефония"
POST /api/v1.1/telephonies/
Обновить "Телефония" с идентификатором {id}
PUT /api/v1.1/telephonies/{id}/
{"site_id": 1, "telephony_driver_id": 1, ...}
Удалить "Телефония" с переданным {id}
DELETE /api/v1.1/telephonies/{id}/
Связанные элементы
Получить "Линии" у "Телефония" с идентификатором {id}
GET /api/v1.1/telephonies/{id}/telephony_lines/
Драйвер
Получить "Драйвер"
GET /api/v1.1/telephony_drivers/
Фильтрация "Драйвер" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/telephony_drivers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| driver |
string |
Драйвер |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Драйвер"
POST /api/v1.1/telephony_drivers/
Обновить "Драйвер" с идентификатором {id}
PUT /api/v1.1/telephony_drivers/{id}/
{"name": "...", "driver": "...", ...}
Удалить "Драйвер" с переданным {id}
DELETE /api/v1.1/telephony_drivers/{id}/
Связанные элементы
Получить "Телефония" у "Драйвер" с идентификатором {id}
GET /api/v1.1/telephony_drivers/{id}/telephonies/
Линии
Получить "Линии"
GET /api/v1.1/telephony_lines/
Фильтрация "Линии" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/telephony_lines/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| telephony_id |
int |
Телефония |
|
| user_id |
int |
Идентификатор сотрудника |
|
| name |
string |
Название |
|
| login |
string |
Логин |
|
| password |
string |
Пароль |
|
| active |
int |
Активность |
|
| sorting |
int |
Порядок сортировки |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Линии"
POST /api/v1.1/telephony_lines/
Обновить "Линии" с идентификатором {id}
PUT /api/v1.1/telephony_lines/{id}/
{"telephony_id": 1, "user_id": 1, ...}
Удалить "Линии" с переданным {id}
DELETE /api/v1.1/telephony_lines/{id}/
Типовые динамические страницы
Разделы типовых динамических страниц
Получить "Разделы типовых динамических страниц"
GET /api/v1.1/lib_dirs/
Фильтрация "Разделы типовых динамических страниц" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/lib_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Родительский раздел |
|
| name |
string |
Название раздела |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Разделы типовых динамических страниц"
POST /api/v1.1/lib_dirs/
Обновить "Разделы типовых динамических страниц" с идентификатором {id}
PUT /api/v1.1/lib_dirs/{id}/
{"parent_id": 1, "name": "...", ...}
Удалить "Разделы типовых динамических страниц" с переданным {id}
DELETE /api/v1.1/lib_dirs/{id}/
Связанные элементы
Получить "Типовые динамические страницы" у "Разделы типовых динамических страниц" с идентификатором {id}
GET /api/v1.1/lib_dirs/{id}/libs/
Получить "Разделы типовых динамических страниц" у "Разделы типовых динамических страниц" с идентификатором {id}
GET /api/v1.1/lib_dirs/{id}/lib_dirs/
Свойства типовой динамической страницы
Получить "Свойства типовой динамической страницы"
GET /api/v1.1/lib_properties/
Фильтрация "Свойства типовой динамической страницы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/lib_properties/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Родительский параметр |
|
| lib_id |
int |
Идентификатор типовой динамической страницы |
|
| name |
string |
Название параметра |
|
| description |
string |
Описание параметра |
|
| varible_name |
string |
Название переменной |
|
| type |
int |
Тип |
|
| default_value |
string |
Значение по умолчанию |
|
| multivalue |
int |
Множественные значения |
|
| sorting |
int |
Порядок сортировки |
|
| sql_request |
string |
SQL-запрос |
|
| sql_caption_field |
string |
Поле заголовка |
|
| sql_value_field |
string |
Поле значения |
|
| change_filename |
int |
Изменять названия загружаемых файлов |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Свойства типовой динамической страницы"
POST /api/v1.1/lib_properties/
Обновить "Свойства типовой динамической страницы" с идентификатором {id}
PUT /api/v1.1/lib_properties/{id}/
{"parent_id": 1, "lib_id": 1, ...}
Удалить "Свойства типовой динамической страницы" с переданным {id}
DELETE /api/v1.1/lib_properties/{id}/
Связанные элементы
Получить "Свойства типовой динамической страницы" у "Свойства типовой динамической страницы" с идентификатором {id}
GET /api/v1.1/lib_properties/{id}/lib_properties/
Получить "Значения параметров типовой динамической страницы" у "Свойства типовой динамической страницы" с идентификатором {id}
GET /api/v1.1/lib_properties/{id}/lib_property_list_values/
Значения параметров типовой динамической страницы
Получить "Значения параметров типовой динамической страницы"
GET /api/v1.1/lib_property_list_values/
Фильтрация "Значения параметров типовой динамической страницы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/lib_property_list_values/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| lib_property_id |
int |
Идентификатор свойства |
|
| name |
string |
Название |
|
| value |
string |
Значение |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Значения параметров типовой динамической страницы"
POST /api/v1.1/lib_property_list_values/
Обновить "Значения параметров типовой динамической страницы" с идентификатором {id}
PUT /api/v1.1/lib_property_list_values/{id}/
{"lib_property_id": 1, "name": "...", ...}
Удалить "Значения параметров типовой динамической страницы" с переданным {id}
DELETE /api/v1.1/lib_property_list_values/{id}/
Типовые динамические страницы
Получить "Типовые динамические страницы"
GET /api/v1.1/libs/
Фильтрация "Типовые динамические страницы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/libs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| lib_dir_id |
int |
Родительский раздел |
|
| type |
int |
Тип |
|
| name |
string |
Название типовой динамической страницы |
|
| description |
string |
Описание типовой динамической страницы |
|
| file |
string |
Превью |
|
| class |
string |
Атрибут "class" |
|
| style |
string |
Атрибут "style" |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Типовые динамические страницы"
POST /api/v1.1/libs/
Обновить "Типовые динамические страницы" с идентификатором {id}
PUT /api/v1.1/libs/{id}/
{"lib_dir_id": 1, "type": 1, ...}
Удалить "Типовые динамические страницы" с переданным {id}
DELETE /api/v1.1/libs/{id}/
Связанные элементы
Получить "Свойства типовой динамической страницы" у "Типовые динамические страницы" с идентификатором {id}
GET /api/v1.1/libs/{id}/lib_properties/
Получить "Виджеты секции макета сайта" у "Типовые динамические страницы" с идентификатором {id}
GET /api/v1.1/libs/{id}/template_section_libs/
Уведомления
Уведомления, подписчики
Получить "Уведомления, подписчики"
GET /api/v1.1/notification_subscribers/
Фильтрация "Уведомления, подписчики" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/notification_subscribers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| module_id |
int |
|
|
| type |
int |
|
|
| entity_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Уведомления, подписчики"
POST /api/v1.1/notification_subscribers/
Обновить "Уведомления, подписчики" с идентификатором {id}
PUT /api/v1.1/notification_subscribers/{id}/
{"module_id": 1, "type": 1, ...}
Удалить "Уведомления, подписчики" с переданным {id}
DELETE /api/v1.1/notification_subscribers/{id}/
Уведомления, сотрудники
Получить "Уведомления, сотрудники"
GET /api/v1.1/notification_users/
Фильтрация "Уведомления, сотрудники" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/notification_users/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| notification_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| read |
int |
|
|
Создать "Уведомления, сотрудники"
POST /api/v1.1/notification_users/
Обновить "Уведомления, сотрудники" с идентификатором {id}
PUT /api/v1.1/notification_users/{id}/
{"notification_id": 1, "user_id": 1, ...}
Удалить "Уведомления, сотрудники" с переданным {id}
DELETE /api/v1.1/notification_users/{id}/
Уведомления
Получить "Уведомления"
GET /api/v1.1/notifications/
Фильтрация "Уведомления" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/notifications/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| module_id |
int |
|
|
| type |
int |
|
|
| entity_id |
int |
|
|
| title |
string |
|
|
| description |
string |
|
|
| json |
string |
|
|
| datetime |
string |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Уведомления"
POST /api/v1.1/notifications/
Обновить "Уведомления" с идентификатором {id}
PUT /api/v1.1/notifications/{id}/
{"module_id": 1, "type": 1, ...}
Удалить "Уведомления" с переданным {id}
DELETE /api/v1.1/notifications/{id}/
Связанные элементы
Получить "Уведомления, сотрудники" у "Уведомления" с идентификатором {id}
GET /api/v1.1/notifications/{id}/notification_users/
Получить "Сотрудники" у "Уведомления" с идентификатором {id}
GET /api/v1.1/notifications/{id}/users/
Получить "Группа полей"
GET /api/v1.1/form_field_dirs/
Фильтрация "Группа полей" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/form_field_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| form_id |
int |
Идентификатор формы |
|
| parent_id |
int |
Группа |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Группа полей"
POST /api/v1.1/form_field_dirs/
Обновить "Группа полей" с идентификатором {id}
PUT /api/v1.1/form_field_dirs/{id}/
{"form_id": 1, "parent_id": 1, ...}
Удалить "Группа полей" с переданным {id}
DELETE /api/v1.1/form_field_dirs/{id}/
Связанные элементы
Получить "Группа полей" у "Группа полей" с идентификатором {id}
GET /api/v1.1/form_field_dirs/{id}/form_field_dirs/
Получить "Поля формы" у "Группа полей" с идентификатором {id}
GET /api/v1.1/form_field_dirs/{id}/form_fields/
Получить "Поля формы"
GET /api/v1.1/form_fields/
Фильтрация "Поля формы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/form_fields/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| form_id |
int |
Идентификатор формы |
|
| form_field_dir_id |
int |
|
|
| list_id |
int |
Список |
|
| type |
int |
Тип |
|
| size |
int |
Размер |
|
| rows |
int |
Высота |
|
| cols |
int |
Ширина |
|
| checked |
int |
Выбран (атрибут 'selected') |
|
| name |
string |
Название элемента (атрибут 'name') |
|
| placeholder |
string |
Placeholder |
|
| caption |
string |
Текстовое название элемента формы |
|
| default_value |
string |
Значение по умолчанию |
|
| sorting |
int |
Порядок сортировки |
|
| description |
string |
Описание поля формы |
|
| obligatory |
int |
Поле обязательно для заполнения |
|
| active |
int |
Активность |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Поля формы"
POST /api/v1.1/form_fields/
Обновить "Поля формы" с идентификатором {id}
PUT /api/v1.1/form_fields/{id}/
{"form_id": 1, "form_field_dir_id": 1, ...}
Удалить "Поля формы" с переданным {id}
DELETE /api/v1.1/form_fields/{id}/
Связанные элементы
Получить "Формы, поля заполненных форм" у "Поля формы" с идентификатором {id}
GET /api/v1.1/form_fields/{id}/form_fill_fields/
Получить "Формы, соответствие полей лидов" у "Поля формы" с идентификатором {id}
GET /api/v1.1/form_fields/{id}/form_lead_conformities/
Получить "Формы, поля заполненных форм"
GET /api/v1.1/form_fill_fields/
Фильтрация "Формы, поля заполненных форм" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/form_fill_fields/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| form_fill_id |
int |
|
|
| form_field_id |
int |
|
|
| value |
string |
|
|
Создать "Формы, поля заполненных форм"
POST /api/v1.1/form_fill_fields/
Обновить "Формы, поля заполненных форм" с идентификатором {id}
PUT /api/v1.1/form_fill_fields/{id}/
{"form_fill_id": 1, "form_field_id": 1, ...}
Удалить "Формы, поля заполненных форм" с переданным {id}
DELETE /api/v1.1/form_fill_fields/{id}/
Получить "Заполненные формы"
GET /api/v1.1/form_fills/
Фильтрация "Заполненные формы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/form_fills/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| form_id |
int |
Идентификатор формы |
|
| form_status_id |
int |
Статус |
|
| source_id |
int |
Идентификатор URL метки |
|
| ip |
string |
IP |
|
| datetime |
string |
Дата заполнения |
|
| read |
int |
Прочитано |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Заполненные формы"
POST /api/v1.1/form_fills/
Обновить "Заполненные формы" с идентификатором {id}
PUT /api/v1.1/form_fills/{id}/
{"form_id": 1, "form_status_id": 1, ...}
Удалить "Заполненные формы" с переданным {id}
DELETE /api/v1.1/form_fills/{id}/
Связанные элементы
Получить "Формы, поля заполненных форм" у "Заполненные формы" с идентификатором {id}
GET /api/v1.1/form_fills/{id}/form_fill_fields/
Получить "Формы, соответствие полей лидов"
GET /api/v1.1/form_lead_conformities/
Фильтрация "Формы, соответствие полей лидов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/form_lead_conformities/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| form_id |
int |
|
|
| form_field_id |
int |
|
|
| conformity |
string |
|
|
Создать "Формы, соответствие полей лидов"
POST /api/v1.1/form_lead_conformities/
Обновить "Формы, соответствие полей лидов" с идентификатором {id}
PUT /api/v1.1/form_lead_conformities/{id}/
{"form_id": 1, "form_field_id": 1, ...}
Удалить "Формы, соответствие полей лидов" с переданным {id}
DELETE /api/v1.1/form_lead_conformities/{id}/
Получить "Статусы форм"
GET /api/v1.1/form_statuses/
Фильтрация "Статусы форм" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/form_statuses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Статусы форм"
POST /api/v1.1/form_statuses/
Обновить "Статусы форм" с идентификатором {id}
PUT /api/v1.1/form_statuses/{id}/
{"name": "...", "description": "...", ...}
Удалить "Статусы форм" с переданным {id}
DELETE /api/v1.1/form_statuses/{id}/
Связанные элементы
Получить "Формы" у "Статусы форм" с идентификатором {id}
GET /api/v1.1/form_statuses/{id}/forms/
Получить "Формы"
GET /api/v1.1/forms/
Фильтрация "Формы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/forms/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название формы |
|
| email |
string |
E-mail куратора формы |
|
| description |
string |
Описание формы |
|
| button_name |
string |
Имя кнопки (на англ. языке) |
|
| button_value |
string |
Текстовое название |
|
| use_captcha |
int |
Использовать CAPTCHA |
|
| use_antispam |
int |
Использовать антиспам |
|
| csrf |
int |
Использовать CSRF-токен |
|
| csrf_lifetime |
int |
Время жизни CSRF-токена |
|
| create_lead |
int |
Создавать лид |
|
| crm_source_id |
int |
Источник по умолчанию |
|
| user_id |
int |
Идентификатор сотрудника |
|
| email_subject |
string |
Тема письма |
|
| success_text |
string |
Текст сообщения успешной отправки формы |
|
| guid |
string |
GUID |
|
| site_id |
int |
Сайт |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Формы"
POST /api/v1.1/forms/
Обновить "Формы" с идентификатором {id}
PUT /api/v1.1/forms/{id}/
{"name": "...", "email": "...", ...}
Удалить "Формы" с переданным {id}
DELETE /api/v1.1/forms/{id}/
Связанные элементы
Получить "Поля формы" у "Формы" с идентификатором {id}
GET /api/v1.1/forms/{id}/form_fields/
Получить "Группа полей" у "Формы" с идентификатором {id}
GET /api/v1.1/forms/{id}/form_field_dirs/
Получить "Заполненные формы" у "Формы" с идентификатором {id}
GET /api/v1.1/forms/{id}/form_fills/
Получить "Формы, соответствие полей лидов" у "Формы" с идентификатором {id}
GET /api/v1.1/forms/{id}/form_lead_conformities/
Получить "Действия формы центра администрирования, разделы"
GET /api/v1.1/admin_form_action_dirs/
Фильтрация "Действия формы центра администрирования, разделы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/admin_form_action_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор поля формы |
|
| admin_word_id |
int |
|
|
| admin_form_id |
int |
Идентификатор формы центра администрирования |
|
| name |
string |
Название |
|
| icon |
string |
Пиктограмма |
|
| color |
string |
Цвет |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Действия формы центра администрирования, разделы"
POST /api/v1.1/admin_form_action_dirs/
Обновить "Действия формы центра администрирования, разделы" с идентификатором {id}
PUT /api/v1.1/admin_form_action_dirs/{id}/
{"admin_word_id": 1, "admin_form_id": 1, ...}
Удалить "Действия формы центра администрирования, разделы" с переданным {id}
DELETE /api/v1.1/admin_form_action_dirs/{id}/
Связанные элементы
Получить "Действия формы центра администрирования" у "Действия формы центра администрирования, разделы" с идентификатором {id}
GET /api/v1.1/admin_form_action_dirs/{id}/admin_form_actions/
Получить "Действия формы центра администрирования"
GET /api/v1.1/admin_form_actions/
Фильтрация "Действия формы центра администрирования" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/admin_form_actions/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор поля формы |
|
| admin_word_id |
int |
|
|
| admin_form_id |
int |
Идентификатор формы центра администрирования |
|
| admin_form_action_dir_id |
int |
Родительский раздел |
|
| name |
string |
Функция-обработчик |
|
| picture |
string |
Изображение |
|
| icon |
string |
Пиктограмма |
|
| color |
string |
Цвет |
|
| single |
int |
Отображать в списке действий |
|
| group |
int |
Групповая операция |
|
| modal |
int |
Открывать в модальном окне |
|
| new_window |
int |
Открывать в новом окне |
|
| sorting |
int |
Порядок сортировки |
|
| dataset |
int |
Индекс набора данных |
|
| confirm |
int |
Запрашивать подтверждение |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Действия формы центра администрирования"
POST /api/v1.1/admin_form_actions/
Обновить "Действия формы центра администрирования" с идентификатором {id}
PUT /api/v1.1/admin_form_actions/{id}/
{"admin_word_id": 1, "admin_form_id": 1, ...}
Удалить "Действия формы центра администрирования" с переданным {id}
DELETE /api/v1.1/admin_form_actions/{id}/
Связанные элементы
Получить "Доступы для группы" у "Действия формы центра администрирования" с идентификатором {id}
GET /api/v1.1/admin_form_actions/{id}/company_department_action_accesses/
Получить "Формы центра администрирования, автосохранение"
GET /api/v1.1/admin_form_autosaves/
Фильтрация "Формы центра администрирования, автосохранение" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/admin_form_autosaves/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| admin_form_id |
int |
|
|
| dataset |
int |
|
|
| entity_id |
int |
|
|
| json |
string |
|
|
| datetime |
string |
|
|
Создать "Формы центра администрирования, автосохранение"
POST /api/v1.1/admin_form_autosaves/
Обновить "Формы центра администрирования, автосохранение" с идентификатором {id}
PUT /api/v1.1/admin_form_autosaves/{id}/
{"user_id": 1, "admin_form_id": 1, ...}
Удалить "Формы центра администрирования, автосохранение" с переданным {id}
DELETE /api/v1.1/admin_form_autosaves/{id}/
Получить "Формы центра администрирования, настройки полей"
GET /api/v1.1/admin_form_field_settings/
Фильтрация "Формы центра администрирования, настройки полей" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/admin_form_field_settings/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| admin_form_id |
int |
|
|
| admin_form_field_id |
int |
|
|
| field_id |
int |
|
|
| width |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Формы центра администрирования, настройки полей"
POST /api/v1.1/admin_form_field_settings/
Обновить "Формы центра администрирования, настройки полей" с идентификатором {id}
PUT /api/v1.1/admin_form_field_settings/{id}/
{"admin_form_id": 1, "admin_form_field_id": 1, ...}
Удалить "Формы центра администрирования, настройки полей" с переданным {id}
DELETE /api/v1.1/admin_form_field_settings/{id}/
Получить "Поля формы центра администрирования"
GET /api/v1.1/admin_form_fields/
Фильтрация "Поля формы центра администрирования" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/admin_form_fields/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор поля формы |
|
| admin_form_id |
int |
Идентификатор формы центра администрирования |
|
| admin_word_id |
int |
|
|
| name |
string |
Ключевое поле из таблицы или модели |
|
| sorting |
int |
Порядок сортировки |
|
| ico |
string |
Изображение для поля |
|
| type |
int |
Тип поля |
|
| view |
int |
Отображение |
|
| format |
string |
Формат отображения |
|
| allow_sorting |
int |
Разрешить сортировку |
|
| allow_filter |
int |
Разрешить фильтр |
|
| editable |
int |
Редактировать прямо на форме |
|
| show_by_default |
int |
Показывать по умолчанию |
|
| filter_type |
int |
Тип фильтрации |
|
| filter_condition |
int |
Условие фильтрации |
|
| class |
string |
CSS-класс |
|
| width |
string |
Ширина поля (px, %) |
|
| image |
string |
Соответствие изображений значениям поля |
|
| link |
string |
Ссылка |
|
| onclick |
string |
Onclick |
|
| list |
string |
Соответствие значений элементам списка |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Поля формы центра администрирования"
POST /api/v1.1/admin_form_fields/
Обновить "Поля формы центра администрирования" с идентификатором {id}
PUT /api/v1.1/admin_form_fields/{id}/
{"admin_form_id": 1, "admin_word_id": 1, ...}
Удалить "Поля формы центра администрирования" с переданным {id}
DELETE /api/v1.1/admin_form_fields/{id}/
Связанные элементы
Получить "Формы центра администрирования, настройки полей" у "Поля формы центра администрирования" с идентификатором {id}
GET /api/v1.1/admin_form_fields/{id}/admin_form_field_settings/
Получить "Формы центра администрирования, блокировка"
GET /api/v1.1/admin_form_locks/
Фильтрация "Формы центра администрирования, блокировка" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/admin_form_locks/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| admin_form_id |
int |
|
|
| dataset |
int |
|
|
| entity_id |
int |
|
|
| datetime |
string |
|
|
Создать "Формы центра администрирования, блокировка"
POST /api/v1.1/admin_form_locks/
Обновить "Формы центра администрирования, блокировка" с идентификатором {id}
PUT /api/v1.1/admin_form_locks/{id}/
{"user_id": 1, "admin_form_id": 1, ...}
Удалить "Формы центра администрирования, блокировка" с переданным {id}
DELETE /api/v1.1/admin_form_locks/{id}/
Получить "Формы центра администрирования, настройки"
GET /api/v1.1/admin_form_settings/
Фильтрация "Формы центра администрирования, настройки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/admin_form_settings/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| admin_form_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| page_number |
int |
|
|
| order_field_id |
int |
|
|
| order_direction |
int |
|
|
| filter |
string |
|
|
| on_page |
int |
|
|
| view |
string |
|
|
Создать "Формы центра администрирования, настройки"
POST /api/v1.1/admin_form_settings/
Обновить "Формы центра администрирования, настройки" с идентификатором {id}
PUT /api/v1.1/admin_form_settings/{id}/
{"admin_form_id": 1, "user_id": 1, ...}
Удалить "Формы центра администрирования, настройки" с переданным {id}
DELETE /api/v1.1/admin_form_settings/{id}/
Получить "Формы центра администрирования"
GET /api/v1.1/admin_forms/
Фильтрация "Формы центра администрирования" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/admin_forms/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| admin_word_id |
int |
|
|
| on_page |
int |
Количество элементов на страницу |
|
| key_field |
string |
Название ключевого поля |
|
| show_operations |
int |
Отображать действия |
|
| show_group_operations |
int |
Групповые операции |
|
| default_order_field |
string |
Поле сортировки |
|
| default_order_direction |
int |
Направление сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| guid |
string |
GUID |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Формы центра администрирования"
POST /api/v1.1/admin_forms/
Обновить "Формы центра администрирования" с идентификатором {id}
PUT /api/v1.1/admin_forms/{id}/
{"admin_word_id": 1, "on_page": 1, ...}
Удалить "Формы центра администрирования" с переданным {id}
DELETE /api/v1.1/admin_forms/{id}/
Связанные элементы
Получить "Формы центра администрирования, настройки" у "Формы центра администрирования" с идентификатором {id}
GET /api/v1.1/admin_forms/{id}/admin_form_settings/
Получить "Поля формы центра администрирования" у "Формы центра администрирования" с идентификатором {id}
GET /api/v1.1/admin_forms/{id}/admin_form_fields/
Получить "Действия формы центра администрирования" у "Формы центра администрирования" с идентификатором {id}
GET /api/v1.1/admin_forms/{id}/admin_form_actions/
Получить "Действия формы центра администрирования, разделы" у "Формы центра администрирования" с идентификатором {id}
GET /api/v1.1/admin_forms/{id}/admin_form_action_dirs/
Получить "Формы центра администрирования, автосохранение" у "Формы центра администрирования" с идентификатором {id}
GET /api/v1.1/admin_forms/{id}/admin_form_autosaves/
Получить "Формы центра администрирования, настройки полей" у "Формы центра администрирования" с идентификатором {id}
GET /api/v1.1/admin_forms/{id}/admin_form_field_settings/
Форумы
Категории группы форума
Получить "Категории группы форума"
GET /api/v1.1/forum_categories/
Фильтрация "Категории группы форума" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/forum_categories/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| forum_group_id |
int |
Название группы |
|
| name |
string |
Название категории |
|
| description |
string |
Описание |
|
| closed |
int |
Категория закрыта |
|
| sorting |
int |
Порядок сортировки |
|
| email |
string |
E-mail куратора категории |
|
| postmoderation |
int |
Постмодерация |
|
| visible |
int |
Показывать всем |
|
| use_captcha |
int |
Использовать CAPTCHA для пользователя Гость |
|
| user_id |
int |
Идентификатор сотрудника |
|
| allow_guest_posting |
int |
Разрешить оставлять записи неавторизированным пользователям (Гость) |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Категории группы форума"
POST /api/v1.1/forum_categories/
Обновить "Категории группы форума" с идентификатором {id}
PUT /api/v1.1/forum_categories/{id}/
{"forum_group_id": 1, "name": "...", ...}
Удалить "Категории группы форума" с переданным {id}
DELETE /api/v1.1/forum_categories/{id}/
Связанные элементы
Получить "Темы форума" у "Категории группы форума" с идентификатором {id}
GET /api/v1.1/forum_categories/{id}/forum_topics/
Получить "Группы посетителей категории" у "Категории группы форума" с идентификатором {id}
GET /api/v1.1/forum_categories/{id}/forum_category_siteuser_groups/
Группы посетителей категории
Получить "Группы посетителей категории"
GET /api/v1.1/forum_category_siteuser_groups/
Фильтрация "Группы посетителей категории" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/forum_category_siteuser_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_group_id |
int |
Группа клиентов |
|
| forum_category_id |
int |
Идентификатор категории форума |
|
| moderator |
int |
Модератор |
|
| user_id |
int |
Идентификатор сотрудника |
|
Создать "Группы посетителей категории"
POST /api/v1.1/forum_category_siteuser_groups/
Обновить "Группы посетителей категории" с идентификатором {id}
PUT /api/v1.1/forum_category_siteuser_groups/{id}/
{"siteuser_group_id": 1, "forum_category_id": 1, ...}
Удалить "Группы посетителей категории" с переданным {id}
DELETE /api/v1.1/forum_category_siteuser_groups/{id}/
Группы форума
Получить "Группы форума"
GET /api/v1.1/forum_groups/
Фильтрация "Группы форума" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/forum_groups/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название группы |
|
| description |
string |
Описание группы |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| forum_id |
int |
Идентификатор форума |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Группы форума"
POST /api/v1.1/forum_groups/
Обновить "Группы форума" с идентификатором {id}
PUT /api/v1.1/forum_groups/{id}/
{"name": "...", "description": "...", ...}
Удалить "Группы форума" с переданным {id}
DELETE /api/v1.1/forum_groups/{id}/
Связанные элементы
Получить "Категории группы форума" у "Группы форума" с идентификатором {id}
GET /api/v1.1/forum_groups/{id}/forum_categories/
Форум, количество клиентов
Получить "Форум, количество клиентов"
GET /api/v1.1/forum_siteuser_counts/
Фильтрация "Форум, количество клиентов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/forum_siteuser_counts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| forum_id |
int |
|
|
| siteuser_id |
int |
|
|
| count |
int |
|
|
Создать "Форум, количество клиентов"
POST /api/v1.1/forum_siteuser_counts/
Обновить "Форум, количество клиентов" с идентификатором {id}
PUT /api/v1.1/forum_siteuser_counts/{id}/
{"forum_id": 1, "siteuser_id": 1, ...}
Удалить "Форум, количество клиентов" с переданным {id}
DELETE /api/v1.1/forum_siteuser_counts/{id}/
Сообщения форума
Получить "Сообщения форума"
GET /api/v1.1/forum_topic_posts/
Фильтрация "Сообщения форума" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/forum_topic_posts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| siteuser_id |
int |
Код пользователя |
|
| text |
string |
Текст сообщения |
|
| datetime |
string |
Дата добавления сообщения |
|
| ip |
string |
IP-адрес отправителя |
|
| subject |
string |
Тема |
|
| forum_topic_id |
int |
Код темы |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Сообщения форума"
POST /api/v1.1/forum_topic_posts/
Обновить "Сообщения форума" с идентификатором {id}
PUT /api/v1.1/forum_topic_posts/{id}/
{"siteuser_id": 1, "text": "...", ...}
Удалить "Сообщения форума" с переданным {id}
DELETE /api/v1.1/forum_topic_posts/{id}/
Форум, подписчики
Получить "Форум, подписчики"
GET /api/v1.1/forum_topic_subscribers/
Фильтрация "Форум, подписчики" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/forum_topic_subscribers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| forum_topic_id |
int |
|
|
| siteuser_id |
int |
|
|
Создать "Форум, подписчики"
POST /api/v1.1/forum_topic_subscribers/
Обновить "Форум, подписчики" с идентификатором {id}
PUT /api/v1.1/forum_topic_subscribers/{id}/
{"forum_topic_id": 1, "siteuser_id": 1, ...}
Удалить "Форум, подписчики" с переданным {id}
DELETE /api/v1.1/forum_topic_subscribers/{id}/
Форум, просмотр тем клиентами
Получить "Форум, просмотр тем клиентами"
GET /api/v1.1/forum_topic_views/
Фильтрация "Форум, просмотр тем клиентами" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/forum_topic_views/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| siteuser_id |
int |
|
|
| forum_topic_id |
int |
|
|
| datetime |
string |
|
|
Создать "Форум, просмотр тем клиентами"
POST /api/v1.1/forum_topic_views/
Обновить "Форум, просмотр тем клиентами" с идентификатором {id}
PUT /api/v1.1/forum_topic_views/{id}/
{"siteuser_id": 1, "forum_topic_id": 1, ...}
Удалить "Форум, просмотр тем клиентами" с переданным {id}
DELETE /api/v1.1/forum_topic_views/{id}/
Темы форума
Получить "Темы форума"
GET /api/v1.1/forum_topics/
Фильтрация "Темы форума" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/forum_topics/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| forum_category_id |
int |
Категория |
|
| visible |
int |
Отображать |
|
| announcement |
int |
Объявление |
|
| closed |
int |
Закрыта |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Темы форума"
POST /api/v1.1/forum_topics/
Обновить "Темы форума" с идентификатором {id}
PUT /api/v1.1/forum_topics/{id}/
{"forum_category_id": 1, "visible": 1, ...}
Удалить "Темы форума" с переданным {id}
DELETE /api/v1.1/forum_topics/{id}/
Связанные элементы
Получить "Сообщения форума" у "Темы форума" с идентификатором {id}
GET /api/v1.1/forum_topics/{id}/forum_topic_posts/
Получить "Форум, просмотр тем клиентами" у "Темы форума" с идентификатором {id}
GET /api/v1.1/forum_topics/{id}/forum_topic_views/
Получить "Форум, подписчики" у "Темы форума" с идентификатором {id}
GET /api/v1.1/forum_topics/{id}/forum_topic_subscribers/
Форумы
Получить "Форумы"
GET /api/v1.1/forums/
Фильтрация "Форумы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/forums/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| structure_id |
int |
Узел структуры |
|
| user_id |
int |
Идентификатор сотрудника |
|
| site_id |
int |
Сайт |
|
| name |
string |
Название форума |
|
| description |
string |
Описание форума |
|
| topics_on_page |
int |
Количество тем на странице |
|
| posts_on_page |
int |
Количество сообщений на странице |
|
| flood_protection_time |
int |
Задержка для защиты от флуда (сек.) |
|
| allow_edit_time |
int |
Время редактирования своих сообщений (сек.) |
|
| allow_delete_time |
int |
Время удаления своих сообщений (сек.) |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Форумы"
POST /api/v1.1/forums/
Обновить "Форумы" с идентификатором {id}
PUT /api/v1.1/forums/{id}/
{"structure_id": 1, "user_id": 1, ...}
Удалить "Форумы" с переданным {id}
DELETE /api/v1.1/forums/{id}/
Связанные элементы
Получить "Группы форума" у "Форумы" с идентификатором {id}
GET /api/v1.1/forums/{id}/forum_groups/
Получить "Форум, количество клиентов" у "Форумы" с идентификатором {id}
GET /api/v1.1/forums/{id}/forum_siteuser_counts/
Хранилище версий
Хранилище версий
Получить "Хранилище версий"
GET /api/v1.1/revisions/
Фильтрация "Хранилище версий" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/revisions/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| model |
string |
|
|
| entity_id |
int |
|
|
| value |
string |
|
|
| datetime |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Хранилище версий"
POST /api/v1.1/revisions/
Обновить "Хранилище версий" с идентификатором {id}
PUT /api/v1.1/revisions/{id}/
{"model": "...", "entity_id": 1, ...}
Удалить "Хранилище версий" с переданным {id}
DELETE /api/v1.1/revisions/{id}/
Шаблоны документов
Разделы шаблонов документов
Получить "Разделы шаблонов документов"
GET /api/v1.1/printlayout_dirs/
Фильтрация "Разделы шаблонов документов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/printlayout_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Раздел |
|
| name |
string |
Название |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Разделы шаблонов документов"
POST /api/v1.1/printlayout_dirs/
Обновить "Разделы шаблонов документов" с идентификатором {id}
PUT /api/v1.1/printlayout_dirs/{id}/
{"parent_id": 1, "name": "...", ...}
Удалить "Разделы шаблонов документов" с переданным {id}
DELETE /api/v1.1/printlayout_dirs/{id}/
Связанные элементы
Получить "Шаблоны документов" у "Разделы шаблонов документов" с идентификатором {id}
GET /api/v1.1/printlayout_dirs/{id}/printlayouts/
Получить "Разделы шаблонов документов" у "Разделы шаблонов документов" с идентификатором {id}
GET /api/v1.1/printlayout_dirs/{id}/printlayout_dirs/
Драйвер
Получить "Драйвер"
GET /api/v1.1/printlayout_drivers/
Фильтрация "Драйвер" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/printlayout_drivers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| driver |
string |
Драйвер |
|
| active |
int |
Активность |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Драйвер"
POST /api/v1.1/printlayout_drivers/
Обновить "Драйвер" с идентификатором {id}
PUT /api/v1.1/printlayout_drivers/{id}/
{"name": "...", "driver": "...", ...}
Удалить "Драйвер" с переданным {id}
DELETE /api/v1.1/printlayout_drivers/{id}/
Шаблоны документов, модули
Получить "Шаблоны документов, модули"
GET /api/v1.1/printlayout_modules/
Фильтрация "Шаблоны документов, модули" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/printlayout_modules/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| printlayout_id |
int |
|
|
| module_id |
int |
|
|
| type |
int |
|
|
Создать "Шаблоны документов, модули"
POST /api/v1.1/printlayout_modules/
Обновить "Шаблоны документов, модули" с идентификатором {id}
PUT /api/v1.1/printlayout_modules/{id}/
{"printlayout_id": 1, "module_id": 1, ...}
Удалить "Шаблоны документов, модули" с переданным {id}
DELETE /api/v1.1/printlayout_modules/{id}/
Шаблоны документов
Получить "Шаблоны документов"
GET /api/v1.1/printlayouts/
Фильтрация "Шаблоны документов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/printlayouts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| printlayout_dir_id |
int |
Раздел |
|
| name |
string |
Название |
|
| active |
int |
Активность |
|
| file_name |
string |
|
|
| file_mask |
string |
Маска имени файла |
|
| mail_template |
string |
Шаблон письма |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Шаблоны документов"
POST /api/v1.1/printlayouts/
Обновить "Шаблоны документов" с идентификатором {id}
PUT /api/v1.1/printlayouts/{id}/
{"printlayout_dir_id": 1, "name": "...", ...}
Удалить "Шаблоны документов" с переданным {id}
DELETE /api/v1.1/printlayouts/{id}/
Связанные элементы
Получить "Шаблоны документов, модули" у "Шаблоны документов" с идентификатором {id}
GET /api/v1.1/printlayouts/{id}/printlayout_modules/
Шорткоды
Группы шорткодов
Получить "Группы шорткодов"
GET /api/v1.1/shortcode_dirs/
Фильтрация "Группы шорткодов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shortcode_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Группа |
|
| name |
string |
Название |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Группы шорткодов"
POST /api/v1.1/shortcode_dirs/
Обновить "Группы шорткодов" с идентификатором {id}
PUT /api/v1.1/shortcode_dirs/{id}/
{"parent_id": 1, "name": "...", ...}
Удалить "Группы шорткодов" с переданным {id}
DELETE /api/v1.1/shortcode_dirs/{id}/
Связанные элементы
Получить "Группы шорткодов" у "Группы шорткодов" с идентификатором {id}
GET /api/v1.1/shortcode_dirs/{id}/shortcode_dirs/
Получить "Шорткоды" у "Группы шорткодов" с идентификатором {id}
GET /api/v1.1/shortcode_dirs/{id}/shortcodes/
Шорткоды
Получить "Шорткоды"
GET /api/v1.1/shortcodes/
Фильтрация "Шорткоды" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/shortcodes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| shortcode_dir_id |
int |
Группа |
|
| name |
string |
Название |
|
| shortcode |
string |
Шорткод |
|
| example |
string |
Пример вызова |
|
| php |
string |
PHP-код шорткода |
|
| active |
int |
Активность |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Шорткоды"
POST /api/v1.1/shortcodes/
Обновить "Шорткоды" с идентификатором {id}
PUT /api/v1.1/shortcodes/{id}/
{"shortcode_dir_id": 1, "name": "...", ...}
Удалить "Шорткоды" с переданным {id}
DELETE /api/v1.1/shortcodes/{id}/
AI-интеграция
Key 'model_name' in 'ru' language does not exist for model 'ai_chat_message'.
Получить "Key 'model_name' in 'ru' language does not exist for model 'ai_chat_message'."
GET /api/v1.1/ai_chat_messages/
Фильтрация "Key 'model_name' in 'ru' language does not exist for model 'ai_chat_message'." — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/ai_chat_messages/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| ai_chat_id |
int |
|
|
| role |
string |
|
|
| message |
string |
|
|
Создать "Key 'model_name' in 'ru' language does not exist for model 'ai_chat_message'."
POST /api/v1.1/ai_chat_messages/
Обновить "Key 'model_name' in 'ru' language does not exist for model 'ai_chat_message'." с идентификатором {id}
PUT /api/v1.1/ai_chat_messages/{id}/
{"ai_chat_id": 1, "role": "...", ...}
Удалить "Key 'model_name' in 'ru' language does not exist for model 'ai_chat_message'." с переданным {id}
DELETE /api/v1.1/ai_chat_messages/{id}/
AI, чаты
Получить "AI, чаты"
GET /api/v1.1/ai_chats/
Фильтрация "AI, чаты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/ai_chats/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| ai_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "AI, чаты"
POST /api/v1.1/ai_chats/
Обновить "AI, чаты" с идентификатором {id}
PUT /api/v1.1/ai_chats/{id}/
{"ai_id": 1, "user_id": 1, ...}
Удалить "AI, чаты" с переданным {id}
DELETE /api/v1.1/ai_chats/{id}/
Связанные элементы
Получить "Key 'model_name' in 'ru' language does not exist for model 'ai_chat_message'." у "AI, чаты" с идентификатором {id}
GET /api/v1.1/ai_chats/{id}/ai_chat_messages/
Разделы промптов
Получить "Разделы промптов"
GET /api/v1.1/ai_prompt_dirs/
Фильтрация "Разделы промптов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/ai_prompt_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| parent_id |
int |
Родительский раздел |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Разделы промптов"
POST /api/v1.1/ai_prompt_dirs/
Обновить "Разделы промптов" с идентификатором {id}
PUT /api/v1.1/ai_prompt_dirs/{id}/
{"site_id": 1, "parent_id": 1, ...}
Удалить "Разделы промптов" с переданным {id}
DELETE /api/v1.1/ai_prompt_dirs/{id}/
Связанные элементы
Получить "Промпты" у "Разделы промптов" с идентификатором {id}
GET /api/v1.1/ai_prompt_dirs/{id}/ai_prompts/
Получить "Разделы промптов" у "Разделы промптов" с идентификатором {id}
GET /api/v1.1/ai_prompt_dirs/{id}/ai_prompt_dirs/
Промпты
Получить "Промпты"
GET /api/v1.1/ai_prompts/
Фильтрация "Промпты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/ai_prompts/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| ai_prompt_dir_id |
int |
Группа промптов |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| prompt |
string |
Промпт |
|
| model |
string |
Модель |
|
| field |
string |
Поле |
|
| active |
int |
Активность |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Промпты"
POST /api/v1.1/ai_prompts/
Обновить "Промпты" с идентификатором {id}
PUT /api/v1.1/ai_prompts/{id}/
{"site_id": 1, "ai_prompt_dir_id": 1, ...}
Удалить "Промпты" с переданным {id}
DELETE /api/v1.1/ai_prompts/{id}/
AI
Получить "AI"
GET /api/v1.1/ais/
Фильтрация "AI" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/ais/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| name |
string |
Название |
|
| driver |
string |
Драйвер |
|
| model |
string |
Модель |
|
| api_key |
string |
API-ключ |
|
| balance |
decimal |
Баланс |
|
| balance_datetime |
string |
Дата последнего запроса баланса |
|
| active |
int |
Активность |
|
| default |
int |
По умолчанию |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "AI"
POST /api/v1.1/ais/
Обновить "AI" с идентификатором {id}
PUT /api/v1.1/ais/{id}/
{"site_id": 1, "name": "...", ...}
Удалить "AI" с переданным {id}
DELETE /api/v1.1/ais/{id}/
Связанные элементы
Получить "AI, чаты" у "AI" с идентификатором {id}
GET /api/v1.1/ais/{id}/ai_chats/
CDN
Key 'model_name' in 'ru' language does not exist for model 'cdn_file'.
Получить "Key 'model_name' in 'ru' language does not exist for model 'cdn_file'."
GET /api/v1.1/cdn_files/
Фильтрация "Key 'model_name' in 'ru' language does not exist for model 'cdn_file'." — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/cdn_files/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| cdn_id |
int |
|
|
| hash |
string |
|
|
| datetime |
string |
|
|
| source |
string |
|
|
| status |
int |
|
|
Создать "Key 'model_name' in 'ru' language does not exist for model 'cdn_file'."
POST /api/v1.1/cdn_files/
Обновить "Key 'model_name' in 'ru' language does not exist for model 'cdn_file'." с идентификатором {id}
PUT /api/v1.1/cdn_files/{id}/
{"cdn_id": 1, "hash": "...", ...}
Удалить "Key 'model_name' in 'ru' language does not exist for model 'cdn_file'." с переданным {id}
DELETE /api/v1.1/cdn_files/{id}/
CDN, правила
Получить "CDN, правила"
GET /api/v1.1/cdn_rules/
Фильтрация "CDN, правила" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/cdn_rules/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| cdn_id |
int |
Идентификатор CDN |
|
| extension |
string |
Расширение |
|
| size |
string |
Размер |
|
| dir |
string |
Директория, %s |
|
| active |
int |
Активность |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "CDN, правила"
POST /api/v1.1/cdn_rules/
Обновить "CDN, правила" с идентификатором {id}
PUT /api/v1.1/cdn_rules/{id}/
{"cdn_id": 1, "extension": "...", ...}
Удалить "CDN, правила" с переданным {id}
DELETE /api/v1.1/cdn_rules/{id}/
Опции CDN
Получить "Опции CDN"
GET /api/v1.1/cdn_sites/
Фильтрация "Опции CDN" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/cdn_sites/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| cdn_id |
int |
Идентификатор CDN |
|
| site_id |
int |
Идентификатор сайта |
|
| active |
int |
Активность |
|
| default |
int |
По умолчанию |
|
| css |
int |
CDN для CSS |
|
| css_domain |
string |
CDN-домен для CSS |
|
| js |
int |
CDN для JavaScript |
|
| js_domain |
string |
CDN-домен для JS |
|
| informationsystem |
int |
CDN для изображений информационных систем |
|
| informationsystem_domain |
string |
CDN-домен для изображений информационных систем |
|
| shop |
int |
CDN для изображений магазинов |
|
| shop_domain |
string |
CDN-домен для изображений магазинов |
|
| structure |
int |
CDN для узлов структуры |
|
| structure_domain |
string |
CDN-домен для узлов структуры |
|
Создать "Опции CDN"
POST /api/v1.1/cdn_sites/
Обновить "Опции CDN" с идентификатором {id}
PUT /api/v1.1/cdn_sites/{id}/
{"cdn_id": 1, "site_id": 1, ...}
Удалить "Опции CDN" с переданным {id}
DELETE /api/v1.1/cdn_sites/{id}/
Key 'model_name' in 'ru' language does not exist for model 'cdn_sync'.
Получить "Key 'model_name' in 'ru' language does not exist for model 'cdn_sync'."
GET /api/v1.1/cdn_syncs/
Фильтрация "Key 'model_name' in 'ru' language does not exist for model 'cdn_sync'." — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/cdn_syncs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| cdn_id |
int |
|
|
| dir |
string |
|
|
| completed |
int |
|
|
Создать "Key 'model_name' in 'ru' language does not exist for model 'cdn_sync'."
POST /api/v1.1/cdn_syncs/
Обновить "Key 'model_name' in 'ru' language does not exist for model 'cdn_sync'." с идентификатором {id}
PUT /api/v1.1/cdn_syncs/{id}/
{"cdn_id": 1, "dir": "...", ...}
Удалить "Key 'model_name' in 'ru' language does not exist for model 'cdn_sync'." с переданным {id}
DELETE /api/v1.1/cdn_syncs/{id}/
CDN
Получить "CDN"
GET /api/v1.1/cdns/
Фильтрация "CDN" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/cdns/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| driver |
string |
Драйвер |
|
| login |
string |
Логин |
|
| key |
string |
Ключ |
|
| balance |
decimal |
Баланс |
|
| balance_datetime |
string |
Дата последнего запроса баланса |
|
| host |
string |
Хост |
|
| bucket_name |
string |
Название бакета |
|
| key_id |
string |
Идентификатор ключа |
|
| key_secret |
string |
Секретный ключ |
|
| region |
string |
Регион |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "CDN"
POST /api/v1.1/cdns/
Обновить "CDN" с идентификатором {id}
PUT /api/v1.1/cdns/{id}/
{"name": "...", "driver": "...", ...}
Удалить "CDN" с переданным {id}
DELETE /api/v1.1/cdns/{id}/
Связанные элементы
Получить "Опции CDN" у "CDN" с идентификатором {id}
GET /api/v1.1/cdns/{id}/cdn_sites/
Получить "Key 'model_name' in 'ru' language does not exist for model 'cdn_file'." у "CDN" с идентификатором {id}
GET /api/v1.1/cdns/{id}/cdn_files/
Получить "CDN, правила" у "CDN" с идентификатором {id}
GET /api/v1.1/cdns/{id}/cdn_rules/
Получить "Key 'model_name' in 'ru' language does not exist for model 'cdn_sync'." у "CDN" с идентификатором {id}
GET /api/v1.1/cdns/{id}/cdn_syncs/
CRM
Key 'model_name' in 'ru' language does not exist for model 'crm_icon'.
Получить "Key 'model_name' in 'ru' language does not exist for model 'crm_icon'."
GET /api/v1.1/crm_icons/
Фильтрация "Key 'model_name' in 'ru' language does not exist for model 'crm_icon'." — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/crm_icons/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| value |
string |
|
|
Создать "Key 'model_name' in 'ru' language does not exist for model 'crm_icon'."
POST /api/v1.1/crm_icons/
Обновить "Key 'model_name' in 'ru' language does not exist for model 'crm_icon'." с идентификатором {id}
PUT /api/v1.1/crm_icons/{id}/
{"value": "...",, ...}
Удалить "Key 'model_name' in 'ru' language does not exist for model 'crm_icon'." с переданным {id}
DELETE /api/v1.1/crm_icons/{id}/
Связанные элементы
Получить "Проекты" у "Key 'model_name' in 'ru' language does not exist for model 'crm_icon'." с идентификатором {id}
GET /api/v1.1/crm_icons/{id}/crm_projects/
Получить "Классы документов" у "Key 'model_name' in 'ru' language does not exist for model 'crm_icon'." с идентификатором {id}
GET /api/v1.1/crm_icons/{id}/dms_classes/
CRM: Заметки, вложения
Получить "CRM: Заметки, вложения"
GET /api/v1.1/crm_note_attachments/
Фильтрация "CRM: Заметки, вложения" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/crm_note_attachments/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| crm_note_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| file_name |
string |
|
|
| file |
string |
|
|
Создать "CRM: Заметки, вложения"
POST /api/v1.1/crm_note_attachments/
Обновить "CRM: Заметки, вложения" с идентификатором {id}
PUT /api/v1.1/crm_note_attachments/{id}/
{"crm_note_id": 1, "user_id": 1, ...}
Удалить "CRM: Заметки, вложения" с переданным {id}
DELETE /api/v1.1/crm_note_attachments/{id}/
Key 'model_name' in 'ru' language does not exist for model 'crm_note_reaction'.
Получить "Key 'model_name' in 'ru' language does not exist for model 'crm_note_reaction'."
GET /api/v1.1/crm_note_reactions/
Фильтрация "Key 'model_name' in 'ru' language does not exist for model 'crm_note_reaction'." — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/crm_note_reactions/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| crm_note_id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| emoji |
string |
|
|
Создать "Key 'model_name' in 'ru' language does not exist for model 'crm_note_reaction'."
POST /api/v1.1/crm_note_reactions/
Обновить "Key 'model_name' in 'ru' language does not exist for model 'crm_note_reaction'." с идентификатором {id}
PUT /api/v1.1/crm_note_reactions/{id}/
{"crm_note_id": 1, "user_id": 1, ...}
Удалить "Key 'model_name' in 'ru' language does not exist for model 'crm_note_reaction'." с переданным {id}
DELETE /api/v1.1/crm_note_reactions/{id}/
CRM: Заметки
Получить "CRM: Заметки"
GET /api/v1.1/crm_notes/
Фильтрация "CRM: Заметки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/crm_notes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Родительская заметка |
|
| subject |
string |
Тема |
|
| text |
string |
Текст |
|
| datetime |
string |
|
|
| ip |
string |
|
|
| result |
int |
Результат |
|
| dir |
string |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "CRM: Заметки"
POST /api/v1.1/crm_notes/
Обновить "CRM: Заметки" с идентификатором {id}
PUT /api/v1.1/crm_notes/{id}/
{"parent_id": 1, "subject": "...", ...}
Удалить "CRM: Заметки" с переданным {id}
DELETE /api/v1.1/crm_notes/{id}/
Связанные элементы
Получить "CRM: Заметки" у "CRM: Заметки" с идентификатором {id}
GET /api/v1.1/crm_notes/{id}/crm_notes/
Получить "CRM: Заметки, вложения" у "CRM: Заметки" с идентификатором {id}
GET /api/v1.1/crm_notes/{id}/crm_note_attachments/
Получить "Key 'model_name' in 'ru' language does not exist for model 'crm_note_reaction'." у "CRM: Заметки" с идентификатором {id}
GET /api/v1.1/crm_notes/{id}/crm_note_reactions/
Проекты, вложения
Получить "Проекты, вложения"
GET /api/v1.1/crm_project_attachments/
Фильтрация "Проекты, вложения" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/crm_project_attachments/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| crm_project_id |
int |
Идентификатор проекта |
|
| user_id |
int |
Идентификатор сотрудника |
|
| file_name |
string |
|
|
| file |
string |
|
|
| datetime |
string |
|
|
Создать "Проекты, вложения"
POST /api/v1.1/crm_project_attachments/
Обновить "Проекты, вложения" с идентификатором {id}
PUT /api/v1.1/crm_project_attachments/{id}/
{"crm_project_id": 1, "user_id": 1, ...}
Удалить "Проекты, вложения" с переданным {id}
DELETE /api/v1.1/crm_project_attachments/{id}/
Проекты, заметки
Получить "Проекты, заметки"
GET /api/v1.1/crm_project_crm_notes/
Фильтрация "Проекты, заметки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/crm_project_crm_notes/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| crm_note_id |
int |
|
|
| crm_project_id |
int |
|
|
Создать "Проекты, заметки"
POST /api/v1.1/crm_project_crm_notes/
Обновить "Проекты, заметки" с идентификатором {id}
PUT /api/v1.1/crm_project_crm_notes/{id}/
{"crm_note_id": 1, "crm_project_id": 1, ...}
Удалить "Проекты, заметки" с переданным {id}
DELETE /api/v1.1/crm_project_crm_notes/{id}/
Проекты
Получить "Проекты"
GET /api/v1.1/crm_projects/
Фильтрация "Проекты" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/crm_projects/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| crm_icon_id |
int |
Иконка |
|
| name |
string |
Назание |
|
| description |
string |
Описание |
|
| color |
string |
Цвет |
|
| datetime |
string |
Дата |
|
| deadline |
string |
Выполнить до |
|
| completed |
int |
Завершен |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Проекты"
POST /api/v1.1/crm_projects/
Обновить "Проекты" с идентификатором {id}
PUT /api/v1.1/crm_projects/{id}/
{"site_id": 1, "crm_icon_id": 1, ...}
Удалить "Проекты" с переданным {id}
DELETE /api/v1.1/crm_projects/{id}/
Связанные элементы
Получить "Дела" у "Проекты" с идентификатором {id}
GET /api/v1.1/crm_projects/{id}/events/
Получить "Сделки" у "Проекты" с идентификатором {id}
GET /api/v1.1/crm_projects/{id}/deals/
Получить "Проекты, заметки" у "Проекты" с идентификатором {id}
GET /api/v1.1/crm_projects/{id}/crm_project_crm_notes/
Получить "CRM: Заметки" у "Проекты" с идентификатором {id}
GET /api/v1.1/crm_projects/{id}/crm_notes/
Получить "Проекты, вложения" у "Проекты" с идентификатором {id}
GET /api/v1.1/crm_projects/{id}/crm_project_attachments/
Получить "Документооборот" у "Проекты" с идентификатором {id}
GET /api/v1.1/crm_projects/{id}/dms_documents/
Получить "Дела, проекты" у "Проекты" с идентификатором {id}
GET /api/v1.1/crm_projects/{id}/event_crm_projects/
Источники клиентов
Получить "Источники клиентов"
GET /api/v1.1/crm_sources/
Фильтрация "Источники клиентов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/crm_sources/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Назание |
|
| color |
string |
Цвет |
|
| icon |
string |
Иконка |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Источники клиентов"
POST /api/v1.1/crm_sources/
Обновить "Источники клиентов" с идентификатором {id}
PUT /api/v1.1/crm_sources/{id}/
{"name": "...", "color": "...", ...}
Удалить "Источники клиентов" с переданным {id}
DELETE /api/v1.1/crm_sources/{id}/
Связанные элементы
Получить "Клиенты" у "Источники клиентов" с идентификатором {id}
GET /api/v1.1/crm_sources/{id}/siteusers/
IP-адреса
Группы IP-адресов
Получить "Группы IP-адресов"
GET /api/v1.1/ipaddress_dirs/
Фильтрация "Группы IP-адресов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/ipaddress_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Группа |
|
| name |
string |
Название |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Группы IP-адресов"
POST /api/v1.1/ipaddress_dirs/
Обновить "Группы IP-адресов" с идентификатором {id}
PUT /api/v1.1/ipaddress_dirs/{id}/
{"parent_id": 1, "name": "...", ...}
Удалить "Группы IP-адресов" с переданным {id}
DELETE /api/v1.1/ipaddress_dirs/{id}/
Связанные элементы
Получить "Группы IP-адресов" у "Группы IP-адресов" с идентификатором {id}
GET /api/v1.1/ipaddress_dirs/{id}/ipaddress_dirs/
Получить "IP-адреса" у "Группы IP-адресов" с идентификатором {id}
GET /api/v1.1/ipaddress_dirs/{id}/ipaddresses/
Группы фильтров IP-адресов
Получить "Группы фильтров IP-адресов"
GET /api/v1.1/ipaddress_filter_dirs/
Фильтрация "Группы фильтров IP-адресов" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/ipaddress_filter_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Группа |
|
| name |
string |
Название |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Группы фильтров IP-адресов"
POST /api/v1.1/ipaddress_filter_dirs/
Обновить "Группы фильтров IP-адресов" с идентификатором {id}
PUT /api/v1.1/ipaddress_filter_dirs/{id}/
{"parent_id": 1, "name": "...", ...}
Удалить "Группы фильтров IP-адресов" с переданным {id}
DELETE /api/v1.1/ipaddress_filter_dirs/{id}/
Связанные элементы
Получить "Группы фильтров IP-адресов" у "Группы фильтров IP-адресов" с идентификатором {id}
GET /api/v1.1/ipaddress_filter_dirs/{id}/ipaddress_filter_dirs/
Получить "Фильтры IP" у "Группы фильтров IP-адресов" с идентификатором {id}
GET /api/v1.1/ipaddress_filter_dirs/{id}/ipaddress_filters/
Фильтры IP
Получить "Фильтры IP"
GET /api/v1.1/ipaddress_filters/
Фильтрация "Фильтры IP" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/ipaddress_filters/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| ipaddress_filter_dir_id |
int |
Группа |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| json |
string |
JSON |
|
| active |
int |
Активность |
|
| mode |
int |
Режим |
|
| datetime |
string |
Дата |
|
| banned |
int |
Запросов |
|
| block_ip |
int |
Заблокировать IP, соответствующий условию |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Фильтры IP"
POST /api/v1.1/ipaddress_filters/
Обновить "Фильтры IP" с идентификатором {id}
PUT /api/v1.1/ipaddress_filters/{id}/
{"ipaddress_filter_dir_id": 1, "name": "...", ...}
Удалить "Фильтры IP" с переданным {id}
DELETE /api/v1.1/ipaddress_filters/{id}/
Группы фильтров посетителей
Получить "Группы фильтров посетителей"
GET /api/v1.1/ipaddress_visitor_filter_dirs/
Фильтрация "Группы фильтров посетителей" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/ipaddress_visitor_filter_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Группа |
|
| name |
string |
Название |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Группы фильтров посетителей"
POST /api/v1.1/ipaddress_visitor_filter_dirs/
Обновить "Группы фильтров посетителей" с идентификатором {id}
PUT /api/v1.1/ipaddress_visitor_filter_dirs/{id}/
{"parent_id": 1, "name": "...", ...}
Удалить "Группы фильтров посетителей" с переданным {id}
DELETE /api/v1.1/ipaddress_visitor_filter_dirs/{id}/
Связанные элементы
Получить "Группы фильтров посетителей" у "Группы фильтров посетителей" с идентификатором {id}
GET /api/v1.1/ipaddress_visitor_filter_dirs/{id}/ipaddress_visitor_filter_dirs/
Получить "Фильтры посетителей" у "Группы фильтров посетителей" с идентификатором {id}
GET /api/v1.1/ipaddress_visitor_filter_dirs/{id}/ipaddress_visitor_filters/
Фильтры посетителей
Получить "Фильтры посетителей"
GET /api/v1.1/ipaddress_visitor_filters/
Фильтрация "Фильтры посетителей" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/ipaddress_visitor_filters/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| ipaddress_visitor_filter_dir_id |
int |
Группа |
|
| name |
string |
Название |
|
| description |
string |
Описание |
|
| json |
string |
JSON |
|
| active |
int |
Активность |
|
| mode |
int |
Режим |
|
| datetime |
string |
Дата |
|
| ban_hours |
int |
Блокировать, часов |
|
| banned |
int |
Запросов |
|
| block_mode |
int |
Режим блокировки |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Фильтры посетителей"
POST /api/v1.1/ipaddress_visitor_filters/
Обновить "Фильтры посетителей" с идентификатором {id}
PUT /api/v1.1/ipaddress_visitor_filters/{id}/
{"ipaddress_visitor_filter_dir_id": 1, "name": "...", ...}
Удалить "Фильтры посетителей" с переданным {id}
DELETE /api/v1.1/ipaddress_visitor_filters/{id}/
Посетители
Получить "Посетители"
GET /api/v1.1/ipaddress_visitors/
Фильтрация "Посетители" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/ipaddress_visitors/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
string |
|
|
| ip |
string |
|
|
| useragent |
string |
|
|
| headers |
string |
|
|
| lng |
string |
|
|
| site_id |
int |
|
|
| result |
int |
|
|
| result_expired |
int |
|
|
| ipaddress_visitor_filter_id |
int |
|
|
| visits |
int |
|
|
| datetime |
string |
|
|
Создать "Посетители"
POST /api/v1.1/ipaddress_visitors/
Обновить "Посетители" с идентификатором {id}
PUT /api/v1.1/ipaddress_visitors/{id}/
{"ip": "...", "useragent": "...", ...}
Удалить "Посетители" с переданным {id}
DELETE /api/v1.1/ipaddress_visitors/{id}/
IP-адреса
Получить "IP-адреса"
GET /api/v1.1/ipaddresses/
Фильтрация "IP-адреса" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/ipaddresses/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| ipaddress_dir_id |
int |
Группа |
|
| ip |
string |
IP-адреса или CIDR, через запятую |
|
| deny_access |
int |
Запретить доступ |
|
| deny_backend |
int |
Запретить доступ к центру администрирования |
|
| no_statistic |
int |
Не учитывать в статистике |
|
| comment |
string |
Комментарий |
|
| banned |
int |
|
|
| datetime |
string |
Дата |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "IP-адреса"
POST /api/v1.1/ipaddresses/
Обновить "IP-адреса" с идентификатором {id}
PUT /api/v1.1/ipaddresses/{id}/
{"ipaddress_dir_id": 1, "ip": "...", ...}
Удалить "IP-адреса" с переданным {id}
DELETE /api/v1.1/ipaddresses/{id}/
REST API
REST API, запрещенный доступ
Получить "REST API, запрещенный доступ"
GET /api/v1.1/restapi_accessdenieds/
Фильтрация "REST API, запрещенный доступ" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/restapi_accessdenieds/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| datetime |
string |
|
|
| ip |
string |
|
|
Создать "REST API, запрещенный доступ"
POST /api/v1.1/restapi_accessdenieds/
Обновить "REST API, запрещенный доступ" с идентификатором {id}
PUT /api/v1.1/restapi_accessdenieds/{id}/
{"datetime": "...", "ip": "...", ...}
Удалить "REST API, запрещенный доступ" с переданным {id}
DELETE /api/v1.1/restapi_accessdenieds/{id}/
Токены REST API
Получить "Токены REST API"
GET /api/v1.1/restapi_tokens/
Фильтрация "Токены REST API" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/restapi_tokens/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| user_id |
int |
Сотрудник |
|
| token |
string |
Токен |
|
| active |
int |
Активность |
|
| https |
int |
HTTPS |
|
| datetime |
string |
Дата создания |
|
| expire |
string |
Дата истечения |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Токены REST API"
POST /api/v1.1/restapi_tokens/
Обновить "Токены REST API" с идентификатором {id}
PUT /api/v1.1/restapi_tokens/{id}/
{"user_id": 1, "token": "...", ...}
Удалить "Токены REST API" с переданным {id}
DELETE /api/v1.1/restapi_tokens/{id}/
SQL-запросы
Вкладки баз данных
Получить "Вкладки баз данных"
GET /api/v1.1/sql_user_tabs/
Фильтрация "Вкладки баз данных" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/sql_user_tabs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| user_id |
int |
Идентификатор сотрудника |
|
| name |
string |
|
|
| content |
string |
|
|
| page |
int |
|
|
| limit |
int |
|
|
| datetime |
string |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Вкладки баз данных"
POST /api/v1.1/sql_user_tabs/
Обновить "Вкладки баз данных" с идентификатором {id}
PUT /api/v1.1/sql_user_tabs/{id}/
{"user_id": 1, "name": "...", ...}
Удалить "Вкладки баз данных" с переданным {id}
DELETE /api/v1.1/sql_user_tabs/{id}/
TPL-шаблоны
Разделы TPL
Получить "Разделы TPL"
GET /api/v1.1/tpl_dirs/
Фильтрация "Разделы TPL" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/tpl_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Родительский раздел |
|
| name |
string |
Название раздела |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Разделы TPL"
POST /api/v1.1/tpl_dirs/
Обновить "Разделы TPL" с идентификатором {id}
PUT /api/v1.1/tpl_dirs/{id}/
{"parent_id": 1, "name": "...", ...}
Удалить "Разделы TPL" с переданным {id}
DELETE /api/v1.1/tpl_dirs/{id}/
Связанные элементы
Получить "TPL-шаблоны" у "Разделы TPL" с идентификатором {id}
GET /api/v1.1/tpl_dirs/{id}/tpls/
Получить "Разделы TPL" у "Разделы TPL" с идентификатором {id}
GET /api/v1.1/tpl_dirs/{id}/tpl_dirs/
TPL-шаблоны
Получить "TPL-шаблоны"
GET /api/v1.1/tpls/
Фильтрация "TPL-шаблоны" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/tpls/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| tpl_dir_id |
int |
Раздел TPL-шаблона |
|
| name |
string |
Название TPL-шаблона |
|
| description |
string |
Комментарий к TPL-шаблону |
|
| sorting |
int |
Порядковый номер TPL-шаблона |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "TPL-шаблоны"
POST /api/v1.1/tpls/
Обновить "TPL-шаблоны" с идентификатором {id}
PUT /api/v1.1/tpls/{id}/
{"tpl_dir_id": 1, "name": "...", ...}
Удалить "TPL-шаблоны" с переданным {id}
DELETE /api/v1.1/tpls/{id}/
XSL-шаблоны
Разделы XSL
Получить "Разделы XSL"
GET /api/v1.1/xsl_dirs/
Фильтрация "Разделы XSL" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/xsl_dirs/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| parent_id |
int |
Родительский раздел |
|
| name |
string |
Название раздела |
|
| sorting |
int |
Порядок сортировки |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Разделы XSL"
POST /api/v1.1/xsl_dirs/
Обновить "Разделы XSL" с идентификатором {id}
PUT /api/v1.1/xsl_dirs/{id}/
{"parent_id": 1, "name": "...", ...}
Удалить "Разделы XSL" с переданным {id}
DELETE /api/v1.1/xsl_dirs/{id}/
Связанные элементы
Получить "XSL-шаблоны" у "Разделы XSL" с идентификатором {id}
GET /api/v1.1/xsl_dirs/{id}/xsls/
Получить "Разделы XSL" у "Разделы XSL" с идентификатором {id}
GET /api/v1.1/xsl_dirs/{id}/xsl_dirs/
XSL-шаблоны
Получить "XSL-шаблоны"
GET /api/v1.1/xsls/
Фильтрация "XSL-шаблоны" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/xsls/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| xsl_dir_id |
int |
Раздел XSL-шаблона |
|
| name |
string |
Название XSL-шаблона |
|
| description |
string |
Комментарий к XSL-шаблону |
|
| sorting |
int |
Порядковый номер XSL-шаблона |
|
| format |
int |
Форматировать XSL-шаблон |
|
| user_id |
int |
Идентификатор сотрудника |
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "XSL-шаблоны"
POST /api/v1.1/xsls/
Обновить "XSL-шаблоны" с идентификатором {id}
PUT /api/v1.1/xsls/{id}/
{"xsl_dir_id": 1, "name": "...", ...}
Удалить "XSL-шаблоны" с переданным {id}
DELETE /api/v1.1/xsls/{id}/
Поисковая оптимизация (SEO)
Поисковые системы
Получить "Поисковые системы"
GET /api/v1.1/seo_drivers/
Фильтрация "Поисковые системы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/seo_drivers/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| name |
string |
Название |
|
| driver |
string |
Драйвер |
|
Создать "Поисковые системы"
POST /api/v1.1/seo_drivers/
Обновить "Поисковые системы" с идентификатором {id}
PUT /api/v1.1/seo_drivers/{id}/
{"name": "...", "driver": "...", ...}
Удалить "Поисковые системы" с переданным {id}
DELETE /api/v1.1/seo_drivers/{id}/
Связанные элементы
Получить "Поисковые системы" у "Поисковые системы" с идентификатором {id}
GET /api/v1.1/seo_drivers/{id}/seo_sites/
SEO, проиндексировано
Получить "SEO, проиндексировано"
GET /api/v1.1/seo_indexeds/
Фильтрация "SEO, проиндексировано" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/seo_indexeds/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| seo_site_id |
int |
|
|
| date |
string |
|
|
| searchable |
int |
|
|
| downloaded |
int |
|
|
| downloaded_2xx |
int |
|
|
| downloaded_3xx |
int |
|
|
| downloaded_4xx |
int |
|
|
| downloaded_5xx |
int |
|
|
| failed_to_download |
int |
|
|
| excluded |
int |
|
|
Создать "SEO, проиндексировано"
POST /api/v1.1/seo_indexeds/
Обновить "SEO, проиндексировано" с идентификатором {id}
PUT /api/v1.1/seo_indexeds/{id}/
{"seo_site_id": 1, "date": "...", ...}
Удалить "SEO, проиндексировано" с переданным {id}
DELETE /api/v1.1/seo_indexeds/{id}/
SEO, ссылки
Получить "SEO, ссылки"
GET /api/v1.1/seo_links/
Фильтрация "SEO, ссылки" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/seo_links/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| seo_site_id |
int |
|
|
| date |
string |
|
|
| value |
int |
|
|
Создать "SEO, ссылки"
POST /api/v1.1/seo_links/
Обновить "SEO, ссылки" с идентификатором {id}
PUT /api/v1.1/seo_links/{id}/
{"seo_site_id": 1, "date": "...", ...}
Удалить "SEO, ссылки" с переданным {id}
DELETE /api/v1.1/seo_links/{id}/
SEO, страницы
Получить "SEO, страницы"
GET /api/v1.1/seo_pages/
Фильтрация "SEO, страницы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/seo_pages/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| seo_site_id |
int |
|
|
| value |
string |
|
|
| clicks |
int |
|
|
| shows |
int |
|
|
| sorting |
int |
|
|
Создать "SEO, страницы"
POST /api/v1.1/seo_pages/
Обновить "SEO, страницы" с идентификатором {id}
PUT /api/v1.1/seo_pages/{id}/
{"seo_site_id": 1, "value": "...", ...}
Удалить "SEO, страницы" с переданным {id}
DELETE /api/v1.1/seo_pages/{id}/
SEO, запросы
Получить "SEO, запросы"
GET /api/v1.1/seo_queries/
Фильтрация "SEO, запросы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/seo_queries/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| seo_site_id |
int |
|
|
| value |
string |
|
|
| clicks |
int |
|
|
| shows |
int |
|
|
| sorting |
int |
|
|
Создать "SEO, запросы"
POST /api/v1.1/seo_queries/
Обновить "SEO, запросы" с идентификатором {id}
PUT /api/v1.1/seo_queries/{id}/
{"seo_site_id": 1, "value": "...", ...}
Удалить "SEO, запросы" с переданным {id}
DELETE /api/v1.1/seo_queries/{id}/
SEO, рейтинг
Получить "SEO, рейтинг"
GET /api/v1.1/seo_ratings/
Фильтрация "SEO, рейтинг" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/seo_ratings/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
|
|
| seo_site_id |
int |
|
|
| date |
string |
|
|
| value |
int |
|
|
Создать "SEO, рейтинг"
POST /api/v1.1/seo_ratings/
Обновить "SEO, рейтинг" с идентификатором {id}
PUT /api/v1.1/seo_ratings/{id}/
{"seo_site_id": 1, "date": "...", ...}
Удалить "SEO, рейтинг" с переданным {id}
DELETE /api/v1.1/seo_ratings/{id}/
Поисковые системы
Получить "Поисковые системы"
GET /api/v1.1/seo_sites/
Фильтрация "Поисковые системы" — получить следующие 5, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count
GET /api/v1.1/seo_sites/?$limit=5&$offset=10&$count=true
Атрибуты
| Атрибут |
Тип |
Описание |
| id |
int |
Идентификатор |
|
| site_id |
int |
Идентификатор сайта |
|
| seo_driver_id |
int |
Поисковая система |
|
| token |
string |
Токен |
|
| last_update |
string |
Дата обновления |
|
| active |
int |
Активность |
|
| expired_in |
int |
|
|
| deleted |
int |
Флаг, удален ли объект в корзину |
|
Создать "Поисковые системы"
POST /api/v1.1/seo_sites/
Обновить "Поисковые системы" с идентификатором {id}
PUT /api/v1.1/seo_sites/{id}/
{"site_id": 1, "seo_driver_id": 1, ...}
Удалить "Поисковые системы" с переданным {id}
DELETE /api/v1.1/seo_sites/{id}/
Связанные элементы
Получить "SEO, рейтинг" у "Поисковые системы" с идентификатором {id}
GET /api/v1.1/seo_sites/{id}/seo_ratings/
Получить "SEO, проиндексировано" у "Поисковые системы" с идентификатором {id}
GET /api/v1.1/seo_sites/{id}/seo_indexeds/
Получить "SEO, ссылки" у "Поисковые системы" с идентификатором {id}
GET /api/v1.1/seo_sites/{id}/seo_links/
Получить "SEO, страницы" у "Поисковые системы" с идентификатором {id}
GET /api/v1.1/seo_sites/{id}/seo_pages/
Получить "SEO, запросы" у "Поисковые системы" с идентификатором {id}
GET /api/v1.1/seo_sites/{id}/seo_queries/
