API v1.1 Свернуть всё

 

Авторизация
Справочники
Поручения
Контроль
Документы
Документ
Системные
Пользователь



Описание API v1.1

Все обращения происходят путём обмена JSON-пакетами на основе описанного функционала.

Авторизация #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
user_login string (50) Да Логин доступа к БД
user_password password (50) Да Пароль доступа к БД
db_type string (10) Да Тип БД (postgresql/mssql)
db_server string (255) Да Сервер БД
db_port integer (10) Порт БД
db_name string (255) Да Имя БД

Пример запроса:

{
    "user_login": "test@example.com",
    "user_password": "P@ssw0rd",
    "db_type": "postgresql",
    "db_server": "192.168.0.10",
    "db_port": 5432,
    "db_name": "example_db"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.auth Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
token string (255) Выделенный токен доступа (время жизни токена: 30 минут)
valid_to datetime (YYYY-MM-DD HH:MM:SS) Дата/время окончания действия токена
refresh_token string (255) Ключ обновления токена

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

{
    "request_identifier": "alphapi.auth",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "token": "79feb733-0578-4cc6-b206-a2c8a4b6ca4d",
    "valid_to": "2001-01-01 01:01:01",
    "refresh_token": "79feb733-0578-4cc6-b206-79feb73344d2"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Авторизация для организаций #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
user_login string (50) Да Логин доступа к БД
user_password password (50) Да Пароль доступа к БД
org_ident string (50) Да Идентификатор организации. Можно получить у разработчика.

Пример запроса:

{
    "user_login": "test@example.com",
    "user_password": "P@ssw0rd",
    "org_ident": "firma"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.auth Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
token string (255) Выделенный токен доступа (время жизни токена: 30 минут)
valid_to datetime (YYYY-MM-DD HH:MM:SS) Дата/время окончания действия токена
refresh_token string (255) Ключ обновления токена
db_type string (255) Тип базы данных
storage_url string (255) Путь к хранилищу

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

{
    "request_identifier": "alphapi.auth.org",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "token": "79feb733-0578-4cc6-b206-a2c8a4b6ca4d",
    "valid_to": "2001-01-01 01:01:01",
    "refresh_token": "79feb733-0578-4cc6-b206-79feb73344d2",
    "db_type": "mssql",
    "storage_url": "https:\/\/storage01.alpha-doc.ru\/bbs\/"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Обновление токена #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
refresh_token string Да Ключ обновления токена, полученный при авторизации

Пример запроса:

{
    "refresh_token": "79feb733-0578-4cc6-b206-a2c8a4b6ca4d"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.auth Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
token string (255) Выделенный токен доступа (время жизни токена: 30 минут)
valid_to datetime (YYYY-MM-DD HH:MM:SS) Дата/время окончания действия токена
refresh_token string (255) Ключ обновления токена

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

{
    "request_identifier": "alphapi.auth.refresh",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "token": "79feb733-0578-4cc6-b206-a2c8a4b6ca4d",
    "valid_to": "2001-01-01 01:01:01",
    "refresh_token": "79feb733-0578-4cc6-b206-79feb73344d2"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Завершение авторизации #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.logout Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.logout",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1."
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Справочник проектов #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк
dt_id integer (10) Тип документа

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.projects.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — P_ID integer (10) ID проекта
— — PARENTS string (255) Строка ID объектов родителей экранированных # (последний код всегда равен ID проекта)
— — RESPONSIBLE_ID integer (10) ID Пользователя ответсвенного за проект
— — Номер integer (10) Внутренний номер проекта (равен ID проекта)
— — След string (2048) Информационная строка для отображения подчиненности
— — Название string (255) Название проекта
— — Создан date (Y-m-d H:i:s) Дата создания проекта
— — Активен boolean (1) Флаг: доступности проекта для выбора при создании документов
— — План-график date (Y-m-d H:i:s) Дата соответсвия проекта плану-графику (рудимент)
— — Цвет integer (10) Цветовой тег проекта (цвет передается в кодировке R255+G255+B255)
— — БлокЦвета integer (10) Флаг: показывает доступна ли смена цвета в самой карточки документа
— — Примечание string (255) Примечание проекта
— — Ответственный string (255) Ф.И.О. пответственного по проекту

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

{
    "request_identifier": "alphapi.projects.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "P_ID": 101,
                "PARENTS": "#101#",
                "RESPONSIBLE_ID": 101,
                "Номер": 101,
                "След": null,
                "Название": "Название проекта",
                "Создан": "2001-01-01 01:01:01",
                "Активен": 1,
                "План-график": "2001-01-01 01:01:01",
                "Цвет": null,
                "БлокЦвета": null,
                "Примечание": "Текст примечания",
                "Ответственный": "Иванов И.И."
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Добавление проекта #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
parents string (255) Строка ID родителей экранированных # (последний код всегда равен ID точки маршрута)
name string (255) Да Название
enable boolean (1) Флаг активности
login_id integer (10) Да LOGIN_ID ответственного по проекту
planschedule date (YYYY-MM-DD) Да Дата план графика проекта
key string (255) Поле связи проекта со внешними системами
color integer (10) Цветовой тег проекта, возможные значения на вход: NULL, 16711680, 32768, 255, 642815, 8421504, 8388736
comment string (255) Название

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "parents": "#101##102#",
    "name": "Зеленоград",
    "enable": 1,
    "login_id": 1931,
    "key": "",
    "color": 16711680,
    "comment": "комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.project.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— p_id integer (10) ID проекта

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

{
    "request_identifier": "alphapi.project.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Project added successfully",
    "data": {
        "p_id": 5
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Справочник типов документов #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "ROW_ID = 1",
    "orderby": "ROW_ID ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.types.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — ROW_ID integer (10) ID записи
— — DT_ID integer (10) ID типа документа
— — EXT_DOCS string (255)
— — EXT_P string (255)
— — EXT_LT string (255)
— — Нумерация integer (3) Нумерация
— — Шаблон string (50) Шаблон
— — Активен boolean (1) Флаг активности
— — Название string (50) Название
— — Описание string (255) Описание
— — Маска string (480) Маска
— — Параметры string (1024) Параметры
— — Примечание string (255) Примечание

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

{
    "request_identifier": "alphapi.doc.types.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "ROW_ID": 8,
                "DT_ID": 108,
                "EXT_DOCS": null,
                "EXT_P": "#101#",
                "EXT_LT": null,
                "Нумерация": 5,
                "Шаблон": "<!{Номер}>",
                "Активен": 1,
                "Название": "Документ",
                "Описание": "Применяется при регистрации общих документов.",
                "Маска": null,
                "Параметры": null,
                "Примечание": null
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Справочник групп и пользователей #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "[RECIPIENT_ID] = 1",
    "orderby": "[Объект] ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.recipients.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — CustomKey string (511) Составной идентификатор, уникальный в рамках данного справочника (состоит из RECIPIENT_TABLE_ID и RECIPIENT_ID)
— — RECIPIENT_TABLE_ID integer (3) ID таблицы сущности
— — RECIPIENT_ID integer (10) ID сущности
— — Источник string (50) Тип сущности (группа или пользователь)
— — Объект string (255) Описание сущности (Ф.И.О. или название группы)
— — Примечание string (255) Примечание сущности

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

{
    "request_identifier": "alphapi.recipients.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CustomKey": "1.1023",
                "RECIPIENT_TABLE_ID": 1,
                "RECIPIENT_ID": 1064,
                "Источник": "Пользователь",
                "Объект": "Василий Николаевич Петров",
                "Примечание": "стажер"
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Справочник групп и пользователей (расширенный) #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "[LOGIN_ID] = 1",
    "orderby": "[Основная группа] ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.users.groups.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — GROUP_TABLE_ID integer (3) ID таблицы групп пользователей
— — USERS_TABLE_ID integer (3) ID таблицы пользователей
— — LOGIN_ID integer (10) ID пользователя
— — GROUP_ID integer (10) ID группы пользователя
— — ЛогинФИО string (564) Строка вида login-[номер сервера]/Ф.И.О/ однозначно идентифицирующая пользователя
— — ФИО string (255) Ф.И.О. пользователя
— — Логин string (50) Логин пользователя
— — Основная группа string (50) Основная группа, в которую входит пользователь. Удалить пользователя из основной группы нельзя.
— — Название string (50) Название группы пользователей
— — Активный boolean (1) Флаг: активен ли пользователь в системе
— — Примечание string (255) Примечание пользователя

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

{
    "request_identifier": "alphapi.users.groups.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "GROUP_TABLE_ID": 2,
                "USERS_TABLE_ID": 1,
                "LOGIN_ID": 102,
                "GROUP_ID": 1,
                "ЛогинФИО": "Sync-1 \/яяСинхронизатор\/",
                "ФИО": "Василий Николаевич Петров",
                "Логин": "стажер",
                "Основная группа": "Все пользователи",
                "Название": "Все пользователи",
                "Активный": 1,
                "Примечание": null
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Справочник пользователей #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "[LOGIN_ID] = 1",
    "orderby": "[Логин] ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.users.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — LOGIN_ID integer (10) ID пользователя
— — EXT_GROUPS string (255) Список ID групп пользователя, в которых он состоит (экранированный #)
— — Активный boolean (1) Флаг: активен ли пользователь в системе
— — Логин string (255) Логин пользователя
— — Основная группа string (50) Основная группа, в которую входит пользователь. Удалить пользователя из основной группы нельзя.
— — ФИО string (255) Ф.И.О. пользователя
— — Должность string (255) Должность пользователя (данная строка не коллериуется с разделом системы "должности")
— — Примечание string (255) Примечание пользователя
— — ЛогинФИО string (564) Строка вида login-[номер сервера]/Ф.И.О/ однозначно идентифицирующая пользователя
— — Сервер integer (3) Номер сервера АЛЬФА ДОК, где был создан логин

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

{
    "request_identifier": "alphapi.users.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "LOGIN_ID": 1,
                "EXT_GROUPS": "#1#",
                "Активный": 1,
                "Логин": "alpha-101",
                "Основная группа": "Основная группа",
                "ФИО": "Иванов Иван Иванович",
                "Должность": "Ведущий специалист",
                "Примечание": "Текст примечания",
                "ЛогинФИО": "alpha-101 \/Иванов Иван Иванович\/",
                "Сервер": 1
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Справочник активных пользователей #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "[LOGIN_ID] = 1",
    "orderby": "[Логин] ASC",
    "limit": 1,
    "offset": 0
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.users.active Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — LOGIN_ID integer (10) ID пользователя
— — EXT_GROUPS string (255) Список ID групп пользователя, в которых он состоит (экранированный #)
— — Активный boolean (1) Флаг: активен ли пользователь в системе
— — Логин string (255) Логин пользователя
— — Основная группа string (50) Основная группа, в которую входит пользователь. Удалить пользователя из основной группы нельзя.
— — ФИО string (255) Ф.И.О. пользователя
— — Должность string (255) Должность пользователя (данная строка не коллериуется с разделом системы "должности")
— — Примечание string (255) Примечание пользователя
— — ЛогинФИО string (564) Строка вида login-[номер сервера]/Ф.И.О/ однозначно идентифицирующая пользователя
— — Сервер integer (3) Номер сервера АЛЬФА ДОК, где был создан логин

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

{
    "request_identifier": "alphapi.users.active",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "LOGIN_ID": 1,
                "EXT_GROUPS": "#1#",
                "Активный": 1,
                "Логин": "alpha-101",
                "Основная группа": "Основная группа",
                "ФИО": "Иванов Иван Иванович",
                "Должность": "Ведущий специалист",
                "Примечание": "Текст примечания",
                "ЛогинФИО": "alpha-101 \/Иванов Иван Иванович\/",
                "Сервер": 1
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Список должностей #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "POS_ID = 1",
    "orderby": "Должность ASC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.positions.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — POS_ID integer (10) ID должности
— — PARENTS string (255) Строка ID объектов родителей экранированных # (последний код всегда равен ID должности)
— — Номер integer (10) Внутренний номер должности (равен ID должности)
— — След string (2048) Информационная строка для отображения подчиненности
— — Логин string (50) Логин пользователя, назначенного на должность
— — Сервер integer (3) Сервер, где была создана должность
— — Должность string (255) Название должности
— — ФИО string (255) ФИО пользователя, назначенного на должность
— — Email string (255) Адрес электронной почты пользователя, назначенного на должность
— — Подразделение string (50) Подразделение пользователя, назначенного на должность
— — Телефон string (255) Телефон пользователя, назначенного на должность
— — Примечание string (255) Примечание должности
— — Активна boolean (1) Флаг: активности должности
— — Создана datetime (Y-m-d H:i:s) Метка даты и времени создания должности

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

{
    "request_identifier": "alphapi.positions.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "POS_ID": 101,
                "PARENTS": "#101#",
                "След": null,
                "Логин": "alpha-101",
                "Сервер": 1,
                "Должность": "Ведущий специалист",
                "ФИО": "Петров Василий Иванович",
                "Email": "email@example.com",
                "Подразделение": "Дирекция",
                "Телефон": "+74951234567",
                "Примечание": null,
                "Активна": 1,
                "Создана": "2001-01-01 01:01:01"
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Автозамены #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.autoreplaces.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — FAV_ID integer (10) ID замены
— — Слово string (255) Слово
— — Замена string (255) Замена

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

{
    "request_identifier": "alphapi.autoreplaces.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "FAV_ID": 135,
                "Слово": "коробка",
                "Замена": "упаковка"
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Список поручений #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "RP_ID = 101",
    "orderby": "Дата DESC",
    "limit": 1,
    "offset": 0,
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.commissions.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — RP_ID integer (10) ID поручения
— — RPS_ID integer (10) ID статуса поручения
— — PARENTS string (255) Строка ID родителей экранированных # (последний код всегда равен ID точки маршрута)
— — RPT_ID integer (10) ID типа поручения (Поручение/Уведомление/Согласование)
— — DOC_ID integer (10) ID документа
— — RESPONSIBLE_TABLE_ID integer (3) ID таблицы сущности исполнителя (пользователь/должность/группа)
— — RESPONSIBLE_ID integer (3) ID сущности исполнителя (пользователь/должность/группа)
— — LOGIN_ID integer (10) ID пользователя исполнителя поручения
— — Новое boolean (1) Флаг: прочитано ли пользователем поручение
— — Индикатор integer (3) Число, отображающее количество рабочих дней до истечения срока поручения (если число отрицателельное, то срок уже прошел)
— — Документ integer (10) Внутренний номер документа (равен ID документа)
— — Содержание string (400) Содержание документа
— — Дата datetime (Y-m-d H:i:s) Дата создания черновика документа
— — Статус string (50) Статус документа
— — Контролер string (255) Ф.И.О пользователя контролера по документу
— — Регистратор string (255) Ф.И.О пользователя регистратора по документу
— — Проект string (255) Название проекта документа
— — Тип string (50) Тип поручения
— — Описание string (100) Описание поручения
— — Срок datetime (Y-m-d H:i:s) Срок поручения
— — Дней integer (3) Срок поручения в рабочих днях (может быть пустым, если срок указан явно через дату)
— — Регистрация datetime (Y-m-d H:i:s) Дата регистрации документа, если эта функция используется
— — Рег.номер string (50) Регистрационный номер документа, если эта функция используется
— — Примечание string (255) Примечание поручения
— — Содержание_MASK string (480) Маска поля ввода "Содержание", используется для форматированного ввода текста в поле содержание

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

{
    "request_identifier": "alphapi.commissions.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "RP_ID": 1,
                "RPS_ID": 1,
                "PARENTS": "#10449#",
                "RPT_ID": 1,
                "DOC_ID": 101,
                "RESPONSIBLE_TABLE_ID": 1,
                "RESPONSIBLE_ID": 1,
                "LOGIN_ID": 1,
                "Новое": 1,
                "Индикатор": 1,
                "Документ": 1,
                "Содержание": "Текст содержания",
                "Дата": "2001-01-01 01:01:01",
                "Статус": "Выполняется",
                "Контролер": "Ф.И.О. контролёра",
                "Регистратор": "Ф.И.О. регистратора",
                "Проект": "Название проекта",
                "Тип": "Тип поручения",
                "Описание": "Текст описания поручения",
                "Срок": "2001-01-01 01:01:01",
                "Дней": 1,
                "Регистрация": "2001-01-01 01:01:01",
                "Рег.номер": "12345",
                "Примечание": "Текст примечания",
                "Содержание_MASK": null
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Счетчик поручений #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.commissions.count Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer (10) Общее кол-во
— count_new integer (10) Кол-во новых
— count_expired integer (10) Кол-во просроченных
— ids string (255) Массив ID поручений, разделенных "&"
— ids_new string (255) Массив ID новых поручений, разделенных "&"

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

{
    "request_identifier": "alphapi.commissions.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Counter of documents under control",
    "data": {
        "count": 123,
        "count_new": 12,
        "count_expired": 1,
        "ids": "101&102&103",
        "ids_new": "101&102&103"
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Согласование точки маршрута #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
rp_id integer (10) Да ID точки маршрута
comment string (2048) Текст резолюции/комментария

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 101,
    "comment": "Комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.routepoint.accept Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.routepoint.accept",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point accepted successfully"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Отклонение точки маршрута #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
rp_id integer (10) Да ID точки маршрута
comment string (2048) Текст резолюции/комментария

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 101,
    "comment": "Комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.routepoint.decline Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— rp_id integer (10) ID точки

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

{
    "request_identifier": "alphapi.doc.routepoint.decline",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point declined successfully",
    "data": {
        "rp_id": 101
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Пометить прочитанной точку маршрута #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
rp_id integer (10) Да ID точки маршрута

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 101,
    "comment": "Комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.routepoint.mark.read Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.read",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point marked as read successfully"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Подтверждение выполнения поручения #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
rp_id integer (10) Да ID точки маршрута
comment string (2048) Текст резолюции/комментария

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 101,
    "comment": "Комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.routepoint.mark.confirm Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.confirm",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point marked as confirmed successfully"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Отчитаться о выполнении поручения #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
rp_id integer (10) Да ID точки маршрута
comment string (2048) Текст резолюции/комментария

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 101,
    "comment": "Комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.routepoint.mark.finish Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.finish",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point marked as finished successfully"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Вернуть поручение на доработку #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
rp_id integer (10) Да ID точки маршрута
comment string (2048) Текст резолюции/комментария

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 101,
    "comment": "Комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.routepoint.mark.return Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.return",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point marked as returned successfully"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Остановить точку маршрута #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
rp_id integer (10) Да ID точки маршрута
comment string (2048) Текст резолюции/комментария

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 10449,
    "comment": "Комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.routepoint.mark.stop Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.stop",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point marked as stoped successfully"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Отметить уведомление как прочитаное #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
rp_id integer (10) Да ID точки маршрута
comment string (2048) Текст резолюции/комментария

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 101,
    "comment": "Комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.routepoint.mark.view Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.view",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point marked as viewed successfully"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Отметить точку маршрута как взятую #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
rp_id integer (10) Да ID точки маршрута
comment string (2048) Текст резолюции/комментария

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 101,
    "comment": "Комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.routepoint.mark.taken Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.routepoint.mark.taken",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point taken successfully"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Установка исполнителя поручения #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
rp_id integer (10) Да ID точки маршрута
responsible_table_id integer (3) Да ID таблицы сущности исполнителя (пользователь/должность/группа)
responsible_id integer (10) Да ID сущности исполнителя (пользователь/должность/группа)

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 101,
    "responsible_table_id": 1,
    "responsible_id": 101
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.routepoint.responsible.set Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.routepoint.responsible.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point responsible set successfully"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Список документов на контроле #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "DOC_ID = 101",
    "orderby": "Дата ASC",
    "limit": 1,
    "offset": 0,
    "count_only": 0
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.control.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — DOC_ID integer (10) ID документа
— — DOC_CONTROLLER_ID integer (10) ID контроллера документа
— — DS_ID integer (10) ID статуса документа
— — DT_ID integer (10) ID типа документа
— — Активен boolean (1) Флаг: активен ли докумнт или нет (документ может быть неактивным, если это черновик или на паузе)
— — Индикатор integer (3) Кол-во дней без изменений в документе. Если индикатор = -1, то это значит, что есть изменения требующие внимания контролера
— — Тип string (50) Тип документа
— — Номер integer (10) Внутренний номер документа (равен ID документа)
— — Дата date (Y-m-d H:i:s) Дата создания черновика документа
— — Статус string (50) Статус документа
— — Контролер string (50) Ф.И.О. пользователя контролера по документу
— — Регистратор string (50) Ф.И.О. пользователя регистратора по документу
— — Проект string (255) Название проекта документа
— — Содержание string (400) Содержание документа
— — Срок date (Y-m-d H:i:s) Общий срок документа (не путать со сроком поручения)
— — Регистрация date (Y-m-d H:i:s) Дата регистрации документа, если эта функция используется
— — Рег.номер string (50) Регистрационный номер документа, если эта функция используется
— — Выполнение integer (3) Процент выполнения маршрута документа (отношение выполненых точек маршрута к общему числу)
— — Исполнители string (255) ФИО текущих исполнителей по документу через запятую (до 3 человек)
— — Комментарий string (255) Комментарий документа
— — Содержание_MASK string (1024) Маска поля ввода "Содержание" (используется для форматированного ввода текста в поле содержание)

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

{
    "request_identifier": "alphapi.control.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "DOC_ID": 101,
                "DOC_CONTROLLER_ID": 1070,
                "DS_ID": 101,
                "DT_ID": 1,
                "Активен": 1,
                "Индикатор": 12,
                "Тип": "Документ",
                "Номер": 101,
                "Дата": "2001-01-01 01:01:01",
                "Статус": "Выполняется",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Название проекта",
                "Содержание": "Содержание документа",
                "Срок": "2001-01-01 01:01:01",
                "Регистрация": "2001-01-01 01:01:01",
                "Рег.номер": "",
                "Выполнение": 33,
                "Исполнители": "Сидоров С.С.",
                "Комментарий": "Комментарий к документу",
                "Содержание_MASK": ""
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Счетчик документов на контроле #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.control.count Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer (10) Общее кол-во
— count_new integer (10) Кол-во новых
— count_expired integer (10) Кол-во просроченных
— ids string (255) Массив ID документов, разделенных "&"
— ids_new string (255) Массив ID новых документов, разделенных "&"

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

{
    "request_identifier": "alphapi.control.count",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Counter of documents under control",
    "data": {
        "count": 123,
        "count_new": 12,
        "count_expired": 1,
        "ids": "101&102&103",
        "ids_new": "101&102&103"
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Список документов #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.docs.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — DOC_ID integer (10) ID документа
— — REGISTRAR_ID integer (10) ID логина пользователя создавшего документ
— — CONTROLLER_ID integer (10) ID логина пользователя контролера документа
— — DS_ID integer (10) ID статуса документа
— — DT_ID integer (10) ID типа документа
— — Тип string (50) Тип документа
— — Активен boolean (1) Флаг: активен ли документ или нет (документ может быть неактивным, если это черновик или на паузе)
— — Статус string (255) Статус документа
— — Номер integer (10) Внутренний номер документа (равен ID документа)
— — Дата datetime (Y-m-d H:i:s) Дата создания черновика документа
— — Контролер string (255) Ф.И.О. пользователя контролера по документу
— — Регистратор string (255) Ф.И.О. пользователя регистратора по документу
— — Проект string (255) Название проекта
— — Содержание string (255) Содержание документа
— — Содержание_MASK string (480) Маска поля ввода "Содержание", используется для форматированного ввода текста в поле содержание
— — Содержание_MASK_PARAMS string (1024) Содержит информацию о параметрах документа, которые сохранены в его содержании
— — Содержание_MASK_COND string (261) Содержит информацию об условии, которое нужно применить при поиске документов данного типа
— — Запуск datetime (Y-m-d H:i:s) Дата автоматического запуска документа в работу, если установлен отсроченный запуск
— — Срок datetime (Y-m-d H:i:s) Общий срок документа (не путать со сроком поручения)
— — Исполнен datetime (Y-m-d H:i:s) Дата остановки документа (чаще всего когда все поручения по нему выполнены)
— — Регистрация datetime (Y-m-d H:i:s) Дата регистрации документа, если эта функция используется
— — Рег.номер string (50) Регистрационный номер документа, если эта функция используется
— — Комментарий string (255) Комментарий документа

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

{
    "request_identifier": "alphapi.docs.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "DOC_ID": 101,
                "REGISTRAR_ID": 101,
                "CONTROLLER_ID": 101,
                "DS_ID": 101,
                "DT_ID": 101,
                "Тип": "Уведомление",
                "Активен": 1,
                "Статус": "Просрочен",
                "Номер": 101,
                "Дата": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Договора",
                "Содержание": "Содержание документа",
                "Содержание_MASK": "",
                "Содержание_MASK_PARAMS": "",
                "Содержание_MASK_COND": "DT_ID=101",
                "Запуск": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Регистрация": "2001-01-01 01:01:01",
                "Рег.номер": "101",
                "Комментарий": null
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Файлы документов #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк
date_created date Дата создания
before_date_created boolean 0 Флаг: Перед датой создания

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "date_created": "2001-01-01",
    "before_date_created": 0
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.docs.files.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — F_ID integer (10) ID файла
— — DOC_ID integer (10) ID документа
— — PARENT_TABLE_ID integer (3) ID таблицы сущности
— — PARENT_ID integer (10) ID сущности
— — Активен boolean (1) Флаг: активен ли документ или нет (документ может быть неактивным, если это черновик или на паузе)
— — Документ integer (10) Номер документа
— — ДатаДокумента datetime (Y-m-d H:i:s) Дата создания черновика документа
— — Срок datetime (Y-m-d H:i:s) Общий срок документа (не путать со сроком поручения)
— — Исполнен datetime (Y-m-d H:i:s) Дата остановки документа (чаще всего когда все поручения по нему выполнены)
— — Контролер string (255) Ф.И.О. пользователя контролера по документу
— — Регистратор string (255) Ф.И.О. пользователя регистратора по документу
— — Проект string (255) Название проекта документа
— — Содержание string (255) Содержание документа
— — Название string (59) Название файла
— — Редакция integer (3) Редакция файла
— — Пользователь string (255) Логин пользователя, который добавил файл
— — Атрибуты string (255) Атрибуты файла, флаги архивирования и шифрования
— — Примечание string (5) Примечание к файлу
— — Создан datetime (Y-m-d H:i:s) Дата время создания файла
— — Скопирован datetime (Y-m-d H:i:s) Дата время завершения копирования файла в хранилище
— — Индикатор boolean (1) Индикатор, является ли данный файл последней редакцией в данном документе

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

{
    "request_identifier": "alphapi.docs.files.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "F_ID": 101,
                "DOC_ID": 101,
                "PARENT_TABLE_ID": 1,
                "PARENT_ID": 101,
                "Активен": 1,
                "Документ": 101,
                "ДатаДокумента": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Название проекта документа",
                "Содержание": "Содержание документа",
                "Название": "Название_файла.docx",
                "Редакция": 1,
                "Пользователь": "Сидоров С.С.",
                "Атрибуты": "",
                "Примечание": null,
                "Создан": "2001-01-01 01:01:01",
                "Скопирован": "2001-01-01 01:01:01",
                "Индикатор": 1
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Аудит документов #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) Да 1000 Ограничить кол-во записей. Максимально допустимое значение: 1000
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "where": "DOC_ID = 101",
    "orderby": "[Дата время] DESC",
    "limit": 1000,
    "offset": 0
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.docs.audit.all Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — AUDIT_ID integer (20) ID записи аудита
— — DOC_ID integer (10) ID документа
— — Активен boolean (1) Флаг: активен ли документ или нет (документ может быть неактивным, если это черновик или на паузе)
— — Номер integer (10) Внутренний номер документа (равен ID документа)
— — Дата datetime (Y-m-d H:i:s) Дата создания черновика документа
— — Срок datetime (Y-m-d H:i:s) Общий срок документа (не путать со сроком поручения)
— — Исполнен datetime (Y-m-d H:i:s) Дата остановки документа (чаще всего когда все поручения по нему выполнены)
— — Проект string (255) Название проекта документа
— — Содержание string (255) Содержание документа
— — Контролер string (255) Ф.И.О. пользователя контролера по документу
— — Регистратор string (255) Ф.И.О. пользователя регистратора по документу
— — Дата время datetime (Y-m-d H:i:s) Дата и время события
— — Параметр01 string (305) Предыдущее значение параметра или прочая информация
— — Параметр02 string (305) Следующее значение параметра или прочая информация
— — Станция string (255) Название компьютера, с которого произошло изменение
— — Пользователь string (564) Логин пользователя, который сделал изменение
— — Приоритет события integer (10) Приориет события аудита
— — Событие string (564) Описание события аудита
— — Элемент string (411) Элемент документа, с которым прошли изменения

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

{
    "request_identifier": "alphapi.docs.audit.all",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "AUDIT_ID": 1234567890,
                "DOC_ID": 101,
                "Активен": 1,
                "Номер": 101,
                "Дата": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Проект": "Название проекта документа",
                "Содержание": "Содержание документа",
                "Контролер": "Ремесленников Р.Р.",
                "Регистратор": "Дорофеев Д.Д.",
                "Дата время": "2001-01-01 01:01:01",
                "Параметр01": "Спасибо. Выполнено",
                "Параметр02": "Успешно, ID 10238",
                "Станция": "ALPHA101",
                "Пользователь": "Логин пользователя",
                "Приоритет события": 2,
                "Событие": "Добавление комментария",
                "Элемент": null
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Процент выполнения документов #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.docs.progress Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— items Массив элементов
— — DOC_ID integer (10) ID документа
— — Выполнение integer (2) Процент выполнения документа

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

{
    "request_identifier": "alphapi.docs.progress",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "items": [
            {
                "DOC_ID": 101,
                "Выполнение": 50
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Доступ к документу #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
doc_id integer (10) Да ID типа документа
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.access Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — CustomKey string (255) Уникальный ключ
— — ACCESS_ID integer (10) ID ключ строки доступа
— — DOC_ID integer (10) ID документа
— — PROVIDER_TABLE_ID integer (3) ID таблицы источника доступа
— — PROVIDER_ID integer (10) ID источника доступа
— — RECIPIENT_TABLE_ID integer (3) ID таблицы получателя доступа
— — RECIPIENT_ID integer (10) ID получателя доступа
— — Тип string (255) Тип доступа
— — Источник string (255) Источник доступа
— — Объект string (255) Объект получатель доступа
— — Примечание string (255) Примечание к объекту получателя доступа
— — Родитель string (255) Объект источника доступа

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

{
    "request_identifier": "alphapi.doc.access",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "CustomKey": "Наследуемый.1010748.1019264",
                "ACCESS_ID": 1077,
                "DOC_ID": 1010748,
                "PROVIDER_TABLE_ID": 49,
                "PROVIDER_ID": 103,
                "RECIPIENT_TABLE_ID": 2,
                "RECIPIENT_ID": 1,
                "Тип": "Наследуемый",
                "Источник": "Группы пользователей",
                "Объект": "Администраторы",
                "Примечание": "Встроенная группа",
                "Родитель": "Проект: Договора и ДС"
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Счетчики для документа #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
doc_id integer (10) Да ID документа

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 2014
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.counters Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— comments_count integer (10) Кол-во резолюций
— files_count integer (10) Кол-во файлов
— links_count integer (10) Кол-во привязанных документов
— contractor_count integer (10) Кол-во контрагентов
— views_count integer (10) Кол-во просмотров

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

{
    "request_identifier": "alphapi.doc.counters",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Incorrect text identifier \"counter_of_documents_success\".",
    "data": {
        "comments_count": 55,
        "files_count": 12,
        "links_count": 1,
        "contractor_count": 6,
        "views_count": 5
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Добавление черновика документа #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
dt_id integer (10) Да ID типа документа
p_id integer (10) Да ID проекта документа
controller_id integer (10) Да ID пользователя контролера документа
plan_end_date date (YYYY-MM-DD) Срок документа
content text (255) Да Содержание документа
comment text (255) Комментарий документа
pg date (YYYY-MM-DD) План-график (рудимент)
start date (YYYY-MM-DD) Дата планового запуска документа в работу
reg_date date (YYYY-MM-DD) Дата регистрации документа
reg_number varchar (50) Регистрационный номер документа
color integer (4) Цветовой тег проекта, цвет передается в кодировке R255+G255+B255

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "dt_id": 101,
    "p_id": 101,
    "controller_id": 101,
    "content": "Текст"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— doc_id integer (10) ID документа

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

{
    "request_identifier": "alphapi.doc.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Document added successfully",
    "data": {
        "doc_id": 101
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Добавление точки маршрута #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
doc_id integer (10) Да ID документа
rpt_id integer (10) Да ID типа точки маршрута (поручение/уведомление/согласование)
responsible_table_id integer (3) Да ID таблицы сущности исполнителя (пользователь/должность/группа)
responsible_id integer (10) Да ID сущности исполнителя (пользователь/должность/группа)
parents text (255) Строка ID родителей экранированных # (последний код всегда равен ID точки маршрута)
links text (255) Строка ID входящих зависимостей экранированных #
end_date date (YYYY-MM-DD) Срок (если указывается точная дата, иначе NULL если срок указывается через рабочие дни)
days integer (3) Срок в рабочик днях (NULL, если срок указывается через точную дату)
content text (100) Да Описание точки маршрута (что требуется от исполнителя)
comment text (255) Примечание точки маршрута
parent_id integer (10) ID точки маршрута, с которой была скопирована текущая (применяется в стандартных маршрутах)

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101,
    "rpt_id": 101,
    "responsible_table_id": 1,
    "responsible_id": 101,
    "content": "Текст"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.routepoint.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— rp_id integer (10) ID точки маршрута

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

{
    "request_identifier": "alphapi.doc.routepoint.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point added successfully",
    "data": {
        "rp_id": 101
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Изменение точки маршрута #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
rp_id integer (10) Да ID точки маршрута
doc_id integer (10) Да ID документа
rpt_id integer (10) Да ID типа точки маршрута (поручение/уведомление/согласование)
responsible_table_id integer (10) Да ID таблицы сущности исполнителя (пользователь/должность/группа)
responsible_id integer (10) Да ID сущности исполнителя (пользователь/должность/группа)
parents text (255) Строка ID родителей экранированных # (последний код всегда равен ID точки маршрута)
links text (255) Строка ID входящих зависимостей экранированных #
end_date date (YYYY-MM-DD) Срок (если указывается точная дата, иначе NULL если срок указывается через рабочие дни)
days integer (10) Срок в рабочик днях (NULL, если срок указывается через точную дату)
content text (100) Да Описание точки маршрута (что требуется от исполнителя)
comment text (255) Примечание точки маршрута
parent_id integer (10) ID точки маршрута, с которой была скопирована текущая (применяется в стандартных маршрутах)

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "rp_id": 101,
    "doc_id": 101,
    "rpt_id": 101,
    "responsible_table_id": 1,
    "responsible_id": 101,
    "content": "Текст"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.routepoint.edit Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— rp_id integer (10) ID точки маршрута

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

{
    "request_identifier": "alphapi.doc.routepoint.edit",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Route point edited successfully",
    "data": {
        "rp_id": 101
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Запуск или постановка документа на паузу #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
doc_id integer (1, 10) Да ID документа
active integer (0, 1) Да 0 - на паузу, 1 - запуск

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101,
    "active": 1
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.activation.set Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.activation.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Остановка документа #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
doc_id integer (10) Да ID документа
comment string (2048) Текст резолюции

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101,
    "comment": "Комментарий"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.stop Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— doc_id integer (10) ID документа

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

{
    "request_identifier": "alphapi.doc.stop",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Document stoped successfully",
    "data": {
        "doc_id": 101
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Список поручений по документу #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк
doc_id integer Да 10 ID документа

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101,
    "where": "LOGIN_ID = 1",
    "orderby": "[Создана] DESC",
    "limit": 1,
    "offset": 0
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.routespoints.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — RP_ID integer (10) ID точки маршрута
— — DOC_ID integer (10) ID документа
— — RESPONSIBLE_TABLE_ID integer (3) ID таблицы сущности исполнителя (пользователь/должность/группа)
— — RESPONSIBLE_ID integer (10) ID сущности исполнителя (пользователь/должность/группа)
— — LOGIN_ID integer (10) ID пользователя исполнителя поручения
— — RPT_ID integer (10) ID типа точки маршрута (поручение/уведомление/согласование)
— — RPS_ID integer (10) ID статуса точки маршрута
— — PARENTS string (255) Строка ID родителей экранированных # (последний код всегда равен ID точки маршрута)
— — LINKS string (255) Строка ID входящих зависимостей, экранированных #
— — Уровень integer (3) Уровень точки маршрута, начиная с 0
— — Номер integer (3) Последовательный номер точки маршрута по последовательности исполнения документа
— — Предыдущий string (255) Предыдущие номера точек маршрута через запятую, которые должны быть выполнены до запуска текущей точки
— — Тип string (255) Тип точки маршрута
— — Срок datetime (Y-m-d H:i:s) Срок точки маршрута
— — Дней integer (3) Срок точки маршрута в рабочих днях, если он был указан при создании маршрута
— — Выполнено datetime (Y-m-d H:i:s) Дата/время выполнения точки маршрута
— — Исполнитель string (255) Исполнитель точки маршрута
— — Контролер string (255) ФИО контролера точки маршрута
— — Статус string (255) Статус точки маршрута
— — Описание string (255) Описание точки маршрута
— — Примечание string (255) Примечание точки маршрута
— — Индикатор integer (3) Число, отображающее количество рабочих дней до истечения срока (если число отрицательное, то срок уже прошел)
— — Создана date (Y-m-d H:i:s) Число, отображающее количество рабочих дней до истечения срока (если число отрицательное, то срок уже прошел)
— — Флаг boolean (1) Флаг: является ли текущий пользователь контролёром данной точки
— — Родитель integer (10) ID точки маршрута, из которой была скопирована текущая точка маршрута

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

{
    "request_identifier": "alphapi.doc.routespoints.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "RP_ID": 101,
                "DOC_ID": 101,
                "RESPONSIBLE_TABLE_ID": 1,
                "RESPONSIBLE_ID": 101,
                "LOGIN_ID": 101,
                "RPT_ID": 2,
                "RPS_ID": 3,
                "PARENTS": "#101#",
                "LINKS": null,
                "Уровень": 0,
                "Номер": 0,
                "Предыдущий": "",
                "Тип": "Уведомление",
                "Срок": "2001-01-01 01:01:01",
                "Дней": 3,
                "Выполнено": "",
                "Исполнитель": "Имя",
                "Контролер": "Имя",
                "Статус": "Просрочено",
                "Описание": "Добавлен комментарий",
                "Примечание": "Добавлен комментарий",
                "Индикатор": -9,
                "Создана": "2001-01-01 01:01:01",
                "Флаг": 1,
                "Родитель": 101
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Список резолюций по документу #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк
doc_id integer (10) Да ID типа документа

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.comments.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — COMMENT_ID integer (10) ID резолюции/комментария
— — PARENT_TABLE_ID integer (3) ID таблицы сущности
— — PARENT_ID integer (10) ID сущности
— — DOC_ID integer (10) ID документа
— — Активен boolean (1) Флаг: документ активен
— — Номер integer (10) Внутренний номер документа (равен ID документа)
— — Дата datetime (Y-m-d H:i:s) Дата документа
— — Срок datetime (Y-m-d H:i:s) Срок документа (может быть пустым)
— — Исполнен datetime (Y-m-d H:i:s) Дата остановки документа (чаще всего когда все поручения по нему выполнены)
— — Контролер string (255) Ф.И.О. контролера документа
— — Регистратор string (255) Ф.И.О. пользователя, который создал документ
— — Проект string (255) Название проекта документа
— — Содержание string (255) Содержание документа
— — Дата время datetime (Y-m-d H:i:s) Дата и время резолюции/комментария
— — Текст string (2048) Текст резолюции/комментария
— — Пользователь string (255) Ф.И.О. пользователя, который создал резолюцию/комментарий
— — Элемент string (255) Описательная часть поручения, к которой относится резолюция/комментарий

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

{
    "request_identifier": "alphapi.doc.comments.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "COMMENT_ID": 101,
                "PARENT_TABLE_ID": 1,
                "PARENT_ID": 101,
                "DOC_ID": 101,
                "Активен": 1,
                "Номер": 101,
                "Дата": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Название проекта документа",
                "Содержание": "Содержание документа",
                "Дата время": "2001-01-01 01:01:01",
                "Текст": "Текст резолюции\/комментария",
                "Пользователь": "Сидоров С.С.",
                "Элемент": null
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Файлы документов #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк
doc_id integer (10) Да ID документа

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.files.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — F_ID integer (10) ID файла
— — DOC_ID integer (10) ID документа
— — PARENT_TABLE_ID integer (10) ID таблицы сущности
— — PARENT_ID integer (10) ID сущности
— — Активен boolean (1) Флаг: активен ли документ или нет (документ может быть неактивным, если это черновик или на паузе)
— — НомерДокумента integer (10) Внутренний номер документа (равен ID документа)
— — ДатаДокумента datetime (Y-m-d H:i:s) Дата создания черновика документа
— — Срок datetime (Y-m-d H:i:s) Общий срок документа (не путать со сроком поручения)
— — Исполнен datetime (Y-m-d H:i:s) Дата остановки документа (чаще всего когда все поручения по нему выполнены)
— — Контролер string (255) Ф.И.О. пользователя контролера по документу
— — Регистратор string (255) Ф.И.О. пользователя регистратора по документу
— — Проект string (255) Название проекта документа
— — Содержание string (255) Содержание документа
— — Номер integer (3) Номер файла в документе
— — Название string (255) Название файла
— — Редакция integer (3) Редакция файла
— — Пользователь string (255) Логин пользователя, который добавил файл
— — Файл string (255) Путь к файлу в хранилище данных
— — Примечание string (255) Примечание к файлу
— — Создан datetime (Y-m-d H:i:s) Дата и время создания файла
— — Скопирован datetime (Y-m-d H:i:s) Дата и время завершения копирования файла в хранилище
— — Индикатор boolean (1) Индикатор, является ли данный файл последней редакцией в данном документе
— — Атрибуты string (5) Атрибуты файла, флаги архивирования и шифрования
— — Размер integer (10) Размер файла в байтах
— — ЭП integer (4) Метка простой цифровой подписи файла

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

{
    "request_identifier": "alphapi.doc.files.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "F_ID": 101,
                "DOC_ID": 101,
                "PARENT_TABLE_ID": 101,
                "PARENT_ID": 101,
                "Активен": 1,
                "НомерДокумента": 101,
                "ДатаДокумента": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Название проекта документа",
                "Содержание": "Содержание документа",
                "Номер": 2,
                "Название": "Название файла",
                "Редакция": 3,
                "Пользователь": "Сидоров С.С.",
                "Файл": "Путь к файлу в хранилище данных",
                "Примечание": "Примечание к файлу",
                "Создан": "2001-01-01 01:01:01",
                "Скопирован": "2001-01-01 01:01:01",
                "Индикатор": 1,
                "Атрибуты": "",
                "Размер": 12345,
                "ЭП": null
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Список простых ЭП файлов документа #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
doc_id integer (10) Да ID документа
count_only boolean false Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.files.signatures.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — F_ID integer (10) ID файла
— — DOC_ID integer (10) ID документа
— — Номер integer (3) Номер файла в документе
— — Файл string (255) Название файла
— — Редакция integer (3) Редакция файла
— — Пользователь string (255) Логин пользователя, который добавил файл
— — ЭП float (255) Метка простой цифровой подписи файла

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

{
    "request_identifier": "alphapi.doc.files.signatures.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "count": 1,
    "data": {
        "items": [
            {
                "F_ID": 101,
                "DOC_ID": 101,
                "Номер": 2,
                "Файл": "Приложение.doc",
                "Редакция": 3,
                "Пользователь": "Сидоров С.С.",
                "ЭП": -4.94714764660603
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Пометить документ как прочитанный #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
doc_id integer (10) Да ID документа

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.mark.view Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.doc.mark.view",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Смена контролера #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
doc_id integer (10) Да ID документа
login_id integer (10) Да ID логина

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101,
    "login_id": 101
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.controller.set Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— doc_id integer (10) ID документа

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

{
    "request_identifier": "alphapi.doc.controller.set",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Controller setted successfully",
    "data": {
        "doc_id": 101
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Маршрут документа #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
doc_id integer (10) Да ID документа

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.doc.gantt.items Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы точек маршрута
— — RP_ID integer (10) ID точки маршрута
— — DOC_ID integer (10) ID документа
— — RPT_ID integer (10) ID типа точки маршрута (поручение/согласование/уведомление)
— — RPS_ID integer (10) ID статуса точки маршрута
— — DOC_CONTROLLER_ID integer (10) ID пользователя контролера документа
— — LOGIN_ID integer (10) ID пользователя исполнителя по точке маршрута
— — LINKS string (255) Строка вида #ID1##ID2# связей точки маршрута
— — PARENTS string (255) Строка вида #ID1##ID2#, которая указывает на родительскую точку маршрута
— — Номер integer (10) Номер точки маршрута в документе, отсортировано автоматически
— — Описание string (255) Описание точки маршрута
— — Исполнитель string (255) Исполнитель данной точки маршрута (Роль/группа/пользователь)
— — Документ string (255) Описание документа точки маршрута
— — Статус string (255) Статус точки маршрута
— — НачалоПлан date (Y-m-d H:i:s) Дата/время планового начала исполнения точки маршрута
— — Начало date (Y-m-d H:i:s) Фактическое дата время начала исполнения точки маршрута
— — Срок date (Y-m-d H:i:s) Срок для исполнения точки маршрута
— — Выполнено date (Y-m-d H:i:s) Дата/время фактического исполнения точки маршрута исполнителем
— — Подтверждено date (Y-m-d H:i:s) Дата/время проверки результата исполнения контролером точки маршрута
— — Индикатор integer (3) Индикатор точки маршрута (кол-во рабочих дней до или после срока)
— — Контролер string (255) Контролер точки маршрута (может отличаться от контролера документа)
— — Примечание string (255) Примечание точки маршрута

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

{
    "request_identifier": "alphapi.doc.gantt.items",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "items": [
            {
                "TABLE_ID": 1,
                "RP_ID": 101,
                "DOC_ID": 101,
                "RPT_ID": 101,
                "RPS_ID": 101,
                "DOC_CONTROLLER_ID": 101,
                "LOGIN_ID": 101,
                "LINKS": "#101##102#",
                "PARENTS": "#101##102#",
                "Номер": 101,
                "Описание": "Описание точки маршрута",
                "Исполнитель": "Роль\/группа\/пользователь",
                "Документ": "Описание документа точки маршрута",
                "Статус": "Статус точки маршрута",
                "НачалоПлан": "2001-01-01 01:01:01",
                "Начало": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Выполнено": "2001-01-01 01:01:01",
                "Подтверждено": "2001-01-01 01:01:01",
                "Индикатор": 1,
                "Контролер": "Иванов И.И.",
                "Примечание": null
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Просмотры документа #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
doc_id integer Да 10 ID документа
count_only boolean false Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "doc_id": 101
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.docs.views.all Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — KEY_ID integer (10) ID-ключ
— — DOC_ID integer (10) ID документа
— — Активен boolean (1) Флаг активности
— — Документ integer (10) ID документа
— — ДатаДокумента date (Y-m-d H:i:s) Дата создания черновика документа
— — Срок date (Y-m-d H:i:s) Общий срок документа (не путать со сроком поручения)
— — Исполнен date (Y-m-d H:i:s) Дата остановки документа (чаще всего когда все поручения по нему выполнены)
— — Контролер string (255) Ф.И.О. пользователя контролера по документу
— — Регистратор string (255) Ф.И.О. пользователя регистратора по документу
— — Проект string (255) Название проекта документа
— — Содержание string (255) Содержание документа
— — Пользователь string (255) Логин пользователя
— — Дата date (Y-m-d H:i:s) Дата просмотра
— — Активно boolean (1) Флаг активности

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

{
    "request_identifier": "alphapi.docs.views.all",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "KEY_ID": 101,
                "DOC_ID": 101,
                "Активен": 1,
                "Документ": "",
                "ДатаДокумента": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Главный",
                "Содержание": "Тест",
                "Пользователь": "Сидоров С.С.",
                "Дата": "2001-01-01 01:01:01",
                "Активно": 1
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Контрагенты документов #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
doc_id integer (10) Да ID типа документа
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.docs.clients.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — LINK_ID integer (10) ID ссылки
— — DOC_ID integer (10) ID документа
— — CLIENT_ID integer (10) ID контрагента
— — Ссылка string (50) Ссылка
— — Номер integer (3) Номер
— — Тип string (50) Тип
— — Название string (308) Название
— — Менеджер string (255) Менеджер
— — Создана datetime (Y-m-d H:i:s) Дата создания
— — Примечание string (255) Примечание

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

{
    "request_identifier": "alphapi.docs.clients.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 55,
                "LINK_ID": 101,
                "DOC_ID": 101,
                "CLIENT_ID": 101,
                "Ссылка": "По умолчанию",
                "Номер": 101,
                "Тип": "Юридическое лицо",
                "Название": "АЛЬФА ДОК",
                "Менеджер": "яяРазработчик",
                "Создана": "2001-01-01 01:01:01",
                "Примечание": null
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Документы документов #

URL:
Эмулятор

Пометить как непрочитанное #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
parent_table_id integer (3) Да ID таблицы сущности
parent_id integer (10) Да ID сущности

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "parent_table_id": 101,
    "parent_id": 101
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.set.unread Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.system.set.unread",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Список комментариев/резолюций документов #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.comments.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — COMMENT_ID integer (10) ID резолюции/комментария
— — DOC_ID integer (10) ID документа
— — Активен boolean (1) Флаг: документ активен
— — Номер integer (10) Внутренний номер документа (равен ID документа)
— — Дата datetime (Y-m-d H:i:s) Дата документа
— — Срок datetime (Y-m-d H:i:s) Срок документа (может быть пустым)
— — Исполнен datetime (Y-m-d H:i:s) Дата остановки документа (чаще всего когда все поручения по нему выполнены)
— — Контролер string (255) Ф.И.О. контролера документа
— — Регистратор string (255) Ф.И.О. пользователя, который создал документ
— — Проект string (255) Название проекта документа
— — Содержание string (255) Содержание документа
— — Дата время datetime (Y-m-d H:i:s) Дата и время резолюции/комментария
— — Текст string (2048) Текст резолюции/комментария
— — Пользователь string (255) Ф.И.О. пользователя, который создал резолюцию/комментарий
— — Элемент string (255) Описательная часть поручения, к которой относится резолюция/комментарий

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

{
    "request_identifier": "alphapi.system.comments.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "COMMENT_ID": 101,
                "DOC_ID": 101,
                "Активен": 1,
                "Номер": 101,
                "Дата": "2001-01-01 01:01:01",
                "Срок": "2001-01-01 01:01:01",
                "Исполнен": "2001-01-01 01:01:01",
                "Контролер": "Иванов И.И.",
                "Регистратор": "Петров П.П.",
                "Проект": "Название проекта документа",
                "Содержание": "Содержание документа",
                "Дата время": "2001-01-01 01:01:01",
                "Текст": "Текст резолюции\/комментария",
                "Пользователь": "Сидоров С.С.",
                "Элемент": null
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Добавление комментария #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
parent_table_id integer (10) Да ID таблицы сущности
parent_id integer (10) Да ID сущности
comment string (2048) Да Комментарий

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "parent_table_id": 101,
    "parent_id": 101,
    "comment": "Тест"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.comment.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— comment_id integer ID комментария

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

{
    "request_identifier": "alphapi.system.comment.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Добавление файла #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
parent_table_id integer Да 3 ID таблицы сущности
parent_id integer Да 10 ID сущности
file_path string Да 255 Относительный пусть файла
file_name string Да 50 Имя файла
file_size integer Да 255 Размер файла
file_edition integer 3 Номер ревизии
comment string 255 Комментарий
attributes string 5 Атрибуты

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "parent_table_id": 101,
    "parent_id": 101,
    "file_path": "\/a\/b\/c\/d\/e\/f\/abcdefjiklmnopqrstuvw",
    "file_name": "some-file-name.jpg",
    "file_size": 1234567890,
    "file_edition": 1,
    "comment": null,
    "attributes": ""
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.file.add Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— file_id integer ID файла

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

{
    "request_identifier": "alphapi.system.file.add",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Получение файла #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
file_id integer Да 10 ID файла

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "file_id": 101
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.file.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
file_base64 text Содержимое файла в формате BASE64

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

{
    "request_identifier": "alphapi.system.file.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Пометить файл как скопированный #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
file_id integer Да 10 ID файла

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "file_id": 101
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.file.markascopied Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.system.file.markascopied",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Добавить просмотр файла #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
file_ids integer[] (10) Да Массив ID файлов

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "file_ids": [
        101,
        777
    ]
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.file.addview Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.system.file.addview",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Мета данные по файлу #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
file_hash string Да Хеш файла

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "file_hash": "0A4BB28F7C07FAA3424DF3342DAABBA1184"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.file.meta.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Массив данных
— count_pages integer Кол-во страниц

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

{
    "request_identifier": "alphapi.system.file.meta.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful",
    "data": {
        "count_pages": 7
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Срок в рабочих днях #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
date_start date (YYYY-MM-DD) Дата, с которой посчитать срок в рабочих днях (если указывается точная дата, иначе NULL если срок указывается с текущего дня)
count_day integer (10) Да 0 Сколько рабочих дней добавить к дате

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "count_day": 3
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.get.deadline Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Массив элементов
— date date (DD.MM.YYYY) Дата

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

{
    "request_identifier": "alphapi.system.get.deadline",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "date": "01.01.2001"
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Разница в рабочих днях #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
date_start date (YYYY-MM-DD) Да Стартовая дата для вычисления
date_end date (YYYY-MM-DD) Да Конечная дата для вычисления

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "date_start": "2021-01-15",
    "date_end": "2021-01-30"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.workdaysdiff Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count_days integer (10) Кол-во рабочих дней

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

{
    "request_identifier": "alphapi.system.workdaysdiff",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count_days": 11
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Разница в рабочих днях (множественная) #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
items Массив элементов
— date_start date (YYYY-MM-DD) Да Дата начала для вычисления
— date_end date (YYYY-MM-DD) Да Конечная дата для вычисления

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "items": [
        {
            "date_start": "2021-01-15",
            "date_end": "2021-01-30"
        },
        {
            "date_start": "2021-02-01",
            "date_end": "2021-02-13"
        }
    ]
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.system.workdaysdiff.multiple Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— items Массив элементов
— — date_start date (Y-m-d) Дата начала
— — date_end date (Y-m-d) Конечная дата
— — count_days integer (10) Кол-во рабочих дней

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

{
    "request_identifier": "alphapi.system.workdaysdiff.multiple",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "items": [
            {
                "date_start": "2021-01-15",
                "date_end": "2021-01-30",
                "count_days": 11
            },
            {
                "date_start": "2021-02-01",
                "date_end": "2021-02-13",
                "count_days": 10
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Рабочий календарь #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)
count_only boolean false Вывод только количества строк

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "count_only": false
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.calendar.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— count integer Количество записей без учета "limit"
— items Массив элементов
— — TABLE_ID integer (3) ID таблицы
— — DAY_ID integer (10) ID дня
— — DT_ID integer (10) Тип дня
— — Дата date (Y-m-d H:i:s) Дата
— — Примечание string (255) Примечание

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

{
    "request_identifier": "alphapi.calendar.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "count": 1,
        "items": [
            {
                "TABLE_ID": 1,
                "DAY_ID": 6,
                "DT_ID": 2,
                "Дата": "2001-01-01 01:01:01",
                "Примечание": "Текст примечания"
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

ID текущего пользователя #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.user.id Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— login_id integer (10) ID пользователя

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

{
    "request_identifier": "alphapi.user.id",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "login_id": 101
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Активация пользователя #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
login_id integer (1, 10) Да ID пользователя

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "login_id": 101
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.user.activate Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.user.activate",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Деактивация пользователя #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
login_id integer (1, 10) Да ID пользователя

Пример запроса:

{
    "token": "unique_token_for_30_minutes",
    "login_id": 101
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.user.deactivate Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса

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

{
    "request_identifier": "alphapi.user.deactivate",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "The request was successful"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Избранное кратко #

URL:
Эмулятор
Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
where string (2048) Строка "WHERE" к запросу BASE
orderby string (2048) Строка "ORDER BY" к запросу BASE
limit integer (10) 0 Ограничить кол-во записей (0 - без ограничения)
offset integer (10) 0 Кол-во записей, которое необходимо пропустить (0 - с самого начала)

Пример запроса:

{
    "token": "unique_token_for_30_minutes"
}
Параметр Тип По умолчанию Описание
request_identifier string (255) alphapi.favourites.short Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data Данные
— items Массив элементов
— — FAV_ID integer (10) ID избранного
— — PARENTS string (255) Строка вида #ID1##ID2#, которая указывает на родительскую папку в избранном
— — PARENT_TABLE_ID integer (10) ID таблицы сущности
— — PARENT_ID integer (10) ID Сущности
— — Название string (255) Название избранного
— — Примечание string (255) Примечание избранного
— — OWNER_ID integer (10) ID Пользователя владельца избранного

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

{
    "request_identifier": "alphapi.favourites.short",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "items": [
            {
                "FAV_ID": 123,
                "Примечание": "Текст примечания",
                "PARENT_TABLE_ID": 6,
                "PARENT_ID": 2,
                "Название": "избранное 1",
                "OWNER_ID": 34
            }
        ]
    }
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.
Есть вопросы? E-mail технической поддержки: info@alpha-doc.ru