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

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


Получение токена #

Параметр Тип Обязателен По умолчанию Описание
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) Дата/время окончания действия токена

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

{
    "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"
}
КодСообщениеОписание
400Некорректный запрос.Запрос не содержит необходимых инструкций JSON.
400Проверьте правильность передаваемых ключей параметров.Отсутсвуют обязательные параметры запроса.
403Введённая пара логин/пароль некорректны.Переданные параметры логин/пароль не найдены в БД.
403Ваш аккаунт деактивирован. Обратитесь к администратору системы.Аккаунт с парой логин/пароль деактивирован в подсистеме.
200Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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.projects.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data

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

{
    "request_identifier": "alphapi.projects.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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",
    "where": "ROW_ID = 1",
    "orderby": "ROW_ID ASC",
    "limit": 1,
    "offset": 0
}
Параметр Тип По умолчанию Описание
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

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

{
    "request_identifier": "alphapi.doc.types.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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",
    "where": "[RECIPIENT_ID] = 1",
    "orderby": "[Объект] ASC",
    "limit": 1,
    "offset": 0
}
Параметр Тип По умолчанию Описание
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

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

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

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

Параметр Тип Обязателен По умолчанию Описание
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",
    "where": "[LOGIN_ID] = 1",
    "orderby": "[Основная группа] ASC",
    "limit": 1,
    "offset": 0
}
Параметр Тип По умолчанию Описание
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

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

{
    "request_identifier": "alphapi.users.groups.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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",
    "where": "[LOGIN_ID] = 1",
    "orderby": "[Логин] ASC",
    "limit": 1,
    "offset": 0
}
Параметр Тип По умолчанию Описание
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

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

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

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

Параметр Тип Обязателен По умолчанию Описание
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",
    "where": "POS_ID = 1",
    "orderby": "Должность ASC",
    "limit": 1,
    "offset": 0
}
Параметр Тип По умолчанию Описание
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

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

{
    "request_identifier": "alphapi.positions.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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",
    "where": "RP_ID = 101",
    "orderby": "Дата DESC",
    "limit": 1,
    "offset": 0
}
Параметр Тип По умолчанию Описание
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

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

{
    "request_identifier": "alphapi.commissions.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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

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

{
    "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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 Сообщение успешности запроса

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

{
    "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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",
    "where": "DOC_ID = 101",
    "orderby": "Дата ASC",
    "limit": 1,
    "offset": 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

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

{
    "request_identifier": "alphapi.control.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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.get Информационный идентификатор запроса
error boolean (1) 0 Флаг наличия ошибки в запросе
error_code integer (3) Код ошибки в запросе
error_message string (2048) Сообщение ошибки в запросе
success boolean (1) 0 Флаг успешности запроса
success_message string (2048) 0 Сообщение успешности запроса
data

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

{
    "request_identifier": "alphapi.docs.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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 документа
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

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

{
    "request_identifier": "alphapi.docs.files.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

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

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

{
    "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

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

{
    "request_identifier": "alphapi.docs.audit.all",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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

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

{
    "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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 - с самого начала)

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

{
    "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

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

{
    "request_identifier": "alphapi.doc.access",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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

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

{
    "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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

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

{
    "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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

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

{
    "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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

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

{
    "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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",
    "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

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

{
    "request_identifier": "alphapi.doc.routespoints.get",
    "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,
                "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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",
    "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

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

{
    "request_identifier": "alphapi.doc.comments.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
token string Да Ключ запроса API, полученный при авторизации
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

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

{
    "request_identifier": "alphapi.doc.files.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

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

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

{
    "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

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

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

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

Параметр Тип Обязателен По умолчанию Описание
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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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

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

{
    "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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

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

{
    "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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 документа

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

{
    "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

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

{
    "request_identifier": "alphapi.docs.views.all",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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 - с самого начала)

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

{
    "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

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

{
    "request_identifier": "alphapi.docs.clients.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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


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

Параметр Тип Обязателен По умолчанию Описание
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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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.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

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

{
    "request_identifier": "alphapi.system.comments.get",
    "error": false,
    "error_code": 0,
    "error_message": "",
    "success": true,
    "success_message": "Number of records 1.",
    "data": {
        "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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

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

{
    "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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

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

{
    "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

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

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

{
    "token": "unique_token_for_30_minutes",
    "file_id": 101
}
Параметр Тип По умолчанию Описание
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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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

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

{
    "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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

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

{
    "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

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

Параметр Тип Обязателен По умолчанию Описание
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

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

{
    "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Запрос прошёл успешноНеобходимо прочитать ответный пакет данных.

Есть вопросы? E-mail технической поддержки: info@alpha-doc.ru